Receive updates, by webhooks, regarding your payments that you have sent through the API.
| Event Name | Description |
|---|---|
| payment.transfer.paid | The payment has been completed, and the beneficiary received the money sent straight to his bank account. |
| payment.transfer.rejected | The payment has been rejected, and the beneficiary did not receive the money. (The sent money will be added to your balance) |
| payment.transfer.returned | The payment has been returned from the bank, and the beneficiary did not receive the money. (The returned money will be added to your balance, while additional fees may be applied) |
Objects Structure Samples
{
"Id":"8fad3651-672e-41a1-8c22-11604cdb8f16",
"Name":"payment.transfer.paid",
"AccountId":"a51ad689-bbca-42ac-8442-fe54c55b9a0e",
"Data":{
"Id":"841c8913-9a15-46bc-8473-9b984b91105d",
"Send": {
"Currency":"AUD",
"Amount":206.6
},
"Charge": {
"Currency":"CNY",
"Amount":1000
},
"Fee": {
"Amount":6.37,
"Currency":"CNY"
},
"TransferDate":"2022-04-05T21:00:00+00:00",
"Beneficiary":{
"Name":"Comp Ltd.",
"Type":"Company",
"Country":"AU",
"BankDetails": {
"Country":"AU",
"AccountName":"Gook-GTs",
"AccountNumber":"123123123",
"Currency":"AUD",
"Iban": "",
"SwiftCode" "",
"AccountRoutingType":"bsb",
"AccountRoutingValue":"012495"
}
},
"Status":"Completed",
"CreatedAt":"2025-06-11T10:50:06.4418208+00:00",
"UpdatedAt":"2025-06-11T10:50:06.4418729+00:00",
"TransferMethod":"LOCAL",
"SwiftChargeOption":"SHARED",
"FailureReason": "",
"RefundDetails": null
},
"CreateAtUtc":"2025-06-11T10:50:07.9172226Z"
}{
"Id":"8fad3651-672e-41a1-8c22-11604cdb8f16",
"Name":"payment.transfer.completed",
"AccountId":"a51ad689-bbca-42ac-8442-fe54c55b9a0e",
"Data":{
"Id":"841c8913-9a15-46bc-8473-9b984b91105d",
"Send": {
"Currency":"AUD",
"Amount":206.6
},
"Charge": {
"Currency":"CNY",
"Amount":1000
},
"Fee": {
"Amount":6.37,
"Currency":"CNY"
},
"TransferDate":"2022-04-05T21:00:00+00:00",
"Beneficiary":{
Id: "578fd445-05a2-43c5-bdc4-4ddd9dbd304d",
"Name":"Comp Ltd.",
"Type":"Company",
"Country":"AU",
"BankDetails": {
"Country":"AU",
"AccountNumber":"123123123",
"SwiftCode": "",
"Iban": "",
"Currency":"AUD",
"AccountRoutingType":"bsb",
"AccountRoutingValue":"012495"
}
},
"Status":"Rejected",
"CreatedAt":"2025-06-11T10:50:06.4418208+00:00",
"UpdatedAt":"2025-06-11T10:50:06.4418729+00:00",
"TransferMethod":"LOCAL",
"FailureReason": "Missing Documents",
"RefundDetails": {
"Amount": 206.6,
"Fee" 0,
"Currency": "AUD"
}
},
"CreateAtUtc":"2025-06-11T10:50:07.9172226Z"
}{
"Id":"8fad3651-672e-41a1-8c22-11604cdb8f16",
"Name":"payment.transfer.completed",
"AccountId":"a51ad689-bbca-42ac-8442-fe54c55b9a0e",
"Data":{
"Id":"841c8913-9a15-46bc-8473-9b984b91105d",
"Send": {
"Currency":"AUD",
"Amount":206.6
},
"Charge": {
"Currency":"CNY",
"Amount":1000
},
"Fee": {
"Amount":6.37,
"Currency":"CNY"
},
"TransferDate":"2022-04-05T21:00:00+00:00",
"Beneficiary":{
Id: "578fd445-05a2-43c5-bdc4-4ddd9dbd304d",
"Name":"Comp Ltd.",
"Type":"Company",
"Country":"AU",
"BankDetails": {
"Country":"AU",
"AccountNumber":"123123123",
"SwiftCode": "",
"Iban": "",
"Currency":"AUD",
"AccountRoutingType":"bsb",
"AccountRoutingValue":"012495"
}
},
"Status":"Returned",
"CreatedAt":"2025-06-11T10:50:06.4418208+00:00",
"UpdatedAt":"2025-06-11T10:50:06.4418729+00:00",
"TransferMethod":"LOCAL",
"FailureReason": "Missing Documents",
"RefundDetails": {
"Amount": 201.5,
"Fee" 2.4,
"Currency": "AUD"
}
},
"CreateAtUtc":"2025-06-11T10:50:07.9172226Z"
}Data Object For Payments
| Property | Type | Description |
|---|---|---|
Id | Guid | Unique identifier of the payment. |
Send | object | Amount and currency sent by the payer. |
Send.Currency | string | Currency code in ISO 4217 format (e.g., "USD", "EUR"). |
Send.Amount | decimal | Sent amount in the given currency. |
Charge | object | Amount and currency charged. |
Charge.Currency | string | Currency code in ISO 4217 format (e.g., "USD", "EUR"). |
Charge.Amount | decimal | Charged amount in the given currency |
Fee | object | Fee details including amount, currency, and who paid it. |
Fee.Currency | string | Currency code in ISO 4217 format (e.g., "USD", "EUR"). |
Fee.Amount | decimal | Fee amount in the given currency. |
TransferDate | DateTimeOffset | Date the transfer is scheduled or completed. |
Beneficiary | object | Recipient details such as name, type, and bank info. |
Beneficiary.Name | string | The name of the beneficiary. |
Beneficiary.Type | string | Type of beneficiary ("Individual", "Company") |
Beneficiary.Country | string | Country code (ISO) of the beneficiary. |
Beneficiary.BankDetails | object | Bank account details of the beneficiary. |
Beneficiary.BankDetails.Country | string | Bank country code (ISO). |
Beneficiary.BankDetails.AccountName | string | Bank account holder name |
Beneficiary.BankDetails.AccountNumber | string | Account number |
Beneficiary.BankDetails.Currency | string | Currency code in ISO 4217 format (e.g., "USD", "EUR"). |
Beneficiary.BankDetails.Iban | string? | Iban number, if available. |
Beneficiary.BankDetails.SwiftCode | string? | Swift code, if available. |
Beneficiary.BankDetails.AccountRoutingType | string? | Type of bank routing info ("ABA", "CNAPS", etc.), if available. |
Beneficiary.BankDetails.AccountRoutingValue | string? | Routing value, if available. |
Status | string | Current status of the payment ("Completed", "Failed"). |
CreatedAt | DateTimeOffset | When the payment was created in the system. |
UpdatedAt | DateTimeOffset | Last time the payment was updated. |
TransferMethod | string | Method of transfer. |
FailureReason | string | The reason of failure |
RefundDetails | object | The details of the refund |
RefundDetails.Amount | decimal | The amount refunded (fee may apply on top of that) |
RefundDetails.Fee | decimal | The taken fee for the rejection/return operation |
RefundDetails.Currency | string | The Sent money Currency code in ISO 4217 format (e.g., "USD", "EUR"). |