Skip to main content


This custodial integrator webhook endpoint is called when a clearing or refund request is made.

For more information on setting up webhooks see the webhooks guide

Request Body required
  • cardId string required

    The card ID

  • transactionId string required
  • authorizationId string nullable
  • transactionType string required

    Possible values: [1200, 1400]

    The transaction type:

    1200 - clearing

    1400 - refund

  • accountId string required
  • merchantId string required

    Card acceptor ID

  • merchantName string required

    Card acceptor name

  • merchantCity string required

    Card acceptor city

  • merchantCountry string required

    Card acceptor country

  • merchantCurrency string required

    Card acceptor currency

  • merchantAmount number required

    Card acceptor amount in minor units of the merchant currency

  • billingCurrency string required

    Billing currency

  • billingAmount number required

    Billing amount in minor units of the billing currency

  • settlementCurrency string required
  • settlementAmount number required

    Settlement amount in minor units of the settlement currency

  • mcc string required

    Merchant category code

  • exchangeRate string required

    Exchange rate between merchant and settlement currencies

  • channel string required


  • approvedAt date-time required

    Transaction approval date

  • creationAt date-time

    Transaction creation date


Transaction request accepted