> ## Documentation Index > Fetch the complete documentation index at: https://docs.rc.cleverhub.co/llms.txt > Use this file to discover all available pages before exploring further. # Get Payout Requests in a Period of Time > You can easily query payout payments in a period of time. Currently we support up to 1 year period. Should you need more, please contact us directly. ## OpenAPI ````yaml /api/openapi/v2-reference.yaml get /v2/payouts/all openapi: 3.0.2 info: title: Multi-currency Payment APIs description: >- ## Introduction The Multi-currency Payment API Solution provides developers with a unified API schema to support multiple currencies efficiently. These APIs enable seamless transactions for both payin and payout operations, ensuring a robust, reliable, and scalable payment infrastructure for businesses dealing with various currencies. ### Key Features - **Single API Schema**: A single schema supports all currencies in your account, simplifying integration and management. - **Payin and Payout Process**: - **Step 1**: Call the **Get payin method list** to retrieve the list of supported methods. - **Step 2**: Call the **Get payin required fields** to get specific required fields for each method. - **Step 3**: Create the payment using the method and required fields from the previous step. - **Step 4**: On the sandbox environment, you can call the **Simulate payin** to simulate the payment.
Please note: GST should only be set to true for AU Merchants for AUD currency only. For all other currencies, set GST to false.
This documentation provides detailed guidance for integrating these capabilities into your application. version: 2.0.0 termsOfService: https://helloclever.co/terms contact: email: support@helloclever.co servers: - url: https://api.cleverhub.co/api description: Sandbox Environment - url: https://api-merchant.helloclever.co/api description: Production Environment security: - app-id: [] secret-key: [] paths: /v2/payouts/all: get: tags: - Payout summary: Get Payout Requests in a Period of Time description: >- You can easily query payout payments in a period of time. Currently we support up to 1 year period. Should you need more, please contact us directly. parameters: - name: from_date in: query required: false schema: type: string description: >- Start date to queries payment requests from, format 'DD/MM/YY' or 'YYYY-MM-DDThh:mm:ss'. This datetime would be in UTC timezone example: '2022-01-01T00:00:00' - name: to_date in: query required: false schema: type: string description: >- End date to queries payment requests, format 'DD/MM/YY' or 'YYYY-MM-DDThh:mm:ss'. This datetime would be in UTC timezone example: '2022-01-01T00:00:00' - name: page in: query required: false schema: type: string description: Page number to query. Currently we support 20 records per page - name: external_id in: query required: false schema: type: string description: > Filter payout requests by a custom external_id (either the global-level ID assigned to the payout request or any ID inside individual payout_transactions[]). example: '123' responses: '200': description: OK content: application/json: schema: type: object properties: from_date: type: string example: 2022-01-01T00:00:00.000+0000 to_date: type: string example: 2022-12-01T00:00:00.000+0000 page: type: integer example: 1 size: type: integer example: 10 next_page: type: integer example: 2 total_page: type: integer example: 1 total_count: type: integer example: 10 records: type: array items: type: object properties: uuid: type: string example: OHXTEF9M currency: type: string example: PHP description: Currency payout payout_method_name: type: string example: ph_ewallet_gcash_php description: Payout method description: type: string example: Payout payment 2023 description: Description of payout payment. minLength: 1 maxLength: 90 total_amount: type: string example: '1000' description: Total amount of list payout transactions status: type: string description: Status of payout payment example: completed enum: - created - processing - scheduled - completed - expired webhook_notification: allOf: - required: - endpoint_url - authorization_header type: object description: Merchant Callback Details properties: endpoint_url: type: string format: url (endpoint_url) example: https://example.org description: >- An internet accessible url which Hello Clever will invoke when the status of the transaction has changed. The call will be done using the HTTP POST method. The endpoint exposed by the client must be TLS 1.2 and the server certificate must be issued by a well known commercial certificate authority and that self-signed or internally signed certs are not acceptable. authorization_header: type: string format: (authorization_header) example: SECRET description: >- The string which Hello Clever will put into the Authorization request header when calling the Callback url. scheduled_at: type: string format: YYYY-MM-DDTHH:mm:ss description: >- Payout transaction to payee in this time. This datetime would be in UTC timezone. example: 2023-04-01T00:00:00.000+0000 payout_transactions: type: array items: type: object properties: uuid: type: string example: OHXTEF9M balance_id: type: string description: Balance transaction UUID example: 808C75EF-988143EB payee: type: string example: John Scarlet description: Name of payee. amount: type: string example: '100.00' description: Amount to charge payment. payout_method_params: type: object description: Required parameters for payout method name example: account_number: 123456789999 account_name: Luyx bank_code: 11111 status: type: string description: Status of payout transaction example: settled enum: - created - processing - settled - failed external_id: type: string description: Custom ID example: '456' error_message: type: string example: PayID not found description: Error message when payout transaction failed. created_at: type: string description: >- Timestamp when the payout transaction was created (UTC Time) example: 2022-01-01T00:00:00.000+0000 error_code: type: string description: >- Error code for the batch. We have 2 error codes `HC_PAYOUT1` (Insufficient funds to payout. Please topup balance in dashboard) and `HC_PAYOUT2` (Insufficient Balance. Hello Clever will charge your PayTo agreement to pay out). example: HC_PAYOUT1 error_message: type: string description: >- A description corresponds to the value of the statusCode field. example: Insufficient available funds. Top up your balance. external_id: type: string description: Custom ID example: '123' '400': description: Bad Request '401': description: Unauthorized content: application/json: schema: type: object properties: errors: type: object properties: code: type: string message: type: string example: errors: code: REQUIRE_LOGIN message: Not Authorised '404': description: Not Found content: application/json: schema: type: object properties: errors: type: object properties: message: type: string example: errors: message: Not found '422': description: Unporcessable Entity content: application/json: schema: type: object properties: errors: type: object properties: message: type: string example: errors: message: Invalid date components: securitySchemes: app-id: type: apiKey in: header name: app-id description: | A unique identifier assigned to each application. secret-key: type: apiKey in: header name: secret-key description: | A secure token associated with the `app-id`. ```` ## Related topics - [Get Contact Requests in a Period of Time](/api/contact/get-contact-requests-in-a-period-of-time.md) - [Get Customer Requests in a Period of Time](/api/customer/get-customer-requests-in-a-period-of-time.md) - [Get Payin Requests in a Period of Time](/api/payin/get-payin-requests-in-a-period-of-time.md)