Skip to main content

Webhook Notifications

Notification payloads for each webhook event type.

Events​

Webhook Lifecycle​

WEBHOOK_CREATED

    type WEBHOOK_CREATEDrequired

    data

    object

    required

    webhookId stringrequired
    traceId stringrequired

WEBHOOK_UPDATED

    type WEBHOOK_UPDATEDrequired

    data

    object

    required

    webhookId stringrequired
    traceId stringrequired

WEBHOOK_DELETED

Sent when a webhook subscription is deleted (soft-deleted).

    type WEBHOOK_DELETEDrequired

    data

    object

    required

    webhookId stringrequired
    traceId stringrequired

Customer Events​

CUSTOMER_CREATED

    type CUSTOMER_CREATEDrequired

    data

    object

    required

    customerId stringrequired
    traceId stringrequired

VIRTUAL_ACCOUNT_CREATED

    type VIRTUAL_ACCOUNT_CREATEDrequired

    data

    object

    required

    customerId stringrequired
    walletId stringrequired
    traceId stringrequired

Asset Trade Events​

ASSET_TRADE_SUCCESSFUL

    type ASSET_TRADE_SUCCESSFULrequired

    data

    object

    required

    transactionId stringrequired

    Parent transaction ID

    traceId stringrequired

ASSET_TRADE_FAIL

    type ASSET_TRADE_FAILrequired

    data

    object

    required

    transactionId stringrequired

    Parent transaction ID

    traceId stringrequired

LTV Events​

LTV_LIQUIDATED

    type LTV_LIQUIDATEDrequired

    data

    object

    required

    customerId stringrequired
    traceId stringrequired

LTV_LIQUIDATION_WARNING

    type LTV_LIQUIDATION_WARNINGrequired

    data

    object

    required

    customerId stringrequired
    traceId stringrequired

LTV_URGENT_COLLATERAL_NEEDED

    type LTV_URGENT_COLLATERAL_NEEDEDrequired

    data

    object

    required

    customerId stringrequired
    traceId stringrequired

LTV_COLLATERAL_NEEDED

    type LTV_COLLATERAL_NEEDEDrequired

    data

    object

    required

    customerId stringrequired
    traceId stringrequired

LTV_PURCHASE_RESTRICTED

    type LTV_PURCHASE_RESTRICTEDrequired

    data

    object

    required

    customerId stringrequired
    traceId stringrequired

LTV_THRESHOLD_WARNING

    type LTV_THRESHOLD_WARNINGrequired

    data

    object

    required

    customerId stringrequired
    traceId stringrequired

Bank Transaction Events​

Events for ACH and wire transfers. Use GET /v1/baas/transactions/:bankTransactionId for full details.

BANK_DEPOSIT_TRANSACTION_PENDING

Deposit received, pending clearing.

    type BANK_DEPOSIT_TRANSACTION_PENDINGrequired

    data

    object

    required

    walletId stringrequired
    bankTransactionId stringrequired

    ID of the child bank_transaction record

    amount stringrequired

    Transaction amount (e.g. "1000.00")

    asset stringrequired

    Currency acronym (e.g. "USD")

    bankNetwork string | nullrequired

    "SWIFT", "ACH", "FEDWIRE", or null

    counterparty

    object

    required

    Sender information for deposits. Always null for withdrawals.

    name stringrequired
    givenName string | nullrequired
    surname string | nullrequired
    accountNumber stringrequired
    swiftCode string | null

    BIC/SWIFT code

    routingNumber string | null

    ABA routing number

    financialInstitutionId string | null

    Fallback FI ID when type is not BIC/SWIFT/ABA/ROUTING

    street1 string | null
    street2 string | null
    cityCounty string | null
    stateRegion string | null
    countryCode string | null
    zip string | null
    addressLine string | null
    traceId stringrequired

BANK_DEPOSIT_TRANSACTION_COMPLETED

Deposit cleared successfully.

    type BANK_DEPOSIT_TRANSACTION_COMPLETEDrequired

    data

    object

    required

    walletId stringrequired
    bankTransactionId stringrequired

    ID of the child bank_transaction record

    amount stringrequired

    Transaction amount (e.g. "1000.00")

    asset stringrequired

    Currency acronym (e.g. "USD")

    bankNetwork string | nullrequired

    "SWIFT", "ACH", "FEDWIRE", or null

    counterparty

    object

    required

    Sender information for deposits. Always null for withdrawals.

    name stringrequired
    givenName string | nullrequired
    surname string | nullrequired
    accountNumber stringrequired
    swiftCode string | null

    BIC/SWIFT code

    routingNumber string | null

    ABA routing number

    financialInstitutionId string | null

    Fallback FI ID when type is not BIC/SWIFT/ABA/ROUTING

    street1 string | null
    street2 string | null
    cityCounty string | null
    stateRegion string | null
    countryCode string | null
    zip string | null
    addressLine string | null
    traceId stringrequired

BANK_DEPOSIT_TRANSACTION_FAILED

Deposit failed (returned, rejected).

    type BANK_DEPOSIT_TRANSACTION_FAILEDrequired

    data

    object

    required

    walletId stringrequired
    bankTransactionId stringrequired

    ID of the child bank_transaction record

    amount stringrequired

    Transaction amount (e.g. "1000.00")

    asset stringrequired

    Currency acronym (e.g. "USD")

    bankNetwork string | nullrequired

    "SWIFT", "ACH", "FEDWIRE", or null

    counterparty

    object

    required

    Sender information for deposits. Always null for withdrawals.

    name stringrequired
    givenName string | nullrequired
    surname string | nullrequired
    accountNumber stringrequired
    swiftCode string | null

    BIC/SWIFT code

    routingNumber string | null

    ABA routing number

    financialInstitutionId string | null

    Fallback FI ID when type is not BIC/SWIFT/ABA/ROUTING

    street1 string | null
    street2 string | null
    cityCounty string | null
    stateRegion string | null
    countryCode string | null
    zip string | null
    addressLine string | null
    traceId stringrequired

BANK_WITHDRAWAL_TRANSACTION_PENDING

Withdrawal initiated, funds reserved.

    type BANK_WITHDRAWAL_TRANSACTION_PENDINGrequired

    data

    object

    required

    walletId stringrequired
    bankTransactionId stringrequired

    ID of the child bank_transaction record

    amount stringrequired

    Transaction amount (e.g. "1000.00")

    asset stringrequired

    Currency acronym (e.g. "USD")

    bankNetwork string | nullrequired

    "SWIFT", "ACH", "FEDWIRE", or null

    counterparty

    object

    required

    Sender information for deposits. Always null for withdrawals.

    name stringrequired
    givenName string | nullrequired
    surname string | nullrequired
    accountNumber stringrequired
    swiftCode string | null

    BIC/SWIFT code

    routingNumber string | null

    ABA routing number

    financialInstitutionId string | null

    Fallback FI ID when type is not BIC/SWIFT/ABA/ROUTING

    street1 string | null
    street2 string | null
    cityCounty string | null
    stateRegion string | null
    countryCode string | null
    zip string | null
    addressLine string | null
    traceId stringrequired

BANK_WITHDRAWAL_TRANSACTION_COMPLETED

Withdrawal completed successfully.

    type BANK_WITHDRAWAL_TRANSACTION_COMPLETEDrequired

    data

    object

    required

    walletId stringrequired
    bankTransactionId stringrequired

    ID of the child bank_transaction record

    amount stringrequired

    Transaction amount (e.g. "1000.00")

    asset stringrequired

    Currency acronym (e.g. "USD")

    bankNetwork string | nullrequired

    "SWIFT", "ACH", "FEDWIRE", or null

    counterparty

    object

    required

    Sender information for deposits. Always null for withdrawals.

    name stringrequired
    givenName string | nullrequired
    surname string | nullrequired
    accountNumber stringrequired
    swiftCode string | null

    BIC/SWIFT code

    routingNumber string | null

    ABA routing number

    financialInstitutionId string | null

    Fallback FI ID when type is not BIC/SWIFT/ABA/ROUTING

    street1 string | null
    street2 string | null
    cityCounty string | null
    stateRegion string | null
    countryCode string | null
    zip string | null
    addressLine string | null
    traceId stringrequired

BANK_WITHDRAWAL_TRANSACTION_FAILED

Withdrawal failed.

    type BANK_WITHDRAWAL_TRANSACTION_FAILEDrequired

    data

    object

    required

    walletId stringrequired
    bankTransactionId stringrequired

    ID of the child bank_transaction record

    amount stringrequired

    Transaction amount (e.g. "1000.00")

    asset stringrequired

    Currency acronym (e.g. "USD")

    bankNetwork string | nullrequired

    "SWIFT", "ACH", "FEDWIRE", or null

    counterparty

    object

    required

    Sender information for deposits. Always null for withdrawals.

    name stringrequired
    givenName string | nullrequired
    surname string | nullrequired
    accountNumber stringrequired
    swiftCode string | null

    BIC/SWIFT code

    routingNumber string | null

    ABA routing number

    financialInstitutionId string | null

    Fallback FI ID when type is not BIC/SWIFT/ABA/ROUTING

    street1 string | null
    street2 string | null
    cityCounty string | null
    stateRegion string | null
    countryCode string | null
    zip string | null
    addressLine string | null
    traceId stringrequired

Internal Transfer Events​

Events for wallet-to-wallet transfers. Note: Internal transfers send 2 webhooks - one for each wallet.

INTERNAL_TRANSACTION_COMPLETED

Internal transfer completed. Source wallet owner receives a debit webhook; destination wallet owner receives a credit webhook.

    type INTERNAL_TRANSACTION_COMPLETEDrequired

    data

    object

    required

    walletId stringrequired
    transactionId stringrequired

    ID of the parent ledger transaction

    traceId stringrequired

KYC Events​

CUSTOMER_KYC_STARTED

SDK links generated. User needs to complete identity verification.

    type CUSTOMER_KYC_STARTEDrequired

    data

    object

    required

    customerId stringrequired
    status stringrequired

    Onboarding status

    onboardingId stringrequired
    traceId stringrequired

CUSTOMER_KYC_SDK_FLOW_REQUIRED

SDK links generated. User needs to complete identity verification.

    type CUSTOMER_KYC_SDK_FLOW_REQUIREDrequired

    data

    object

    required

    customerId stringrequired
    status stringrequired

    Onboarding status

    onboardingId stringrequired
    traceId stringrequired

CUSTOMER_KYC_SDK_FLOW_COMPLETED

User finished SDK flow. Identity verification submitted.

    type CUSTOMER_KYC_SDK_FLOW_COMPLETEDrequired

    data

    object

    required

    customerId stringrequired
    status stringrequired

    Onboarding status

    onboardingId stringrequired
    traceId stringrequired

CUSTOMER_KYC_FINISHED

Final KYC outcome reached. Check the status field (APPROVED, DENIED_COMPLIANCE, etc.).

    type CUSTOMER_KYC_FINISHEDrequired

    data

    object

    required

    customerId stringrequired
    status stringrequired

    Onboarding status

    onboardingId stringrequired
    traceId stringrequired

CUSTOMER_KYC_RESTARTED

KYC re-run via POST /v1/compliance/kyc/:id/rerun. New onboarding created.

    type CUSTOMER_KYC_RESTARTEDrequired

    data

    object

    required

    customerId stringrequired
    status stringrequired

    Onboarding status

    onboardingId stringrequired
    previousOnboardingId stringrequired
    traceId stringrequired

CUSTOMER_KYC_SDK_EXPIRED

SDK links expired before user completed verification.

    type CUSTOMER_KYC_SDK_EXPIREDrequired

    data

    object

    required

    customerId stringrequired
    status stringrequired

    Onboarding status

    onboardingId stringrequired
    traceId stringrequired

CUSTOMER_KYC_ERROR

System error during verification. Contact support may be required.

    type CUSTOMER_KYC_ERRORrequired

    data

    object

    required

    customerId stringrequired
    status stringrequired

    Onboarding status

    onboardingId stringrequired
    errorType string
    errorMessage string
    traceId stringrequired

KYB Events​

CUSTOMER_KYB_STARTED

Business KYB process started.

    type CUSTOMER_KYB_STARTEDrequired

    data

    object

    required

    customerId stringrequired
    status stringrequired

    Onboarding status

    businessOnboardingId stringrequired
    traceId stringrequired

CUSTOMER_KYB_FINISHED

Business KYB process finished. Check the status field for the outcome.

    type CUSTOMER_KYB_FINISHEDrequired

    data

    object

    required

    customerId stringrequired
    status stringrequired

    Onboarding status

    businessOnboardingId stringrequired
    traceId stringrequired

Cooperative Authorization Events (Credit Cards)​

COOP_AUTH_0100

Authorization request for cooperative authorization cards. Sent when a card transaction requires approval.

    type COOP_AUTH_0100required

    data

    object

    required

    mti stringrequired

    ISO8583 message type indicator

    stan string

    System trace audit number

    rrn string

    Retrieval reference number

    timestamp string

    Transaction timestamp

    amountMinor number

    Transaction amount in minor units

    billingAmountMinor number

    Billing amount in minor units

    currency string

    Currency code

    processingCode string

    Processing code

    mcc string

    Merchant category code

    posEntryMode string

    POS entry mode

    posConditionCode string

    POS condition code

    terminalId string

    Terminal ID

    merchantId string

    Merchant ID

    merchantNameLocation string

    Merchant name and location

    acquirerId string

    Acquirer ID

    cardReferenceId string

    Card reference ID

    posData string

    POS data

    networkData string

    Network data

    networkDataRef string

    Stable transaction lifecycle identifier. Use this to correlate authorization and completion messages when the RRN changes due to settlement batching.

    tpi string

    Transaction program identifier

    original

    object

    mti string

    Original message type indicator

    stan string

    Original STAN

    rrn string

    Original retrieval reference number

    raw

    object

    isoMti stringrequired

    ISO message type indicator

    fields objectrequired

    Raw ISO 8583 fields

    responseCode string

    Response code

    authCode string

    Authorization code

    approvedAmountMinor number

    Approved amount in minor units

    message string

    Response message

    traceId stringrequired

COOP_AUTH_0120

Authorization advice for cooperative authorization cards. Sent for advice messages.

    type COOP_AUTH_0120required

    data

    object

    required

    mti stringrequired

    ISO8583 message type indicator

    stan string

    System trace audit number

    rrn string

    Retrieval reference number

    timestamp string

    Transaction timestamp

    amountMinor number

    Transaction amount in minor units

    billingAmountMinor number

    Billing amount in minor units

    currency string

    Currency code

    processingCode string

    Processing code

    mcc string

    Merchant category code

    posEntryMode string

    POS entry mode

    posConditionCode string

    POS condition code

    terminalId string

    Terminal ID

    merchantId string

    Merchant ID

    merchantNameLocation string

    Merchant name and location

    acquirerId string

    Acquirer ID

    cardReferenceId string

    Card reference ID

    posData string

    POS data

    networkData string

    Network data

    networkDataRef string

    Stable transaction lifecycle identifier. Use this to correlate authorization and completion messages when the RRN changes due to settlement batching.

    tpi string

    Transaction program identifier

    original

    object

    mti string

    Original message type indicator

    stan string

    Original STAN

    rrn string

    Original retrieval reference number

    raw

    object

    isoMti stringrequired

    ISO message type indicator

    fields objectrequired

    Raw ISO 8583 fields

    responseCode string

    Response code

    authCode string

    Authorization code

    approvedAmountMinor number

    Approved amount in minor units

    message string

    Response message

    traceId stringrequired

COOP_AUTH_0200

Financial transaction for cooperative authorization cards. Sent for financial presentments.

    type COOP_AUTH_0200required

    data

    object

    required

    mti stringrequired

    ISO8583 message type indicator

    stan string

    System trace audit number

    rrn string

    Retrieval reference number

    timestamp string

    Transaction timestamp

    amountMinor number

    Transaction amount in minor units

    billingAmountMinor number

    Billing amount in minor units

    currency string

    Currency code

    processingCode string

    Processing code

    mcc string

    Merchant category code

    posEntryMode string

    POS entry mode

    posConditionCode string

    POS condition code

    terminalId string

    Terminal ID

    merchantId string

    Merchant ID

    merchantNameLocation string

    Merchant name and location

    acquirerId string

    Acquirer ID

    cardReferenceId string

    Card reference ID

    posData string

    POS data

    networkData string

    Network data

    networkDataRef string

    Stable transaction lifecycle identifier. Use this to correlate authorization and completion messages when the RRN changes due to settlement batching.

    tpi string

    Transaction program identifier

    original

    object

    mti string

    Original message type indicator

    stan string

    Original STAN

    rrn string

    Original retrieval reference number

    raw

    object

    isoMti stringrequired

    ISO message type indicator

    fields objectrequired

    Raw ISO 8583 fields

    responseCode string

    Response code

    authCode string

    Authorization code

    approvedAmountMinor number

    Approved amount in minor units

    message string

    Response message

    traceId stringrequired

COOP_AUTH_0220

Authorization completion for cooperative authorization cards. Note: The RRN may differ from the original authorization due to settlement batching - use networkDataRef for reliable correlation.

    type COOP_AUTH_0220required

    data

    object

    required

    mti stringrequired

    ISO8583 message type indicator

    stan string

    System trace audit number

    rrn string

    Retrieval reference number

    timestamp string

    Transaction timestamp

    amountMinor number

    Transaction amount in minor units

    billingAmountMinor number

    Billing amount in minor units

    currency string

    Currency code

    processingCode string

    Processing code

    mcc string

    Merchant category code

    posEntryMode string

    POS entry mode

    posConditionCode string

    POS condition code

    terminalId string

    Terminal ID

    merchantId string

    Merchant ID

    merchantNameLocation string

    Merchant name and location

    acquirerId string

    Acquirer ID

    cardReferenceId string

    Card reference ID

    posData string

    POS data

    networkData string

    Network data

    networkDataRef string

    Stable transaction lifecycle identifier. Use this to correlate authorization and completion messages when the RRN changes due to settlement batching.

    tpi string

    Transaction program identifier

    original

    object

    mti string

    Original message type indicator

    stan string

    Original STAN

    rrn string

    Original retrieval reference number

    raw

    object

    isoMti stringrequired

    ISO message type indicator

    fields objectrequired

    Raw ISO 8583 fields

    responseCode string

    Response code

    authCode string

    Authorization code

    approvedAmountMinor number

    Approved amount in minor units

    message string

    Response message

    traceId stringrequired

COOP_AUTH_0420

Reversal transaction for cooperative authorization cards. Sent when a previously authorized transaction is reversed.

    type COOP_AUTH_0420required

    data

    object

    required

    mti stringrequired

    ISO8583 message type indicator

    stan string

    System trace audit number

    rrn string

    Retrieval reference number

    timestamp string

    Transaction timestamp

    amountMinor number

    Transaction amount in minor units

    billingAmountMinor number

    Billing amount in minor units

    currency string

    Currency code

    processingCode string

    Processing code

    mcc string

    Merchant category code

    posEntryMode string

    POS entry mode

    posConditionCode string

    POS condition code

    terminalId string

    Terminal ID

    merchantId string

    Merchant ID

    merchantNameLocation string

    Merchant name and location

    acquirerId string

    Acquirer ID

    cardReferenceId string

    Card reference ID

    posData string

    POS data

    networkData string

    Network data

    networkDataRef string

    Stable transaction lifecycle identifier. Use this to correlate authorization and completion messages when the RRN changes due to settlement batching.

    tpi string

    Transaction program identifier

    original

    object

    mti string

    Original message type indicator

    stan string

    Original STAN

    rrn string

    Original retrieval reference number

    raw

    object

    isoMti stringrequired

    ISO message type indicator

    fields objectrequired

    Raw ISO 8583 fields

    responseCode string

    Response code

    authCode string

    Authorization code

    approvedAmountMinor number

    Approved amount in minor units

    message string

    Response message

    traceId stringrequired

Card Transaction Events (Debit Cards)​

Events for debit card transactions. Use GET /v1/cards/transactions/:cardTransactionId for full details.

CARD_TRANSACTION_PENDING

Authorization approved - a hold is placed on the card.

    type CARD_TRANSACTION_PENDINGrequired

    data

    object

    required

    cardId stringrequired

    ID of the card (debit or credit)

    cardTransactionId stringrequired

    ID of the child card_transaction record

    parentCardTransactionId string

    Parent card transaction ID for grouping related events

    cardType string

    Card type: CREDIT or DEBIT

    type string

    Transaction type: PRE_AUTHORIZATION, PRE_AUTH_COMPLETION, REVERSAL_ADVICE, etc.

    operation string

    Transaction operation: CREDIT or DEBIT

    status string

    Transaction status: PENDING, COMPLETED, FAILED, CANCELLED

    amount number

    Transaction amount in major units

    asset string

    Asset/currency acronym (e.g., USD)

    amounts

    object

    transaction numberrequired

    DE4 - Total transaction amount in major units

    transactionCurrency stringrequired

    DE49 - Transaction currency acronym

    surcharge number

    DE28 - Surcharge/ATM fee amount (included in transaction total)

    fees

    object

    Array of fee entries from DE54 Additional Amounts.

    type stringrequired

    Fee type

    amount numberrequired

    Fee amount

    currency string

    Fee currency

    retrievalReferenceNo string

    DE37 Retrieval Reference Number

    merchant

    object

    name string

    Merchant name

    mcc string

    Merchant Category Code

    city string

    Merchant city

    state string

    Merchant state/province

    country string

    Merchant country

    timestamp string

    Transaction timestamp (ISO 8601)

    traceId stringrequired

CARD_TRANSACTION_COMPLETED

Transaction settled - funds have been captured.

    type CARD_TRANSACTION_COMPLETEDrequired

    data

    object

    required

    cardId stringrequired

    ID of the card (debit or credit)

    cardTransactionId stringrequired

    ID of the child card_transaction record

    parentCardTransactionId string

    Parent card transaction ID for grouping related events

    cardType string

    Card type: CREDIT or DEBIT

    type string

    Transaction type: PRE_AUTHORIZATION, PRE_AUTH_COMPLETION, REVERSAL_ADVICE, etc.

    operation string

    Transaction operation: CREDIT or DEBIT

    status string

    Transaction status: PENDING, COMPLETED, FAILED, CANCELLED

    amount number

    Transaction amount in major units

    asset string

    Asset/currency acronym (e.g., USD)

    amounts

    object

    transaction numberrequired

    DE4 - Total transaction amount in major units

    transactionCurrency stringrequired

    DE49 - Transaction currency acronym

    surcharge number

    DE28 - Surcharge/ATM fee amount (included in transaction total)

    fees

    object

    Array of fee entries from DE54 Additional Amounts.

    type stringrequired

    Fee type

    amount numberrequired

    Fee amount

    currency string

    Fee currency

    retrievalReferenceNo string

    DE37 Retrieval Reference Number

    merchant

    object

    name string

    Merchant name

    mcc string

    Merchant Category Code

    city string

    Merchant city

    state string

    Merchant state/province

    country string

    Merchant country

    timestamp string

    Transaction timestamp (ISO 8601)

    traceId stringrequired

CARD_TRANSACTION_FAILED

Authorization denied - no hold placed.

    type CARD_TRANSACTION_FAILEDrequired

    data

    object

    required

    cardId stringrequired

    ID of the card (debit or credit)

    cardTransactionId stringrequired

    ID of the child card_transaction record

    parentCardTransactionId string

    Parent card transaction ID for grouping related events

    cardType string

    Card type: CREDIT or DEBIT

    type string

    Transaction type: PRE_AUTHORIZATION, PRE_AUTH_COMPLETION, REVERSAL_ADVICE, etc.

    operation string

    Transaction operation: CREDIT or DEBIT

    status string

    Transaction status: PENDING, COMPLETED, FAILED, CANCELLED

    amount number

    Transaction amount in major units

    asset string

    Asset/currency acronym (e.g., USD)

    amounts

    object

    transaction numberrequired

    DE4 - Total transaction amount in major units

    transactionCurrency stringrequired

    DE49 - Transaction currency acronym

    surcharge number

    DE28 - Surcharge/ATM fee amount (included in transaction total)

    fees

    object

    Array of fee entries from DE54 Additional Amounts.

    type stringrequired

    Fee type

    amount numberrequired

    Fee amount

    currency string

    Fee currency

    retrievalReferenceNo string

    DE37 Retrieval Reference Number

    merchant

    object

    name string

    Merchant name

    mcc string

    Merchant Category Code

    city string

    Merchant city

    state string

    Merchant state/province

    country string

    Merchant country

    timestamp string

    Transaction timestamp (ISO 8601)

    traceId stringrequired

CARD_TRANSACTION_CANCELLED

Transaction reversed or voided.

    type CARD_TRANSACTION_CANCELLEDrequired

    data

    object

    required

    cardId stringrequired

    ID of the card (debit or credit)

    cardTransactionId stringrequired

    ID of the child card_transaction record

    parentCardTransactionId string

    Parent card transaction ID for grouping related events

    cardType string

    Card type: CREDIT or DEBIT

    type string

    Transaction type: PRE_AUTHORIZATION, PRE_AUTH_COMPLETION, REVERSAL_ADVICE, etc.

    operation string

    Transaction operation: CREDIT or DEBIT

    status string

    Transaction status: PENDING, COMPLETED, FAILED, CANCELLED

    amount number

    Transaction amount in major units

    asset string

    Asset/currency acronym (e.g., USD)

    amounts

    object

    transaction numberrequired

    DE4 - Total transaction amount in major units

    transactionCurrency stringrequired

    DE49 - Transaction currency acronym

    surcharge number

    DE28 - Surcharge/ATM fee amount (included in transaction total)

    fees

    object

    Array of fee entries from DE54 Additional Amounts.

    type stringrequired

    Fee type

    amount numberrequired

    Fee amount

    currency string

    Fee currency

    retrievalReferenceNo string

    DE37 Retrieval Reference Number

    merchant

    object

    name string

    Merchant name

    mcc string

    Merchant Category Code

    city string

    Merchant city

    state string

    Merchant state/province

    country string

    Merchant country

    timestamp string

    Transaction timestamp (ISO 8601)

    traceId stringrequired

Crypto Transaction Events​

Events for cryptocurrency deposits and withdrawals. Use GET /v1/baas/transactions?cryptoTransactionId=:id for full details.

CRYPTO_DEPOSIT_TRANSACTION_PENDING

Crypto deposit detected on-chain, awaiting confirmations.

    type CRYPTO_DEPOSIT_TRANSACTION_PENDINGrequired

    data

    object

    required

    walletId stringrequired
    cryptoTransactionId stringrequired

    ID of the child crypto_transaction record

    traceId stringrequired

CRYPTO_DEPOSIT_TRANSACTION_COMPLETED

Crypto deposit confirmed.

    type CRYPTO_DEPOSIT_TRANSACTION_COMPLETEDrequired

    data

    object

    required

    walletId stringrequired
    cryptoTransactionId stringrequired

    ID of the child crypto_transaction record

    traceId stringrequired

CRYPTO_DEPOSIT_TRANSACTION_FAILED

Crypto deposit failed.

    type CRYPTO_DEPOSIT_TRANSACTION_FAILEDrequired

    data

    object

    required

    walletId stringrequired
    cryptoTransactionId stringrequired

    ID of the child crypto_transaction record

    traceId stringrequired

CRYPTO_WITHDRAWAL_TRANSACTION_PENDING

Crypto withdrawal initiated.

    type CRYPTO_WITHDRAWAL_TRANSACTION_PENDINGrequired

    data

    object

    required

    walletId stringrequired
    cryptoTransactionId stringrequired

    ID of the child crypto_transaction record

    traceId stringrequired

CRYPTO_WITHDRAWAL_TRANSACTION_COMPLETED

Crypto withdrawal confirmed on-chain.

    type CRYPTO_WITHDRAWAL_TRANSACTION_COMPLETEDrequired

    data

    object

    required

    walletId stringrequired
    cryptoTransactionId stringrequired

    ID of the child crypto_transaction record

    traceId stringrequired

CRYPTO_WITHDRAWAL_TRANSACTION_FAILED

Crypto withdrawal failed.

    type CRYPTO_WITHDRAWAL_TRANSACTION_FAILEDrequired

    data

    object

    required

    walletId stringrequired
    cryptoTransactionId stringrequired

    ID of the child crypto_transaction record

    traceId stringrequired