Additional topics
Overview
The aim of this section is to cover general useful information about the usage of the Offramps service.
Handling edge payment cases
Overpayment
If an quote is overpaid for, we will send out only the fiat equivalent and credit the remaining balance to the business’ account
Underpayment
For underpayments, we will payout the fiat equivalent of the underpayment
Delayed payment
If an quote is expired but the payment still comes after, we will not honor the quote, the crypto asset will be deposited into the account of the business
Quote status
This is a list of quote statuses and their meaning
| State | Description |
|---|---|
underpayment | Representing an underpayment issue from an address. |
quote | Representing when you get a quote the first time. |
initiated | Representing an initialized state. |
success | Marking a successful settlement or completion. |
pending | Representing a pending state when finalized. |
expired | Indicating an expired state. |
failed | Marking a failed state. |
processing | Indicating a processing state where we send funds to our provider for settlement. |
pending_address_deposit | Indicating a pending address deposit for a given quote. |
Offramps webhooks
This is a list of webhooks that we send out and their meanings
| Webhook | Description |
|---|---|
payouts.asset.received | Indicates that the asset has been received. |
payouts.withdrawal.processing | Fiat payout processing has begun. |
payouts.withdrawal.success | Fiat payout processing was successful. |
payouts.withdrawal.failed | Fiat payout processing has failed. |
payouts.withdrawal.rejected | This payment was rejected, most likely for AML reasons. |
payouts.withdrawal.expired | Payments expired. |
payouts.asset.underpayment | Onchain amount sent is insufficient to proceed to settlement. |
Trip details
This is a list of properties of the trip object in a quote and their meaning
| Property | Description |
|---|---|
submitted | Indicates the time the transaction was submitted to Bitnob. |
assetReceived | Indicates the time Bitnob first saw the asset on the blockchain. |
assetConfirmed | Indicates the time the asset is considered fully received by Bitnob. |
processingStart | Indicates the time Bitnob started processing the fiat phase transaction, typically after receiving the asset. |
completionTime | Indicates the time the transaction reaches its final state. Completion doesn’t always mean success, but it signifies a final state. |
timeToFinish | Indicates the total time taken to reach the final state of the transaction from the point of submission. |