Transfers

Relevant webhook events:

payout.transfer.in_approval
payout.transfer.scheduled
payout.transfer.overdue
payout.transfer.processing
payout.transfer.sent
payout.transfer.failed
payout.transfer.paid
payout.transfer.cancellation_requested
payout.transfer.cancelled

Payload example:

The data object is the same as the response body of Get transfer by ID API. See example beleow.

JSON
1{
2  "id": "afcee0a3-ea9d-4ce7-88d2-c92f971a6e24",
3  "name": "payout.transfer.scheduled",
4  "account_id": "acct_T_DLJt7NMEKmDaH9gjywcg",
5  "data": {
6    "amount_beneficiary_receives": 50,
7    "amount_payer_pays": 68.14,
8    "beneficiary": {
9      "additional_info": {
10        "personal_email": "[email protected]"
11      },
12      "address": {
13        "city": "Seattle",
14        "country_code": "US",
15        "postcode": "98104",
16        "state": "Alaska",
17        "street_address": "412 5th Avenue"
18      },
19      "bank_details": {
20        "account_currency": "USD",
21        "account_name": "John Walker",
22        "account_number": "50001121",
23        "account_routing_type1": "aba",
24        "account_routing_value1": "021000021",
25        "bank_account_category": "Checking",
26        "bank_country_code": "US",
27        "bank_name": "JP Morgan Chase Bank",
28        "local_clearing_system": "ACH"
29      },
30      "company_name": "Complete Concrete Pty Ltd",
31      "entity_type": "COMPANY",
32      "type": "BANK_ACCOUNT"
33    },
34    "conversion": {
35      "currency_pair": "USDSGD",
36      "rate": 1.285682
37    },
38    "created_at": "2025-07-09T15:41:50+0000",
39    "fee_amount": 3.86,
40    "fee_currency": "SGD",
41    "fee_paid_by": "PAYER",
42    "funding": {
43      "status": "SCHEDULED"
44    },
45    "id": "43217eec-6053-4fe6-b760-6a0d29bf9d51",
46    "lock_rate_on_create": true,
47    "payer": {
48      "additional_info": {
49        "business_incorporation_date": "2024-03-04",
50        "business_registration_number": "HK-575-92-5785",
51        "business_registration_type": "COMPANY"
52      },
53      "address": {
54        "city": "Melbourne",
55        "country_code": "HK",
56        "postcode": "3000",
57        "state": "VIC",
58        "street_address": "Melbourne St, Melbourne St"
59      },
60      "company_name": "Complete Concrete Pty Ltd",
61      "entity_type": "COMPANY"
62    },
63    "prepayment": {
64      "amount": 3.22,
65      "currency": "SGD"
66    },
67    "reason": "travel",
68    "reference": "PMT1936398",
69    "remarks": "",
70    "request_id": "133f6801-0dfe-40a6-9d74-2d1c4b9a89ea",
71    "short_reference_id": "P250709-K61UKW4",
72    "source_currency": "SGD",
73    "status": "SCHEDULED",
74    "swift_charge_option": "SHARED",
75    "transfer_amount": 50,
76    "transfer_currency": "USD",
77    "transfer_date": "2025-07-25",
78    "transfer_method": "LOCAL",
79    "updated_at": "2025-07-09T15:41:50+0000"
80  },
81  "created_at": "2025-07-09T15:41:51+0000",
82  "version": "2025-06-30"
83}

You can also find payload examples of legacy API versions from the Example Response of Get transfer by ID API.

Batch transfers

Relevant webhook events:

payout.batch_transfers.drafting
payout.batch_transfers.in_approval
payout.batch_transfers.approval_recalled
payout.batch_transfers.approval_rejected
payout.batch_transfers.approval_blocked
payout.batch_transfers.scheduled
payout.batch_transfers.overdue
payout.batch_transfers.booking
payout.batch_transfers.partially_booked
payout.batch_transfers.booked
payout.batch_transfers.failed
payout.batch_transfers.cancellation_requested
payout.batch_transfers.cancelled
payout.batch_transfers.funding.scheduled
payout.batch_transfers.funding.processing
payout.batch_transfers.funding.funded
payout.batch_transfers.funding.cancelled
payout.batch_transfers.funding.failed
payout.batch_transfers.funding.reversed

Payload example:

JSON
1{
2  "id": "2a396f97-92f4-3075-98fa-43acf6e87412",
3  "name": "payout.batch_transfers.funding.funded",
4  "account_id": "acct_t6nlGSCgPpWIBE-3ncOTxA",
5  "data": {
6    "funding": {
7      "deposit_type": "DIRECT_DEBIT",
8      "funding_source_id": "ff621b96-9ee9-4429-9dd7-9defef411d11",
9      "status": "FUNDED"
10    },
11    "id": "378e0df8-2c64-460b-921a-9ee69fdd38cd",
12    "metadata": {
13      "id": "5"
14    },
15    "name": "batch-name",
16    "quote_summary": {
17      "expires_at": "2024-03-04T03:09:05+0000",
18      "last_quoted_at": "2024-03-04T03:06:05+0000",
19      "quotes": [
20        {
21          "amount_beneficiary_receives": 100,
22          "amount_payer_pays": 100,
23          "fee_amount": 0,
24          "fee_currency": "AUD",
25          "transfer_currency": "AUD",
26          "source_currency": "AUD"
27        },
28        {
29          "amount_beneficiary_receives": 200,
30          "amount_payer_pays": 308.12,
31          "client_rate": 0.649109,
32          "currency_pair": "AUDUSD",
33          "fee_amount": 0,
34          "fee_currency": "AUD",
35          "transfer_currency": "USD",
36          "source_currency": "AUD"
37        }
38      ]
39    },
40    "remarks": "Any information",
41    "request_id": "8be90dda-cce4-4c70-b5b8-bcff408f599f",
42    "short_reference_id": "B240304-3GK4EPI",
43    "status": "SCHEDULED",
44    "total_item_count": 4,
45    "transfer_date": "2024-03-04",
46    "updated_at": "2024-03-04T03:06:05+0000",
47    "valid_item_count": 3
48  },
49  "created_at": "2024-03-20T09:05:54+0000",
50  "version": "2024-09-27"
51}

Was this page helpful?

On this page

Was this page helpful?