Fiat Callbacks
Invoice
First of all, invoices can be in three statuses:
⏳Pending – client entered his email and goes to "Enter card" form, email is available here
✅ Done – invoice was paid successfully.
😡 Failed – payment has failed
Webhook request body:
Field | Type | Description |
---|---|---|
id | string* | Identifier |
kind | string* | "Invoice" |
ticker | string* | "KZT" |
amount | string | amount specified when invoice was created or entered by user |
paidAmount | string | The field is optional and exists only when the status of the invoice is "Done". Look at the "status" field. This field can differ from amount field in specific bank cases so it should be used as source of true. |
cardNumber | string | optional, exists only on status "DONE", displays the number of recipients banking card used for withdrawal operation |
fee | string | optional and exists only when status is "Done" |
meta | string | metadata you defined when withdrawal was created |
description | string | Invoice description |
status | string* | "Failed", "Pending", "Done" |
time | number* | timestamp when withdrawal was created in ms |
Withdrawal
First of all, withdrawals can be in two statuses:
😡 Failed – withdrawal is failed
✅ Done – withdrawal was sent
Webhook request body:
Field | Type | Description |
---|---|---|
id | string* | Identifier |
kind | "Withdraw" | |
ticker | string* | "KZT" |
cardNumber | string* | destination card number |
amount | string* | amount in decimal format, look at the example |
fee | string | service fee, learn more here |
meta | string | metadata you defined when withdrawal was created |
localId | string | localId you defined when withdrawal was created |
status | string* | "Failed", "Done" |
time | number* | timestamp when withdrawal was created in ms |
Batch Withdrawal
Fiat batch withdrawals are split into single withdraws, so some of them may fail.
Fail withdraws will be refunded to your balance, but you should pay attention to paidAmount, amount and failedAmount fields in body.
You should use paid amount field which represents success withdrawal amount
First of all, batch withdraw can be in single status:
✅ Done – withdrawal was sent
Webhook request body:
Field | Type | Description |
---|---|---|
kind | "WithdrawBatch" | |
id | string* | Identifier |
ticker | string* | "KZT" |
amount | string* | amount in decimal format, look at the example |
paidAmount | string* | This field can differ from amount field in specific bank cases so it should be used as source of true. |
failedAmount | string* | withdraw amount that not sent on bank side |
fee | string | service fee, learn more here |
to | string* | destination card number |
meta | string | metadata you defined when withdrawal was created |
localId | string | localId you defined when withdrawal was created |
status | string* | "Done" |
time | number* | timestamp when withdrawal was created in ms |
Last updated