Transfers API

List Transfers

GET /transfer/list/

Returns a list of Transfers objects that belong to the merchant.
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.
Merchant	merchant_id	Any transacition with this merchant_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

Other values: CREATED, PENDING, PROCESSING,
SUCCESSFUL, REFUNDED, DISPUTED,
FAILED, CANCELED, REVERSED

tenant

object

The Transaction’s tenant unique identifier

Example value: uuid: "trx_12312_asdfasdf_123aa"

type

string

The type of Transaction.

Example value: TRANSFER

creation_source

string

The creation source of the Transaction.

Example value: MERCHANT_PORTAL

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

variable_fee

integer

The variable fee amount for this transaction.

Example value: 300

fixed_fee

integer

The fixed fee amount for this transaction.

Example value: 100

total_fee

integer

The total fee amount charged for this transaction.

Example value: 400

net_amount

integer

The total net amount (total_amount minus total_fee) to be paid for this transaction

Example value: 9600

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: currency: { 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

remarks

string

The Transaction’s Remarks.

Example value: REQUESTED_BY_MERCHANT

Other values here.

origin_account

string

The ID of the account used to fund this transaction.

Example value: acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340

destination_account

string

The ID of the destination account for this transaction.

Example value: acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340

statement_descriptor

string

Description that DRUO will report to institutions so that it appears on your customers’ statements. This request may or may not be honored by the institutions. Must contain at least one letter, and be between 4 and 22 characters.

Example value: NOVO BILLING* 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

boolean

Declined reason for the transfer.

auto_send_receipt

boolean

If true, the system should generate a receipt automatically to the preffered receipt method.

Example value: FALSE

date_created_gmt

string

Transaction created date

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

date_updated_gmt

string

Transaction created date

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

GET /transfers/list

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

Response

{
    "transfers": [
        {
            "uuid": "trx_1c027030-c89a-4764-bbc1-d79892766cd5",
            "code": "TX2587N5AH5",
            "status": "CANCELED",
            "tenant": {
                "uuid": "ten_35516d40-ca41-4fa3-885c-d13d0ccdae0a"
            },
            "type": "TRANSFER",
            "creation_source": "MERCHANT_API",
            "amount": 20000,
            "variable_fee": "400",
            "fixed_fee": "0",
            "total_fee": "400",
            "net_amount": "0",
            "currency": {
                "code": "USD"
            },
            "description": "Insurance policy renewal - INV12324",
            "remarks": "REQUESTED_BY_MERCHANT",
            "origin_account": {
                "uuid": "acc_b7c41206-afb4-4954-a15c-dbcd59356120"
            },
            "destination_account": {
                "uuid": "acc_286a20b3-b0e7-4907-aeae-461bd1708752"
            },
            "statement_descriptor": "NOVO BILLING* INV12324",
            "primary_reference": null,
            "secondary_reference": null,
            "metadata": {},
            "decline_reason": null,
            "auto_send_receipt": "false",
            "date_created_gmt": "2023-10-09T16:20:12.015Z",
            "date_updated_gmt": "2023-10-09T16:20:39.804Z"
        }
    ],
    "page_info": {
        "has_next_page": true,
        "page_size": 1
    }
}