Receive updates regarding your payments that you have sent through the API.
EventName | Description |
---|---|
payment.transfer.completed | The payment has been completed, and the beneficiary received the money sent straight to his bank account. |
payment.transfer.failed | The payment has been failed to be executed, and the beneficiary did not receive the money. (The money will be added to your balance, and fees may be taken during the process). |
Objects Structure Samples
{
"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",
"PaidBy":"BENEFICIARY"
},
"AmountPayerPays":1000,
"AmountBeneficiaryReceives":205.28,
"TransferDate":"2022-04-05T21:00:00+00:00",
"Beneficiary":{
"Name":null,
"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"
},
"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",
"PaidBy":"BENEFICIARY"
},
"AmountPayerPays":1000,
"AmountBeneficiaryReceives":205.28,
"TransferDate":"2022-04-05T21:00:00+00:00",
"Beneficiary":{
"Name":null,
"Type":"Company",
"Country":"AU",
"BankDetails": {
"Country":"AU",
"AccountName":"Gook-GTs",
"AccountNumber":"123123123",
"Currency":"AUD",
"AccountRoutingType":"bsb",
"AccountRoutingValue":"012495"
}
},
"Status":"Failed",
"CreatedAt":"2025-06-11T10:50:06.4418208+00:00",
"UpdatedAt":"2025-06-11T10:50:06.4418729+00:00",
"TransferMethod":"LOCAL",
"SwiftChargeOption":"SHARED"
},
"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. |
Fee.PaidBy | string | Indicates who pays the fee ("PAYER", "BENEFICIARY"). |
AmountPayerPays | decimal | Final amount the payer is paying, including fees. |
AmountBeneficiaryReceives | decimal | Final amount the beneficiary receives. |
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. |
SwiftChargeOption | string? | Optional field representing SWIFT charge type (e.g., "SHARED", "OUR"), if available. |