Off Ramp

This set of API endpoints is designed to allow your users to create and retrieve the necessary information for making a fiat currency withdraw (an "off-ramp") from their account.

Notifications

To get notified about incoming deposit or to follow your withrawals statuses, go to the account webhooks section.

Flow

Step by Step

1. Create withdrawal destination (if you do not a have a previous one)
   1. Create a new beneficiary if the recipient does not exist.
      1. Call the get all countries endpoint to get the country id for the new beneficiary address.
      2. Call the create beneficiary endpoint.
   2. If the beneficiary already exists, get the beneficiary id.
      1. Call the get all beneficiaries endpoint to find which one will be used.
      2. Call the get beneficiary by id endpoint to verify it is the correct one.
   3. Call the get requirements by currency id endpoint.
   4. Call the get requirements by id endpoint using the selected ID to confirm the specific data fields required for that destination.
   5. Call the create withdrawal destination endpoint providing the required data gathered in the previous step.
2. Get the id for the withdrawal destination where you want to send (If using a previously created destination).
   1. Call the get destinations by beneficiary endpoint.
   2. Call the get destination by id info endpoint with an id from the previous step.
3. Call the execute withdrawal endpoint. Ensure the source account matches the currency being sent.
4. Once the transaction has reached a terminal status if a webhook is configured on the account, a post request will be sent to the webhook endpoint containing the transaction details.