Documentation of Banking as a Service Webhooks
Key | Type | Description |
---|---|---|
event_type | string | Indicate which type of event the currently sent webhook corresponds to, in this case KYC.COMPLETED |
issued_datetime | string | Indicate the datetime the webhook was sent. |
payload | string | Payload with the information about the completed verification submission. |
submission_id | string | KYC Submission unique identifier. |
provider_url | string or null | URL to redirect users in order for them upload or fulfill extra information. E.g: ID photo, proof of life, etc. May be null if no further information is required. |
status | string | KYC Submission status. |
created_at | string | ISO datetime indicating Verification Submission creation date. |
Key | Type | Description |
---|---|---|
event_type | string | Indicate which type of event the currently sent webhook corresponds to, in this case FIAT_ACCOUNT.ENABLED |
issued_datetime | string | Indicate the datetime the webhook was sent. |
payload | string | Payload with the information about the enabled fiat account. |
fiat_account_id | string | UUID4 formated unique id. |
payment_method_type | string | It indicates the account type. Usually bank_transfer . |
currency | string | It defines the currency that the FiatAccount accepts. |
status | string | Indicates the Fiat Account status. Only when “ENABLED”, the fiat payment instructions will be provided. |
fiat_payment_instructions | string | JSON fields with account identification details. It varies based on the account type. |
cvu | string | Accunt identifier number for AR Fiat Accounts. |
created_at | string | ISO datetime indicating Fiat Account creation date. |
end_user_id | string | End user’s external ref |
Key | Type | Description |
---|---|---|
event_type | string | Indicate which type of event the currently sent webhook corresponds to, in this case BENEFICIARY_FIAT_ACCOUNT.ENABLED |
issue_datetime | string | Indicate the datetime the webhook was sent. |
payload | string | Payload with the information about the enabled beneficiary fiat account. |
beneficiary_fiat_account_id | string | UUID4 formated unique id. |
payment_method_type | string | It indicates the account type. Usually bank_transfer . |
currency | string | It defines the currency that the Beneficiary Fiat Account accepts. |
status | string | Indicates the Beneficiary Fiat Account status. Only when “ENABLED”, the fiat payment instructions will be provided. |
fiat_payment_instructions | string | JSON fields with account identification details. It varies based on the account type. |
cvu | string | Account identifier number for AR Beneficiary Fiat Accounts. |
created_at | string | ISO datetime indicating Beneficiary Fiat Account creation date. |
end_user_id | string | End user’s external ref |
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. |
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:
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. |
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
.