DRUO
Get started
Payouts

List Payouts

GEThttps://api.druo.com/payouts/list

Retrieve a list of payouts associated with a business.

This list is paginated and supports advanced filtering and search capabilities based on query parameters such as status and transaction identifiers.

Query parameters

pageintegeroptional

The page number to return. Starts at 1.

page_sizeintegeroptional

The number of items per page. Defaults to 1000 when omitted.

Pagination · Filters

Response— Returns a paginated list.

uuidstringoptional

The unique identifier (UUID) of the transaction.

Example: trx_422f0f81-5001-4cce-a229-242d9ab9960a
codestringoptional

The unique short code of the transaction.

Example: TXNMW9PCWE
statusstringoptional

The current status of the transaction.

Example: SUCCESSFUL
remarksstringoptional

Additional system remarks or notes regarding the transaction status.

Example: INSUFFICIENT_FUNDS
tenantobjectoptional

The tenant object containing the identifier of the tenant that originated the transaction.

Example: {"uuid": "ten_0521aadc-5fbd-4b3c-af0a-a4f4b8d6f20a"}
creation_sourcestringoptional

The system or API channel that initiated the transaction creation.

Example: MERCHANT_API
destination_accountobjectoptional

The destination account object for the payout.

Example: {"uuid": "acc_0521aadc-5fbd-4b3c-af0a-a4f4b8d6f20a"}
typestringoptional

The transaction type, which is always PAYOUT for this endpoint.

Example: PAYOUT
amountintegeroptional

The transaction amount in the smallest denomination of the currency (e.g., cents for USD). For example, $100.00 USD is represented as 10000.

Example: 10000
currencyobjectoptional

The ISO 4217 currency object representing the currency of the transaction.

Example: {"code": "USD"}
descriptionstringoptional

An optional description of the transaction, which may be displayed to users in receipts or notifications.

Example: Insurance policy renewal - INV12324
primary_referencestringoptional

An optional primary identifier used to associate the transaction with an entity in your internal database. Maximum length is 40 characters.

Example: ABC123
secondary_referencestringoptional

An optional secondary identifier used to associate the transaction with an entity in your internal database. Maximum length is 40 characters.

Example: bj39fhow39fhqp3f0hfae4344
metadataobjectoptional

Custom key-value pairs associated with the transaction. You can specify up to 50 keys, with key names up to 40 characters and values up to 500 characters.

Example: {"order_id": "6735"}
decline_reasonstringoptional

The reason why the transaction was declined, if applicable.

Example: INSUFFICCIENT_FUNDS
date_created_gmtstringoptional

The date and time the transaction was created in GMT.

Example: 2021-11-15T23:23:38
date_updated_gmtstringoptional

The date and time the transaction was last updated in GMT.

Example: 2021-11-15T23:23:38
net_amountintegeroptional

The net amount of the transaction after fees.

Example: 20400
fixed_feeintegeroptional

The fixed fee applied to the transaction.

Example: 0
total_feeintegeroptional

The total processing fee applied to the transaction.

Example: 400
variable_feeintegeroptional

The variable fee applied to the transaction.

Example: 400
NextPOSTCreate Transfer