IPN Webhooks
Documentation of IPN Webhooks
The B2B API provides an IPN (Instant Payment notification) webhooks mechanism for notifying transaction events that occur asynchronously.
IPN BaaS Webhooks
For the BaaS service, notifications will be sent when an update occurs for a Fiat Withdrawal or a Fiat Deposit.
IPN Fiat Deposit Webhook
When a Fiat Deposit is credited to a specific Fiat Account, an IPN will be sent with the following structure:
Key | Type | Description | |
---|---|---|---|
event_type | string | Indicate which type of event the currently sent webhook corresponds to, in this case FIAT_DEPOSIT.COMPLETED | |
issued_datetime | string | Indicate the datetime the webhook was sent. | |
payload | string | Payload with the information about the completed Fiat Deposit. | |
id | string | Unique ID for this Fiat Deposit. | |
created_at | string | Indicates the creation date of the Fiat Deposit. | |
updated_at | string | Indicates the update date of the Fiat Deposit. | |
currency_code | string | Indicates the currency that has been deposited. | |
end_user_id | string | End user’s external ref, usually a uuid. Indicates the end user that has received the Fiat Deposit. | |
amount | string | Indicates the amount deposited. | |
status | string | Indicates Fiat Deposit status. | |
refunded | boolean | Indicates if the fiat deposit was refunded. | |
refund_fiat_withdrawal_id | string or null | Indicates the Fiat Withdrawal id associated with the refund, could be null. | |
origin_account_identifier | string | Indicates the identifier of the fiat deposit’s issuing account. | |
origin_account_holder_id | string | Indicates the identification of the fiat deposit’s issuing account holder. | |
origin_account_holder_name | string | Indicates the name of the fiat deposit’s issuing account holder. |
If a Fiat Deposit is blocked due to limits, an IPN will be sent with the event_type
value equal to: FIAT_DEPOSIT.BLOCKED_LIMIT_EXCEEDED
.
If a Fiat Deposit is refunded, an IPN will be sent with the following information:
IPN Fiat Withdrawal Webhook
When a Fiat Whitdrawal is crcompleted, an IPN will be sent with the following structure:
Key | Type | Description | |
---|---|---|---|
event_type | string | Indicate which type of event the currently sent webhook corresponds to, in this case FIAT_WITHDRAWAL.COMPLETED | |
issued_datetime | string | Indicate the datetime the webhook was sent. | |
payload | string | Payload with the information about the completed Fiat Withdrawal. | |
id | string | UUID used as Fiat Withdrawal identifier. | |
created_at | string | Indicates the creation date of the Fiat Withdrawal. | |
updated_at | string | Indicates the update date of the Fiat Withdrawal. | |
currency_code | string | Indicates the asset name involved in the Fiat Withdrawal. | |
end_user_id | string | End user’s external ref, usually a uuid. Identifies the user that owns this operation. | |
amount | string | Indicates the fiat amount withdrawed. | |
status | string | Specifies the Fiat Withdrawal status. | |
external_ref | string | Client side identification reference. Usually a UUID. | |
beneficiary_fiat_account_id | string or null | Indicates the Fiat Withdrawal id associated with the refund, could be null. | |
is_fiat_deposit_refund | boolean | Indicates the identifier of the fiat deposit’s issuing account. | |
refunded_fiat_deposit | string | Indicates the identification of the fiat deposit’s issuing account holder. |
If a Fiat Withdrawal is not completed due to an external issue, it will remain in a CANCELLED
state, and an IPN will be sent with event_type
equal to: FIAT_WITHDRAWAL.CANCELLED
.
When a Fiat Withdrawal is created, it will be in a PENDING
status, and an IPN will be sent with event_type
equal to: FIAT_WITHDRAWAL.PENDING
.
Was this page helpful?