Issuin icon

Webhook structure and types

Learn which webhook types are sent for each event.

Webhooks are typically sent when:

  • A resource was created or updated.
  • A request was initiated (such as a payment authorisation request, a refund request, or a funds transfer request).
  • There was a funds movement (funds added to or deducted from balance accounts).

You can subscribe to Configuration, Payment method, Transfer, and Report webhooks, and differentiate the events based on the type. Some webhook types also include a data.status field that informs you of the outcome of the event.

Configuration webhooks

Configuration webhooks inform your system about events that occur with account holders, balance accounts, and payment instruments.

Type Description
balancePlatform.accountHolder.created An account holder was successfully created.
balancePlatform.accountHolder.updated An account holder was successfully updated.
balancePlatform.balanceAccount.created A balance account was successfully created.
balancePlatform.balanceAccount.updated A balance account was successfully updated.
balancePlatform.paymentInstrument.created A debit card was successfully created.
balancePlatform.paymentInstrument.updated A debit card was successfully updated.

Transfer webhooks

Transfer webhooks inform your system about incoming and outgoing transfers in your issuing integration.

Type Description
balancePlatform.transfer.created A transfer request was created to credit funds to or deduct funds from a balance account in your issuing integration. The content informs you of the event that triggered the transfer request, such as a payment or refund.
balancePlatform.transfer.updated A transfer request's status changed.


You can identify transfer webhooks sent for different events by checking the following parameters and values:

category type
Payment issuedCard payment
Fund transfer bank bankTransfer

Report webhooks

Report webhooks inform your system when a report is generated and ready to be downloaded.

Type Description
balancePlatform.report.created A report was generated and is ready to be downloaded.

Payment webhooks (deprecated)

Payment webhooks are deprecated. Use the transfer webhooks instead.

Type Description
balancePlatform.incomingTransfer.created There are funds that will be added to the balance account because of a pending refund or a fund transfer.
Possible statuses: PendingIncomingTransfer
balancePlatform.incomingTransfer.updated Funds were added to a balance account because of a refund or a funds transfer.
Possible values: Refunded, IncomingTransfer
balancePlatform.outgoingTransfer.created Funds were deducted from a balance account because of a payment capture or a funds transfer.
Possible statuses: Captured, OutgoingTransfer
balancePlatform.outgoingTransfer.updated There was an update after funds were deducted from a balance account. For example, the fund transfer to a transfer instrument failed.
Possible statuses: TransferConfirmed, TransferSentOut, or TransferFailed
balancePlatform.payment.created A payment authorisation, a refund, or a funds transfer has been initiated.
Possible statuses: Authorised, Refused, Error
balancePlatform.payment.updated A payment authorisation has expired or has been cancelled.
Possible statuses: Expired, Cancelled

Next steps

Learn which webhooks are sent for different scenarios.