Payments

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

Event NameDescription
payment.transfer.paidThe payment has been completed, and the beneficiary received the money sent straight to his bank account.
payment.transfer.rejectedThe payment has been rejected, and the beneficiary did not receive the money. (The sent money will be added to your balance)
payment.transfer.returnedThe 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


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.
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.
FailureReasonstringThe reason of failure
RefundDetailsobjectThe details of the refund
RefundDetails.AmountdecimalThe amount refunded (fee may apply on top of that)
RefundDetails.FeedecimalThe taken fee for the rejection/return operation
RefundDetails.CurrencystringThe Sent money Currency code in ISO 4217 format (e.g., "USD", "EUR").