Payments

Receive updates regarding your payments that you have sent through the API.

EventNameDescription
payment.transfer.completedThe payment has been completed, and the beneficiary received the money sent straight to his bank account.
payment.transfer.failedThe 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


PropertyTypeDescription
IdGuidUnique identifier of the payment.
SendobjectAmount and currency sent by the payer.
Send.CurrencystringCurrency code in ISO 4217 format (e.g., "USD", "EUR").
Send.AmountdecimalSent amount in the given currency.
ChargeobjectAmount and currency charged.
Charge.CurrencystringCurrency code in ISO 4217 format (e.g., "USD", "EUR").
Charge.AmountdecimalCharged amount in the given currency
FeeobjectFee details including amount, currency, and who paid it.
Fee.CurrencystringCurrency code in ISO 4217 format (e.g., "USD", "EUR").
Fee.AmountdecimalFee amount in the given currency.
Fee.PaidBystringIndicates who pays the fee ("PAYER", "BENEFICIARY").
AmountPayerPaysdecimalFinal amount the payer is paying, including fees.
AmountBeneficiaryReceivesdecimalFinal amount the beneficiary receives.
TransferDateDateTimeOffsetDate the transfer is scheduled or completed.
BeneficiaryobjectRecipient details such as name, type, and bank info.
Beneficiary.NamestringThe name of the beneficiary.
Beneficiary.TypestringType of beneficiary ("Individual", "Company")
Beneficiary.CountrystringCountry code (ISO) of the beneficiary.
Beneficiary.BankDetailsobjectBank account details of the beneficiary.
Beneficiary.BankDetails.CountrystringBank country code (ISO).
Beneficiary.BankDetails.AccountNamestringBank account holder name
Beneficiary.BankDetails.AccountNumberstringAccount number
Beneficiary.BankDetails.CurrencystringCurrency code in ISO 4217 format (e.g., "USD", "EUR").
Beneficiary.BankDetails.Ibanstring?Iban number, if available.
Beneficiary.BankDetails.SwiftCodestring?Swift code, if available.
Beneficiary.BankDetails.AccountRoutingTypestring?Type of bank routing info ("ABA", "CNAPS", etc.), if available.
Beneficiary.BankDetails.AccountRoutingValuestring?Routing value, if available.
StatusstringCurrent status of the payment ("Completed", "Failed").
CreatedAtDateTimeOffsetWhen the payment was created in the system.
UpdatedAtDateTimeOffsetLast time the payment was updated.
TransferMethodstringMethod of transfer.
SwiftChargeOptionstring?Optional field representing SWIFT charge type (e.g., "SHARED", "OUR"), if available.