> ## Documentation Index > Fetch the complete documentation index at: https://docs.ripio.com/llms.txt > Use this file to discover all available pages before exploring further. # Create Withdrawal > This endpoint allows the creation of a withdrawal. It will debit from the end user's currency's balance and credit the amount in the destination address. ## OpenAPI ````yaml crypto-as-a-service/openapi.json POST /api/v1/withdrawals/ openapi: 3.0.2 info: title: B2B API version: '1.0' description: >- B2B API allows a third party to access different use cases and services inside of Ripio ecosystem. It is organized around RESTful constraints, with requests and responses in JSON format, using HTTP in the standard format and the answer codes. The API is designed to be compliant with OpenAPI Specification v3.0, which is a trusted open source standard for HTTP-Based APIs. The API offers the ability to test it with a simple, yet powerful sandbox that will enhance developer experience and replicate production capabilities in a well isolated and safe environment, giving developers full freedom to try the integration without compromises. # Error Handling If a request to B2B REST API fails, the response will contain an five-digit error code with a corresponding error message to indicate the details of the error. The following code snippet is a sample error response that contains an error code and message pair: ```` { "code": 40001, "type": "NotAuthenticated", "detail": { "message": "Authentication credentials were not provided.", "code": "not_authenticated" }, "status": 403 } ```` ## Error Codes | Code | Error Category | Description | Resolution | | :------- | :------ | :------ | :----- | | 20000 | Validation Error | Raised when there is a semantic error in the payload of the request. | Check the docs for precise information on how to provide correct values for each resource atribute. | | 20001 | Parse Error | Raised when the API receives a malformed JSON document. | Check for syntax errors in the payload of your request. Also look for sample requests in the docs related to the desired operation. | | 20010 | Expired Quote | Raised when the received quote to execute has expired. | Generate a new quote and execute it within the 30 seconds time window. | | 20011 | Already Executed Quote | Raised when the received quote to execute has been executed before. | Try Generating a new quote with the former pair/amounts to replicate a similar trade. | | 20012 | Not Enough Balance | Raised when the amount to operate (sale/purchase) is larger than the balance amount of the debited currency. | Check end user's balances in order to inform the discrepancy before quote execution. Please contact our support team for further assistance. | | 20013 | Buy Limit Frequency Exceeded | Raised when the "BUY" frequency limit for a given end user has been reached.| Check end user's limits using Limits API in order to inform the discrepancy before performing a quote execution. | | 20014 | Sell Limit Frequency Exceeded | Raised when the "SELL" frequency limit for a given end user has been reached.| Check end user's limits using Limits API in order to inform the discrepancy before performing a quote execution. | | 20015 | Buy Limit Amount Exceeded | Raised when the "BUY" amount limit for a given end user has been reached.| Check end user's limits using Limits API in order to inform the discrepancy before performing a quote execution. | | 20016 | Sell Limit Amount Exceeded | Raised when the "SELL" amount limit for a given end user has been reached.| Check end user's limits using Limits API in order to inform the discrepancy before performing a quote execution. | | 20017 | Buy Transaction Min Limit Exceeded | Raised when the "BUY" amount min limit on a single transaction is exceeded.| Check Ripio's min and max transaction limits. | | 20018 | Buy Transaction Max Limit Exceeded | Raised when the "BUY" amount max limit on a single transaction is exceeded.| Check Ripio's min and max transaction limits. | | 20019 | Sell Transaction Min Limit Exceeded | Raised when the "SELL" amount min limit on a single transaction is exceeded.| Check Ripio's min and max transaction limits. | | 20020 | Sell Transaction Max Limit Exceeded | Raised when the "SELL" amount max limit on a single transaction is exceeded.| Check Ripio's min and max transaction limits. | | 20021 | Banned EndUser | Raised when a quote execution request comes from a banned user.| Please reach out our support team in order to get full detail on why the end user has been banned. | | 20022 | Swap Transaction Min Limit Exceeded | Raised when the "SWAP" amount min limit on a single transaction is exceeded.| Check Ripio's min and max transaction limits. | | 20023 | Swap Transaction Max Limit Exceeded | Raised when the "SWAP" amount max limit on a single transaction is exceeded.| Check Ripio's min and max transaction limits. | | 20024 | Swap Limit Frequency Exceeded | Raised when the "SWAP" frequency limit for a given end user has been reached.| Check end user's limits using Limits API in order to inform the discrepancy before performing a quote execution. | | 20025 | Swap Limit Amount Exceeded | Raised when the "SWAP" amount limit for a given end user has been reached.| Check end user's limits using Limits API in order to inform the discrepancy before performing a quote execution. | | 20026 | Quote With No Price | Raised when the received reusable quote to execute has no price. | Try Generating a new reusable quote with the former pair to replicate a similar trade. | | 20027 | Expired Withdrawal Fee | Raised when trying to execute a withdrawal fee that has already expired. | Request another withdrawal Fee. | | 20029 | Invalid address | Raised when the address provided is not valid on given network. | Try with a valid addres for that network. | | 20030 | Kyc not approved for end user | Raised when the end user doesn't have a kyc process approved. | Check the status of end user's verification submission | | 20031 | Kyc already approved for end user | Raised when the end user already has an approved kyc process. | - | | 20032 | Invalid or disabled payment method type | Raised when the payment_method_type does not exist or is disabled for the acccount. | Please reach out our support team. | | 20033 | Frequency limit exceeded for fiat withdrawals | Raised when the QTY limit for a given currency in a FIAT_WITHDRAWAL operation is exceeded. | - | | 20034 | Amount limit exceeded for fiat withdrawals | Raised when the amount limit for a given currency in a FIAT_WITHDRAWAL operation is exceeded. | - | | 20035 | Fiat account is required | Raised when a fiat account is required. | Create a Fiat account first. | | 20036 | Withdrawal amount less than network dust limit. | Raised when the amount of withdrawal request is less to the network dust limit. | Increase Withrawal amount. | | 20037 | There is no address created for end user and given network. | Raised when there is no address for a given concrete network name. | Create an AutoSwap address first. | || | 40000 | Authentication Failed | Raised when an incoming request includes incorrect authentication. | Check for invalid credentials in your request when trying to authenticate. | | 40001 | Not Authenticated | Raised when an unauthenticated request fails the permission checks. | Check if your request contains a valid and non-expired `access_token`. | | 40003 | Permission Denied | Raised when an authenticated request fails the permission checks. | Check if you have OAuth scopes to access requested resource. Please contact our support team if you think this is an error. | | 40004 | Not Found | Raised when a resource does not exists at the given URL. | Check if the resource you're looking for does exist. | | 40005 | Method Not Allowed | Raised when an incoming request has been performed with certain HTTP verb that is not valid for the requested resource. | Check the resource's docs section to learn the accepted HTTP methods. | | 40006 | Bad Request | Raised when historical market price API endpoint has not been used properly. | Check for syntax errors in the payload of your request. Also look for sample requests in the docs related to the desired operation. | | 40007 | Bad Request | Raised when a currency network is not allowed to operate the selected currency. | Check if your request contains a valid network for the selected currency. | | 40008 | Not Found | Raised when a currency doesn't have its limits configured. | Please reach out our support team with the error details and detailed execution flow. | | 40009 | Bad Request | Raised when an existing Quote with defined external_ref has not been executed, thus it can not be excuted idempotently. | Use another external_ref for the Quote. | | 40010 | Service Unavailable | Raised when there are no addresses available for networks compatible with a specific network name. | Please reach out our support team with the error details and detailed execution flow. | | 40015 | Unsupported Media Type | Raised when the content type of the request data is not JSON compliant. | Check if your request data is compliant with JSON format. | | 40029 | Throttled | Raised when an incoming request fails the throttling checks. | Check if you are exceding the daily/hourly request quota for your account. Please contact our support team if you think you'll need an extended quota for your use-case. | || | 50003 | Service Unavailable | Raised when the service (or requested resource) is not available. | Please reach out our support team with the error details and detailed execution flow. | contact: name: Ripio email: b2b@ripio.com url: https://ripio.com termsOfService: https://www.ripio.com/ar/terms/ servers: - url: https://sandbox-b2b.ripio.com description: Sandbox environment - url: https://b2b-api.ripio.com/ description: Production environment security: - OAuth2: [] tags: - name: Access Token - name: Addresses - name: Auto Swap Addresses - name: Balance - name: Beneficiary Fiat Accounts - name: Deposit IPN - name: Deposits - name: End User - name: Fiat Accounts - name: IPN Webhooks - name: Pairs - name: Periodic Limits - name: Quote Execution - name: Quotes - name: Rates - name: Reusable Quote Execution - name: Reusable Quotes - name: Service Status - name: Swap Reusable Quote Execution - name: Swap Reusable Quotes - name: Transactions - name: TXN Limits - name: Withdrawals - name: Fiat Withdrawals - name: Fiat Deposits - name: KYC Requirements - name: KYC Submissions - name: Simulate Fiat Deposit - name: Yields paths: /api/v1/withdrawals/: parameters: [] post: tags: - Withdrawals summary: Create Withdrawal description: >- This endpoint allows the creation of a withdrawal. It will debit from the end user's currency's balance and credit the amount in the destination address. operationId: createWithdrawal requestBody: content: application/json: schema: type: object x-examples: example-1: end_user: CUST_1 currency: ETH address: '0x42ac578CDF0912768627c47117aC39E3F4646674' network: ETHEREUM_SEPOLIA amount: 0.0002 external_ref: 8a8d0f79-72b3-4ab9-a372-c9999ab2129 properties: end_user: type: string description: End use's external ref currency: type: string description: Currency of the amount to be withdrwaled address: type: string description: Destination address network: type: string description: Blockchain network to operate amount: type: number description: >- Amount to withdrawal. Is the amount that the destination address will receive. external_ref: type: string description: An external identifier, usually a unique UUID withdrawal_fee: type: string description: >- Indicates the withdrawal fee id to use in order to define the applied fees on this withdrawal. examples: example-1: value: end_user: customer_10 currency: BTC address: '0x36f672385c060290f4785F1ECFF58aE4aBB2FD15' network: BITCOIN_TESTNET amount: 1.5 external_ref: ac243840-ac04-4b3a-9efb-176554d4a029 withdrawal_fee: 497f6eca-6276-4993-bfeb-53cbbbba6f08 application/xml: schema: type: object properties: {} multipart/form-data: schema: type: object properties: {} text/html: schema: type: object properties: end_user: type: string currency: type: string address: type: string network: type: string amount: type: number external_ref: type: string x-examples: example-1: end_user: CUST_1 currency: BTC address: '0x42ac578CDF0912768627c47117aC39E3F4646674' network: BTC_TESTNET amount: 0.0002 external_ref: 8a8d0f79-72b3-4ab9-a372-c9999ab2129 description: '' responses: '201': description: Created content: application/json: schema: type: object x-examples: Example: id: ac243840-ac04-4b3a-9efb-176554d4a029 created_at: '2022-03-30T19:38:39.765190Z' confirmation_date: null txn_hash: null end_user_id: customer_10 currency: BTC amount: '0.000000010000016378' address: '0x36f672385c060290f4785F1ECFF58aE4aBB2FD15' network_name: BITCOIN title: Withdrawal Response description: '' properties: id: type: string format: uuid description: UUID used as withdrawal identifier. created_at: type: string format: date-time description: Indicates the withdrawal request creation date. confirmation_date: type: string format: date-time description: >- Identifies the withdrawal confirmation date. This field will be null if the withdrawal is still pending. nullable: true txn_hash: type: string format: hash description: >- Indicates the hash of the blockchain transaction, once completed. This field will be null if the withdrawal is still pending. nullable: true end_user_id: type: string description: Identifies the user that owns this operation. currency: type: string description: Indicates the asset name involved in the withdrawal. amount: type: number format: decimal description: Indicates the amount withdrawed. address: type: string description: Identifies the destination address. maxLength: 128 network_name: type: string enum: - BITCOIN - ETHEREUM status: type: string description: >- Specifies the withdrawal status. Possible values: `COMPLETED` (successfully completed), `PENDING` (being processed), `ERROR` (failed due to external error), `CANCELLED` (cancelled due to internal reason), `BLOCKED_LIMIT_EXCEEDED` (blocked due to exceeding withdrawal limits). enum: - COMPLETED - PENDING - ERROR - CANCELLED - BLOCKED_LIMIT_EXCEEDED transaction_id: type: string description: The ID of the associated transaction object nullable: false provisory_transaction_hash: type: string description: >- Indicates the provisory hash of the blockchain transaction, could be different to txn_hash nullable: true risk_score: type: string description: indicates the risk score of the withdrawal nullable: true is_blocked: type: boolean description: indicates if the withdrawal was blocked nullable: false reason: type: string description: indicates the block reason if the withdrawal was blocked nullable: false external_ref: type: string description: Withdrawal external_ref defined in creation request nullable: false debited_amount: type: string description: The withdrawal amount plus the withdrawal fee amount nullable: false x-stoplight: id: kb4zkahmkjw34 examples: example-1: value: id: 497f6eca-6276-4993-bfeb-53cbbbba6f08 created_at: '2019-08-24T14:15:22Z' confirmation_date: null txn_hash: null end_user_id: customer_10 currency: ETH amount: '0.002' address: '0x36f672385c060290f4785F1ECFF58aE4aBB2FD15' network_name: BITCOIN status: PENDING transaction_id: 8df65b81-8227-4d03-950d-0d8d5fef9402 provisory_transaction_hash: null risk_score: null is_blocked: false reason: '' external_ref: 8df65b81-8227-4d03-950d-0d8d5fef9402 debited_amount: '0.0025' components: securitySchemes: OAuth2: type: oauth2 flows: clientCredentials: scopes: read: Default scope to read all resources. write: Default scope to performe write operations on certain resources. tokenUrl: https://sandbox-b2b.ripio.com/oauth2/token/ description: > B2B’s White Label API uses OAuth2. Currently there is only one supported authentication flow: * **clientCredentials** allows you to access your own B2B account (First-Party Integration) and performs transactions against the public API. This oauth2 flow is well suited for this API, as it allows machine-to-machine communication. Every call to the API has to be authenticated with an OAuth2 Token. In order to request this token, you will need to have sandbox or production API Keys (client id and client secret) that will be needed to generate a credential in order to negotiate an ephemeral access token. Every request must be accompianed by an `Authorization` header with a value that follows the following schema: `Bearer ACCESS_TOKEN` ````