Transaction created webhook

Authorizations

Authorization

string

header

required

To authenticate server-side requests

Body

application/json

Response schema for a transaction creation request

transactionId

string<uuid>

required

Unique identifier of the transaction

Example:

"1d8beb26-b4d1-47ee-8e5d-0d3905f200c7"

customerId

string

required

ID of the customer associated with this transaction

Example:

"0423300f-ae6d-4e82-8afb-a3b430e22e29"

quoteId

string

required

ID of the quote used for this transaction

Example:

"1d8beb26-b4d1-47ee-8e5d-0d3905f200c7"

transactionStatus

enum<string>

required

Current status of the transaction

Available options:

AWAITING_TRANSFER,

PROCESSING,

COMPLETED,

FAILED,

CANCELLED,

CREATED,

EXPIRED

Example:

"PROCESSING"

source

object

required

Show child attributes

source.sourceCurrency

Currency Schema · object

required

Schema representing either a fiat or crypto currency

Currency Schema
Currency Schema

Show child attributes

source.sourceCurrency.label

string

required

source.sourceCurrency.chain

enum<string>

The chain the crypto currency is on

Available options:

ARBITRUM,

BASE,

ETHEREUM,

OPTIMISM,

POLYGON,

SOLANA

source.sourceCurrency.contractAddress

string

source.sourceCurrency.currencyDecimals

number

Example:

{
  "label": "USDC",
  "chain": "ETHEREUM",
  "contractAddress": "0x123456789abcd123456789abcd123456789abcd",
  "currencyDecimals": 18
}

source.sourcePaymentMethod

required

The payment method for the source transaction

Available options:

ACH,

WIRE,

SEPA,

AE_UAEFTS,

AR_TRANSFERS_3,

AU_BECS,

BD_BEFTN,

BO_RTGS,

BR_TED_DOC_PIX,

CA_INTERAC,

CL_TEF,

CN_CNAPS,

CO_ACH,

CR_SINPE,

CZ_CERTIS,

DK_NEMKONTO_FI,

DO_ACH,

EC_LOCAL,

EG_RTGS_IPN,

GB_BACS_CHAPS_FPS,

GH_GHIPSS,

GT_ACH,

HK_HKICL_CHATS_ECG,

HU_GIRO,

ID_SKN_RTGS,

IL_ZAHAV,

IN_NEFT_RTGS_IMPS,

JM_LOCAL,

JO_ACH,

JP_ZENGIN,

KE_KIBBS_PESALINK,

KR_LOCAL,

LK_LOCAL,

MX_SPEI,

MY_IBG_RENTAS,

NG_NIBSS_NEFT,

NO_NICS,

NP_LOCAL,

NZ_LOCAL,

PE_CCE,

PH_INSTAPAY_PESONET,

PK_RAAST_IBFT,

PL_ELIXIR_BLUE_CASH,

QA_QPS,

RO_RTGS,

SA_MADA,

SE_BANKGIROT,

SG_FAST_MEPS,

SV_LOCAL,

SWIFT,

TH_BAHTNET_PROMPTPAY,

TR_FAST_EFT,

TZ_RTGS,

VN_IBPS,

ZA_RTGS_EFT,

ACH_SAME_DAY

Example:

"ACH"

source.sourceAmount

string

required

The amount to be sent

Example:

"100.00"

source.sourcePaymentAccountId

string<uuid>

The sending Payment Account Id.

Example:

"072a8b7b-38c7-429a-a6cf-35dae7f2fb77"

source.sourceReferenceId

string

The source reference id or on chain transaction hash when applicable

Example:

"0x5332ee2726b7a1b818447d116f81af3be3518a801fb229ebf43e563c0ac4b4bc"

destination

object

required

Show child attributes

destination.destinationPaymentAccountId

string<uuid>

required

The receiving Payment Account Id.

Example:

"072a8b7b-38c7-429a-a6cf-35dae7f2fb77"

destination.destinationPaymentMethod

required

The payment method for the destination transaction

Available options:

ACH,

WIRE,

SEPA,

AE_UAEFTS,

AR_TRANSFERS_3,

AU_BECS,

BD_BEFTN,

BO_RTGS,

BR_TED_DOC_PIX,

CA_INTERAC,

CL_TEF,

CN_CNAPS,

CO_ACH,

CR_SINPE,

CZ_CERTIS,

DK_NEMKONTO_FI,

DO_ACH,

EC_LOCAL,

EG_RTGS_IPN,

GB_BACS_CHAPS_FPS,

GH_GHIPSS,

GT_ACH,

HK_HKICL_CHATS_ECG,

HU_GIRO,

ID_SKN_RTGS,

IL_ZAHAV,

IN_NEFT_RTGS_IMPS,

JM_LOCAL,

JO_ACH,

JP_ZENGIN,

KE_KIBBS_PESALINK,

KR_LOCAL,

LK_LOCAL,

MX_SPEI,

MY_IBG_RENTAS,

NG_NIBSS_NEFT,

NO_NICS,

NP_LOCAL,

NZ_LOCAL,

PE_CCE,

PH_INSTAPAY_PESONET,

PK_RAAST_IBFT,

PL_ELIXIR_BLUE_CASH,

QA_QPS,

RO_RTGS,

SA_MADA,

SE_BANKGIROT,

SG_FAST_MEPS,

SV_LOCAL,

SWIFT,

TH_BAHTNET_PROMPTPAY,

TR_FAST_EFT,

TZ_RTGS,

VN_IBPS,

ZA_RTGS_EFT,

ACH_SAME_DAY

Example:

"ETHEREUM"

destination.destinationCurrency

Currency Schema · object

required

Schema representing either a fiat or crypto currency

Currency Schema
Currency Schema

Show child attributes

destination.destinationCurrency.label

string

required

destination.destinationCurrency.chain

enum<string>

The chain the crypto currency is on

Available options:

ARBITRUM,

BASE,

ETHEREUM,

OPTIMISM,

POLYGON,

SOLANA

destination.destinationCurrency.contractAddress

string

destination.destinationCurrency.currencyDecimals

number

Example:

{
  "label": "USDC",
  "chain": "ETHEREUM",
  "contractAddress": "0x123456789abcd123456789abcd123456789abcd",
  "currencyDecimals": 18
}

destination.exchangeRate

string

required

The rate at which the source currency is multiplied to determine the equivalent amount in the destination currency

Example:

"1.2"

destination.destinationAmount

string

required

The amount to convert and send, expressed in decimals and denominated in the source currency

Example:

"100"

destination.destinationReferenceId

string

The destination reference id or on chain transaction hash when applicable

Example:

"0x5332ee2726b7a1b818447d116f81af3be3518a801fb229ebf43e563c0ac4b4bc"

fees

Fees Schema · object

required

Fee structure for a transaction

Show child attributes

fees.feeCurrency

Currency Schema · object

required

Schema representing either a fiat or crypto currency

Currency Schema
Currency Schema

Show child attributes

fees.feeCurrency.label

string

required

fees.feeCurrency.chain

enum<string>

The chain the crypto currency is on

Available options:

ARBITRUM,

BASE,

ETHEREUM,

OPTIMISM,

POLYGON,

SOLANA

fees.feeCurrency.contractAddress

string

fees.feeCurrency.currencyDecimals

number

Example:

{
  "label": "USDC",
  "chain": "ETHEREUM",
  "contractAddress": "0x123456789abcd123456789abcd123456789abcd",
  "currencyDecimals": 18
}

fees.fernFee

Fee Schema · object

required

Fee Amount in USD and in the fee currency

Show child attributes

fees.fernFee.feeAmount

string

required

Amount of this fee that was applied

Example:

"5.45"

fees.fernFee.feeUSDAmount

string

required

Amount of this fee that was applied in USD

Example:

"5.45"

fees.developerFee

Fee Schema · object

required

Fee Amount in USD and in the fee currency

Show child attributes

fees.developerFee.feeAmount

string

required

Amount of this fee that was applied

Example:

"5.45"

fees.developerFee.feeUSDAmount

string

required

Amount of this fee that was applied in USD

Example:

"5.45"

createdAt

string

required

ISO timestamp when this transaction was created

Example:

"2023-08-01T12:00:00Z"

updatedAt

string

required

ISO timestamp when this transaction was last updated

Example:

"2023-08-01T12:00:00Z"

correlationId

string

Optional: You can add your own correlationId to match the transaction to your own internal records.

Example:

"03b7030f-6da1-4e76-3352-3debd82112c8"

transferInstructions

Fiat Transfer Instructions · object

Instructions for the customer to initiate the transfer

Fiat Transfer Instructions
Crypto Transfer Instructions

Show child attributes

transferInstructions.type

enum<string>

required

Available options:

fiat

transferInstructions.transferPaymentMethod

enum<string>

required

The fiat payment method used for the transaction

Available options:

ACH,

WIRE,

SEPA,

AE_UAEFTS,

AR_TRANSFERS_3,

AU_BECS,

BD_BEFTN,

BO_RTGS,

BR_TED_DOC_PIX,

CA_INTERAC,

CL_TEF,

CN_CNAPS,

CO_ACH,

CR_SINPE,

CZ_CERTIS,

DK_NEMKONTO_FI,

DO_ACH,

EC_LOCAL,

EG_RTGS_IPN,

GB_BACS_CHAPS_FPS,

GH_GHIPSS,

GT_ACH,

HK_HKICL_CHATS_ECG,

HU_GIRO,

ID_SKN_RTGS,

IL_ZAHAV,

IN_NEFT_RTGS_IMPS,

JM_LOCAL,

JO_ACH,

JP_ZENGIN,

KE_KIBBS_PESALINK,

KR_LOCAL,

LK_LOCAL,

MX_SPEI,

MY_IBG_RENTAS,

NG_NIBSS_NEFT,

NO_NICS,

NP_LOCAL,

NZ_LOCAL,

PE_CCE,

PH_INSTAPAY_PESONET,

PK_RAAST_IBFT,

PL_ELIXIR_BLUE_CASH,

QA_QPS,

RO_RTGS,

SA_MADA,

SE_BANKGIROT,

SG_FAST_MEPS,

SV_LOCAL,

SWIFT,

TH_BAHTNET_PROMPTPAY,

TR_FAST_EFT,

TZ_RTGS,

VN_IBPS,

ZA_RTGS_EFT,

ACH_SAME_DAY

transferInstructions.transferMessage

string

Message or memo that the customer must include with the deposit

Example:

"Payment for order #12345"

transferInstructions.transferBankName

string

Name of the bank for deposit

Example:

"First National Bank"

transferInstructions.transferBankAddress

string

Address of the bank

Example:

"123 Bank St, Finance City"

transferInstructions.transferBankAccountNumber

string

Bank account number for deposit

Example:

"987654321"

transferInstructions.transferRoutingNumber

string

Routing number of the bank

Example:

"123456789"

transferInstructions.transferBankBeneficiaryName

string

Beneficiary name associated with the bank account

Example:

"John Doe"

transferInstructions.transferIban

string

IBAN for international transfers

Example:

"GB29NWBK60161331926819"

transferInstructions.transferBicSwift

string

BIC/SWIFT code of the bank

Example:

"DEUTDEFF"

transferInstructions.transferIfscCode

string

IFSC code for Indian bank transfers

Example:

"SBIN0005943"

transferInstructions.transferSortCode

string

UK sort code

Example:

"40-47-36"

transferInstructions.transferBsbNumber

string

BSB number for Australian banks

Example:

"082-902"

transferInstructions.transferTransitNumber

string

Canadian transit number

Example:

"12345"

transferInstructions.transferBankCode

string

Generic bank code

Example:

"001"

transferInstructions.transferClabeNumber

string

CLABE number for Mexican bank transfers

Example:

"002010077777777771"

transferInstructions.transferRoutingCode

string

Alternate routing code

Example:

"ROUT1234"

transferInstructions.transferBranchCode

string

Branch code

Example:

"0001"

transferInstructions.transferClearingCode

string

Clearing code

Example:

"110000"

transferInstructions.transferCnapsCode

string

CNAPS code for Chinese banks

Example:

"102033003330"

transferInstructions.transferNubanCode

string

NUBAN number for Nigerian banks

Example:

"1234567890"

transferInstructions.transferPixCode

string

PIX key for Brazilian instant payments

Example:

"[email protected]"

transferInstructions.transferPaymentLink

string

Payment link for making the transfer (used for Colombian pesos)

Example:

"https://secure.payzen.lat/t/paxsz1d7"

expiresAt

string

ISO timestamp when this transaction expires (only for AWAITING_TRANSFER status)

Example:

"2023-08-01T12:05:00Z"

Response

200

Acknowledged

Customers

Transactions

Quotes

Payment Accounts

Automation Rules

Webhooks

Authorizations

Body

Response