List transactions

curl --request GET \
  --url https://api.fernhq.com/transactions \
  --header 'Authorization: Bearer <token>'

{
  "transactions": [
    {
      "transactionId": "1d8beb26-b4d1-47ee-8e5d-0d3905f200c7",
      "customerId": "0423300f-ae6d-4e82-8afb-a3b430e22e29",
      "quoteId": "1d8beb26-b4d1-47ee-8e5d-0d3905f200c7",
      "transactionStatus": "PROCESSING",
      "source": {
        "sourceCurrency": {
          "label": "USDC",
          "chain": "ETHEREUM",
          "contractAddress": "0x123456789abcd123456789abcd123456789abcd",
          "currencyDecimals": 18
        },
        "sourcePaymentMethod": "ACH",
        "sourceAmount": "100.00",
        "sourcePaymentAccountId": "072a8b7b-38c7-429a-a6cf-35dae7f2fb77",
        "sourceReferenceId": "0x5332ee2726b7a1b818447d116f81af3be3518a801fb229ebf43e563c0ac4b4bc"
      },
      "destination": {
        "destinationPaymentAccountId": "072a8b7b-38c7-429a-a6cf-35dae7f2fb77",
        "destinationPaymentMethod": "ETHEREUM",
        "destinationCurrency": {
          "label": "USDC",
          "chain": "ETHEREUM",
          "contractAddress": "0x123456789abcd123456789abcd123456789abcd",
          "currencyDecimals": 18
        },
        "exchangeRate": "1.2",
        "destinationAmount": "100",
        "destinationReferenceId": "0x5332ee2726b7a1b818447d116f81af3be3518a801fb229ebf43e563c0ac4b4bc"
      },
      "fees": {
        "feeCurrency": {
          "label": "USDC",
          "chain": "ETHEREUM",
          "contractAddress": "0x123456789abcd123456789abcd123456789abcd",
          "currencyDecimals": 18
        },
        "fernFee": {
          "feeAmount": "5.45",
          "feeUSDAmount": "5.45"
        },
        "developerFee": {
          "feeAmount": "5.45",
          "feeUSDAmount": "5.45"
        }
      },
      "createdAt": "2023-08-01T12:00:00Z",
      "updatedAt": "2023-08-01T12:00:00Z",
      "correlationId": "03b7030f-6da1-4e76-3352-3debd82112c8",
      "transferInstructions": {
        "type": "fiat",
        "transferPaymentMethod": "ACH",
        "transferMessage": "Payment for order #12345",
        "transferBankName": "First National Bank",
        "transferBankAddress": "123 Bank St, Finance City",
        "transferBankAccountNumber": "987654321",
        "transferRoutingNumber": "123456789",
        "transferBankBeneficiaryName": "John Doe",
        "transferIban": "GB29NWBK60161331926819",
        "transferBicSwift": "DEUTDEFF",
        "transferIfscCode": "SBIN0005943",
        "transferSortCode": "40-47-36",
        "transferBsbNumber": "082-902",
        "transferTransitNumber": "12345",
        "transferBankCode": "001",
        "transferClabeNumber": "002010077777777771",
        "transferRoutingCode": "ROUT1234",
        "transferBranchCode": "0001",
        "transferClearingCode": "110000",
        "transferCnapsCode": "102033003330",
        "transferNubanCode": "1234567890",
        "transferPixCode": "[email protected]",
        "transferPaymentLink": "https://secure.payzen.lat/t/paxsz1d7"
      },
      "expiresAt": "2023-08-01T12:05:00Z"
    }
  ],
  "nextPageToken": "ZDE4YmViMjYtYjRkMS00N2VlLThlNWQtMGQzOTA1ZjIwMGM3"
}

GET

transactions

List transactions

curl --request GET \
  --url https://api.fernhq.com/transactions \
  --header 'Authorization: Bearer <token>'

{
  "transactions": [
    {
      "transactionId": "1d8beb26-b4d1-47ee-8e5d-0d3905f200c7",
      "customerId": "0423300f-ae6d-4e82-8afb-a3b430e22e29",
      "quoteId": "1d8beb26-b4d1-47ee-8e5d-0d3905f200c7",
      "transactionStatus": "PROCESSING",
      "source": {
        "sourceCurrency": {
          "label": "USDC",
          "chain": "ETHEREUM",
          "contractAddress": "0x123456789abcd123456789abcd123456789abcd",
          "currencyDecimals": 18
        },
        "sourcePaymentMethod": "ACH",
        "sourceAmount": "100.00",
        "sourcePaymentAccountId": "072a8b7b-38c7-429a-a6cf-35dae7f2fb77",
        "sourceReferenceId": "0x5332ee2726b7a1b818447d116f81af3be3518a801fb229ebf43e563c0ac4b4bc"
      },
      "destination": {
        "destinationPaymentAccountId": "072a8b7b-38c7-429a-a6cf-35dae7f2fb77",
        "destinationPaymentMethod": "ETHEREUM",
        "destinationCurrency": {
          "label": "USDC",
          "chain": "ETHEREUM",
          "contractAddress": "0x123456789abcd123456789abcd123456789abcd",
          "currencyDecimals": 18
        },
        "exchangeRate": "1.2",
        "destinationAmount": "100",
        "destinationReferenceId": "0x5332ee2726b7a1b818447d116f81af3be3518a801fb229ebf43e563c0ac4b4bc"
      },
      "fees": {
        "feeCurrency": {
          "label": "USDC",
          "chain": "ETHEREUM",
          "contractAddress": "0x123456789abcd123456789abcd123456789abcd",
          "currencyDecimals": 18
        },
        "fernFee": {
          "feeAmount": "5.45",
          "feeUSDAmount": "5.45"
        },
        "developerFee": {
          "feeAmount": "5.45",
          "feeUSDAmount": "5.45"
        }
      },
      "createdAt": "2023-08-01T12:00:00Z",
      "updatedAt": "2023-08-01T12:00:00Z",
      "correlationId": "03b7030f-6da1-4e76-3352-3debd82112c8",
      "transferInstructions": {
        "type": "fiat",
        "transferPaymentMethod": "ACH",
        "transferMessage": "Payment for order #12345",
        "transferBankName": "First National Bank",
        "transferBankAddress": "123 Bank St, Finance City",
        "transferBankAccountNumber": "987654321",
        "transferRoutingNumber": "123456789",
        "transferBankBeneficiaryName": "John Doe",
        "transferIban": "GB29NWBK60161331926819",
        "transferBicSwift": "DEUTDEFF",
        "transferIfscCode": "SBIN0005943",
        "transferSortCode": "40-47-36",
        "transferBsbNumber": "082-902",
        "transferTransitNumber": "12345",
        "transferBankCode": "001",
        "transferClabeNumber": "002010077777777771",
        "transferRoutingCode": "ROUT1234",
        "transferBranchCode": "0001",
        "transferClearingCode": "110000",
        "transferCnapsCode": "102033003330",
        "transferNubanCode": "1234567890",
        "transferPixCode": "[email protected]",
        "transferPaymentLink": "https://secure.payzen.lat/t/paxsz1d7"
      },
      "expiresAt": "2023-08-01T12:05:00Z"
    }
  ],
  "nextPageToken": "ZDE4YmViMjYtYjRkMS00N2VlLThlNWQtMGQzOTA1ZjIwMGM3"
}

Authorizations

Authorization

string

header

required

To authenticate server-side requests

Query Parameters

pageToken

string

Token for forward pagination

pageSize

integer

default:10

Number of items per page (default: 10, max: 100)

Required range: x >= 1

customerId

string<uuid>

Customer to list transaction for

paymentAccountId

string<uuid>

Payment account to list transaction for

organizationId

string<uuid>

Organization to list transactions for

Response

Response schema for listing transactions with pagination

transactions

Transactions · object[]

Retrieved transactions

Show child attributes

transactions.transactionId

string<uuid>

required

Unique identifier of the transaction

Example:

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

transactions.customerId

string

required

ID of the customer associated with this transaction

Example:

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

transactions.quoteId

string

required

ID of the quote used for this transaction

Example:

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

transactions.transactionStatus

enum<string>

required

Current status of the transaction

Available options:

AWAITING_TRANSFER,

PROCESSING,

COMPLETED,

FAILED,

CANCELLED,

CREATED,

EXPIRED

Example:

"PROCESSING"

transactions.source

object

required

Show child attributes

transactions.source.sourceCurrency

Currency Schema · object

required

Schema representing either a fiat or crypto currency

Currency Schema
Currency Schema

Show child attributes

transactions.source.sourceCurrency.label

string

required

transactions.source.sourceCurrency.chain

enum<string>

The chain the crypto currency is on

Available options:

ARBITRUM,

BASE,

ETHEREUM,

OPTIMISM,

POLYGON,

SOLANA

transactions.source.sourceCurrency.contractAddress

string

transactions.source.sourceCurrency.currencyDecimals

number

Example:

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

transactions.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"

transactions.source.sourceAmount

string

required

The amount to be sent

Example:

"100.00"

transactions.source.sourcePaymentAccountId

string<uuid>

The sending Payment Account Id.

Example:

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

transactions.source.sourceReferenceId

string

The source reference id or on chain transaction hash when applicable

Example:

"0x5332ee2726b7a1b818447d116f81af3be3518a801fb229ebf43e563c0ac4b4bc"

transactions.destination

object

required

Show child attributes

transactions.destination.destinationPaymentAccountId

string<uuid>

required

The receiving Payment Account Id.

Example:

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

transactions.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"

transactions.destination.destinationCurrency

Currency Schema · object

required

Schema representing either a fiat or crypto currency

Currency Schema
Currency Schema

Show child attributes

transactions.destination.destinationCurrency.label

string

required

transactions.destination.destinationCurrency.chain

enum<string>

The chain the crypto currency is on

Available options:

ARBITRUM,

BASE,

ETHEREUM,

OPTIMISM,

POLYGON,

SOLANA

transactions.destination.destinationCurrency.contractAddress

string

transactions.destination.destinationCurrency.currencyDecimals

number

Example:

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

transactions.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"

transactions.destination.destinationAmount

string

required

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

Example:

"100"

transactions.destination.destinationReferenceId

string

The destination reference id or on chain transaction hash when applicable

Example:

"0x5332ee2726b7a1b818447d116f81af3be3518a801fb229ebf43e563c0ac4b4bc"

transactions.fees

Fees Schema · object

required

Fee structure for a transaction

Show child attributes

transactions.fees.feeCurrency

Currency Schema · object

required

Schema representing either a fiat or crypto currency

Currency Schema
Currency Schema

Show child attributes

transactions.fees.feeCurrency.label

string

required

transactions.fees.feeCurrency.chain

enum<string>

The chain the crypto currency is on

Available options:

ARBITRUM,

BASE,

ETHEREUM,

OPTIMISM,

POLYGON,

SOLANA

transactions.fees.feeCurrency.contractAddress

string

transactions.fees.feeCurrency.currencyDecimals

number

Example:

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

transactions.fees.fernFee

Fee Schema · object

required

Fee Amount in USD and in the fee currency

Show child attributes

transactions.fees.fernFee.feeAmount

string

required

Amount of this fee that was applied

Example:

"5.45"

transactions.fees.fernFee.feeUSDAmount

string

required

Amount of this fee that was applied in USD

Example:

"5.45"

transactions.fees.developerFee

Fee Schema · object

required

Fee Amount in USD and in the fee currency

Show child attributes

transactions.fees.developerFee.feeAmount

string

required

Amount of this fee that was applied

Example:

"5.45"

transactions.fees.developerFee.feeUSDAmount

string

required

Amount of this fee that was applied in USD

Example:

"5.45"

transactions.createdAt

string

required

ISO timestamp when this transaction was created

Example:

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

transactions.updatedAt

string

required

ISO timestamp when this transaction was last updated

Example:

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

transactions.correlationId

string

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

Example:

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

transactions.transferInstructions

Fiat Transfer Instructions · object

Instructions for the customer to initiate the transfer

Fiat Transfer Instructions
Crypto Transfer Instructions

Show child attributes

transactions.transferInstructions.type

enum<string>

required

Available options:

fiat

transactions.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

transactions.transferInstructions.transferMessage

string

Message or memo that the customer must include with the deposit

Example:

"Payment for order #12345"

transactions.transferInstructions.transferBankName

string

Name of the bank for deposit

Example:

"First National Bank"

transactions.transferInstructions.transferBankAddress

string

Address of the bank

Example:

"123 Bank St, Finance City"

transactions.transferInstructions.transferBankAccountNumber

string

Bank account number for deposit

Example:

"987654321"

transactions.transferInstructions.transferRoutingNumber

string

Routing number of the bank

Example:

"123456789"

transactions.transferInstructions.transferBankBeneficiaryName

string

Beneficiary name associated with the bank account

Example:

"John Doe"

transactions.transferInstructions.transferIban

string

IBAN for international transfers

Example:

"GB29NWBK60161331926819"

transactions.transferInstructions.transferBicSwift

string

BIC/SWIFT code of the bank

Example:

"DEUTDEFF"

transactions.transferInstructions.transferIfscCode

string

IFSC code for Indian bank transfers

Example:

"SBIN0005943"

transactions.transferInstructions.transferSortCode

string

UK sort code

Example:

"40-47-36"

transactions.transferInstructions.transferBsbNumber

string

BSB number for Australian banks

Example:

"082-902"

transactions.transferInstructions.transferTransitNumber

string

Canadian transit number

Example:

"12345"

transactions.transferInstructions.transferBankCode

string

Generic bank code

Example:

"001"

transactions.transferInstructions.transferClabeNumber

string

CLABE number for Mexican bank transfers

Example:

"002010077777777771"

transactions.transferInstructions.transferRoutingCode

string

Alternate routing code

Example:

"ROUT1234"

transactions.transferInstructions.transferBranchCode

string

Branch code

Example:

"0001"

transactions.transferInstructions.transferClearingCode

string

Clearing code

Example:

"110000"

transactions.transferInstructions.transferCnapsCode

string

CNAPS code for Chinese banks

Example:

"102033003330"

transactions.transferInstructions.transferNubanCode

string

NUBAN number for Nigerian banks

Example:

"1234567890"

transactions.transferInstructions.transferPixCode

string

PIX key for Brazilian instant payments

Example:

"[email protected]"

transactions.transferInstructions.transferPaymentLink

string

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

Example:

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

transactions.expiresAt

string

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

Example:

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

nextPageToken

string

Token for fetching the next page of results

Example:

"ZDE4YmViMjYtYjRkMS00N2VlLThlNWQtMGQzOTA1ZjIwMGM3"

Update customer KYC data Create transaction

⌘I

Customers

Transactions

Quotes

Payment Accounts

Automation Rules

Webhooks

List transactions

Authorizations

Query Parameters

Response