Payouts API

List Payouts

GET /payouts/list

Returns a list of Payouts associated to a business.

This list uses pagination.

Available Filters

This endpoint supports advanced filtering and search capabilities based on the parameters below.
The parameters should be appended to the API URL as follows:

https://api.druo.com/transfers/list?status=SUCCESSFUL&end_user_email=j.smith@example.com.

Category	Query Parameter	Description
General	code	The transaction's code.
General	status	The transaction's status.
General	description	Any text contained within the transaction's description.
General	amount	The exact transaction amount.
General	tenant_uuid	The transaction's Tenant uuid.
General	amount_less_than	An amount that the transaction must be less than or equal to.
General	amount_greater_than	An amount that the transaction must be greater than or equal to.
General	primary_reference	Any value contained within the primary reference.
General	secondary_reference	Any value contained within the secondary reference.
General	date_from	The beginning of the creation date range in GMT time.
General	date_to	The end of creation date range in GMT time.
Origin Account	origin_account_uuid	Any transaction with an origin account uuid
Origin Account	origin_account_code	Any transaction with an origin account code
Origin Account	origin_account_last_4	Any transaction with an origin account last 4
Origin Account	origin_account_institution_uuid	Any transaction with an origin account institution
Destination Account	destination_account_uuid	Any transaction with an destination account uuid
Destination Account	destination_account_code	Any transaction with an destination account code
Destination Account	destination_account_last_4	Any transaction with an destination account last 4
Destination Account	destination_account_institution_uuid	Any transaction with an destination account institution
End User	end_user_uuid	Any transaction with an end user uuid
End User	end_user_code	Any transaction with an end user code
End User	end_user_email	Any transaction with an end user email
End User	end_user_local_id	Any transaction with an end user local id

Response Fields (array)

uuid

string

The Transaction’s UUID.

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

code

string

The Transaction’s code.

Example value: TXNMW9PCWE

status

string

The Transaction’s status.

Example value: SUCCESSFUL

remarks

string

The Transaction’s remarks.

Example value: INSUFFICIENT_FUNDS

tenant

object

The ID of the Tenant that originated the transaction.

Example value:

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

creation_source

string

The creation source of the Transaction.

Example value: MERCHANT_API

destination_account

object

The ID of the destination account.

Example value:

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

type

string

The type of Transaction.

Example value: PAYOUT

amount

integer

The amount of money, in the smallest denomination of the currency indicated by currency, including the values after the decimal separator. For example, when currency is USD, amount is in cents. $10.00 USD is 1000.

Example value: 10000

currency

object

The type of currency, in ISO 4217 format. See Currency for values. For example, the currency code for US dollars is USD.

Example value: {"code": "USD"}

description

string

The description of this transaction. Users may see this description (e.g., in email receipts DRUO sends on your behalf).

Example value: Insurance policy renewal - INV12324

primary_reference

string

An optional primary ID you can associate with the transaction for your own purposes (such as to associate the transaction with an entity ID in your own database). This value cannot exceed 40 characters.

Example value: ABC123

secondary_reference

string

An optional secondary ID you can associate with the transaction for your own purposes (such as to associate the transaction with an entity ID in your own database). This value cannot exceed 40 characters.
Example value: bj39fhow39fhqp3f0hfae4344

metadata

string

Set of key-value pairs that you can attach to an object. You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long.

Example value: {"order_id": "6735"}

decline_reason

string

The reason behind a transaction being declined.

Example value: INSUFFICCIENT_FUNDS

date_created_gmt

string

Transaction created date

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

date_updated_gmt

string

Transaction updated date

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

net_amount

integer

The Transaction’s net amount:

Example value: 20400

fixed_fee

integer

The Transaction’s fixed fee.

Example value: 0

total_fee

integer

The Transaction’s total fee.

Example value: 400

variable_fee

integer

The Transaction’s variable fee.

Example value: 400

GET /payouts/list

curl --location 'https://api.druo.com/payouts/list' \
--header 'DRUO-Version: 2021-11-22' \
--header 'Authorization: Bearer ACCESS_TOKEN'

Response

{
    "payouts": [
        {
            "uuid": "trx_1f4dc72b-5b76-432c-8f4f-e0919aaff3f5",
            "code": "TICJHVHF85M",
            "status": "SUCCESSFUL",
            "remarks": null,
            "tenant": {
                "uuid": "ten_35516d40-ca41-4fa3-885c-d13d0ccdae0a"
            },
            "creation_source": "MERCHANT_API",
            "destination_account": {
                "uuid": "acc_b7c41206-afb4-4954-a15c-dbcd59356120"
            },
            "type": "PAYOUT",
            "amount": 20000,
            "currency": {
                "code": "USD"
            },
            "description": "null",
            "primary_reference": "null",
            "secondary_reference": "null",
            "metadata": {},
            "decline_reason": null,
            "date_created_gmt": "2023-10-09T16:46:16.766Z",
            "date_updated_gmt": "2023-10-09T16:46:25.163Z",
            "net_amount": "20400",
            "fixed_fee": "0",
            "total_fee": "400",
            "variable_fee": "400"
        }
    ],
    "page_info": {
        "has_next_page": true,
        "page_size": 1
    }
}