{ "openapi": "3.0.2", "x-stoplight": { "id": "4y9ja521uqlfy" }, "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.\n\nThe 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.\n\n# Error Handling\n\nIf 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.\n\nThe following code snippet is a sample error response that contains an error code and message pair:\n\n````\n{\n\"code\": 40001,\n\"type\": \"NotAuthenticated\",\n\"detail\": {\n\"message\": \"Authentication credentials were not provided.\",\n\"code\": \"not_authenticated\"\n},\n\"status\": 403\n}\n````\n\n## Error Codes\n\n| Code | Error Category | Description | Resolution |\n| :------- | :------ | :------ | :----- |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n| 20027 | Expired Withdrawal Fee | Raised when trying to execute a withdrawal fee that has already expired. | Request another withdrawal Fee. |\n| 20029 | Invalid address | Raised when the address provided is not valid on given network. | Try with a valid addres for that network. |\n| 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 |\n| 20031 | Kyc already approved for end user | Raised when the end user already has an approved kyc process. | - |\n| 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. |\n| 20033 | Frequency limit exceeded for fiat withdrawals | Raised when the QTY limit for a given currency in a FIAT_WITHDRAWAL operation is exceeded. | - |\n| 20034 | Amount limit exceeded for fiat withdrawals | Raised when the amount limit for a given currency in a FIAT_WITHDRAWAL operation is exceeded. | - |\n| 20035 | Fiat account is required | Raised when a fiat account is required. | Create a Fiat account first. |\n| 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. |\n| 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. |\n||\n| 40000 | Authentication Failed | Raised when an incoming request includes incorrect authentication. | Check for invalid credentials in your request when trying to authenticate. |\n| 40001 | Not Authenticated | Raised when an unauthenticated request fails the permission checks. | Check if your request contains a valid and non-expired `access_token`. |\n| 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. |\n| 40004 | Not Found | Raised when a resource does not exists at the given URL. | Check if the resource you're looking for does exist. |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n||\n| 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/" }, "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" } ], "x-tagGroups": [ { "name": "OAuth2", "tags": [ "Access Token" ] }, { "name": "Trading", "tags": [ "Pairs", "Rates", "Quotes", "Quote Execution", "Reusable Quotes", "Reusable Quote Execution", "Swap Reusable Quotes", "Swap Reusable Quote Execution" ] }, { "name": "Transactions", "tags": [ "TXN Limits", "Transactions" ] }, { "name": "End Users", "tags": [ "End User", "Balance", "Periodic Limits" ] }, { "name": "Health Check", "tags": [ "Service Status" ] }, { "name": "Deposits And Withdrawals", "tags": [ "Wallets", "Addresses", "Auto Swap Addresses", "Deposits", "Withdrawals" ] }, { "name": "Bank as a Service", "tags": [ "Beneficiary Fiat Accounts", "Fiat Accounts", "Fiat Withdrawals", "Fiat Deposits", "KYC Requirements", "KYC Submissions" ] }, { "name": "Sandbox", "tags": [ "IPN Webhooks", "Deposit IPN", "Simulate Fiat Deposit" ] } ], "paths": { "/oauth2/token/": { "post": { "operationId": "GetAccessToken", "description": "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 allow to negotiate an ephemeral access token.\n\nTo generate the access token, you should call this endpoint providing the header `Authorization` with the following schema: `Basic CREDENTIAL` where `CREDENTIAL` should be specified as a string with the format`client_id:client_secret` encoded in Base64.", "parameters": [ { "schema": { "type": "string" }, "in": "header", "name": "Authorization", "description": "Basic CREDENTIAL" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "description": "", "type": "object", "x-examples": { "example-1": { "grant_type": "String", "client_id": "String", "client_secret": "String" } }, "properties": { "grant_type": { "type": "string", "description": "Always as `client_credentials`", "example": "client_credentials" }, "client_id": { "type": "string", "description": "Production or Sandbox Client ID" }, "client_secret": { "type": "string", "description": "Production or Sandbox Client Secret" } }, "required": [ "grant_type", "client_id", "client_secret" ] }, "examples": { "Valid Access Token Generation": { "value": { "grant_type": "client_credentials", "client_id": "DzZTzx2iam7jdaCZA85VRpKut10qDy6SGDsTYHTJ", "client_secret": "UcIKFqnh1EHg1nC2eL6dN9NTbFjXUuXn0J3QBxPUfyXKKXLfiVxCN19UNucd9W7fiKbUCs5cIOC6GvnKAHuTEPTCVKQSaAf8wP0KIIPR7qkl0rLpFq3oJTvUFslg6D9W" } } } } }, "description": "" }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "type": "object", "x-examples": { "example-1": { "access_token": "string", "expires_in": "number", "token_type": "string", "scope": "string" } }, "properties": { "access_token": { "type": "string", "description": "Access token used to authenticate requests to the API." }, "expires_in": { "type": "number", "description": "Number of seconds the access token will be valid for." }, "token_type": { "type": "string", "description": "Type of token used to authenticate requests to the API." }, "scope": { "type": "string", "description": "Scope of the access token." } }, "required": [ "access_token", "expires_in", "token_type", "scope" ] }, "examples": { "Generate Access Token": { "value": { "access_token": "gAgXJcRMnGP6TG9vFcepgP6OMtProD", "expires_in": 36000, "token_type": "Bearer", "scope": "read write" } } } } }, "description": "Successful response" }, "401": { "description": "Invalid Credentials Provided", "content": { "application/json": { "schema": { "description": "", "type": "object", "properties": { "error": { "type": "string", "minLength": 1 } }, "required": [ "error" ], "x-examples": { "example-1": { "error": "invalid_client" } } }, "examples": { "Invalid Client": { "value": { "error": "invalid_client" } } } } } } }, "security": [ { "OAuth2": [] } ], "summary": "Get Access Token", "tags": [ "Access Token" ], "x-stoplight": { "id": "v4jb7eq1gjecf" } }, "parameters": [] }, "/api/v1/quotes/": { "post": { "operationId": "createQuoteResponse", "description": "Quotes are \"held rates\" offered by Ripio to buy or sell assets at a specific price within a period of time - for example, the option to buy ETH within the next 30 seconds for $10,000.\n\nThe typical Quotes workflow is as follows:\n\n* Call [List Market Rates](#operation/listRatesViewSets) to get the latest available quoted prices for the assets you want to buy or sell. Please note that these rates are subject to change depending on the amount of base/quote currency the end user is willing to trade.\n* User Selects a Pair of interest and ask for a BUY/SELL Quotation.\n* Partner performs a POST request to [Quote Endpoint](#operation/createQuoteResponse), providing a base OR quote amount. B2B will respond a price for the given amount.\n* Present the offered price to the end-user, with a timer indicating the time to expiration (30 seconds).\n* If a user accepts the price, call [Create Quote Execution](#operation/executeQuoteResponse) passing the quote id.\n* Call [Get Transaction](#operation/retrieveTransaction) or [Get Transaction List](#operation/listTransactions) to query trade status information.\n\nAn otherwise-valid request to create a quote may fail with the following types of errors:\n\n* **Buy Transaction Min Limit Exceeded** if the amount is lower than the minimum amount allowed on BUY operations.\n* **Buy Transaction Max Limit Exceeded** if the amount is higher than the maximum amount allowed on BUY operations.\n* **Sell Transaction Min Limit Exceeded** if the amount is lower than the minimum amount allowed on SELL operations.\n* **Sell Transaction Max Limit Exceeded** if the amount is higher than the maximum amount allowed on SELL operations.", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "description": "Object indicating the requirements for the quotation. **Beware** that you can ask for a quotation using either a `base_amount` or `quote_amount`, but **never both** in the same request.", "type": "object", "x-examples": { "Base Asset Quotation": { "pair": "USDT_USD", "op_type": "BUY", "external_ref": "op1", "base_amount": 5 }, "Quote Asset Quotatioin": { "pair": "USDT_USD", "op_type": "BUY", "external_ref": "op1", "quote_amount": 5 } }, "title": "QuoteRequest", "properties": { "pair": { "type": "string", "minLength": 1, "description": "Indicates pair name." }, "external_ref": { "type": "string", "minLength": 1, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." }, "op_type": { "type": "string", "enum": [ "BUY", "SELL" ], "description": "Indicates the operation type." }, "base_amount": { "type": "number", "description": "Specifies the amount of crypto to buy or sell." }, "quote_amount": { "type": "number", "description": "Specifies the amount of fiat to buy or sell." } }, "required": [ "pair", "external_ref", "op_type" ], "x-stoplight": { "id": "ywp6ryhj3vq9r" } }, "examples": { "example-1": { "value": { "pair": "USDT_USD", "op_type": "BUY", "external_ref": "op1", "base_amount": 5 } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "QuoteResponse", "description": "", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "pair": { "type": "string", "description": "Indicates pair name involved in the quotation." }, "op_type": { "enum": [ "BUY", "SELL" ], "type": "string", "description": "Indicates whether the quote is for BUY or SELL." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "base_amount": { "type": "string", "format": "decimal", "description": "Indicates the amount of units or equivalence in the quote for base currency." }, "quote_amount": { "type": "string", "format": "decimal", "description": "Indicates the amount of units or equivalence in the quote for quote currency." }, "rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion." }, "charged_fee": { "type": "string", "format": "decimal", "description": "Indicates fee that will be applied when the execution of quote is effective." }, "external_ref": { "type": "string", "maxLength": 128, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date.", "readOnly": true }, "expires_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating expiration date of the quote. Quote will be invalid after that date." } }, "required": [ "id", "pair", "op_type", "base_asset", "quote_asset", "base_amount", "quote_amount", "rate", "charged_fee", "external_ref", "created_at", "expires_at" ], "x-examples": { "example-1": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "pair": "string", "op_type": "BUY", "base_asset": "string", "quote_asset": "string", "base_amount": "string", "quote_amount": "string", "rate": "string", "charged_fee": "string", "external_ref": "string", "created_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z" } }, "x-stoplight": { "id": "1rx0urcfjqrc9" } } }, "multipart/form-data": { "schema": { "type": "object", "title": "QuoteResponse", "description": "", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "pair": { "type": "string", "description": "Indicates pair name involved in the quotation." }, "op_type": { "enum": [ "BUY", "SELL" ], "type": "string", "description": "Indicates whether the quote is for BUY or SELL." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "base_amount": { "type": "string", "format": "decimal", "description": "Indicates the amount of units or equivalence in the quote for base currency." }, "quote_amount": { "type": "string", "format": "decimal", "description": "Indicates the amount of units or equivalence in the quote for quote currency." }, "rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion." }, "charged_fee": { "type": "string", "format": "decimal", "description": "Indicates fee that will be applied when the execution of quote is effective." }, "external_ref": { "type": "string", "maxLength": 128, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date.", "readOnly": true }, "expires_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating expiration date of the quote. Quote will be invalid after that date." } }, "required": [ "id", "pair", "op_type", "base_asset", "quote_asset", "base_amount", "quote_amount", "rate", "charged_fee", "external_ref", "created_at", "expires_at" ], "x-examples": { "example-1": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "pair": "string", "op_type": "BUY", "base_asset": "string", "quote_asset": "string", "base_amount": "string", "quote_amount": "string", "rate": "string", "charged_fee": "string", "external_ref": "string", "created_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z" } }, "x-stoplight": { "id": "1rx0urcfjqrc9" } } } }, "description": "" }, "responses": { "201": { "content": { "application/json": { "schema": { "type": "object", "title": "QuoteResponse", "description": "", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "pair": { "type": "string", "description": "Indicates pair name involved in the quotation." }, "op_type": { "enum": [ "BUY", "SELL" ], "type": "string", "description": "Indicates whether the quote is for BUY or SELL." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "base_amount": { "type": "string", "format": "decimal", "description": "Indicates the amount of units or equivalence in the quote for base currency." }, "quote_amount": { "type": "string", "format": "decimal", "description": "Indicates the amount of units or equivalence in the quote for quote currency." }, "rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion." }, "charged_fee": { "type": "string", "format": "decimal", "description": "Indicates fee that will be applied when the execution of quote is effective." }, "external_ref": { "type": "string", "maxLength": 128, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date.", "readOnly": true }, "expires_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating expiration date of the quote. Quote will be invalid after that date." } }, "required": [ "id", "pair", "op_type", "base_asset", "quote_asset", "base_amount", "quote_amount", "rate", "charged_fee", "external_ref", "created_at", "expires_at" ], "x-examples": { "example-1": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "pair": "string", "op_type": "BUY", "base_asset": "string", "quote_asset": "string", "base_amount": "string", "quote_amount": "string", "rate": "string", "charged_fee": "string", "external_ref": "string", "created_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z" } }, "x-stoplight": { "id": "1rx0urcfjqrc9" } }, "examples": { "Quote Generated": { "value": { "id": "31f68fdb-2271-4f58-99d3-4a0b62c9d489", "pair": "USDT_USD", "op_type": "BUY", "base_asset": "USDT", "quote_asset": "USD", "base_amount": "5.000000000000000000", "quote_amount": "5.002999999999999670", "rate": "1.00060000", "charged_fee": "0.000", "external_ref": "op1", "created_at": "2021-09-16T15:38:34.425640-03:00", "expires_at": "2021-09-16T15:39:04.424911-03:00" } } } } }, "description": "Successful Response" } }, "security": [ { "OAuth2": [ "read", "write" ] } ], "summary": "Create Quote", "tags": [ "Quotes" ], "x-stoplight": { "id": "qgs8x4zufakor" } }, "get": { "operationId": "listQuoteResponses", "description": "Retrieve a paginated list of generated quotes.", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "op_type", "description": "Filter by operation type" }, { "schema": { "type": "string" }, "in": "query", "name": "pair", "description": "Filter by currency pair" }, { "schema": { "type": "string" }, "in": "query", "name": "date_gt", "description": "Filter by date, greater than value" }, { "schema": { "type": "string" }, "in": "query", "name": "end_user", "description": "Filter by end user external reference" } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "example": 123, "description": "Indicates total count of quotes." }, "next": { "type": "string", "format": "uri", "example": "http://api.example.org/accounts/?page=4", "description": "Indicates next page by URL.", "nullable": true }, "previous": { "type": "string", "format": "uri", "example": "http://api.example.org/accounts/?page=2", "description": "Indicates previous page by URL.", "nullable": true }, "results": { "type": "array", "description": "List of fetched quotes.", "items": { "type": "object", "title": "QuoteResponse", "description": "", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "pair": { "type": "string", "description": "Indicates pair name involved in the quotation." }, "op_type": { "enum": [ "BUY", "SELL" ], "type": "string", "description": "Indicates whether the quote is for BUY or SELL." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "base_amount": { "type": "string", "format": "decimal", "description": "Indicates the amount of units or equivalence in the quote for base currency." }, "quote_amount": { "type": "string", "format": "decimal", "description": "Indicates the amount of units or equivalence in the quote for quote currency." }, "rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion." }, "charged_fee": { "type": "string", "format": "decimal", "description": "Indicates fee that will be applied when the execution of quote is effective." }, "external_ref": { "type": "string", "maxLength": 128, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date.", "readOnly": true }, "expires_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating expiration date of the quote. Quote will be invalid after that date." } }, "required": [ "id", "pair", "op_type", "base_asset", "quote_asset", "base_amount", "quote_amount", "rate", "charged_fee", "external_ref", "created_at", "expires_at" ], "x-examples": { "example-1": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "pair": "string", "op_type": "BUY", "base_asset": "string", "quote_asset": "string", "base_amount": "string", "quote_amount": "string", "rate": "string", "charged_fee": "string", "external_ref": "string", "created_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z" } }, "x-stoplight": { "id": "1rx0urcfjqrc9" } } } } }, "examples": { "List Quotes": { "value": { "count": 36, "next": "https://sandbox-b2b.ripio.com/api/v1/quotes/?page=2", "previous": null, "results": [ { "id": "29427835-e2ad-4741-ab6d-ea532aa0e655", "pair": "USDT_USD", "op_type": "SELL", "base_asset": "USDT", "quote_asset": "USD", "base_amount": "4.997501249375312619", "quote_amount": "5.000000000000000000", "rate": "1.00050000", "charged_fee": "0.000", "external_ref": "op1", "created_at": "2021-09-10T15:13:57.293479-03:00", "expires_at": "2021-09-10T15:14:27.292431-03:00" }, { "id": "aa682b84-0092-4eef-975e-93eb7c3307e5", "pair": "USDT_USD", "op_type": "SELL", "base_asset": "USDT", "quote_asset": "USD", "base_amount": "4.997501249375312619", "quote_amount": "5.000000000000000000", "rate": "1.00050000", "charged_fee": "0.000", "external_ref": "op1", "created_at": "2021-09-10T15:23:39.955150-03:00", "expires_at": "2021-09-10T15:24:09.954402-03:00" }, { "id": "1e02d579-b9cb-4579-a7d6-718fb6401a6e", "pair": "USDT_USD", "op_type": "BUY", "base_asset": "USDT", "quote_asset": "USD", "base_amount": "4.997001798920647941", "quote_amount": "5.000000000000000000", "rate": "1.00060000", "charged_fee": "0.000", "external_ref": "op1", "created_at": "2021-09-10T15:24:15.464813-03:00", "expires_at": "2021-09-10T15:24:45.464142-03:00" } ] } } } } }, "description": "Successful response" } }, "tags": [ "Quotes" ], "summary": "List Account Quotes", "security": [ { "OAuth2": [ "read", "write" ] } ], "x-stoplight": { "id": "g952mhjz50nng" } }, "parameters": [] }, "/api/v1/reusable-quotes/": { "post": { "operationId": "createReusableQuoteResponse", "description": "ReusableQuotes are \"held rates\" offered by Ripio to buy or sell assets at a specific price within a period of time - for example, the option to buy ETH within the next 30 seconds for $10,000.\n\nThe typical Quotes workflow is as follows:\n\n* Call [List Market Rates](#operation/listRatesViewSets) to get the latest available quoted prices for the assets you want to buy or sell. Please note that these rates are subject to change depending on the amount of base/quote currency the end user is willing to trade.\n* Partner performs a POST request to [ReusableQuote Endpoint](#operation/createReusableQuoteResponse), B2B will respond a price for a price valid for 30 second.\n* Present the offered price to the end-user, with a timer indicating the time to expiration (30 seconds).\n* If a user accepts the price, call [Create Reusable Quote Execution](#operation/executeReusableQuoteResponse) passing the reusable quote id, end user external ref, operation type and base or quote amount.\n* Call [Get Transaction](#operation/retrieveTransaction) or [Get Transaction List](#operation/listTransactions) to query trade status information.", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "description": "", "type": "object", "x-examples": { "Example": { "pair": "USDT_USD", "external_ref": "op1" } }, "title": "ReusableQuoteRequest", "properties": { "pair": { "type": "string", "minLength": 1, "description": "Indicates pair name." }, "external_ref": { "type": "string", "minLength": 1, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." } }, "required": [ "pair", "external_ref" ], "x-stoplight": { "id": "qjmhiivfvn09m" } }, "examples": { "example-1": { "value": { "pair": "USDT_USD", "external_ref": "op1" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "QuoteResponse", "description": "", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "pair": { "type": "string", "description": "Indicates pair name involved in the quotation." }, "op_type": { "enum": [ "BUY", "SELL" ], "type": "string", "description": "Indicates whether the quote is for BUY or SELL." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "base_amount": { "type": "string", "format": "decimal", "description": "Indicates the amount of units or equivalence in the quote for base currency." }, "quote_amount": { "type": "string", "format": "decimal", "description": "Indicates the amount of units or equivalence in the quote for quote currency." }, "rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion." }, "charged_fee": { "type": "string", "format": "decimal", "description": "Indicates fee that will be applied when the execution of quote is effective." }, "external_ref": { "type": "string", "maxLength": 128, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date.", "readOnly": true }, "expires_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating expiration date of the quote. Quote will be invalid after that date." } }, "required": [ "id", "pair", "op_type", "base_asset", "quote_asset", "base_amount", "quote_amount", "rate", "charged_fee", "external_ref", "created_at", "expires_at" ], "x-examples": { "example-1": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "pair": "string", "op_type": "BUY", "base_asset": "string", "quote_asset": "string", "base_amount": "string", "quote_amount": "string", "rate": "string", "charged_fee": "string", "external_ref": "string", "created_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z" } }, "x-stoplight": { "id": "1rx0urcfjqrc9" } } }, "multipart/form-data": { "schema": { "type": "object", "title": "QuoteResponse", "description": "", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "pair": { "type": "string", "description": "Indicates pair name involved in the quotation." }, "op_type": { "enum": [ "BUY", "SELL" ], "type": "string", "description": "Indicates whether the quote is for BUY or SELL." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "base_amount": { "type": "string", "format": "decimal", "description": "Indicates the amount of units or equivalence in the quote for base currency." }, "quote_amount": { "type": "string", "format": "decimal", "description": "Indicates the amount of units or equivalence in the quote for quote currency." }, "rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion." }, "charged_fee": { "type": "string", "format": "decimal", "description": "Indicates fee that will be applied when the execution of quote is effective." }, "external_ref": { "type": "string", "maxLength": 128, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date.", "readOnly": true }, "expires_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating expiration date of the quote. Quote will be invalid after that date." } }, "required": [ "id", "pair", "op_type", "base_asset", "quote_asset", "base_amount", "quote_amount", "rate", "charged_fee", "external_ref", "created_at", "expires_at" ], "x-examples": { "example-1": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "pair": "string", "op_type": "BUY", "base_asset": "string", "quote_asset": "string", "base_amount": "string", "quote_amount": "string", "rate": "string", "charged_fee": "string", "external_ref": "string", "created_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z" } }, "x-stoplight": { "id": "1rx0urcfjqrc9" } } } }, "description": "" }, "responses": { "201": { "content": { "application/json": { "schema": { "type": "object", "title": "ReusableQuoteResponse", "description": "", "x-examples": { "example-1": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "pair": "string", "base_asset": "string", "quote_asset": "string", "buy_rate": "string", "sell_rate": "string", "market_buy_rate": "string", "market_sell_rate": "string", "buy_fee_percentage": "string", "sell_fee_percentage": "string", "external_ref": "string", "created_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z" } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "status": { "type": "string", "enum": [ "COM", "PEN", "EXP", "UNA_PRICE" ] }, "pair": { "type": "string", "description": "Indicates pair name involved in the quotation." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "buy_rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion." }, "sell_rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion." }, "market_buy_rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion, without the applied fee." }, "market_sell_rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion, without the applied fee." }, "buy_fee_percentage": { "type": "string", "format": "decimal", "description": "Indicates the fee percentage applied to market_buy_rate to obtain buy_rate." }, "sell_fee_percentage": { "type": "string", "format": "decimal", "description": "Indicates the fee percentage applied to market_sell_rate to obtain sell_rate." }, "external_ref": { "type": "string", "maxLength": 128, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date.", "readOnly": true }, "expires_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating expiration date of the quote. Quote will be invalid after that date." } }, "required": [ "id", "pair", "base_asset", "quote_asset", "buy_rate", "sell_rate", "market_buy_rate", "market_sell_rate", "buy_fee_percentage", "sell_fee_percentage", "external_ref", "created_at", "expires_at" ], "x-stoplight": { "id": "yjdne4mx325hn" } }, "examples": { "Reusable Quote Generated": { "value": { "id": "31f68fdb-2271-4f58-99d3-4a0b62c9d489", "status": "PEN", "pair": "USDT_USD", "base_asset": "USDT", "quote_asset": "USD", "buy_rate": "1.01220000", "sell_rate": "0.98071830", "market_buy_rate": "1.00000000", "market_sell_rate": "0.99900000", "buy_fee_percentage": "1.2200000", "sell_fee_percentage": "1.8300000", "external_ref": "op1", "created_at": "2021-09-16T15:38:34.425640-03:00", "expires_at": "2021-09-16T15:39:04.424911-03:00" } } } } }, "description": "Successful Response" } }, "security": [ { "OAuth2": [ "read", "write" ] } ], "summary": "Create Reusable Quote", "tags": [ "Reusable Quotes" ], "x-stoplight": { "id": "acy3aogq4w6bh" } }, "get": { "operationId": "listReusableQuoteResponses", "description": "Retrieve a paginated list of generated reusable quotes.", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "pair", "description": "Filter by currency pair" }, { "schema": { "type": "string" }, "in": "query", "name": "date_gt", "description": "Filter by date, greater than value" } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "example": 123, "description": "Indicates total count of quotes." }, "next": { "type": "string", "format": "uri", "example": "http://api.example.org/accounts/?page=4", "description": "Indicates next page by URL.", "nullable": true }, "previous": { "type": "string", "format": "uri", "example": "http://api.example.org/accounts/?page=2", "description": "Indicates previous page by URL.", "nullable": true }, "results": { "type": "array", "description": "List of fetched quotes.", "items": { "type": "object", "title": "ReusableQuoteResponse", "description": "", "x-examples": { "example-1": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "pair": "string", "base_asset": "string", "quote_asset": "string", "buy_rate": "string", "sell_rate": "string", "market_buy_rate": "string", "market_sell_rate": "string", "buy_fee_percentage": "string", "sell_fee_percentage": "string", "external_ref": "string", "created_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z" } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "status": { "type": "string", "enum": [ "COM", "PEN", "EXP", "UNA_PRICE" ] }, "pair": { "type": "string", "description": "Indicates pair name involved in the quotation." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "buy_rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion." }, "sell_rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion." }, "market_buy_rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion, without the applied fee." }, "market_sell_rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion, without the applied fee." }, "buy_fee_percentage": { "type": "string", "format": "decimal", "description": "Indicates the fee percentage applied to market_buy_rate to obtain buy_rate." }, "sell_fee_percentage": { "type": "string", "format": "decimal", "description": "Indicates the fee percentage applied to market_sell_rate to obtain sell_rate." }, "external_ref": { "type": "string", "maxLength": 128, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date.", "readOnly": true }, "expires_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating expiration date of the quote. Quote will be invalid after that date." } }, "required": [ "id", "pair", "base_asset", "quote_asset", "buy_rate", "sell_rate", "market_buy_rate", "market_sell_rate", "buy_fee_percentage", "sell_fee_percentage", "external_ref", "created_at", "expires_at" ], "x-stoplight": { "id": "yjdne4mx325hn" } } } } }, "examples": { "List Reusable Quotes": { "value": { "count": 36, "next": "https://sandbox-b2b.ripio.com/api/v1/reusable-quotes/?page=2", "previous": null, "results": [ { "id": "d1230c26-b1ba-4adc-a1cd-7a3b3a1d34d6", "status": "PEN", "pair": "BTC_USD", "base_asset": "BTC", "quote_asset": "USD", "buy_rate": "63250.00000000", "sell_rate": "27200.00000000", "market_buy_rate": "62487.65066192", "market_sell_rate": "27707.03881023", "buy_fee_percentage": "1.2200000", "sell_fee_percentage": "1.8300000", "external_ref": "op1", "created_at": "2022-01-03T10:56:28.829179Z", "expires_at": "2022-01-03T10:56:58.828810Z" }, { "id": "aa682b84-0092-4eef-975e-93eb7c3307e5", "pair": "USDT_USD", "status": "EXP", "base_asset": "USDT", "quote_asset": "USD", "buy_rate": "1.00050000", "sell_rate": "1.00020000", "market_buy_rate": "0.98844102", "market_sell_rate": "1.01884486", "buy_fee_percentage": "1.2200000", "sell_fee_percentage": "1.8300000", "external_ref": "op2", "created_at": "2021-09-10T15:23:39.955150-03:00", "expires_at": "2021-09-10T15:24:09.954402-03:00" }, { "id": "aa682b84-0092-4eef-975e-93eb7c3307e5", "pair": "USDT_USD", "status": "EXP", "base_asset": "USDT", "quote_asset": "USD", "buy_rate": "1.00060000", "sell_rate": "1.00030000", "market_buy_rate": "0.98853981", "market_sell_rate": "1.01894673", "buy_fee_percentage": "1.2200000", "sell_fee_percentage": "1.8300000", "external_ref": "op3", "created_at": "2021-09-10T15:23:39.955150-03:00", "expires_at": "2021-09-10T15:24:09.954402-03:00" } ] } } } } }, "description": "Successful response" } }, "summary": "List Account Reusable Quotes", "security": [ { "OAuth2": [ "read", "write" ] } ], "tags": [ "Reusable Quotes" ], "x-stoplight": { "id": "bf9b362s4ypqk" } }, "parameters": [] }, "/api/v1/swap-quotes/": { "post": { "operationId": "createSwapQuote", "description": "SwapReusableQuotes are \"held rates\" offered by Ripio to swap assets at a specific price within a period of time.\nThe typical Quotes workflow is as follows:\n\n* Partner performs a POST request to [Swap Reusable Quote Endpoint](#operation/createSwapQuote), B2B will respond a price for a price valid for 30 second.\n* Present the offered price to the end-user, with a timer indicating the time to expiration (30 seconds).\n* If a user accepts the price, call [Create Swap Reusable Quote Execution](#operation/executeSwapQuote) passing the reusable quote id, end user external ref, operation type and base or quote amount.\n* Call [Get Transaction](#operation/retrieveTransaction) or [Get Transaction List](#operation/listTransactions) to query trade status information.", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "description": "", "type": "object", "x-examples": { "Example": { "pair": "USDT_USD", "external_ref": "op1" } }, "title": "ReusableQuoteRequest", "properties": { "pair": { "type": "string", "minLength": 1, "description": "Indicates pair name." }, "external_ref": { "type": "string", "minLength": 1, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." } }, "required": [ "pair", "external_ref" ], "x-stoplight": { "id": "qjmhiivfvn09m" } }, "examples": { "example-1": { "value": { "pair": "USDT_ETH", "external_ref": "op1" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "QuoteResponse", "description": "", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "pair": { "type": "string", "description": "Indicates pair name involved in the quotation." }, "op_type": { "enum": [ "BUY", "SELL" ], "type": "string", "description": "Indicates whether the quote is for BUY or SELL." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "base_amount": { "type": "string", "format": "decimal", "description": "Indicates the amount of units or equivalence in the quote for base currency." }, "quote_amount": { "type": "string", "format": "decimal", "description": "Indicates the amount of units or equivalence in the quote for quote currency." }, "rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion." }, "charged_fee": { "type": "string", "format": "decimal", "description": "Indicates fee that will be applied when the execution of quote is effective." }, "external_ref": { "type": "string", "maxLength": 128, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date.", "readOnly": true }, "expires_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating expiration date of the quote. Quote will be invalid after that date." } }, "required": [ "id", "pair", "op_type", "base_asset", "quote_asset", "base_amount", "quote_amount", "rate", "charged_fee", "external_ref", "created_at", "expires_at" ], "x-examples": { "example-1": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "pair": "string", "op_type": "BUY", "base_asset": "string", "quote_asset": "string", "base_amount": "string", "quote_amount": "string", "rate": "string", "charged_fee": "string", "external_ref": "string", "created_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z" } }, "x-stoplight": { "id": "1rx0urcfjqrc9" } } }, "multipart/form-data": { "schema": { "type": "object", "title": "QuoteResponse", "description": "", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "pair": { "type": "string", "description": "Indicates pair name involved in the quotation." }, "op_type": { "enum": [ "BUY", "SELL" ], "type": "string", "description": "Indicates whether the quote is for BUY or SELL." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "base_amount": { "type": "string", "format": "decimal", "description": "Indicates the amount of units or equivalence in the quote for base currency." }, "quote_amount": { "type": "string", "format": "decimal", "description": "Indicates the amount of units or equivalence in the quote for quote currency." }, "rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion." }, "charged_fee": { "type": "string", "format": "decimal", "description": "Indicates fee that will be applied when the execution of quote is effective." }, "external_ref": { "type": "string", "maxLength": 128, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date.", "readOnly": true }, "expires_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating expiration date of the quote. Quote will be invalid after that date." } }, "required": [ "id", "pair", "op_type", "base_asset", "quote_asset", "base_amount", "quote_amount", "rate", "charged_fee", "external_ref", "created_at", "expires_at" ], "x-examples": { "example-1": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "pair": "string", "op_type": "BUY", "base_asset": "string", "quote_asset": "string", "base_amount": "string", "quote_amount": "string", "rate": "string", "charged_fee": "string", "external_ref": "string", "created_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z" } }, "x-stoplight": { "id": "1rx0urcfjqrc9" } } } }, "description": "" }, "responses": { "201": { "content": { "application/json": { "schema": { "type": "object", "title": "SwapReusableQuoteResponse", "description": "", "x-examples": { "example-1": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "pair": "string", "base_asset": "string", "quote_asset": "string", "buy_rate": "string", "sell_rate": "string", "external_ref": "string", "created_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z" } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "status": { "type": "string" }, "pair": { "type": "string", "description": "Indicates pair name involved in the quotation." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "swap_rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion." }, "usd_rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate between base_asset and USD currency, useful to calculate limits consumption." }, "external_ref": { "type": "string", "maxLength": 128, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date.", "readOnly": true }, "expires_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating expiration date of the quote. Quote will be invalid after that date." } }, "required": [ "id", "pair", "base_asset", "quote_asset", "swap_rate", "usd_rate", "external_ref", "created_at", "expires_at" ], "x-stoplight": { "id": "8dl9171wzqwnx" } }, "examples": { "Reusable Quote Generated": { "value": { "id": "31f68fdb-2271-4f58-99d3-4a0b62c9d489", "status": "PEN", "pair": "USDT_ETH", "base_asset": "USDT", "quote_asset": "ETH", "buy_rate": "1.00060000", "sell_rate": "1.00020000", "swap_rate": "1.00020000", "usd_rate": "1.00020000", "external_ref": "op1", "created_at": "2021-09-16T15:38:34.425640-03:00", "expires_at": "2021-09-16T15:39:04.424911-03:00" } } } } }, "description": "Successful Response" } }, "security": [ { "OAuth2": [ "read", "write" ] } ], "summary": "Create Swap Reusable Quotes", "tags": [ "Swap Reusable Quotes" ], "x-stoplight": { "id": "u6taoimt9duln" } }, "get": { "operationId": "listSwapReusableQuote", "description": "Retrieve a paginated list of generated swap quotes.", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "pair", "description": "Filter by currency pair" }, { "schema": { "type": "string" }, "in": "query", "name": "date_gt", "description": "Filter by date, greater than value" } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "example": 123, "description": "Indicates total count of quotes." }, "next": { "type": "string", "format": "uri", "example": "http://api.example.org/accounts/?page=4", "description": "Indicates next page by URL.", "nullable": true }, "previous": { "type": "string", "format": "uri", "example": "http://api.example.org/accounts/?page=2", "description": "Indicates previous page by URL.", "nullable": true }, "results": { "type": "array", "description": "List of fetched quotes.", "items": { "type": "object", "title": "SwapReusableQuoteResponse", "description": "", "x-examples": { "example-1": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "pair": "string", "base_asset": "string", "quote_asset": "string", "buy_rate": "string", "sell_rate": "string", "external_ref": "string", "created_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z" } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "status": { "type": "string" }, "pair": { "type": "string", "description": "Indicates pair name involved in the quotation." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "swap_rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion." }, "usd_rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate between base_asset and USD currency, useful to calculate limits consumption." }, "external_ref": { "type": "string", "maxLength": 128, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date.", "readOnly": true }, "expires_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating expiration date of the quote. Quote will be invalid after that date." } }, "required": [ "id", "pair", "base_asset", "quote_asset", "swap_rate", "usd_rate", "external_ref", "created_at", "expires_at" ], "x-stoplight": { "id": "8dl9171wzqwnx" } } } } }, "examples": { "List Reusable Quotes": { "value": { "count": 36, "next": "https://sandbox-b2b.ripio.com/api/v1/swap-quotes/?page=2", "previous": null, "results": [ { "id": "d1230c26-b1ba-4adc-a1cd-7a3b3a1d34d6", "status": "PEN", "pair": "BTC_ETH", "base_asset": "BTC", "quote_asset": "ETH", "buy_rate": "63250.00000000000000", "sell_rate": "27200.00000000000000", "swap_rate": "63250.00000000000000", "usd_rate": "63250.00000000000000", "external_ref": "op1", "created_at": "2022-01-03T10:56:28.829179Z", "expires_at": "2022-01-03T10:56:58.828810Z" }, { "id": "aa682b84-0092-4eef-975e-93eb7c3307e5", "pair": "USDT_ETH", "status": "EXP", "base_asset": "USDT", "quote_asset": "ETH", "buy_rate": "1.00050000", "sell_rate": "1.00020000", "swap_rate": "1.00020000", "usd_rate": "1.00020000", "external_ref": "op2", "created_at": "2021-09-10T15:23:39.955150-03:00", "expires_at": "2021-09-10T15:24:09.954402-03:00" }, { "id": "aa682b84-0092-4eef-975e-93eb7c3307e5", "pair": "USDT_ETH", "status": "EXP", "base_asset": "USDT", "quote_asset": "ETH", "buy_rate": "1.00060000", "sell_rate": "1.00030000", "swap_rate": "1.00030000", "usd_rate": "1.00030000", "external_ref": "op3", "created_at": "2021-09-10T15:23:39.955150-03:00", "expires_at": "2021-09-10T15:24:09.954402-03:00" } ] } } } } }, "description": "Successful response" } }, "summary": "List Account Swap Quotes", "security": [ { "OAuth2": [ "read", "write" ] } ], "tags": [ "Swap Reusable Quotes" ], "x-stoplight": { "id": "1g8vh899gbfcb" } }, "parameters": [] }, "/api/v1/quotes/{quote_id}/": { "get": { "operationId": "retrieveQuoteResponse", "description": "Retrieve previously generated quote given an id.", "parameters": [ { "name": "quote_id", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "title": "QuoteResponse", "description": "", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "pair": { "type": "string", "description": "Indicates pair name involved in the quotation." }, "op_type": { "enum": [ "BUY", "SELL" ], "type": "string", "description": "Indicates whether the quote is for BUY or SELL." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "base_amount": { "type": "string", "format": "decimal", "description": "Indicates the amount of units or equivalence in the quote for base currency." }, "quote_amount": { "type": "string", "format": "decimal", "description": "Indicates the amount of units or equivalence in the quote for quote currency." }, "rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion." }, "charged_fee": { "type": "string", "format": "decimal", "description": "Indicates fee that will be applied when the execution of quote is effective." }, "external_ref": { "type": "string", "maxLength": 128, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date.", "readOnly": true }, "expires_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating expiration date of the quote. Quote will be invalid after that date." } }, "required": [ "id", "pair", "op_type", "base_asset", "quote_asset", "base_amount", "quote_amount", "rate", "charged_fee", "external_ref", "created_at", "expires_at" ], "x-examples": { "example-1": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "pair": "string", "op_type": "BUY", "base_asset": "string", "quote_asset": "string", "base_amount": "string", "quote_amount": "string", "rate": "string", "charged_fee": "string", "external_ref": "string", "created_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z" } }, "x-stoplight": { "id": "1rx0urcfjqrc9" } }, "examples": { "Get Quote": { "value": { "id": "79296371-308d-455b-8233-fd77efc3a25d", "pair": "USDT_USD", "op_type": "SELL", "base_asset": "USDT", "quote_asset": "USD", "base_amount": "1.000000000000000000", "quote_amount": "1.000499999999999945", "rate": "1.00050000", "charged_fee": "0.000", "external_ref": "op1", "created_at": "2021-09-10T15:27:19.641160-03:00", "expires_at": "2021-09-10T15:27:49.640444-03:00" } } } } }, "description": "Successful response" } }, "tags": [ "Quotes" ], "summary": "Retrieve Account Quote", "security": [ { "OAuth2": [ "read", "write" ] } ], "x-stoplight": { "id": "qgwa4s29awvg5" } }, "parameters": [ { "schema": { "type": "string" }, "name": "quote_id", "in": "path", "required": true } ] }, "/api/v1/reusable-quotes/{reusable_quote_id}/": { "get": { "operationId": "retrieveReusableQuoteResponse", "description": "Retrieve previously generated reusable quote given an id.", "parameters": [ { "name": "reusable_quote_id", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "title": "ReusableQuoteResponse", "description": "", "x-examples": { "example-1": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "pair": "string", "base_asset": "string", "quote_asset": "string", "buy_rate": "string", "sell_rate": "string", "market_buy_rate": "string", "market_sell_rate": "string", "buy_fee_percentage": "string", "sell_fee_percentage": "string", "external_ref": "string", "created_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z" } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "status": { "type": "string", "enum": [ "COM", "PEN", "EXP", "UNA_PRICE" ] }, "pair": { "type": "string", "description": "Indicates pair name involved in the quotation." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "buy_rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion." }, "sell_rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion." }, "market_buy_rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion, without the applied fee." }, "market_sell_rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion, without the applied fee." }, "buy_fee_percentage": { "type": "string", "format": "decimal", "description": "Indicates the fee percentage applied to market_buy_rate to obtain buy_rate." }, "sell_fee_percentage": { "type": "string", "format": "decimal", "description": "Indicates the fee percentage applied to market_sell_rate to obtain sell_rate." }, "external_ref": { "type": "string", "maxLength": 128, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date.", "readOnly": true }, "expires_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating expiration date of the quote. Quote will be invalid after that date." } }, "required": [ "id", "pair", "base_asset", "quote_asset", "buy_rate", "sell_rate", "market_buy_rate", "market_sell_rate", "buy_fee_percentage", "sell_fee_percentage", "external_ref", "created_at", "expires_at" ], "x-stoplight": { "id": "yjdne4mx325hn" } }, "examples": { "Get Reusable Quote": { "value": { "id": "79296371-308d-455b-8233-fd77efc3a25d", "pair": "USDT_USD", "status": "PEN", "base_asset": "USDT", "quote_asset": "USD", "buy_rate": "1.01220000", "sell_rate": "0.98071830", "market_buy_rate": "1.00000000", "market_sell_rate": "0.99900000", "buy_fee_percentage": "1.2200000", "sell_fee_percentage": "1.8300000", "external_ref": "op1", "created_at": "2021-09-10T15:27:19.641160-03:00", "expires_at": "2021-09-10T15:27:49.640444-03:00" } } } } }, "description": "Successful response" } }, "summary": "Retrieve Account Reusable Quote", "security": [ { "OAuth2": [ "read", "write" ] } ], "tags": [ "Reusable Quotes" ], "x-stoplight": { "id": "mpddrheqzilk5" } }, "parameters": [ { "schema": { "type": "string" }, "name": "reusable_quote_id", "in": "path", "required": true } ] }, "/healthcheck/": { "get": { "operationId": "healthcheck", "description": "The healthcheck service allows a third party application to check the B2B API's status. These status are divided for the different APIs, returning a OK or NOT OK status.\n\nThis service does not require any authentication, and can be accessed by simply sending a GET request to the healthcheck URL.\n", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "type": "object", "x-examples": { "example-1": { "auth": "OK", "end-users": "OK", "pairs": "OK", "rates": "OK", "quotes": "OK", "transactions": "OK" } }, "properties": { "auth": { "type": "string", "description": "Indicates whether the Auth Service is OK or NOK.", "enum": [ "OK", "NOK" ] }, "end-users": { "type": "string", "description": "Indicates whether the End-Users Service is OK or NOK.", "enum": [ "OK", "NOK" ] }, "pairs": { "type": "string", "description": "Indicates whether the Pairs Service is OK or NOK.", "enum": [ "OK", "NOK" ] }, "rates": { "type": "string", "description": "Indicates whether the Rates Service is OK or NOK.", "enum": [ "OK", "NOK" ] }, "quotes": { "type": "string", "description": "Indicates whether the Quotes Service is OK or NOK.", "enum": [ "OK", "NOK" ] }, "transactions": { "type": "string", "description": "Indicates whether the Transactions Service is OK or NOK.", "enum": [ "OK", "NOK" ] } }, "required": [ "auth", "end-users", "pairs", "rates", "quotes", "transactions" ] }, "examples": { "OK Services": { "value": { "auth": "OK", "end-users": "OK", "pairs": "OK", "rates": "OK", "quotes": "OK", "transactions": "OK" } }, "NOK Services": { "value": { "auth": "NOK", "end-users": "NOK", "pairs": "NOK", "rates": "NOK", "quotes": "NOK", "transactions": "NOK" } } } } }, "description": "Successful response", "headers": {} } }, "summary": "Healthcheck", "tags": [ "Service Status" ], "x-stoplight": { "id": "2sqas5o699l76" } }, "parameters": [] }, "/api/v1/transactions/": { "get": { "operationId": "listTransactions", "description": "List all executed transactions.", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "op_type", "description": "Filter by operation type: `BUY`, `SELL`, `SWAP`, `DEPOSIT`, `WITHDRAWAL`, `PEER_TO_PEER`, `COIN_EARN`, `COIN_BURN`, `FIAT_DEPOSIT`, `FIAT_WITHDRAWAL`." }, { "schema": { "type": "string" }, "in": "query", "name": "date_gt", "description": "Filter by date, greater than to this date." }, { "schema": { "type": "string" }, "in": "query", "name": "date_lt", "description": "Filter by date, less than to this date." }, { "schema": { "type": "string" }, "in": "query", "name": "end_user", "description": "Filter by end user (external reference)" }, { "schema": { "type": "string" }, "in": "query", "name": "asset", "description": "Filter by asset" }, { "schema": { "type": "string" }, "in": "query", "name": "quote_external_ref", "description": "Filter by the arbitrary identifier used as external reference in the quote" } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "example": 123, "description": "Indicates total count of transactions." }, "next": { "type": "string", "format": "uri", "example": "http://api.example.org/accounts/?page=4", "description": "Indicates next page by URL.", "nullable": true }, "previous": { "type": "string", "format": "uri", "example": "http://api.example.org/accounts/?page=2", "description": "Indicates previous page by URL.", "nullable": true }, "results": { "type": "array", "description": "List of fetched transactions.", "items": { "type": "object", "description": "", "title": "Transaction", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as txn identifier." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of txn.", "readOnly": true }, "end_user": { "type": "string", "description": "Indicates which end user was involved in the transaction.", "readOnly": true }, "op_type": { "enum": [ "BUY", "SELL", "SWAP", "DEPOSIT", "WITHDRAWAL", "PEER_TO_PEER", "COIN_EARN", "COIN_BURN", "FIAT_DEPOSIT", "FIAT_WITHDRAWAL" ], "type": "string", "description": "Indicates whether the transaction is for `BUY`, `SELL`, `SWAP`, `DEPOSIT`, `WITHDRAWAL`, `PEER_TO_PEER`, `COIN_EARN`, `COIN_BURN`, `FIAT_DEPOSIT`, `FIAT_WITHDRAWAL`.", "readOnly": true }, "operation": { "oneOf": [ { "type": "object", "description": "If the transaction represents a `BUY` or `SELL` operation, this object will detail the information of the trade.", "x-examples": { "example-1": { "id": "636ed595-714b-4785-8d36-3dcac7d2567d", "external_ref": "71736720-4d62-473b-9916-015e59986e69", "quote_id": "02642013-9310-47c4-8e85-67cba34d60a5", "txn_id": "39402e8a-0f0e-49dc-928f-c72cf973383e", "end_user_id": "73aa41e6-8a97-45f8-8d20-b2bd0cc91193", "rate": "140.00000000", "market_rate": "140.00000000", "charged_fee": "0E-8", "fee_charged_in_fiat": true, "deferred_charged_fee": true, "crypto_charged_fee": "0E-20", "base_amount": "11.13622013", "quote_amount": "1559.07081820", "base_asset": "RTEST", "quote_asset": "ARS", "created_at": "2025-01-22T20:20:26.218009Z", "metadata": "{}", "invoice_pdf": null } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as trade identifier." }, "external_ref": { "type": "string", "description": "Arbitrary identifier used as external_ref when the quote was created." }, "quote_id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "txn_id": { "type": "string", "format": "uuid", "description": "UUID used as Transaction identifier. Useful to relate this object trade with a transaction object." }, "end_user_id": { "type": "string", "description": "Arbitrary string used as end_user identifier." }, "rate": { "type": "string", "description": "Indicates the exchange rate used for conversion." }, "market_rate": { "type": "string", "description": "Indicates the market rate when the trade was executed." }, "charged_fee": { "type": "string", "description": "Indicates trade's applied fee." }, "fee_charged_in_fiat": { "type": "boolean", "description": "Indicates if the fee was charged in fiat currency." }, "deferred_charged_fee": { "type": "boolean", "description": "Indicates if the fee was deferred." }, "crypto_charged_fee": { "type": "string", "description": "Indicates the fee charged in crypto currency." }, "base_amount": { "type": "string", "description": "Indicates the amount of units or equivalence in the quote for base currency." }, "quote_amount": { "type": "string", "description": "Indicates the amount of units or equivalence in the quote for quote currency." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of trade.", "readOnly": true } }, "required": [ "id", "external_ref", "quote_id", "txn_id", "end_user_id", "rate", "charged_fee", "fee_charged_in_fiat", "deferred_charged_fee", "base_amount", "quote_amount", "base_asset", "quote_asset", "created_at" ], "readOnly": true, "x-stoplight": { "id": "0vqlkdmhgi3f7" } }, { "type": "object", "description": "If the transaction represents a `SWAP` operation, this object will detail the information of the swap.", "x-examples": { "example-1": { "id": "e5151bb5-7bae-4013-b27b-0f49c2d65597", "external_ref": "71736720-4d62-473b-9916-015e59986e69", "quote_id": "02642013-9310-47c4-8e85-67cba34d60a5", "txn_id": "5f753809-062b-41e7-b048-7c5bc3948b94", "end_user_id": "73aa41e6-8a97-45f8-8d20-b2bd0cc91193", "rate": "140.00000000", "market_rate": "140.00000000", "charged_fee": "0E-8", "base_amount": "11.13622013", "quote_amount": "1559.07081820", "base_asset": "RTEST", "quote_asset": "ARS", "created_at": "2025-01-22T20:20:26.218009Z", "metadata": "{}", "invoice_pdf": "base64_encoded_pdf" } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as trade identifier." }, "external_ref": { "type": "string", "description": "Arbitrary identifier used as external_ref when the quote was created." }, "quote_id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "txn_id": { "type": "string", "format": "uuid", "description": "UUID used as Transaction identifier. Useful to relate this object trade with a transaction object." }, "end_user_id": { "type": "string", "description": "Arbitrary string used as end_user identifier." }, "rate": { "type": "string", "description": "Indicates the exchange rate used for conversion." }, "market_rate": { "type": "string", "description": "Indicates the market rate when the trade was executed." }, "charged_fee": { "type": "string", "description": "Indicates trade's applied fee." }, "base_amount": { "type": "string", "description": "Indicates the amount of units or equivalence in the quote for base currency." }, "quote_amount": { "type": "string", "description": "Indicates the amount of units or equivalence in the quote for quote currency." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of trade.", "readOnly": true } }, "required": [ "id", "external_ref", "quote_id", "txn_id", "end_user_id", "rate", "charged_fee", "base_amount", "quote_amount", "base_asset", "quote_asset", "created_at" ], "readOnly": true, "x-stoplight": { "id": "0vqlkdmhgi3f7" } }, { "type": "object", "description": "If the transaction represents a `DEPOSIT` operation, this object will detail the information of the deposit.", "x-examples": { "example-1": { "id": "c6e5fb9b-b57e-46d1-b911-812c8e65e382", "hash": "0xd32844ded49dc0288dcfebd5229fc9535dd648992eaca66ee841af39e03db5cc", "index": 101, "amount": "0.000100000000000000", "create_date": "2024-11-14T19:18:11.635653Z", "created_at": "2024-11-14T19:18:11.635653Z", "update_date": "2024-11-14T19:20:46.353098Z", "updated_at": "2024-11-14T19:20:46.353098Z", "confirmation_date": "2024-11-14T19:20:46.330463Z", "currency_code": "RTEST", "is_blocked": false, "reason": "", "address_destination": "0x2642662552D718244240EadbC25514198791dc83", "address_origin": "0x05946b0d5E413e45069BeC923004F9A3c8F70B2B", "end_user_id": "86c741a2-c3c8-46b1-a807-4fa1f40bf069", "status": "COMPLETED", "network": "ethereum_sepolia", "risk_score": null } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used to identify the deposit." }, "hash": { "type": "string", "description": "Hash of the transaction on the blockchain." }, "index": { "type": "integer", "description": "Index of the transaction on the blockchain." }, "amount": { "type": "string", "description": "Amount of the deposit." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of the deposit.", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating last update date of the deposit.", "readOnly": true }, "confirmation_date": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating confirmation date of the deposit." }, "currency_code": { "type": "string", "description": "Currency of the deposit." }, "is_blocked": { "type": "boolean", "description": "Indicates if the deposit is blocked." }, "reason": { "type": "string", "description": "If the deposit is blocked this field will contain the reason." }, "address_destination": { "type": "string", "description": "Destination address of the deposit." }, "address_origin": { "type": "string", "description": "Origin address of the deposit." }, "end_user_id": { "type": "string", "description": "Arbitrary string used as end_user identifier." }, "status": { "type": "string", "description": "Indicates the status of the deposit." }, "network": { "type": "string", "description": "Indicates the network where the deposit was made." } }, "required": [ "id", "amount", "created_at", "updated_at", "currency_code", "is_blocked", "reason", "address_destination", "address_origin", "end_user_id", "status", "network" ], "readOnly": true, "x-stoplight": { "id": "0vqlkdmhgi3f7" } }, { "type": "object", "description": "If the transaction represents a `WITHDRAWAL` operation, this object will detail the information of the withdrawal.", "x-examples": { "example-1": { "id": "c749d1e0-47c1-4478-af0b-1149bdc1e594", "transaction_id": "d48d24f1-6801-44f6-a9ac-c5210ab700c5", "created_at": "2024-11-14T19:17:41.538960Z", "confirmation_date": "2024-11-14T19:20:02.547553Z", "txn_hash": "d32844ded49dc0288dcfebd5229fc9535dd648992eaca66ee841af39e03db5cc", "provisory_txn_hash": "d32844ded49dc0288dcfebd5229fc9535dd648992eaca66ee841af39e03db5cc", "end_user_id": "86c741a2-c3c8-46b1-a807-4fa1f40bf069", "currency": "RTEST", "amount": "0.000100000000000000", "debited_amount": "0.012857840000000000", "address": "0x2642662552D718244240EadbC25514198791dc83", "network_name": "ETHEREUM_SEPOLIA", "risk_score": null, "status": "COMPLETED", "is_blocked": false, "reason": "", "external_ref": "test_IPN_sandbox_1" } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used to identify the withdrawal." }, "transaction_id": { "type": "string", "format": "uuid", "description": "UUID used to identify the transaction." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of the withdrawal.", "readOnly": true }, "confirmation_date": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating confirmation date of the withdrawal." }, "txn_hash": { "type": "string", "description": "Hash of the transaction on the blockchain." }, "end_user_id": { "type": "string", "description": "Arbitrary string used as end_user identifier." }, "currency": { "type": "string", "description": "Currency of the withdrawal." }, "amount": { "type": "string", "description": "Amount of the withdrawal." }, "debited_amount": { "type": "string", "description": "Amount debited from the user." }, "address": { "type": "string", "description": "Destination address of the withdrawal." }, "network_name": { "type": "string", "description": "Indicates the network where the withdrawal was made." }, "status": { "type": "string", "description": "Indicates the status of the withdrawal." }, "is_blocked": { "type": "boolean", "description": "Indicates if the withdrawal is blocked." }, "reason": { "type": "string", "description": "If the withdrawal is blocked this field will contain the reason." }, "external_ref": { "type": "string", "description": "Arbitrary string used as external_ref when the withdrawal was created." } }, "required": [ "id", "transaction_id", "created_at", "txn_hash", "end_user_id", "currency", "amount", "debited_amount", "address", "status", "is_blocked", "reason", "external_ref" ], "readOnly": true, "x-stoplight": { "id": "0vqlkdmhgi3f7" } }, { "type": "object", "description": "If the transaction represents a `PEER_TO_PEER` operation, this object will detail the information of the peer to peer transaction.", "x-examples": { "example-1": { "id": "peer_to_peer_id_example", "sender": "sender_external_ref", "receiver": "receiver_external_ref", "sender_transaction_id": "sender_transaction_id_example", "receiver_transaction_id": "receiver_transaction_id_example", "currency": "RTEST", "amount": "100.00", "created_at": "2025-01-22T20:20:26.328972Z" } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used to identify the peer to peer transaction." }, "sender": { "type": "string", "description": "Arbitrary string used as end_user identifier for the one performing the transaction." }, "receiver": { "type": "string", "description": "Arbitrary string used as end_user identifier for the one receiving the transaction." }, "sender_transaction_id": { "type": "string", "format": "uuid", "description": "UUID used to identify the transaction of the sender." }, "receiver_transaction_id": { "type": "string", "format": "uuid", "description": "UUID used to identify the transaction of the receiver." }, "currency": { "type": "string", "description": "Currency of the peer to peer transaction." }, "amount": { "type": "string", "description": "Amount of the peer to peer transaction." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of the peer to peer transaction.", "readOnly": true } }, "required": [ "id", "sender", "receiver", "sender_transaction_id", "receiver_transaction_id", "currency", "amount", "created_at" ], "readOnly": true, "x-stoplight": { "id": "0vqlkdmhgi3f7" } }, { "type": "object", "description": "If the transaction represents a `COIN_EARN` operation, this object will detail the information of the coin earn transaction.", "x-examples": { "example-1": { "id": "coin_earn_id_example", "external_ref": "external_ref_example", "end_user": "end_user_external_ref", "transaction_id": "transaction_id_example", "currency": "RTEST", "amount": "50.00", "created_at": "2025-01-22T20:20:26.328972Z" } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used to identify the coin earn transaction." }, "external_ref": { "type": "string", "description": "Arbitrary string used as external_ref when the coin earn transaction was created." }, "end_user": { "type": "string", "description": "Arbitrary string used as end_user identifier." }, "transaction_id": { "type": "string", "format": "uuid", "description": "UUID used to identify the transaction." }, "currency": { "type": "string", "description": "Currency of the coin earn transaction." }, "amount": { "type": "string", "description": "Amount of the coin earn transaction." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of the coin earn transaction.", "readOnly": true } }, "required": [ "id", "external_ref", "end_user", "transaction_id", "currency", "amount", "created_at" ], "readOnly": true, "x-stoplight": { "id": "0vqlkdmhgi3f7" } }, { "type": "object", "description": "If the transaction represents a `COIN_BURN` operation, this object will detail the information of the coin burn transaction.", "x-examples": { "example-1": { "id": "coin_burn_id_example", "external_ref": "external_ref_example", "end_user": "end_user_external_ref", "transaction_id": "transaction_id_example", "currency": "RTEST", "amount": "25.00", "created_at": "2025-01-22T20:20:26.328972Z" } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used to identify the coin burn transaction." }, "external_ref": { "type": "string", "description": "Arbitrary string used as external_ref when the coin burn transaction was created." }, "end_user": { "type": "string", "description": "Arbitrary string used as end_user identifier." }, "transaction_id": { "type": "string", "format": "uuid", "description": "UUID used to identify the transaction." }, "currency": { "type": "string", "description": "Currency of the coin burn transaction." }, "amount": { "type": "string", "description": "Amount of the coin burn transaction." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of the coin burn transaction.", "readOnly": true } }, "required": [ "id", "external_ref", "end_user", "transaction_id", "currency", "amount", "created_at" ], "readOnly": true, "x-stoplight": { "id": "0vqlkdmhgi3f7" } }, { "type": "object", "description": "If the transaction represents a `FIAT_DEPOSIT` operation, this object will detail the information of the fiat deposit.", "x-examples": { "example-1": { "id": "fiat_deposit_id_example", "amount": "1000.00", "created_at": "2025-01-22T20:20:26.328972Z", "updated_at": "2025-01-22T20:25:00.414331Z", "currency_code": "ARS", "end_user_id": "end_user_external_ref", "status": "COMPLETED", "payment_method_type": "BANK_TRANSFER", "refunded": false, "refund_fiat_withdrawal_id": "refund_fiat_withdrawal_id_example" } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used to identify the fiat deposit." }, "amount": { "type": "string", "description": "Amount of the fiat deposit." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of the fiat deposit.", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating last update date of the fiat deposit.", "readOnly": true }, "currency_code": { "type": "string", "description": "Currency of the fiat deposit." }, "end_user_id": { "type": "string", "description": "Arbitrary string used as end_user identifier." }, "status": { "type": "string", "description": "Indicates the status of the deposit." }, "payment_method_type": { "type": "string", "description": "Indicates the payment method used for the deposit." }, "refunded": { "type": "boolean", "description": "Indicates if the deposit was refunded." }, "refund_fiat_withdrawal_id": { "type": "string", "format": "uuid", "description": "UUID used to identify the fiat withdrawal that refunded the deposit." } }, "required": [ "id", "amount", "created_at", "updated_at", "currency_code", "end_user_id", "status", "payment_method_type", "refunded" ], "readOnly": true, "x-stoplight": { "id": "0vqlkdmhgi3f7" } }, { "type": "object", "description": "If the transaction represents a `FIAT_WITHDRAWAL` operation, this object will detail the information of the fiat withdrawal.", "x-examples": { "example-1": { "id": "fiat_withdrawal_id_example", "transaction_id": "transaction_id_example", "created_at": "2025-01-22T20:20:26.328972Z", "updated_at": "2025-01-22T20:25:00.414331Z", "end_user_id": "end_user_external_ref", "currency_code": "ARS", "amount": "1000.00", "status": "COMPLETED", "external_ref": "external_ref_example", "beneficiary_fiat_account_id": "beneficiary_fiat_account_id_example", "is_fiat_deposit_refund": false, "refunded_fiat_deposit": "refunded_fiat_deposit_example" } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used to identify the fiat withdrawal." }, "transaction_id": { "type": "string", "format": "uuid", "description": "UUID used to identify the transaction." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of the fiat withdrawal.", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating last update date of the fiat withdrawal.", "readOnly": true }, "end_user_id": { "type": "string", "description": "Arbitrary string used as end_user identifier." }, "currency_code": { "type": "string", "description": "Currency of the fiat withdrawal." }, "amount": { "type": "string", "description": "Amount of the fiat withdrawal." }, "status": { "type": "string", "description": "Indicates the status of the withdrawal." }, "external_ref": { "type": "string", "description": "Arbitrary string used as external_ref when the fiat withdrawal was created." }, "beneficiary_fiat_account_id": { "type": "string", "format": "uuid", "description": "UUID used to identify the beneficiary fiat account." }, "is_fiat_deposit_refund": { "type": "boolean", "description": "Indicates if the withdrawal is a refund of a deposit." }, "refunded_fiat_deposit": { "type": "string", "format": "uuid", "description": "UUID used to identify the fiat deposit that was refunded." } }, "required": [ "id", "transaction_id", "created_at", "updated_at", "end_user_id", "currency_code", "amount", "status", "external_ref", "beneficiary_fiat_account_id", "is_fiat_deposit_refund" ], "readOnly": true, "x-stoplight": { "id": "0vqlkdmhgi3f7" } } ] }, "status": { "type": "string", "description": "Indicates the status of the transaction.", "readOnly": true, "example": "COMPLETED" } }, "required": [ "id", "created_at", "end_user", "op_type", "status" ], "x-stoplight": { "id": "5671qhgh98enx" } } } } } } }, "description": "Successful response" } }, "tags": [ "Transactions" ], "summary": "List Transactions", "security": [ { "OAuth2": [ "read", "write" ] } ], "x-stoplight": { "id": "q6g23yp98qlym" } }, "parameters": [] }, "/api/v1/transactions/{txn_id}/": { "get": { "operationId": "retrieveTransaction", "description": "Retrieve transaction details given an id.", "parameters": [ { "name": "txn_id", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "description": "", "title": "Transaction", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as txn identifier." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of txn.", "readOnly": true }, "end_user": { "type": "string", "description": "Indicates which end user was involved in the transaction.", "readOnly": true }, "op_type": { "enum": [ "BUY", "SELL", "SWAP", "DEPOSIT", "WITHDRAWAL", "PEER_TO_PEER", "COIN_EARN", "COIN_BURN", "FIAT_DEPOSIT", "FIAT_WITHDRAWAL" ], "type": "string", "description": "Indicates whether the transaction is for `BUY`, `SELL`, `SWAP`, `DEPOSIT`, `WITHDRAWAL`, `PEER_TO_PEER`, `COIN_EARN`, `COIN_BURN`, `FIAT_DEPOSIT`, `FIAT_WITHDRAWAL`.", "readOnly": true }, "operation": { "oneOf": [ { "type": "object", "description": "If the transaction represents a `BUY` or `SELL` operation, this object will detail the information of the trade.", "x-examples": { "example-1": { "id": "636ed595-714b-4785-8d36-3dcac7d2567d", "external_ref": "71736720-4d62-473b-9916-015e59986e69", "quote_id": "02642013-9310-47c4-8e85-67cba34d60a5", "txn_id": "39402e8a-0f0e-49dc-928f-c72cf973383e", "end_user_id": "73aa41e6-8a97-45f8-8d20-b2bd0cc91193", "rate": "140.00000000", "market_rate": "140.00000000", "charged_fee": "0E-8", "fee_charged_in_fiat": true, "deferred_charged_fee": true, "crypto_charged_fee": "0E-20", "base_amount": "11.13622013", "quote_amount": "1559.07081820", "base_asset": "RTEST", "quote_asset": "ARS", "created_at": "2025-01-22T20:20:26.218009Z", "metadata": "{}", "invoice_pdf": null } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as trade identifier." }, "external_ref": { "type": "string", "description": "Arbitrary identifier used as external_ref when the quote was created." }, "quote_id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "txn_id": { "type": "string", "format": "uuid", "description": "UUID used as Transaction identifier. Useful to relate this object trade with a transaction object." }, "end_user_id": { "type": "string", "description": "Arbitrary string used as end_user identifier." }, "rate": { "type": "string", "description": "Indicates the exchange rate used for conversion." }, "market_rate": { "type": "string", "description": "Indicates the market rate when the trade was executed." }, "charged_fee": { "type": "string", "description": "Indicates trade's applied fee." }, "fee_charged_in_fiat": { "type": "boolean", "description": "Indicates if the fee was charged in fiat currency." }, "deferred_charged_fee": { "type": "boolean", "description": "Indicates if the fee was deferred." }, "crypto_charged_fee": { "type": "string", "description": "Indicates the fee charged in crypto currency." }, "base_amount": { "type": "string", "description": "Indicates the amount of units or equivalence in the quote for base currency." }, "quote_amount": { "type": "string", "description": "Indicates the amount of units or equivalence in the quote for quote currency." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of trade.", "readOnly": true } }, "required": [ "id", "external_ref", "quote_id", "txn_id", "end_user_id", "rate", "charged_fee", "fee_charged_in_fiat", "deferred_charged_fee", "base_amount", "quote_amount", "base_asset", "quote_asset", "created_at" ], "readOnly": true, "x-stoplight": { "id": "0vqlkdmhgi3f7" } }, { "type": "object", "description": "If the transaction represents a `SWAP` operation, this object will detail the information of the swap.", "x-examples": { "example-1": { "id": "e5151bb5-7bae-4013-b27b-0f49c2d65597", "external_ref": "71736720-4d62-473b-9916-015e59986e69", "quote_id": "02642013-9310-47c4-8e85-67cba34d60a5", "txn_id": "5f753809-062b-41e7-b048-7c5bc3948b94", "end_user_id": "73aa41e6-8a97-45f8-8d20-b2bd0cc91193", "rate": "140.00000000", "market_rate": "140.00000000", "charged_fee": "0E-8", "base_amount": "11.13622013", "quote_amount": "1559.07081820", "base_asset": "RTEST", "quote_asset": "ARS", "created_at": "2025-01-22T20:20:26.218009Z", "metadata": "{}", "invoice_pdf": "base64_encoded_pdf" } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as trade identifier." }, "external_ref": { "type": "string", "description": "Arbitrary identifier used as external_ref when the quote was created." }, "quote_id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "txn_id": { "type": "string", "format": "uuid", "description": "UUID used as Transaction identifier. Useful to relate this object trade with a transaction object." }, "end_user_id": { "type": "string", "description": "Arbitrary string used as end_user identifier." }, "rate": { "type": "string", "description": "Indicates the exchange rate used for conversion." }, "market_rate": { "type": "string", "description": "Indicates the market rate when the trade was executed." }, "charged_fee": { "type": "string", "description": "Indicates trade's applied fee." }, "base_amount": { "type": "string", "description": "Indicates the amount of units or equivalence in the quote for base currency." }, "quote_amount": { "type": "string", "description": "Indicates the amount of units or equivalence in the quote for quote currency." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of trade.", "readOnly": true } }, "required": [ "id", "external_ref", "quote_id", "txn_id", "end_user_id", "rate", "charged_fee", "base_amount", "quote_amount", "base_asset", "quote_asset", "created_at" ], "readOnly": true, "x-stoplight": { "id": "0vqlkdmhgi3f7" } }, { "type": "object", "description": "If the transaction represents a `DEPOSIT` operation, this object will detail the information of the deposit.", "x-examples": { "example-1": { "id": "c6e5fb9b-b57e-46d1-b911-812c8e65e382", "hash": "0xd32844ded49dc0288dcfebd5229fc9535dd648992eaca66ee841af39e03db5cc", "index": 101, "amount": "0.000100000000000000", "create_date": "2024-11-14T19:18:11.635653Z", "created_at": "2024-11-14T19:18:11.635653Z", "update_date": "2024-11-14T19:20:46.353098Z", "updated_at": "2024-11-14T19:20:46.353098Z", "confirmation_date": "2024-11-14T19:20:46.330463Z", "currency_code": "RTEST", "is_blocked": false, "reason": "", "address_destination": "0x2642662552D718244240EadbC25514198791dc83", "address_origin": "0x05946b0d5E413e45069BeC923004F9A3c8F70B2B", "end_user_id": "86c741a2-c3c8-46b1-a807-4fa1f40bf069", "status": "COMPLETED", "network": "ethereum_sepolia", "risk_score": null } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used to identify the deposit." }, "hash": { "type": "string", "description": "Hash of the transaction on the blockchain." }, "index": { "type": "integer", "description": "Index of the transaction on the blockchain." }, "amount": { "type": "string", "description": "Amount of the deposit." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of the deposit.", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating last update date of the deposit.", "readOnly": true }, "confirmation_date": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating confirmation date of the deposit." }, "currency_code": { "type": "string", "description": "Currency of the deposit." }, "is_blocked": { "type": "boolean", "description": "Indicates if the deposit is blocked." }, "reason": { "type": "string", "description": "If the deposit is blocked this field will contain the reason." }, "address_destination": { "type": "string", "description": "Destination address of the deposit." }, "address_origin": { "type": "string", "description": "Origin address of the deposit." }, "end_user_id": { "type": "string", "description": "Arbitrary string used as end_user identifier." }, "status": { "type": "string", "description": "Indicates the status of the deposit." }, "network": { "type": "string", "description": "Indicates the network where the deposit was made." } }, "required": [ "id", "amount", "created_at", "updated_at", "currency_code", "is_blocked", "reason", "address_destination", "address_origin", "end_user_id", "status", "network" ], "readOnly": true, "x-stoplight": { "id": "0vqlkdmhgi3f7" } }, { "type": "object", "description": "If the transaction represents a `WITHDRAWAL` operation, this object will detail the information of the withdrawal.", "x-examples": { "example-1": { "id": "c749d1e0-47c1-4478-af0b-1149bdc1e594", "transaction_id": "d48d24f1-6801-44f6-a9ac-c5210ab700c5", "created_at": "2024-11-14T19:17:41.538960Z", "confirmation_date": "2024-11-14T19:20:02.547553Z", "txn_hash": "d32844ded49dc0288dcfebd5229fc9535dd648992eaca66ee841af39e03db5cc", "provisory_txn_hash": "d32844ded49dc0288dcfebd5229fc9535dd648992eaca66ee841af39e03db5cc", "end_user_id": "86c741a2-c3c8-46b1-a807-4fa1f40bf069", "currency": "RTEST", "amount": "0.000100000000000000", "debited_amount": "0.012857840000000000", "address": "0x2642662552D718244240EadbC25514198791dc83", "network_name": "ETHEREUM_SEPOLIA", "risk_score": null, "status": "COMPLETED", "is_blocked": false, "reason": "", "external_ref": "test_IPN_sandbox_1" } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used to identify the withdrawal." }, "transaction_id": { "type": "string", "format": "uuid", "description": "UUID used to identify the transaction." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of the withdrawal.", "readOnly": true }, "confirmation_date": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating confirmation date of the withdrawal." }, "txn_hash": { "type": "string", "description": "Hash of the transaction on the blockchain." }, "end_user_id": { "type": "string", "description": "Arbitrary string used as end_user identifier." }, "currency": { "type": "string", "description": "Currency of the withdrawal." }, "amount": { "type": "string", "description": "Amount of the withdrawal." }, "debited_amount": { "type": "string", "description": "Amount debited from the user." }, "address": { "type": "string", "description": "Destination address of the withdrawal." }, "network_name": { "type": "string", "description": "Indicates the network where the withdrawal was made." }, "status": { "type": "string", "description": "Indicates the status of the withdrawal." }, "is_blocked": { "type": "boolean", "description": "Indicates if the withdrawal is blocked." }, "reason": { "type": "string", "description": "If the withdrawal is blocked this field will contain the reason." }, "external_ref": { "type": "string", "description": "Arbitrary string used as external_ref when the withdrawal was created." } }, "required": [ "id", "transaction_id", "created_at", "txn_hash", "end_user_id", "currency", "amount", "debited_amount", "address", "status", "is_blocked", "reason", "external_ref" ], "readOnly": true, "x-stoplight": { "id": "0vqlkdmhgi3f7" } }, { "type": "object", "description": "If the transaction represents a `PEER_TO_PEER` operation, this object will detail the information of the peer to peer transaction.", "x-examples": { "example-1": { "id": "peer_to_peer_id_example", "sender": "sender_external_ref", "receiver": "receiver_external_ref", "sender_transaction_id": "sender_transaction_id_example", "receiver_transaction_id": "receiver_transaction_id_example", "currency": "RTEST", "amount": "100.00", "created_at": "2025-01-22T20:20:26.328972Z" } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used to identify the peer to peer transaction." }, "sender": { "type": "string", "description": "Arbitrary string used as end_user identifier for the one performing the transaction." }, "receiver": { "type": "string", "description": "Arbitrary string used as end_user identifier for the one receiving the transaction." }, "sender_transaction_id": { "type": "string", "format": "uuid", "description": "UUID used to identify the transaction of the sender." }, "receiver_transaction_id": { "type": "string", "format": "uuid", "description": "UUID used to identify the transaction of the receiver." }, "currency": { "type": "string", "description": "Currency of the peer to peer transaction." }, "amount": { "type": "string", "description": "Amount of the peer to peer transaction." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of the peer to peer transaction.", "readOnly": true } }, "required": [ "id", "sender", "receiver", "sender_transaction_id", "receiver_transaction_id", "currency", "amount", "created_at" ], "readOnly": true, "x-stoplight": { "id": "0vqlkdmhgi3f7" } }, { "type": "object", "description": "If the transaction represents a `COIN_EARN` operation, this object will detail the information of the coin earn transaction.", "x-examples": { "example-1": { "id": "coin_earn_id_example", "external_ref": "external_ref_example", "end_user": "end_user_external_ref", "transaction_id": "transaction_id_example", "currency": "RTEST", "amount": "50.00", "created_at": "2025-01-22T20:20:26.328972Z" } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used to identify the coin earn transaction." }, "external_ref": { "type": "string", "description": "Arbitrary string used as external_ref when the coin earn transaction was created." }, "end_user": { "type": "string", "description": "Arbitrary string used as end_user identifier." }, "transaction_id": { "type": "string", "format": "uuid", "description": "UUID used to identify the transaction." }, "currency": { "type": "string", "description": "Currency of the coin earn transaction." }, "amount": { "type": "string", "description": "Amount of the coin earn transaction." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of the coin earn transaction.", "readOnly": true } }, "required": [ "id", "external_ref", "end_user", "transaction_id", "currency", "amount", "created_at" ], "readOnly": true, "x-stoplight": { "id": "0vqlkdmhgi3f7" } }, { "type": "object", "description": "If the transaction represents a `COIN_BURN` operation, this object will detail the information of the coin burn transaction.", "x-examples": { "example-1": { "id": "coin_burn_id_example", "external_ref": "external_ref_example", "end_user": "end_user_external_ref", "transaction_id": "transaction_id_example", "currency": "RTEST", "amount": "25.00", "created_at": "2025-01-22T20:20:26.328972Z" } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used to identify the coin burn transaction." }, "external_ref": { "type": "string", "description": "Arbitrary string used as external_ref when the coin burn transaction was created." }, "end_user": { "type": "string", "description": "Arbitrary string used as end_user identifier." }, "transaction_id": { "type": "string", "format": "uuid", "description": "UUID used to identify the transaction." }, "currency": { "type": "string", "description": "Currency of the coin burn transaction." }, "amount": { "type": "string", "description": "Amount of the coin burn transaction." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of the coin burn transaction.", "readOnly": true } }, "required": [ "id", "external_ref", "end_user", "transaction_id", "currency", "amount", "created_at" ], "readOnly": true, "x-stoplight": { "id": "0vqlkdmhgi3f7" } }, { "type": "object", "description": "If the transaction represents a `FIAT_DEPOSIT` operation, this object will detail the information of the fiat deposit.", "x-examples": { "example-1": { "id": "fiat_deposit_id_example", "amount": "1000.00", "created_at": "2025-01-22T20:20:26.328972Z", "updated_at": "2025-01-22T20:25:00.414331Z", "currency_code": "ARS", "end_user_id": "end_user_external_ref", "status": "COMPLETED", "payment_method_type": "BANK_TRANSFER", "refunded": false, "refund_fiat_withdrawal_id": "refund_fiat_withdrawal_id_example" } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used to identify the fiat deposit." }, "amount": { "type": "string", "description": "Amount of the fiat deposit." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of the fiat deposit.", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating last update date of the fiat deposit.", "readOnly": true }, "currency_code": { "type": "string", "description": "Currency of the fiat deposit." }, "end_user_id": { "type": "string", "description": "Arbitrary string used as end_user identifier." }, "status": { "type": "string", "description": "Indicates the status of the deposit." }, "payment_method_type": { "type": "string", "description": "Indicates the payment method used for the deposit." }, "refunded": { "type": "boolean", "description": "Indicates if the deposit was refunded." }, "refund_fiat_withdrawal_id": { "type": "string", "format": "uuid", "description": "UUID used to identify the fiat withdrawal that refunded the deposit." } }, "required": [ "id", "amount", "created_at", "updated_at", "currency_code", "end_user_id", "status", "payment_method_type", "refunded" ], "readOnly": true, "x-stoplight": { "id": "0vqlkdmhgi3f7" } }, { "type": "object", "description": "If the transaction represents a `FIAT_WITHDRAWAL` operation, this object will detail the information of the fiat withdrawal.", "x-examples": { "example-1": { "id": "fiat_withdrawal_id_example", "transaction_id": "transaction_id_example", "created_at": "2025-01-22T20:20:26.328972Z", "updated_at": "2025-01-22T20:25:00.414331Z", "end_user_id": "end_user_external_ref", "currency_code": "ARS", "amount": "1000.00", "status": "COMPLETED", "external_ref": "external_ref_example", "beneficiary_fiat_account_id": "beneficiary_fiat_account_id_example", "is_fiat_deposit_refund": false, "refunded_fiat_deposit": "refunded_fiat_deposit_example" } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used to identify the fiat withdrawal." }, "transaction_id": { "type": "string", "format": "uuid", "description": "UUID used to identify the transaction." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of the fiat withdrawal.", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating last update date of the fiat withdrawal.", "readOnly": true }, "end_user_id": { "type": "string", "description": "Arbitrary string used as end_user identifier." }, "currency_code": { "type": "string", "description": "Currency of the fiat withdrawal." }, "amount": { "type": "string", "description": "Amount of the fiat withdrawal." }, "status": { "type": "string", "description": "Indicates the status of the withdrawal." }, "external_ref": { "type": "string", "description": "Arbitrary string used as external_ref when the fiat withdrawal was created." }, "beneficiary_fiat_account_id": { "type": "string", "format": "uuid", "description": "UUID used to identify the beneficiary fiat account." }, "is_fiat_deposit_refund": { "type": "boolean", "description": "Indicates if the withdrawal is a refund of a deposit." }, "refunded_fiat_deposit": { "type": "string", "format": "uuid", "description": "UUID used to identify the fiat deposit that was refunded." } }, "required": [ "id", "transaction_id", "created_at", "updated_at", "end_user_id", "currency_code", "amount", "status", "external_ref", "beneficiary_fiat_account_id", "is_fiat_deposit_refund" ], "readOnly": true, "x-stoplight": { "id": "0vqlkdmhgi3f7" } } ] }, "status": { "type": "string", "description": "Indicates the status of the transaction.", "readOnly": true, "example": "COMPLETED" } }, "required": [ "id", "created_at", "end_user", "op_type" ], "x-stoplight": { "id": "5671qhgh98enx" } }, "examples": { "example-1": { "value": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "created_at": "2019-08-24T14:15:22Z", "end_user": "string", "op_type": "BUY", "operation": { "id": "636ed595-714b-4785-8d36-3dcac7d2567d", "external_ref": "71736720-4d62-473b-9916-015e59986e69", "quote_id": "02642013-9310-47c4-8e85-67cba34d60a5", "txn_id": "39402e8a-0f0e-49dc-928f-c72cf973383e", "end_user_id": "73aa41e6-8a97-45f8-8d20-b2bd0cc91193", "rate": "140.00000000", "market_rate": "140.00000000", "charged_fee": "0E-8", "fee_charged_in_fiat": true, "deferred_charged_fee": true, "crypto_charged_fee": "0E-20", "base_amount": "11.13622013", "quote_amount": "1559.07081820", "base_asset": "RTEST", "quote_asset": "ARS", "created_at": "2025-01-22T20:20:26.218009Z" } } } } } }, "description": "Successful response" } }, "tags": [ "Transactions" ], "summary": "Retrieve Transaction", "security": [ { "OAuth2": [ "read", "write" ] } ], "x-stoplight": { "id": "pe43vihwo9f0o" } }, "parameters": [ { "schema": { "type": "string" }, "name": "txn_id", "in": "path", "required": true } ] }, "/api/v1/transactions/limits/": { "get": { "operationId": "getTransactionLimitsViewSets", "description": "A transaction limit is the current maximum or minimum amount allowed for a single operation (BUY, SELL, SWAP) and a given fiat currency.", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "type": "object", "x-examples": { "example-1": { "ARS_BUY_TRANSACTION_MIN_LIMIT": "1400", "ARS_BUY_TRANSACTION_MAX_LIMIT": "500000", "ARS_SELL_TRANSACTION_MIN_LIMIT": "1414", "ARS_SELL_TRANSACTION_MAX_LIMIT:''": "500000" } }, "properties": { "ARS_BUY_TRANSACTION_MIN_LIMIT": { "type": "string", "description": "Represents the minimum amount expressed in ARS for a BUY transaction." }, "ARS_BUY_TRANSACTION_MAX_LIMIT": { "type": "string", "description": "Represents the maximum amount expressed in ARS for a BUY transaction." }, "ARS_SELL_TRANSACTION_MIN_LIMIT": { "type": "string", "description": "Represents the minimum amount expressed in ARS for a SELL transaction." }, "ARS_SELL_TRANSACTION_MAX_LIMIT": { "type": "string", "description": "Represents the maximum amount expressed in ARS for a SELL transaction." } }, "required": [ "ARS_BUY_TRANSACTION_MIN_LIMIT", "ARS_BUY_TRANSACTION_MAX_LIMIT", "ARS_SELL_TRANSACTION_MIN_LIMIT", "ARS_SELL_TRANSACTION_MAX_LIMIT" ] }, "examples": { "Example": { "value": { "ARS_BUY_TRANSACTION_MIN_LIMIT": "1400", "ARS_BUY_TRANSACTION_MAX_LIMIT": "500000", "ARS_SELL_TRANSACTION_MIN_LIMIT": "1414", "ARS_SELL_TRANSACTION_MAX_LIMIT": "500000" } } } } }, "description": "Successful response" } }, "summary": "Get Transaction Limits", "security": [ { "OAuth2": [ "read", "write" ] } ], "tags": [ "TXN Limits" ], "x-stoplight": { "id": "ka2dbfh2kwsr5" } }, "parameters": [] }, "/api/v1/end-users/": { "post": { "operationId": "createEndUser", "description": "An End User represents the ultimate stakeholder that will be attached to all efective buy/sell trades. The partner will operate on-behalf-of the end user, serving as a middle-man for the quotation and trade execution process.\n\nIn order to create an End User, the partner must provide an unique and arbitrary ID. All following trades will requiere this ID or REF in order to attach the trade data to that user.", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date.", "readOnly": true }, "external_ref": { "type": "string", "maxLength": 250, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." } }, "required": [ "external_ref" ], "x-stoplight": { "id": "pgo4xowf0ebeo" } }, "examples": { "Successful Creation": { "value": { "external_ref": "CUST-ABC-1" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date.", "readOnly": true }, "external_ref": { "type": "string", "maxLength": 250, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." } }, "required": [ "external_ref" ], "x-stoplight": { "id": "pgo4xowf0ebeo" } } }, "multipart/form-data": { "schema": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date.", "readOnly": true }, "external_ref": { "type": "string", "maxLength": 250, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." } }, "required": [ "external_ref" ], "x-stoplight": { "id": "pgo4xowf0ebeo" } } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date.", "readOnly": true }, "external_ref": { "type": "string", "maxLength": 250, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." } }, "required": [ "external_ref" ], "x-stoplight": { "id": "pgo4xowf0ebeo" } }, "examples": { "Successful creation": { "value": { "created_at": "2019-08-24T14:15:22Z", "external_ref": "CUST-ABC-1", "account": "FooBar" } } } } }, "description": "Successful Response" } }, "summary": "Create End User", "tags": [ "End User" ], "security": [ { "OAuth2": [ "read", "write" ] } ], "x-stoplight": { "id": "0i35lrd4btsiw" } }, "get": { "operationId": "listEndUsers", "description": "This endpoint allows to fetch a list of all active End Users already created.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "example": 123, "description": "Indicates total count of end users." }, "next": { "type": "string", "format": "uri", "example": "http://api.example.org/accounts/?page=4", "description": "Indicates next page by URL.", "nullable": true }, "previous": { "type": "string", "format": "uri", "example": "http://api.example.org/accounts/?page=2", "description": "Indicates previous page by URL.", "nullable": true }, "results": { "type": "array", "description": "List of fetched end users.", "items": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date.", "readOnly": true }, "external_ref": { "type": "string", "maxLength": 250, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." } }, "required": [ "external_ref" ], "x-stoplight": { "id": "pgo4xowf0ebeo" } } } } } } }, "description": "Successful response" } }, "tags": [ "End User" ], "summary": "List End Users", "security": [ { "OAuth2": [ "read", "write" ] } ], "x-stoplight": { "id": "qahzjiwvtd6jr" } }, "parameters": [] }, "/api/v1/end-users/{end_user_id}/": { "get": { "operationId": "retrieveEndUser", "description": "Retrieve end_user details given an end_user_id (external_ref).", "parameters": [ { "name": "end_user_id", "in": "path", "required": true, "description": "Indicates End User external_ref.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date.", "readOnly": true }, "external_ref": { "type": "string", "maxLength": 250, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." } }, "required": [ "external_ref" ], "x-stoplight": { "id": "pgo4xowf0ebeo" } } } }, "description": "Successful response" } }, "tags": [ "End User" ], "summary": "Retrieve End User", "security": [ { "OAuth2": [ "read", "write" ] } ], "x-stoplight": { "id": "qiu3m7l1v9bsi" } }, "parameters": [ { "schema": { "type": "string" }, "name": "end_user_id", "in": "path", "required": true } ] }, "/api/v1/end-users/{end_user_id}/addresses/": { "post": { "summary": "Create Address for End User", "operationId": "post-api-v1-end-users-end_user_id-addresses", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "Address", "type": "object", "properties": { "network": { "type": "string", "enum": [ "BITCOIN", "EHTEREUM" ] }, "end_user_id": { "type": "string", "description": "End user's external ref, usually a uuid." }, "address": { "type": "string", "description": "End User's Address." }, "xpub": { "type": "string", "description": "Last six characters of The Extended Public Key.", "nullable": true }, "derivation_path": { "type": "string", "description": "Address derivation path, for addresses generated before April 2025, this value will be null.", "nullable": true } }, "x-stoplight": { "id": "kpa5wfu4rfuag" } }, "examples": { "Example 1": { "value": [ { "network": "ETHEREUM_SEPOLIA", "end_user_id": "user_1", "address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE543a3", "xpub": "wSeET7", "derivation_path": "m/24" }, { "network": "ETHEREUM", "end_user_id": "user_1", "address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE543a3", "xpub": "wSeET7", "derivation_path": "m/24" }, { "network": "POLYGON", "end_user_id": "user_1", "address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE543a3", "xpub": "wSeET7", "derivation_path": "m/24" }, { "network": "POLYGON_MUMBAI", "end_user_id": "user_1", "address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE543a3", "xpub": "wSeET7", "derivation_path": "m/24" } ] }, "Example 2": { "value": [ { "network": "BITCOIN", "end_user_id": "user_1", "address": "1Lbcfr7sAHTD9CgdQo3HTMTkV8LK4ZnX71", "xpub": "ks3tMd", "derivation_path": "m/24" }, { "network": "BITCOIN_TESTNET", "end_user_id": "user_1", "address": "1Lbcfr7sAHTD9CgdQo3HTMTkV8LK4ZnX71", "xpub": "ks3tMd", "derivation_path": "m/24" } ] } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "description": "", "type": "object", "x-examples": { "example-1": { "network": "" } }, "properties": { "network": { "type": "string", "description": "Represents the crypto network that will be used to create an address.", "enum": [ "BITCOIN", "ETHEREUM", "ETHEREUM_SEPOLIA" ] } }, "required": [ "network" ] }, "examples": { "Example 1": { "value": { "network": "ETHEREUM_SEPOLIA" } }, "Example 2": { "value": { "network": "BITCOIN_TESTNET" } } } } } }, "description": "Endpoint that allows the creation of a deposit address for a given end user.", "tags": [ "Addresses" ], "x-stoplight": { "id": "mrbc00xw68sr9" } }, "get": { "operationId": "listAddresses", "description": "This endpoint allows to fetch a list of the given user's wallet's addresses", "parameters": [ { "schema": { "type": "string", "enum": [ "BTC", "ETH" ] }, "in": "query", "name": "token", "description": "Network's token to filter addresses" } ], "summary": "List End User's Addresses", "security": [ { "OAuth2": [ "read", "write" ] } ], "tags": [ "Addresses" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Address", "type": "object", "properties": { "network": { "type": "string", "enum": [ "BITCOIN", "EHTEREUM" ] }, "end_user_id": { "type": "string", "description": "End user's external ref, usually a uuid." }, "address": { "type": "string", "description": "End User's Address." }, "xpub": { "type": "string", "description": "Last six characters of The Extended Public Key.", "nullable": true }, "derivation_path": { "type": "string", "description": "Address derivation path, for addresses generated before April 2025, this value will be null.", "nullable": true } }, "x-stoplight": { "id": "kpa5wfu4rfuag" } } }, "examples": { "Example 1": { "value": [ { "network": "BITCOIN", "end_user_id": "user_1", "address": "1Lbcfr7sAHTD9CgdQo3HTMTkV8LK4ZnX71", "xpub": "ks3tMd", "derivation_path": "m/24" }, { "network": "ETHEREUM_SEPOLIA", "end_user_id": "user_1", "address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE543a3", "xpub": "wSeET7", "derivation_path": "m/24" }, { "network": "ETHEREUM", "end_user_id": "user_1", "address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE543a3", "xpub": "wSeET7", "derivation_path": "m/24" }, { "network": "POLYGON", "end_user_id": "user_1", "address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE543a3", "xpub": "wSeET7", "derivation_path": "m/24" }, { "network": "POLYGON_MUMBAI", "end_user_id": "user_1", "address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE543a3", "xpub": "wSeET7", "derivation_path": "m/24" } ] } } } } } }, "x-stoplight": { "id": "5t9qoap698z9s" } }, "parameters": [ { "schema": { "type": "string" }, "name": "end_user_id", "in": "path", "required": true } ] }, "/api/v1/end-users/{end_user_id}/auto-swap-addresses/": { "post": { "summary": "Create Auto Swap Address for End User", "operationId": "post-api-v1-end-users-end_user_id-auto-swap-addresses", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AutoSwapAddress" } }, "examples": { "Example 1": { "value": [ { "network": "ETHEREUM_SEPOLIA", "end_user_id": "user_1", "address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE543a3", "target_address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE542b2", "xpub": "wSeET7", "derivation_path": "m/24" }, { "network": "ETHEREUM", "end_user_id": "user_1", "address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE543a3", "target_address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE542b2", "xpub": "wSeET7", "derivation_path": "m/24" }, { "network": "POLYGON", "end_user_id": "user_1", "address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE543a3", "target_address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE542b2", "xpub": "wSeET7", "derivation_path": "m/24" }, { "network": "POLYGON_MUMBAI", "end_user_id": "user_1", "address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE543a3", "target_address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE542b2", "xpub": "wSeET7", "derivation_path": "m/24" } ] }, "Example 2": { "value": [ { "network": "BITCOIN", "end_user_id": "user_1", "address": "1Lbcfr7sAHTD9CgdQo3HTMTkV8LK4ZnX71", "target_address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa", "xpub": "ks3tMd", "derivation_path": "m/24" }, { "network": "BITCOIN_TESTNET", "end_user_id": "user_1", "address": "1Lbcfr7sAHTD9CgdQo3HTMTkV8LK4ZnX71", "target_address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa", "xpub": "ks3tMd", "derivation_path": "m/24" } ] } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "x-examples": { "example-1": { "network": "", "target_address": "" } }, "properties": { "network": { "type": "string", "description": "Represents the crypto network that will be used to create an address.", "enum": [ "BITCOIN", "BITCOIN_TESTNET", "ETHEREUM", "ETHEREUM_SEPOLIA" ] }, "target_address": { "type": "string", "description": "Represents the desired address to send the funds after a successful swap." } }, "required": [ "network" ] }, "examples": { "Example 1": { "value": { "network": "ETHEREUM_SEPOLIA", "target_address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE542b2" } }, "Example 2": { "value": { "network": "BITCOIN_TESTNET", "target_address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa" } } } } } }, "description": "Endpoint that allows the creation of a auto swap deposit address for a given end user.\nThis endpoint behaves idempontently for a given user and any of the networks from a network family.\n\nAuto Swap is a feature that allows you to create a deposit address, and any deposit you make will be automatically swapped for a pre-defined asset (contact the admin to set this value) and then withdrawn to the desired target address.\n\nImportant Notes:\n\n- The swap will be executed at the best market price obtained after your deposit is confirmed. In other words, this is an open-price model, so there are no guarantees or held-quotes on the final price obtained before the deposit happens.\n- Trading and withdrawal fees will be deducted before the converted funds are sent to your target address.\n", "tags": [ "Auto Swap Addresses" ] }, "get": { "operationId": "list-auto-swap-addresses", "description": "This endpoint allows to fetch a list of the given user's auto-swap addresses", "parameters": [ { "schema": { "type": "string", "enum": [ "BTC", "ETH" ] }, "in": "query", "name": "token", "description": "Network's token to filter addresses" } ], "summary": "List End User's Auto Swap Addresses", "security": [ { "OAuth2": [ "read", "write" ] } ], "tags": [ "Auto Swap Addresses" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AutoSwapAddress" } }, "examples": { "Example 1": { "value": [ { "network": "BITCOIN", "end_user_id": "user_1", "address": "1Lbcfr7sAHTD9CgdQo3HTMTkV8LK4ZnX71", "target_address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa", "xpub": "ks3tMd", "derivation_path": "m/24" }, { "network": "ETHEREUM_SEPOLIA", "end_user_id": "user_1", "address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE543a3", "target_address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE542b2", "xpub": "wSeET7", "derivation_path": "m/24" }, { "network": "ETHEREUM", "end_user_id": "user_1", "address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE543a3", "target_address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE542b2", "xpub": "wSeET7", "derivation_path": "m/24" }, { "network": "POLYGON", "end_user_id": "user_1", "address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE543a3", "target_address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE542b2", "xpub": "wSeET7", "derivation_path": "m/24" }, { "network": "POLYGON_MUMBAI", "end_user_id": "user_1", "address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE543a3", "target_address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE542b2", "xpub": "wSeET7", "derivation_path": "m/24" } ] } } } } } } }, "parameters": [ { "schema": { "type": "string" }, "name": "end_user_id", "in": "path", "required": true, "description": "End user's external ref, usually a uuid." } ], "put": { "summary": "Update target_address of EndUser's AutoSwap address.", "description": "This endpoint allows to update the target_address of the given EndUser's auto-swap addresses", "operationId": "put-api-v1-end-users-end_user_id-auto-swap-addresses", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AutoSwapAddress" } }, "examples": { "Example 1": { "value": [ { "network": "ETHEREUM_SEPOLIA", "end_user_id": "user_1", "address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE543a3", "target_address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE542b2", "xpub": "wSeET7", "derivation_path": "m/24" }, { "network": "ETHEREUM", "end_user_id": "user_1", "address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE543a3", "target_address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE542b2", "xpub": "wSeET7", "derivation_path": "m/24" }, { "network": "POLYGON", "end_user_id": "user_1", "address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE543a3", "target_address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE542b2", "xpub": "wSeET7", "derivation_path": "m/24" }, { "network": "POLYGON_MUMBAI", "end_user_id": "user_1", "address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE543a3", "target_address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE542b2", "xpub": "wSeET7", "derivation_path": "m/24" } ] }, "Example 2": { "value": [ { "network": "BITCOIN", "end_user_id": "user_1", "address": "1Lbcfr7sAHTD9CgdQo3HTMTkV8LK4ZnX71", "target_address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa", "xpub": "ks3tMd", "derivation_path": "m/24" }, { "network": "BITCOIN_TESTNET", "end_user_id": "user_1", "address": "1Lbcfr7sAHTD9CgdQo3HTMTkV8LK4ZnX71", "target_address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa", "xpub": "ks3tMd", "derivation_path": "m/24" } ] } } } } }, "404": { "description": "Address not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "examples": { "Address Not Found": { "value": { "code": 20037, "type": "AddressNotFound", "detail": { "message": "There is no address created for this end user for ETHEREUM_SEPOLIA network." }, "status": 404 } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "x-examples": { "example-1": { "network": "", "address_type": "" } }, "properties": { "network": { "type": "string", "description": "Represents the crypto network that will be used to create an address.", "enum": [ "BITCOIN", "BITCOIN_TESTNET", "ETHEREUM", "ETHEREUM_SEPOLIA" ] }, "target_address": { "type": "string", "description": "Represents the desired address to send the funds after a successful swap." } }, "required": [ "network" ] }, "examples": { "Example 1": { "value": { "network": "ETHEREUM_SEPOLIA", "target_address": "0x3c03a69dEce0A387764d2c1cEC315AC6cBE542b2" } }, "Example 2": { "value": { "network": "BITCOIN_TESTNET", "target_address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa" } } } } } }, "tags": [ "Auto Swap Addresses" ] } }, "/api/v1/end-users/{end_user_id}/balances/": { "get": { "operationId": "balancesEndUser", "description": "Retrieve end_user balances details given an end_user_id (external_ref).", "parameters": [ { "name": "end_user_id", "in": "path", "required": true, "description": "Indicates End User external_ref.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "description": "", "minItems": 1, "uniqueItems": true, "x-examples": { "example-1": [ { "USD": 9999985.9945 }, { "BTC": 0 }, { "ETH": 0 }, { "LTC": 0 }, { "USDT": 13.997001798920648 } ] }, "items": { "type": "object", "properties": { "currency": { "type": "string", "description": "Indicates currency name." }, "balance": { "type": "number", "description": "Indicates currency's balance." } }, "required": [ "currency", "balance" ] } }, "examples": { "example-1": { "value": [ { "currency": "USD", "balance": 100 }, { "currency": "BTC", "balance": 20 }, { "currency": "ETH", "balance": 33 } ] } } } }, "description": "Successful response" } }, "tags": [ "Balance" ], "summary": "Get Balances for End User", "security": [ { "OAuth2": [ "read", "write" ] } ], "x-stoplight": { "id": "ilpl8wclbily6" } }, "parameters": [ { "schema": { "type": "string" }, "name": "end_user_id", "in": "path", "required": true }, { "name": "currency", "description": "Allows filtering the returned balances by one or more currencies. If a currency is requested that the account does not support, it will simply be omitted from the response without error.", "in": "query", "schema": { "type": "string" } } ] }, "/api/v1/end-users/{end_user_id}/limits/": { "parameters": [ { "schema": { "type": "string" }, "name": "end_user_id", "in": "path", "required": true } ], "get": { "summary": "Get Limits for End User. Limits are set per operation basis, so one should expect for \"BUY\", \"SELL\" or \"SWAP\".", "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "", "x-examples": { "BUY ARS Yearly Example": { "type": "BUY", "currency": "ARS", "period": "YEARLY", "allowed_frequency": "5", "allowed_amount": "5.00", "consumed_frequency": "0", "consumed_amount": "0.00" }, "SELL ARS Yearly Example": { "type": "SELL", "currency": "ARS", "period": "YEARLY", "allowed_frequency": "5", "allowed_amount": "5.00", "consumed_frequency": "0", "consumed_amount": "0.00" } }, "properties": { "type": { "type": "string", "description": "Indicates limit type.", "enum": [ "BUY", "SELL" ] }, "currency": { "type": "string", "description": "Indicates the currency in which the limit has been expressed.", "enum": [ "ARS", "USD" ] }, "period": { "type": "string", "description": "Indicates the period in which the limit applies.", "enum": [ "DAILY", "MONTHLY", "YEARLY" ] }, "allowed_frequency": { "type": "string", "description": "Indicates the maximum frequency allowed per period for a given operation type and currency." }, "allowed_amount": { "type": "string", "description": "Indicates the maximum tradable amount allowed per period for a given operation type and currency." }, "consumed_frequency": { "type": "string", "description": "Indicates the spent frequency related to the allowed_frequency declared. It must comply with the following invariant: `allowed_frequency >= consumed_frequency`." }, "consumed_amount": { "type": "string", "description": "Indicates the spent tradable amount related to the allowed_frequency declared. It must comply with the following invariant: `allowed_amount >= consumed_amount`." } }, "required": [ "type", "currency", "period", "allowed_frequency", "allowed_amount", "consumed_frequency", "consumed_amount" ], "readOnly": true, "x-stoplight": { "id": "w06tn5ptzp6vf" } } }, "examples": { "End User Limits": { "value": [ { "type": "BUY", "currency": "ARS", "period": "YEARLY", "allowed_frequency": "1000", "allowed_amount": "5000000.00", "consumed_frequency": "5", "consumed_amount": "10.00" }, { "type": "SELL", "currency": "ARS", "period": "YEARLY", "allowed_frequency": "5000000.00", "allowed_amount": "5.00", "consumed_frequency": "10", "consumed_amount": "200.00" }, { "type": "BUY", "currency": "ARS", "period": "MONTHLY", "allowed_frequency": "4", "allowed_amount": "4.00", "consumed_frequency": "0", "consumed_amount": "0.00" }, { "type": "SELL", "currency": "ARS", "period": "MONTHLY", "allowed_frequency": "4", "allowed_amount": "4.00", "consumed_frequency": "0", "consumed_amount": "0.00" }, { "type": "BUY", "currency": "ARS", "period": "DAILY", "allowed_frequency": "3", "allowed_amount": "3.00", "consumed_frequency": "0", "consumed_amount": "0.00" }, { "type": "SELL", "currency": "ARS", "period": "DAILY", "allowed_frequency": "3", "allowed_amount": "3.00", "consumed_frequency": "0", "consumed_amount": "0.00" } ] } } } } } }, "operationId": "get-api-v1-end-users-end_user_id-limits", "description": "All End Users have certain restrictions when executing trades.\nLimits model seeks to control the maximun allowed frequency and magnitude of the volume operated by an end user in certain period:\n- **Frequency Limits**: Indicates which is the daily / monthly / annual limit of trades that an end user can carry out. A reset of these limits occurs at the end of each period.\n- **Tradable Amount**: Indicates which is the maximum operable amount for a purchase or sale trade within a time period, stratified by day / month / year. A reset of these limits occurs at the end of each period.\n\nCurrently, the limits model applies to two separate types of operations: **Buy Trades** and **Sell Trades**.\nEach type of trade maintains its limits separately, indicating the **Maximum Frequency** and **Tradable Amount** limits for each one, stratified by day / month / year.\n\nIt is important to note that each limit is reset at the end of each period. For instance take in consideration the following scenario:\n\nGiven that an end user can perform at most 6 BUY trades a day, and the End User _CUST-1567_ has already performed 6 BUY trades this day,\nWhen the end user _CUST-1567_ tries to perform another trade,\nthe system will respond indicating it has excedeed the daily limit set to 6 trades a day.\n\nOf course, the following day, end user _CUST-1567_ will have 0 trades performed, due to the daily reset, thus it will be able to perform another 6 trades.\n\nIt's important to note that Limits are set on commercial and compliance aggreements basis, please reach out your commercial partner if you want to know specific details about limits for your use case.\n", "parameters": [], "tags": [ "Periodic Limits" ], "x-stoplight": { "id": "iby2pbkloz3hn" } } }, "/api/v1/end-users/{end_user_id}/ban/": { "parameters": [ { "schema": { "type": "string" }, "name": "end_user_id", "in": "path", "required": true } ], "post": { "summary": "Ban an End User", "tags": [ "End User" ], "operationId": "post-api-v1-end-users-end_user_id-ban", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "end_user_id": { "type": "string", "description": "The provided id from the banned user." }, "is_banned": { "type": "boolean", "description": "Boolean that definies whether the end user is banned or not. Should always be true." }, "reason": { "type": "string", "description": "Provided reason" } } }, "examples": { "Succesfull Response": { "value": { "end_user_id": "Customer_1", "is_banned": true, "reason": "Violating terms & conditions" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "description": "", "type": "object", "x-examples": { "example-1": { "network": "", "address_type": "" } }, "properties": { "reason": { "type": "string", "description": "Reson for banning. Not mandatory." } } }, "examples": { "Example provinding reason.": { "value": { "reason": "Violated terms & conditions" } } } } }, "description": "" }, "description": "Endpoint that bans an End User", "x-stoplight": { "id": "nirb0sbodouno" } } }, "/api/v1/end-users/{end_user_id}/unban/": { "parameters": [ { "schema": { "type": "string" }, "name": "end_user_id", "in": "path", "required": true } ], "post": { "summary": "Unban an End User", "tags": [ "End User" ], "operationId": "post-api-v1-end-users-end_user_id-unban", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "end_user_id": { "type": "string", "description": "The provided id from the banned user." }, "is_banned": { "type": "boolean", "description": "Boolean that definies whether the end user is banned or not. Should always be false." }, "reason": { "type": "string", "description": "Provided reason" } } }, "examples": { "Succesfull Response": { "value": { "end_user_id": "Customer_1", "is_banned": false, "reason": "Allowed to operate" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "description": "", "type": "object", "x-examples": { "example-1": { "network": "", "address_type": "" } }, "properties": { "reason": { "type": "string", "description": "Reson for unbanning. Not mandatory." } } }, "examples": { "Example provinding reason.": { "value": { "reason": "Allowed to operate" } } } } }, "description": "" }, "description": "Endpoint that unbans an End User", "x-stoplight": { "id": "odb10rpxtox47" } } }, "/api/v1/rates/": { "get": { "operationId": "listRatesViewSets", "description": "An exchange rate is the rate at which one currency will be exchanged for another currency.\n\nReturns last market rates (BUY and SELL) for each account pair enabled.", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "description": "", "minItems": 1, "uniqueItems": true, "x-examples": { "example-1": [ { "pair": "BTC_USD", "last_buy_rate": 45482, "last_sell_rate": 45469.03 }, { "pair": "ETH_USD", "last_buy_rate": 3297.4449999999997, "last_sell_rate": 3296.45920597 }, { "pair": "LTC_USD", "last_buy_rate": 175.38302177694163, "last_sell_rate": 175.11074487355896 }, { "pair": "USDT_USD", "last_buy_rate": 1.0006, "last_sell_rate": 1.0005 } ] }, "items": { "type": "object", "properties": { "pair": { "type": "string", "minLength": 1, "description": "Indicates pair name." }, "last_sell_rate": { "type": "number", "description": "Indicates the latest sale rate available for this pair." }, "last_buy_rate": { "type": "number", "description": "Indicates the latest buy rate available for this pair." } }, "required": [ "pair", "last_sell_rate", "last_buy_rate" ] } }, "examples": { "example-1": { "value": [ { "pair": "BTC_USD", "last_buy_rate": 45482, "last_sell_rate": 45469.03 }, { "pair": "ETH_USD", "last_buy_rate": 3297.4449999999997, "last_sell_rate": 3296.45920597 }, { "pair": "LTC_USD", "last_buy_rate": 175.38302177694163, "last_sell_rate": 175.11074487355896 }, { "pair": "USDT_USD", "last_buy_rate": 1.0006, "last_sell_rate": 1.0005 } ] } } } }, "description": "Successful response" } }, "tags": [ "Rates" ], "summary": "Get Last Market Rates", "security": [ { "OAuth2": [ "read", "write" ] } ], "x-stoplight": { "id": "u2w65uqt6e4jb" } }, "parameters": [] }, "/api/v1/markets/{pair}/historical-rates": { "get": { "operationId": "listHistoricalRates", "description": "Returns historical market rates, for a given enabled pair.\n\nEither both or none of `begin` and `end` query params are mandatory.\nIf no `begin` and `end` QueryParams are indicated, the default response will return market prices of the last 24 hours.\n", "parameters": [ { "schema": { "type": "string", "format": "date-time", "example": "2022-01-01T00:00:59Z" }, "in": "query", "name": "begin", "description": "Sets the start of the filter, no rate befor the givn datetime will be returned." }, { "schema": { "type": "string", "format": "date-time", "example": "2022-03-01T23:59:59Z" }, "in": "query", "name": "end", "description": "Sets the end of the filter, no rate after the given datetime will be returned." }, { "schema": { "type": "string", "format": "choice", "enum": [ "ONE_MINUTE", "FIVE_MINUTES", "FIFTEEN_MINUTES", "THIRTY_MINUTES", "ONE_HOUR", "ONE_DAY", "ONE_WEEK", "TWO_WEEKS", "FOUR_WEEKS" ], "default": "ONE_MINUTE" }, "in": "query", "name": "increment", "description": "Sets the increment between frames." }, { "schema": { "type": "integer", "maximum": 40, "minimum": 1 }, "in": "query", "name": "max_data_point", "description": "Value of maximum data points to be grouped as a dynamic increment, if this parameter is given, the increment parameter will be ignored." }, { "schema": { "type": "integer", "default": 25 }, "in": "query", "name": "limit", "description": "Pagination limit parameter, sets the maximum amount of items to be returned." }, { "schema": { "type": "integer" }, "in": "query", "name": "offset", "description": "Offset pagination parameter, sets the number of elements that needs to be skipped." } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "x-examples": { "example-1": { "market": "ETH_ARS", "prices": [ { "average_price": "95638.8143077163", "timestamp": "2022-02-22T04:44:00Z" }, { "average_price": "95300.75424968451", "timestamp": "2022-02-22T04:45:00Z" }, { "average_price": "95651.17851615207", "timestamp": "2022-02-22T04:46:00Z" }, { "average_price": "95593.46221762343", "timestamp": "2022-02-22T04:47:00Z" }, { "average_price": "95387.45525295581", "timestamp": "2022-02-22T04:48:00Z" }, { "average_price": "95150.37934643241", "timestamp": "2022-02-22T04:49:00Z" }, { "average_price": "95786.13943068423", "timestamp": "2022-02-22T04:50:00Z" }, { "average_price": "95360.19525512702", "timestamp": "2022-02-22T04:51:00Z" }, { "average_price": "95670.28209361361", "timestamp": "2022-02-22T04:52:00Z" }, { "average_price": "95693.0849776592", "timestamp": "2022-02-22T04:53:00Z" }, { "average_price": "95497.92466995025", "timestamp": "2022-02-22T04:54:00Z" }, { "average_price": "95282.96795733641", "timestamp": "2022-02-22T04:55:00Z" }, { "average_price": "95770.61123047466", "timestamp": "2022-02-22T04:56:00Z" }, { "average_price": "95421.07629358338", "timestamp": "2022-02-22T04:57:00Z" }, { "average_price": "95172.83964890789", "timestamp": "2022-02-22T04:58:00Z" }, { "average_price": "95457.27157264609", "timestamp": "2022-02-22T04:59:00Z" }, { "average_price": "95368.74568971257", "timestamp": "2022-02-22T05:00:00Z" }, { "average_price": "95540.20823974122", "timestamp": "2022-02-22T05:01:00Z" }, { "average_price": "95771.70205378703", "timestamp": "2022-02-22T05:02:00Z" }, { "average_price": "95279.00497750723", "timestamp": "2022-02-22T05:03:00Z" }, { "average_price": "95672.3730277765", "timestamp": "2022-02-22T05:04:00Z" }, { "average_price": "95436.2849265131", "timestamp": "2022-02-22T05:05:00Z" }, { "average_price": "95445.24007951409", "timestamp": "2022-02-22T05:06:00Z" }, { "average_price": "95727.13382933388", "timestamp": "2022-02-22T05:07:00Z" }, { "average_price": "95520.59849547275", "timestamp": "2022-02-22T05:08:00Z" } ], "total_rows": 534 } }, "properties": { "market": { "type": "string", "description": "Pair of currencies composed by a base asset and a quote asset, separated by a underscore." }, "prices": { "type": "array", "items": { "type": "object", "properties": { "average_price": { "type": "string", "description": "Value calculated between the buy and sell prices of the chosen pair.", "format": "decimal" }, "timestamp": { "type": "string", "description": "Indicates the time and date of the average price.", "format": "date-time" } } } } } }, "examples": { "Example": { "value": { "market": "ETH_ARS", "prices": [ { "average_price": "95638.8143077163", "timestamp": "2022-02-22T04:44:00Z" }, { "average_price": "95300.75424968451", "timestamp": "2022-02-22T04:45:00Z" }, { "average_price": "95651.17851615207", "timestamp": "2022-02-22T04:46:00Z" }, { "average_price": "95593.46221762343", "timestamp": "2022-02-22T04:47:00Z" }, { "average_price": "95387.45525295581", "timestamp": "2022-02-22T04:48:00Z" }, { "average_price": "95150.37934643241", "timestamp": "2022-02-22T04:49:00Z" }, { "average_price": "95786.13943068423", "timestamp": "2022-02-22T04:50:00Z" }, { "average_price": "95360.19525512702", "timestamp": "2022-02-22T04:51:00Z" }, { "average_price": "95670.28209361361", "timestamp": "2022-02-22T04:52:00Z" }, { "average_price": "95693.0849776592", "timestamp": "2022-02-22T04:53:00Z" }, { "average_price": "95497.92466995025", "timestamp": "2022-02-22T04:54:00Z" }, { "average_price": "95282.96795733641", "timestamp": "2022-02-22T04:55:00Z" }, { "average_price": "95770.61123047466", "timestamp": "2022-02-22T04:56:00Z" }, { "average_price": "95421.07629358338", "timestamp": "2022-02-22T04:57:00Z" }, { "average_price": "95172.83964890789", "timestamp": "2022-02-22T04:58:00Z" }, { "average_price": "95457.27157264609", "timestamp": "2022-02-22T04:59:00Z" }, { "average_price": "95368.74568971257", "timestamp": "2022-02-22T05:00:00Z" }, { "average_price": "95540.20823974122", "timestamp": "2022-02-22T05:01:00Z" }, { "average_price": "95771.70205378703", "timestamp": "2022-02-22T05:02:00Z" }, { "average_price": "95279.00497750723", "timestamp": "2022-02-22T05:03:00Z" }, { "average_price": "95672.3730277765", "timestamp": "2022-02-22T05:04:00Z" }, { "average_price": "95436.2849265131", "timestamp": "2022-02-22T05:05:00Z" }, { "average_price": "95445.24007951409", "timestamp": "2022-02-22T05:06:00Z" }, { "average_price": "95727.13382933388", "timestamp": "2022-02-22T05:07:00Z" }, { "average_price": "95520.59849547275", "timestamp": "2022-02-22T05:08:00Z" } ], "total_rows": 534 } } } } }, "description": "Successful response" } }, "tags": [ "Rates" ], "summary": "Get Historical Market Rates", "security": [ { "OAuth2": [ "read", "write" ] } ], "x-stoplight": { "id": "6tbgj5n4lrtd2" } }, "parameters": [ { "schema": { "type": "string", "example": "BTC_ARS" }, "name": "pair", "in": "path", "required": true, "description": "Pair of currencies composed by a base asset and a quote asset, separated by a underscore." } ] }, "/api/v1/pairs/": { "get": { "operationId": "listPairs", "description": "Returns all enabled pairs for the Account.\n\nA currency pair is a quotation for two different currencies. It is the amount you would pay in one currency for a unit of another currency. For instance, when a trader is quoted USDT/ARS 110.50 it means that the trader can exchange 1 USDT and receive 110.50 ARS.", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Indicates pair name." } }, "required": [ "name" ], "x-stoplight": { "id": "y0def15tjagpl" } } }, "examples": { "Get Account Pairs": { "value": [ { "name": "BTC_USD" }, { "name": "ETH_USD" }, { "name": "LTC_USD" }, { "name": "USDT_USD" } ] } } } }, "description": "Successful response" } }, "tags": [ "Pairs" ], "summary": "Get Account Pairs", "x-stoplight": { "id": "u81vd6e0fxljf" } }, "parameters": [] }, "/api/v1/quotes/{quote_id}/actions/execute/": { "post": { "operationId": "executeQuoteResponse", "description": "Quote Executions buy or sell assets using a Quote obtained from the [Quote Creation](#operations/createQuoteResponse) flow.\n\nThe asset, operation type, and guaranteed price/rate of the execution are specified by the quote with ID `quote_id`.\n\nThe amount to buy or sell must be specified in either fiat or crypto by setting exactly one of:\n\n* `base_amount` to specify the amount of crypto to buy or sell.\n* `quote_amount` to specify the amount of fiat to spend or acquire.\n\nAn otherwise-valid request to create a quote execution may fail with the following types of errors:\n\n* **Expired** if the quote with ID `quote_id` has expired.\n* **Insufficient Funds** if the end user with ID `end_user_id` has insufficient available balance to fund the execution.\n* **Already Executed Quote** if a Quote has been already executed before.\n* **Buy Limit Frequency Exceeded** if the end_user reached a Daily/Monthly/Yearly frequency limit for BUY Trades.\n* **Sell Limit Frequency Exceeded** if the end_user reached a Daily/Monthly/Yearly frequency limit for SELL Trades.\n* **Buy Limit Amount Exceeded** if the end_user reached a Daily/Monthly/Yearly amount limit for BUY Trades.\n* **Sell Limit Amount Exceeded** if the end_user reached a Daily/Monthly/Yearly amount limit for SELL Trades.", "parameters": [ { "name": "quote_id", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "type": "object", "x-examples": { "example-1": { "base_amount": 2, "end_user_id": "customer_1" } }, "properties": { "end_user_id": { "type": "string", "description": "Indicates End User external_ref." } }, "required": [ "end_user_id" ] }, "examples": { "Buy 2 BTC": { "value": { "base_amount": 2, "end_user_id": "customer_1" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "QuoteResponse", "description": "", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "pair": { "type": "string", "description": "Indicates pair name involved in the quotation." }, "op_type": { "enum": [ "BUY", "SELL" ], "type": "string", "description": "Indicates whether the quote is for BUY or SELL." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "base_amount": { "type": "string", "format": "decimal", "description": "Indicates the amount of units or equivalence in the quote for base currency." }, "quote_amount": { "type": "string", "format": "decimal", "description": "Indicates the amount of units or equivalence in the quote for quote currency." }, "rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion." }, "charged_fee": { "type": "string", "format": "decimal", "description": "Indicates fee that will be applied when the execution of quote is effective." }, "external_ref": { "type": "string", "maxLength": 128, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date.", "readOnly": true }, "expires_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating expiration date of the quote. Quote will be invalid after that date." } }, "required": [ "id", "pair", "op_type", "base_asset", "quote_asset", "base_amount", "quote_amount", "rate", "charged_fee", "external_ref", "created_at", "expires_at" ], "x-examples": { "example-1": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "pair": "string", "op_type": "BUY", "base_asset": "string", "quote_asset": "string", "base_amount": "string", "quote_amount": "string", "rate": "string", "charged_fee": "string", "external_ref": "string", "created_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z" } }, "x-stoplight": { "id": "1rx0urcfjqrc9" } } }, "multipart/form-data": { "schema": { "type": "object", "title": "QuoteResponse", "description": "", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "pair": { "type": "string", "description": "Indicates pair name involved in the quotation." }, "op_type": { "enum": [ "BUY", "SELL" ], "type": "string", "description": "Indicates whether the quote is for BUY or SELL." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "base_amount": { "type": "string", "format": "decimal", "description": "Indicates the amount of units or equivalence in the quote for base currency." }, "quote_amount": { "type": "string", "format": "decimal", "description": "Indicates the amount of units or equivalence in the quote for quote currency." }, "rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion." }, "charged_fee": { "type": "string", "format": "decimal", "description": "Indicates fee that will be applied when the execution of quote is effective." }, "external_ref": { "type": "string", "maxLength": 128, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date.", "readOnly": true }, "expires_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating expiration date of the quote. Quote will be invalid after that date." } }, "required": [ "id", "pair", "op_type", "base_asset", "quote_asset", "base_amount", "quote_amount", "rate", "charged_fee", "external_ref", "created_at", "expires_at" ], "x-examples": { "example-1": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "pair": "string", "op_type": "BUY", "base_asset": "string", "quote_asset": "string", "base_amount": "string", "quote_amount": "string", "rate": "string", "charged_fee": "string", "external_ref": "string", "created_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z" } }, "x-stoplight": { "id": "1rx0urcfjqrc9" } } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "description": "If the transaction represents a BUY, SELL or SWAP operation, this object will detail the trade operation information.", "x-examples": { "example-1": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "quote_id": "3c071a1d-db86-46a7-9dc8-72ba3fbca992", "end_user_id": "string", "rate": "string", "chargeed_fee": "string", "base_amount": "string", "quote_amount": "string", "base_asset": "string", "quote_asset": "string", "created_at": "2019-08-24T14:15:22Z" } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as trade identifier." }, "txn_id": { "type": "string", "description": "UUID used as Transaction identifier. Useful to relate this object trade with a transaction object." }, "quote_id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "end_user_id": { "type": "string", "description": "Arbitrary string used as end_user identifier." }, "rate": { "type": "string", "description": "Indicates the exchange rate used for conversion." }, "charged_fee": { "type": "string", "description": "Indicates trade's applied fee." }, "base_amount": { "type": "string", "description": "Indicates the amount of units or equivalence in the quote for base currency." }, "quote_amount": { "type": "string", "description": "Indicates the amount of units or equivalence in the quote for quote currency." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of trade.", "readOnly": true } }, "required": [ "id", "txn_id", "quote_id", "end_user_id", "rate", "charged_fee", "base_amount", "quote_amount", "base_asset", "quote_asset", "created_at" ], "readOnly": true, "x-stoplight": { "id": "0vqlkdmhgi3f7" } }, "examples": { "Execute Quote": { "value": { "id": "a61d1778-e0bc-48a1-af92-085b5aeb0691", "quote_id": "31f68fdb-2271-4f58-99d3-4a0b62c9d489", "txn_id": "1a9f9703-55ab-486d-9a4d-b0a7bc3ac507", "end_user_id": "customer_1", "rate": "1.00060000", "charged_fee": "0.000", "base_amount": "5.000000000000000000", "quote_amount": "5.002999999999999670", "base_asset": "USDT", "quote_asset": "USD", "created_at": "2021-09-16T15:38:43.115315-03:00" } } } } } }, "403": { "description": "Bad Response", "content": { "application/json": { "schema": { "description": "", "type": "object", "properties": { "code": { "type": "number" }, "type": { "type": "string", "minLength": 1 }, "detail": { "type": "object", "properties": { "message": { "type": "string", "minLength": 1 } }, "required": [ "message" ] }, "status": { "type": "number" } }, "required": [ "code", "type", "detail", "status" ], "x-examples": { "example-1": { "code": 20012, "type": "NotEnoughBalance", "detail": { "message": "Not enough balance on 'USD' to BUY" }, "status": 400 } } }, "examples": { "Already Executed Quote": { "value": { "code": 20011, "type": "AlreadyExecutedQuote", "detail": { "message": "Quote '31f68fdb-2271-4f58-99d3-4a0b62c9d489' has been executed before" }, "status": 403 } }, "Expired Quote": { "value": { "code": 20010, "type": "ExpiredQuote", "detail": { "message": "Quote ''31f68fdb-2271-4f58-99d3-4a0b62c9d489'' expired at ''2021-10-12 00:20:29.139790+00:00''" }, "status": 403 } }, "Insufficient Funds": { "value": { "code": 20012, "type": "NotEnoughBalance", "detail": { "message": "Not enough balance on 'USD' to BUY" }, "status": 400 } }, "Buy Limit Amount Exceeded": { "value": { "code": 20014, "type": "BuyLimitAmountExceeded", "detail": { "message": "End User CUST_2 Yearly amount reached for USD trades: ''BUY'' Limit currently set to 10.00 USD." }, "status": 429 } }, "Sell Limit Amount Exceeded": { "value": { "code": 20016, "type": "SellLimitAmountExceeded", "detail": { "message": "End User CUST_2 Yearly amount reached for USD trades: ''SELL'' Limit currently set to 10.00 USD." }, "status": 429 } }, "Sell Limit Frequency Exceeded": { "value": { "code": 20015, "type": "SellLimitFrequencyExceeded", "detail": { "message": "End User CUST_2 Yearly frequency reached for USD trades: ''SELL'' Limit currently set to 1 operations." }, "status": 429 } }, "Buy Limit Frequency Exceeded": { "value": { "code": 20013, "type": "BuyLimitFrequencyExceeded", "detail": { "message": "End User CUST_2 Yearly frequency reached for USD trades: ''BUY'' Limit currently set to 1 operations." }, "status": 429 } } } } } } }, "tags": [ "Quote Execution" ], "summary": "Execute Quote", "security": [ { "OAuth2": [ "read", "write" ] } ], "x-stoplight": { "id": "qoeg2hpkp27uy" } }, "parameters": [ { "schema": { "type": "string" }, "name": "quote_id", "in": "path", "required": true } ] }, "/api/v1/reusable-quotes/{reusable_quote_id}/actions/execute/": { "post": { "operationId": "executeReusableQuoteResponse", "description": "Reusable Quote Executions buy or sell assets using a Reusable Quote obtained from the [Reusable Quote Creation](#operations/createReusableQuoteResponse) flow.\n\nThe asset, and guaranteed price/rate of the execution are specified by the quote with ID `quote_id`.\n\nThe amount to buy or sell must be specified in either fiat or crypto by setting exactly one of:\n\n* `base_amount` to specify the amount of crypto to buy or sell.\n* `quote_amount` to specify the amount of fiat to spend or acquire.\n\nAn otherwise-valid request to create a quote execution may fail with the following types of errors:\n\n* **Expired** if the reusable quote with ID `reusable_quote_id` has expired.\n* **Insufficient Funds** if the end user with ID `end_user_id` has insufficient available balance to fund the execution.\n* **Quote with no price** if a Reusable Quote has its prices set to null and status UNA_PRICE (Unavailable Price).\n* **Buy Limit Frequency Exceeded** if the end_user reached a Daily/Monthly/Yearly frequency limit for BUY Trades.\n* **Sell Limit Frequency Exceeded** if the end_user reached a Daily/Monthly/Yearly frequency limit for SELL Trades.\n* **Buy Limit Amount Exceeded** if the end_user reached a Daily/Monthly/Yearly amount limit for BUY Trades.\n* **Sell Limit Amount Exceeded** if the end_user reached a Daily/Monthly/Yearly amount limit for SELL Trades.", "parameters": [ { "name": "reusable_quote_id", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "type": "object", "x-examples": { "example-1": { "base_amount": 2, "end_user_id": "customer_1" } }, "properties": { "end_user_id": { "type": "string", "description": "Indicates End User external_ref." }, "op_type": { "type": "string", "enum": [ "BUY", "SELL" ], "description": "Indicates the operation type." }, "external_ref": { "type": "string", "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." }, "base_amount": { "type": "number", "description": "Specifies the amount of crypto to buy or sell." }, "quote_amount": { "type": "number", "description": "Specifies the amount of fiat to buy or sell." } }, "required": [ "end_user_id", "op_type", "external_ref" ] }, "examples": { "Buy 2 BTC": { "value": { "base_amount": 2, "end_user_id": "customer_1", "op_type": "BUY", "external_ref": "ex_op_1" } }, "Buy BTC for 100 USD": { "value": { "end_user_id": "customer_1", "op_type": "BUY", "quote_amount": 100, "external_ref": "ex_op_2" } }, "Sell 2 BTC": { "value": { "end_user_id": "customer_1", "op_type": "SELL", "base_amount": 2, "external_ref": "ex_op_3" } }, "Sell BTC acquiring 100 USD": { "value": { "end_user_id": "customer_1", "op_type": "SELL", "quote_amount": 100, "external_ref": "ex_op_4" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "QuoteResponse", "description": "", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "pair": { "type": "string", "description": "Indicates pair name involved in the quotation." }, "op_type": { "enum": [ "BUY", "SELL" ], "type": "string", "description": "Indicates whether the quote is for BUY or SELL." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "base_amount": { "type": "string", "format": "decimal", "description": "Indicates the amount of units or equivalence in the quote for base currency." }, "quote_amount": { "type": "string", "format": "decimal", "description": "Indicates the amount of units or equivalence in the quote for quote currency." }, "rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion." }, "charged_fee": { "type": "string", "format": "decimal", "description": "Indicates fee that will be applied when the execution of quote is effective." }, "external_ref": { "type": "string", "maxLength": 128, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date.", "readOnly": true }, "expires_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating expiration date of the quote. Quote will be invalid after that date." } }, "required": [ "id", "pair", "op_type", "base_asset", "quote_asset", "base_amount", "quote_amount", "rate", "charged_fee", "external_ref", "created_at", "expires_at" ], "x-examples": { "example-1": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "pair": "string", "op_type": "BUY", "base_asset": "string", "quote_asset": "string", "base_amount": "string", "quote_amount": "string", "rate": "string", "charged_fee": "string", "external_ref": "string", "created_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z" } }, "x-stoplight": { "id": "1rx0urcfjqrc9" } } }, "multipart/form-data": { "schema": { "type": "object", "title": "QuoteResponse", "description": "", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "pair": { "type": "string", "description": "Indicates pair name involved in the quotation." }, "op_type": { "enum": [ "BUY", "SELL" ], "type": "string", "description": "Indicates whether the quote is for BUY or SELL." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "base_amount": { "type": "string", "format": "decimal", "description": "Indicates the amount of units or equivalence in the quote for base currency." }, "quote_amount": { "type": "string", "format": "decimal", "description": "Indicates the amount of units or equivalence in the quote for quote currency." }, "rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion." }, "charged_fee": { "type": "string", "format": "decimal", "description": "Indicates fee that will be applied when the execution of quote is effective." }, "external_ref": { "type": "string", "maxLength": 128, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date.", "readOnly": true }, "expires_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating expiration date of the quote. Quote will be invalid after that date." } }, "required": [ "id", "pair", "op_type", "base_asset", "quote_asset", "base_amount", "quote_amount", "rate", "charged_fee", "external_ref", "created_at", "expires_at" ], "x-examples": { "example-1": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "pair": "string", "op_type": "BUY", "base_asset": "string", "quote_asset": "string", "base_amount": "string", "quote_amount": "string", "rate": "string", "charged_fee": "string", "external_ref": "string", "created_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z" } }, "x-stoplight": { "id": "1rx0urcfjqrc9" } } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "description": "If the transaction represents a BUY, SELL or SWAP operation, this object will detail the trade operation information.", "x-examples": { "example-1": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "quote_id": "3c071a1d-db86-46a7-9dc8-72ba3fbca992", "end_user_id": "string", "rate": "string", "chargeed_fee": "string", "base_amount": "string", "quote_amount": "string", "base_asset": "string", "quote_asset": "string", "created_at": "2019-08-24T14:15:22Z" } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as trade identifier." }, "txn_id": { "type": "string", "description": "UUID used as Transaction identifier. Useful to relate this object trade with a transaction object." }, "quote_id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "end_user_id": { "type": "string", "description": "Arbitrary string used as end_user identifier." }, "rate": { "type": "string", "description": "Indicates the exchange rate used for conversion." }, "charged_fee": { "type": "string", "description": "Indicates trade's applied fee." }, "base_amount": { "type": "string", "description": "Indicates the amount of units or equivalence in the quote for base currency." }, "quote_amount": { "type": "string", "description": "Indicates the amount of units or equivalence in the quote for quote currency." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of trade.", "readOnly": true } }, "required": [ "id", "txn_id", "quote_id", "end_user_id", "rate", "charged_fee", "base_amount", "quote_amount", "base_asset", "quote_asset", "created_at" ], "readOnly": true, "x-stoplight": { "id": "0vqlkdmhgi3f7" } }, "examples": { "Execute Reusable Quote": { "value": { "id": "a61d1778-e0bc-48a1-af92-085b5aeb0691", "quote_id": "31f68fdb-2271-4f58-99d3-4a0b62c9d489", "txn_id": "1a9f9703-55ab-486d-9a4d-b0a7bc3ac507", "end_user_id": "customer_1", "rate": "1.00060000", "charged_fee": "0.000", "base_amount": "5.000000000000000000", "quote_amount": "5.002999999999999670", "base_asset": "USDT", "quote_asset": "USD", "created_at": "2021-09-16T15:38:43.115315-03:00" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "description": "", "type": "object", "properties": { "code": { "type": "number" }, "type": { "type": "string", "minLength": 1 }, "detail": { "type": "object", "properties": { "message": { "type": "string", "minLength": 1 } }, "required": [ "message" ] }, "status": { "type": "number" } }, "required": [ "code", "type", "detail", "status" ], "x-examples": { "example-1": { "code": 20019, "type": "SellTransactionMinLimitExceeded", "detail": { "message": "0.19000000 BRL exceeds the min limit for BRL trades: ''SELL'' Limit currently set to 0.19 BRL." }, "status": 400 } } }, "examples": { "Sell Min Transactional Limit": { "value": { "code": 20019, "type": "SellTransactionMinLimitExceeded", "detail": { "message": "0.18 BRL exceeds the min limit for BRL trades: ''SELL'' Limit currently set to 0.19 BRL." }, "status": 400 } }, "Buy Min Transactional Limit": { "value": { "code": 0, "type": "string", "detail": { "message": "string" }, "status": 0 } }, "Balance Is not Enough": { "value": { "code": 0, "type": "string", "detail": { "message": "string" }, "status": 0 } } } } } }, "403": { "description": "Bad Response", "content": { "application/json": { "schema": { "description": "", "type": "object", "properties": { "code": { "type": "number" }, "type": { "type": "string", "minLength": 1 }, "detail": { "type": "object", "properties": { "message": { "type": "string", "minLength": 1 } }, "required": [ "message" ] }, "status": { "type": "number" } }, "required": [ "code", "type", "detail", "status" ], "x-examples": { "example-1": { "code": 20012, "type": "NotEnoughBalance", "detail": { "message": "Not enough balance on 'USD' to BUY" }, "status": 400 } } }, "examples": { "Cap Limit Reached": { "value": { "code": 20022, "type": "CapLimitReached", "detail": { "message": "Reusable Quote '31f68fdb-2271-4f58-99d3-4a0b62c9d489' has reached its cap limit" }, "status": 403 } }, "Expired Reusable Quote": { "value": { "code": 20023, "type": "ExpiredQuote", "detail": { "message": "Reusable Quote ''31f68fdb-2271-4f58-99d3-4a0b62c9d489'' expired at ''2021-10-12 00:20:29.139790+00:00''" }, "status": 403 } }, "Insufficient Funds": { "value": { "code": 20012, "type": "NotEnoughBalance", "detail": { "message": "Not enough balance on 'USD' to BUY" }, "status": 400 } }, "Buy Limit Amount Exceeded": { "value": { "code": 20014, "type": "BuyLimitAmountExceeded", "detail": { "message": "End User CUST_2 Yearly amount reached for USD trades: ''BUY'' Limit currently set to 10.00 USD." }, "status": 429 } }, "Sell Limit Amount Exceeded": { "value": { "code": 20016, "type": "SellLimitAmountExceeded", "detail": { "message": "End User CUST_2 Yearly amount reached for USD trades: ''SELL'' Limit currently set to 10.00 USD." }, "status": 429 } }, "Sell Limit Frequency Exceeded": { "value": { "code": 20015, "type": "SellLimitFrequencyExceeded", "detail": { "message": "End User CUST_2 Yearly frequency reached for USD trades: ''SELL'' Limit currently set to 1 operations." }, "status": 429 } }, "Buy Limit Frequency Exceeded": { "value": { "code": 20013, "type": "BuyLimitFrequencyExceeded", "detail": { "message": "End User CUST_2 Yearly frequency reached for USD trades: ''BUY'' Limit currently set to 1 operations." }, "status": 429 } }, "Quote With No Price": { "value": { "code": 20026, "type": "QuoteWithNoPrice", "detail": { "message": "ReusableQuote '6501914f-3b76-465e-8d95-773296f2d63j' has no price" }, "status": 403 } } } } } } }, "summary": "Execute Reusable Quote", "security": [ { "OAuth2": [ "read", "write" ] } ], "tags": [ "Reusable Quote Execution" ], "x-internal": false, "x-stoplight": { "id": "b5px2281ufp2z" } }, "parameters": [ { "schema": { "type": "string" }, "name": "reusable_quote_id", "in": "path", "required": true } ] }, "/api/v1/swap-quotes/{swap_quote_id}/actions/execute/": { "post": { "operationId": "executeSwapQuote", "description": "Swap Quote Executions performs assets using a Reusable Quote obtained from the [Swap Reusable Quote Creation](#operations/createSwapQuote) flow.\n\nThe asset, and guaranteed price/rate of the execution are specified by the quote with ID `quote_id`.\n\nThe amount to swap must be specified by setting the following attribute:\n\n* `base_amount` to specify the amount of crypto that will be debited from base asset in order to accredit the equivalent quote asset.\n\nAn otherwise-valid request to create a quote execution may fail with the following types of errors:\n\n* **Expired** if the reusable quote with ID `swap_quote_id` has expired.\n* **Insufficient Funds** if the end user with ID `end_user_id` has insufficient available balance to fund the execution.\n* **Swap Limit Frequency Exceeded** if the end_user reached a Daily/Monthly/Yearly frequency limit for SWAP Trades.\n* **Swap Limit Amount Exceeded** if the end_user reached a Daily/Monthly/Yearly amount limit for SWAP Trades.", "parameters": [ { "name": "swap_quote_id", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "type": "object", "x-examples": { "example-1": { "base_amount": 2, "end_user_id": "customer_1" } }, "properties": { "end_user_id": { "type": "string", "description": "Indicates End User external_ref." }, "external_ref": { "type": "string", "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." }, "base_amount": { "type": "string", "description": "Specifies the amount of crypto to buy or sell." } }, "required": [ "end_user_id", "external_ref" ] }, "examples": { "Swap 2 BTC": { "value": { "base_amount": "0.02", "end_user_id": "CUST_1", "external_ref": "ex_op_1" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "QuoteResponse", "description": "", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "pair": { "type": "string", "description": "Indicates pair name involved in the quotation." }, "op_type": { "enum": [ "BUY", "SELL" ], "type": "string", "description": "Indicates whether the quote is for BUY or SELL." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "base_amount": { "type": "string", "format": "decimal", "description": "Indicates the amount of units or equivalence in the quote for base currency." }, "quote_amount": { "type": "string", "format": "decimal", "description": "Indicates the amount of units or equivalence in the quote for quote currency." }, "rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion." }, "charged_fee": { "type": "string", "format": "decimal", "description": "Indicates fee that will be applied when the execution of quote is effective." }, "external_ref": { "type": "string", "maxLength": 128, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date.", "readOnly": true }, "expires_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating expiration date of the quote. Quote will be invalid after that date." } }, "required": [ "id", "pair", "op_type", "base_asset", "quote_asset", "base_amount", "quote_amount", "rate", "charged_fee", "external_ref", "created_at", "expires_at" ], "x-examples": { "example-1": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "pair": "string", "op_type": "BUY", "base_asset": "string", "quote_asset": "string", "base_amount": "string", "quote_amount": "string", "rate": "string", "charged_fee": "string", "external_ref": "string", "created_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z" } }, "x-stoplight": { "id": "1rx0urcfjqrc9" } } }, "multipart/form-data": { "schema": { "type": "object", "title": "QuoteResponse", "description": "", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "pair": { "type": "string", "description": "Indicates pair name involved in the quotation." }, "op_type": { "enum": [ "BUY", "SELL" ], "type": "string", "description": "Indicates whether the quote is for BUY or SELL." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "base_amount": { "type": "string", "format": "decimal", "description": "Indicates the amount of units or equivalence in the quote for base currency." }, "quote_amount": { "type": "string", "format": "decimal", "description": "Indicates the amount of units or equivalence in the quote for quote currency." }, "rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion." }, "charged_fee": { "type": "string", "format": "decimal", "description": "Indicates fee that will be applied when the execution of quote is effective." }, "external_ref": { "type": "string", "maxLength": 128, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date.", "readOnly": true }, "expires_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating expiration date of the quote. Quote will be invalid after that date." } }, "required": [ "id", "pair", "op_type", "base_asset", "quote_asset", "base_amount", "quote_amount", "rate", "charged_fee", "external_ref", "created_at", "expires_at" ], "x-examples": { "example-1": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "pair": "string", "op_type": "BUY", "base_asset": "string", "quote_asset": "string", "base_amount": "string", "quote_amount": "string", "rate": "string", "charged_fee": "string", "external_ref": "string", "created_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z" } }, "x-stoplight": { "id": "1rx0urcfjqrc9" } } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "description": "If the transaction represents a BUY, SELL or SWAP operation, this object will detail the trade operation information.", "x-examples": { "example-1": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "quote_id": "3c071a1d-db86-46a7-9dc8-72ba3fbca992", "end_user_id": "string", "rate": "string", "chargeed_fee": "string", "base_amount": "string", "quote_amount": "string", "base_asset": "string", "quote_asset": "string", "created_at": "2019-08-24T14:15:22Z" } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as trade identifier." }, "txn_id": { "type": "string", "description": "UUID used as Transaction identifier. Useful to relate this object trade with a transaction object." }, "quote_id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "end_user_id": { "type": "string", "description": "Arbitrary string used as end_user identifier." }, "rate": { "type": "string", "description": "Indicates the exchange rate used for conversion." }, "charged_fee": { "type": "string", "description": "Indicates trade's applied fee." }, "base_amount": { "type": "string", "description": "Indicates the amount of units or equivalence in the quote for base currency." }, "quote_amount": { "type": "string", "description": "Indicates the amount of units or equivalence in the quote for quote currency." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of trade.", "readOnly": true } }, "required": [ "id", "txn_id", "quote_id", "end_user_id", "rate", "charged_fee", "base_amount", "quote_amount", "base_asset", "quote_asset", "created_at" ], "readOnly": true, "x-stoplight": { "id": "0vqlkdmhgi3f7" } }, "examples": { "Execute Reusable Quote": { "value": { "id": "a61d1778-e0bc-48a1-af92-085b5aeb0691", "quote_id": "31f68fdb-2271-4f58-99d3-4a0b62c9d489", "txn_id": "1a9f9703-55ab-486d-9a4d-b0a7bc3ac507", "end_user_id": "customer_1", "rate": "1.00060000", "charged_fee": "0.000", "base_amount": "5.000000000000000000", "quote_amount": "5.002999999999999670", "base_asset": "USDT", "quote_asset": "ETH", "created_at": "2021-09-16T15:38:43.115315-03:00" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "description": "", "type": "object", "properties": { "code": { "type": "number" }, "type": { "type": "string", "minLength": 1 }, "detail": { "type": "object", "properties": { "message": { "type": "string", "minLength": 1 } }, "required": [ "message" ] }, "status": { "type": "number" } }, "required": [ "code", "type", "detail", "status" ], "x-examples": { "example-1": { "code": 20019, "type": "SellTransactionMinLimitExceeded", "detail": { "message": "0.19000000 BRL exceeds the min limit for BRL trades: ''SELL'' Limit currently set to 0.19 BRL." }, "status": 400 } } }, "examples": { "Swap Min Transactional Limit": { "value": { "code": 20022, "type": "SwapTransactionMinLimitExceeded", "detail": { "message": "18.0730067948840000 USD exceeds the min limit for USD trades: ''SWAP'' Limit currently set to 25 USD." }, "status": 400 } }, "Swap Max Transactional Limit": { "value": { "code": 20023, "type": "SwapTransactionMaxLimitExceeded", "detail": { "message": "180730.0679488400000000 USD exceeds the max limit for USD trades: ''SWAP'' Limit currently set to 5000 USD." }, "status": 400 } }, "Balance Is not Enough": { "value": { "code": 20012, "type": "NotEnoughBalance", "detail": { "message": "Not enough balance on 'BTC' to SWAP" }, "status": 400 } } } } } }, "403": { "description": "Bad Response", "content": { "application/json": { "schema": { "description": "", "type": "object", "properties": { "code": { "type": "number" }, "type": { "type": "string", "minLength": 1 }, "detail": { "type": "object", "properties": { "message": { "type": "string", "minLength": 1 } }, "required": [ "message" ] }, "status": { "type": "number" } }, "required": [ "code", "type", "detail", "status" ], "x-examples": { "example-1": { "code": 20012, "type": "NotEnoughBalance", "detail": { "message": "Not enough balance on 'USD' to BUY" }, "status": 400 } } }, "examples": { "Expired Reusable Quote": { "value": { "code": 20023, "type": "ExpiredQuote", "detail": { "message": "Reusable Quote ''31f68fdb-2271-4f58-99d3-4a0b62c9d489'' expired at ''2021-10-12 00:20:29.139790+00:00''" }, "status": 403 } }, "Swap Limit Amount Exceeded": { "value": { "code": 20025, "type": "SwapLimitAmountExceeded", "detail": { "message": "End User CUST_1 Daily amount reached for USD trades: ''SWAP'' Limit currently set to 5000.00 USD." }, "status": 429 } }, "Swap Limit Frequency Exceeded": { "value": { "code": 20024, "type": "SwapLimitFrequencyExceeded", "detail": { "message": "End User CUST_3 Daily frequency reached for USD trades: ''SWAP'' Limit currently set to 10 operations." }, "status": 429 } } } } } } }, "summary": "Execute Swap Reusable Quote", "security": [ { "OAuth2": [ "read", "write" ] } ], "x-internal": false, "tags": [ "Swap Reusable Quote Execution" ], "x-stoplight": { "id": "p9a3k8ozffahb" } }, "parameters": [ { "schema": { "type": "string" }, "name": "swap_quote_id", "in": "path", "required": true } ] }, "/api/v1/withdrawals/": { "post": { "summary": "Create Withdrawal", "operationId": "createWithdrawal", "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.", "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_id": { "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_id": "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": "" }, "tags": [ "Withdrawals" ], "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." }, "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" } } } } } } }, "x-stoplight": { "id": "agg1tso5wtg2s" } }, "get": { "summary": "List Withdrawals", "operationId": "get-api-v1-withdrawals", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "example": 123, "description": "Indicates total count of withdrawals." }, "next": { "type": "string", "format": "uri", "example": "http://api.example.org/accounts/?page=4", "description": "Indicates next page by URL.", "nullable": true }, "previous": { "type": "string", "format": "uri", "example": "http://api.example.org/accounts/?page=2", "description": "Indicates previous page by URL.", "nullable": true }, "results": { "type": "array", "description": "List of fetched withdrawals.", "items": { "type": "object", "x-examples": { "Example": { "id": "ac243840-ac04-4b3a-9efb-176554d4a029", "created_at": "2022-03-30T19:38:39.765190Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "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": "string", "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." }, "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": { "value": { "count": 38, "next": "http://localhost/api/v1/withdrawals/?page=2", "previous": null, "results": [ { "id": "ac243840-ac04-4b3a-9efb-176554d4a029", "created_at": "2022-03-30T19:38:39.765190Z", "confirmation_date": null, "txn_hash": null, "end_user_id": "customer_12", "currency": "ETH", "amount": "1", "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "network_name": "ETHEREUM", "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": "1.0005" }, { "id": "1432b566-cd9a-4d41-a9a1-9f5c61c79c80", "created_at": "2022-03-30T19:46:37.500081Z", "confirmation_date": null, "txn_hash": null, "end_user_id": "customer_07", "currency": "ETH", "amount": "1", "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "network_name": "ETHEREUM", "status": "ERROR", "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": "1.0005" }, { "id": "e6f67436-65d8-4dc2-bc2e-16f2fb305562", "created_at": "2022-03-30T19:50:39.668401Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_11", "currency": "ETH", "amount": "1", "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "network_name": "ETHEREUM", "status": "COMPLETED", "transaction_id": "8df65b81-8227-4d03-950d-0d8d5fef9402", "provisory_transaction_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "risk_score": null, "is_blocked": false, "reason": "", "external_ref": "8df65b81-8227-4d03-950d-0d8d5fef9402", "debited_amount": "1.0005" }, { "id": "a4f30591-e392-49f5-bb99-2a3e8f244cdd", "created_at": "2022-03-30T19:52:21.075665Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_11", "currency": "ETH", "amount": "1", "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "network_name": "ETHEREUM", "status": "COMPLETED", "transaction_id": "8df65b81-8227-4d03-950d-0d8d5fef9402", "provisory_transaction_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "risk_score": null, "is_blocked": false, "reason": "", "external_ref": "8df65b81-8227-4d03-950d-0d8d5fef9402", "debited_amount": "1.0005" }, { "id": "b2a47f9d-5434-4fb2-8bad-fe78c8f184c6", "created_at": "2022-03-30T19:53:29.088325Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_03", "currency": "ETH", "amount": "1", "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "network_name": "ETHEREUM", "status": "COMPLETED", "transaction_id": "8df65b81-8227-4d03-950d-0d8d5fef9402", "provisory_transaction_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "risk_score": null, "is_blocked": false, "reason": "", "external_ref": "8df65b81-8227-4d03-950d-0d8d5fef9402", "debited_amount": "1.0005" }, { "id": "5c4e5963-cfcf-425a-8499-02e8f8713d3d", "created_at": "2022-03-30T19:55:24.963026Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_09", "currency": "ETH", "amount": "1", "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "network_name": "ETHEREUM", "status": "COMPLETED", "transaction_id": "8df65b81-8227-4d03-950d-0d8d5fef9402", "provisory_transaction_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "risk_score": null, "is_blocked": false, "reason": "", "external_ref": "8df65b81-8227-4d03-950d-0d8d5fef9402", "debited_amount": "1.0005" }, { "id": "a7fc741c-4875-4e3c-b402-b0bf6be15de3", "created_at": "2022-03-30T19:55:46.839591Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_00", "currency": "ETH", "amount": "1", "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "network_name": "ETHEREUM", "status": "COMPLETED", "transaction_id": "8df65b81-8227-4d03-950d-0d8d5fef9402", "provisory_transaction_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "risk_score": null, "is_blocked": false, "reason": "", "external_ref": "8df65b81-8227-4d03-950d-0d8d5fef9402", "debited_amount": "1.0005" }, { "id": "cf00d0ec-0a0a-4f7f-a4c3-d81545127486", "created_at": "2022-03-30T19:58:44.783641Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_06", "currency": "ETH", "amount": "1", "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "network_name": "ETHEREUM", "status": "COMPLETED", "transaction_id": "8df65b81-8227-4d03-950d-0d8d5fef9402", "provisory_transaction_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "risk_score": null, "is_blocked": false, "reason": "", "external_ref": "8df65b81-8227-4d03-950d-0d8d5fef9402", "debited_amount": "1.0005" }, { "id": "c675bfcb-091d-4ad4-97cb-ddc7dc798edd", "created_at": "2022-03-30T20:00:15.157342Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_02", "currency": "ETH", "amount": "1", "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "network_name": "ETHEREUM", "status": "COMPLETED", "transaction_id": "8df65b81-8227-4d03-950d-0d8d5fef9402", "provisory_transaction_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "risk_score": null, "is_blocked": false, "reason": "", "external_ref": "8df65b81-8227-4d03-950d-0d8d5fef9402", "debited_amount": "1.0005" }, { "id": "9ab46ae4-4b2f-48fb-a495-70d32ca98f08", "created_at": "2022-03-30T20:01:23.689408Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_23", "currency": "ETH", "amount": "1", "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "network_name": "ETHEREUM", "status": "COMPLETED", "transaction_id": "8df65b81-8227-4d03-950d-0d8d5fef9402", "provisory_transaction_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "risk_score": null, "is_blocked": false, "reason": "", "external_ref": "8df65b81-8227-4d03-950d-0d8d5fef9402", "debited_amount": "1.0005" }, { "id": "2ca91a53-495c-451c-9624-011ce4c455cf", "created_at": "2022-03-30T20:02:08.292260Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_03", "currency": "ETH", "amount": "1", "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "network_name": "ETHEREUM", "status": "COMPLETED", "transaction_id": "8df65b81-8227-4d03-950d-0d8d5fef9402", "provisory_transaction_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "risk_score": null, "is_blocked": false, "reason": "", "external_ref": "8df65b81-8227-4d03-950d-0d8d5fef9402", "debited_amount": "1.0005" }, { "id": "e454cc55-f667-46c5-98f8-54ef6eea3697", "created_at": "2022-03-30T20:09:09.312063Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_14", "currency": "ETH", "amount": "1", "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "network_name": "ETHEREUM", "status": "COMPLETED", "transaction_id": "8df65b81-8227-4d03-950d-0d8d5fef9402", "provisory_transaction_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "risk_score": null, "is_blocked": false, "reason": "", "external_ref": "8df65b81-8227-4d03-950d-0d8d5fef9402", "debited_amount": "1.0005" }, { "id": "b47654b1-3c3f-41e0-b5d2-caffcbeb6970", "created_at": "2022-03-30T20:10:03.361006Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_01", "currency": "ETH", "amount": "1", "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "network_name": "ETHEREUM", "status": "COMPLETED", "transaction_id": "8df65b81-8227-4d03-950d-0d8d5fef9402", "provisory_transaction_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "risk_score": null, "is_blocked": false, "reason": "", "external_ref": "8df65b81-8227-4d03-950d-0d8d5fef9402", "debited_amount": "1.0005" }, { "id": "d9dd78c8-9715-41bf-8da7-4467ef7319c2", "created_at": "2022-03-31T10:23:51.835858Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_3", "currency": "ETH", "amount": "1", "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "network_name": "ETHEREUM", "status": "COMPLETED", "transaction_id": "8df65b81-8227-4d03-950d-0d8d5fef9402", "provisory_transaction_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "risk_score": null, "is_blocked": false, "reason": "", "external_ref": "8df65b81-8227-4d03-950d-0d8d5fef9402", "debited_amount": "1.0005" }, { "id": "7a093807-c185-4131-8b66-2df5c7384541", "created_at": "2022-03-31T10:37:52.896695Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_3", "currency": "ETH", "amount": "1", "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "network_name": "ETHEREUM", "status": "COMPLETED", "transaction_id": "8df65b81-8227-4d03-950d-0d8d5fef9402", "provisory_transaction_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "risk_score": null, "is_blocked": false, "reason": "", "external_ref": "8df65b81-8227-4d03-950d-0d8d5fef9402", "debited_amount": "1.0005" }, { "id": "2b2f6af9-0bdd-408b-b6fa-6f21f5dabe5b", "created_at": "2022-03-31T10:38:09.660408Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_3", "currency": "ETH", "amount": "1", "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "network_name": "ETHEREUM", "status": "COMPLETED", "transaction_id": "8df65b81-8227-4d03-950d-0d8d5fef9402", "provisory_transaction_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "risk_score": null, "is_blocked": false, "reason": "", "external_ref": "8df65b81-8227-4d03-950d-0d8d5fef9402", "debited_amount": "1.0005" }, { "id": "25b13f48-1a2a-4e66-a63e-27c9c8044347", "created_at": "2022-03-31T10:40:41.384611Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_3", "currency": "ETH", "amount": "1", "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "network_name": "ETHEREUM", "status": "COMPLETED", "transaction_id": "8df65b81-8227-4d03-950d-0d8d5fef9402", "provisory_transaction_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "risk_score": null, "is_blocked": false, "reason": "", "external_ref": "8df65b81-8227-4d03-950d-0d8d5fef9402", "debited_amount": "1.0005" }, { "id": "8df65b81-8227-4d03-950d-0d8d5fef9402", "created_at": "2022-03-31T10:55:41.281023Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_3", "currency": "ETH", "amount": "1", "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "network_name": "ETHEREUM", "status": "COMPLETED", "transaction_id": "8df65b81-8227-4d03-950d-0d8d5fef9402", "provisory_transaction_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "risk_score": null, "is_blocked": false, "reason": "", "external_ref": "8df65b81-8227-4d03-950d-0d8d5fef9402", "debited_amount": "1.0005" }, { "id": "a17f8c8e-bbc6-4e41-a5a9-3ea6f2174782", "created_at": "2022-03-31T10:58:30.702198Z", "confirmation_date": "2022-03-31T10:59:29.025919Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_3", "currency": "ETH", "amount": "1", "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "network_name": "ETHEREUM", "status": "COMPLETED", "transaction_id": "8df65b81-8227-4d03-950d-0d8d5fef9402", "provisory_transaction_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "risk_score": null, "is_blocked": false, "reason": "", "external_ref": "8df65b81-8227-4d03-950d-0d8d5fef9402", "debited_amount": "1.0005" }, { "id": "ee97030e-8a28-469d-9705-3c35cf63443e", "created_at": "2022-03-31T10:59:12.025919Z", "confirmation_date": "2022-03-31T10:59:12.025919Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_3", "currency": "ETH", "amount": "1", "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "network_name": "ETHEREUM", "status": "COMPLETED", "transaction_id": "8df65b81-8227-4d03-950d-0d8d5fef9402", "provisory_transaction_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "risk_score": null, "is_blocked": false, "reason": "", "external_ref": "8df65b81-8227-4d03-950d-0d8d5fef9402", "debited_amount": "1.0005" } ] } } } } }, "description": "Successful Response" } }, "description": "Endpoint that lists every withdrawal operation.", "tags": [ "Withdrawals" ], "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "network_name", "description": "Filters by name of the network in which the withdrawal transactions were operated." }, { "schema": { "type": "string" }, "in": "query", "name": "status", "description": "Filters by status of the withdrawal operations." }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "create_date_lte", "description": "Filter by create_date less than or equal to this date." }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "create_date_gte", "description": "Filter by create_date greater than or equal to this date." }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "update_date_lte", "description": "Filter by update_date less than or equal to this date." }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "update_date_gte", "description": "Filter by update_date greater than or equal to this date." }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "confirmation_date_lte", "description": "Filter by confirmation_date_lte less than or equal to this date." }, { "schema": { "type": "string" }, "in": "query", "name": "confirmation_date_gte", "description": "Filter by confirmation_date_gte greater than or equal to this date." }, { "schema": { "type": "string" }, "in": "query", "name": "end_user_id", "description": "Filter withdrawal operations by end_user_id." }, { "schema": { "type": "string" }, "in": "query", "name": "currency_code_in", "description": "Filter withdrawals by currency." } ], "x-stoplight": { "id": "bh3b2dawxppsg" } }, "parameters": [] }, "/api/v1/withdrawal-fees": { "post": { "summary": "Create Withdrawal Fee", "operationId": "createWithdrawalFee", "description": "This endpoint allows the creation of a withdrawal fee. Withdrawal fees are \"held fees\" offered by Ripio to withdraw assets at a specific fee within a period of time - for example, the option to transfer out 0.25 ETH within the next 15 seconds for 0.001 ETH.", "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": { "currency": { "type": "string", "description": "Currency to estimate the fee for. It needs to be the same currency as the once use later for the withdrawal. The fee in the reponse will be expressed in this currency." }, "network": { "type": "string", "description": "The blockchain network in which the withdrawal fee needs to be estimated. The later withdrawal must be performed in the same network." }, "amount": { "type": "number", "description": "Amount to be withdrawaled. It''s the amount that wants to be transfered, the fee depends on this amount." }, "external_ref": { "type": "string", "description": "An external identifier, usually a unique UUID" } } }, "examples": { "example-1": { "value": { "currency": "ETH", "network": "ethereum", "amount": 0.002, "external_ref": "withdrawal-fee-1234" } } } }, "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": "" }, "tags": [ "Withdrawals" ], "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": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_10", "currency": "BTC", "amount": "0.000000010000016378", "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "charged_fee": "0.00000000", "network_name": "BITCOIN" } }, "title": "Withdrawal Fee Response", "description": "", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as withdrawal identifier." }, "expires_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating expiration date of the withdrawal fee. Fee will be invalid after that date." }, "amount": { "type": "number", "format": "decimal", "description": "It is the requested amount to withdrawal." }, "gas_price": { "type": "number", "format": "decimal", "description": "Indicates de basic cost on a withdrawal fee, the network gas price. It is expressed in the requested currency." }, "fee": { "type": "number", "format": "decimal", "description": "Indicates the basic fee that it is charged on the amount to be withdrawaled. It is expressed in the requested currency." }, "total_fee": { "type": "number", "format": "decimal", "description": "Indicates the total fee that will be charged in order to perform a withdrawal. Tipically, equivalent to gas_price + fee. It is expressed in the requested currency." }, "total_amount": { "type": "number", "format": "decimal", "description": "Indicates the total amount needed to perform a withdrawal for the requested amount. It is the amount that will be decreased on the user balance. Tipically, amount + total_fee. It is expressed in the requested currency." } }, "x-stoplight": { "id": "ww1qxcg7cpl4q" } }, "examples": { "example-1": { "value": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "expires_at": "2022-08-24T14:15:22Z", "amount": 0.002, "gas_price": 0.00001, "fee": 0.00001, "total_fee": 0.00002, "total_amount": 0.00202 } } } } } } }, "x-stoplight": { "id": "nz2u4amr6spne" } }, "get": { "summary": "List Withdrawals", "operationId": "get-api-v1-withdrawal-fees", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "example": 123, "description": "Indicates total count of withdrawals." }, "next": { "type": "string", "format": "uri", "example": "http://api.example.org/accounts/?page=4", "description": "Indicates next page by URL.", "nullable": true }, "previous": { "type": "string", "format": "uri", "example": "http://api.example.org/accounts/?page=2", "description": "Indicates previous page by URL.", "nullable": true }, "results": { "type": "array", "description": "List of fetched withdrawals.", "items": { "type": "object", "x-examples": { "Example": { "id": "ac243840-ac04-4b3a-9efb-176554d4a029", "created_at": "2022-03-30T19:38:39.765190Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_10", "currency": "BTC", "amount": "0.000000010000016378", "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "charged_fee": "0.00000000", "network_name": "BITCOIN" } }, "title": "Withdrawal Fee Response", "description": "", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as withdrawal identifier." }, "expires_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating expiration date of the withdrawal fee. Fee will be invalid after that date." }, "amount": { "type": "number", "format": "decimal", "description": "It is the requested amount to withdrawal." }, "gas_price": { "type": "number", "format": "decimal", "description": "Indicates de basic cost on a withdrawal fee, the network gas price. It is expressed in the requested currency." }, "fee": { "type": "number", "format": "decimal", "description": "Indicates the basic fee that it is charged on the amount to be withdrawaled. It is expressed in the requested currency." }, "total_fee": { "type": "number", "format": "decimal", "description": "Indicates the total fee that will be charged in order to perform a withdrawal. Tipically, equivalent to gas_price + fee. It is expressed in the requested currency." }, "total_amount": { "type": "number", "format": "decimal", "description": "Indicates the total amount needed to perform a withdrawal for the requested amount. It is the amount that will be decreased on the user balance. Tipically, amount + total_fee. It is expressed in the requested currency." } }, "x-stoplight": { "id": "ww1qxcg7cpl4q" } } } } }, "examples": { "Example": { "value": { "count": 38, "next": "http://localhost/api/v1/withdrawals/?page=2", "previous": null, "results": [ { "id": "ac243840-ac04-4b3a-9efb-176554d4a029", "created_at": "2022-03-30T19:38:39.765190Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_12", "currency": "ETH", "amount": 1, "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "charged_fee": 0, "network_name": "ETHEREUM" }, { "id": "1432b566-cd9a-4d41-a9a1-9f5c61c79c80", "created_at": "2022-03-30T19:46:37.500081Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_07", "currency": "ETH", "amount": 1, "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "charged_fee": 0, "network_name": "ETHEREUM" }, { "id": "e6f67436-65d8-4dc2-bc2e-16f2fb305562", "created_at": "2022-03-30T19:50:39.668401Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_11", "currency": "ETH", "amount": 1, "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "charged_fee": 0, "network_name": "ETHEREUM" }, { "id": "a4f30591-e392-49f5-bb99-2a3e8f244cdd", "created_at": "2022-03-30T19:52:21.075665Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_11", "currency": "ETH", "amount": 1, "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "charged_fee": 0, "network_name": "ETHEREUM" }, { "id": "b2a47f9d-5434-4fb2-8bad-fe78c8f184c6", "created_at": "2022-03-30T19:53:29.088325Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_03", "currency": "ETH", "amount": 1, "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "charged_fee": 0, "network_name": "ETHEREUM" }, { "id": "5c4e5963-cfcf-425a-8499-02e8f8713d3d", "created_at": "2022-03-30T19:55:24.963026Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_09", "currency": "ETH", "amount": 1, "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "charged_fee": 0, "network_name": "ETHEREUM" }, { "id": "a7fc741c-4875-4e3c-b402-b0bf6be15de3", "created_at": "2022-03-30T19:55:46.839591Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_00", "currency": "ETH", "amount": 1, "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "charged_fee": 0, "network_name": "ETHEREUM" }, { "id": "cf00d0ec-0a0a-4f7f-a4c3-d81545127486", "created_at": "2022-03-30T19:58:44.783641Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_06", "currency": "ETH", "amount": 1, "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "charged_fee": 0, "network_name": "ETHEREUM" }, { "id": "c675bfcb-091d-4ad4-97cb-ddc7dc798edd", "created_at": "2022-03-30T20:00:15.157342Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_02", "currency": "ETH", "amount": 1, "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "charged_fee": 0, "network_name": "ETHEREUM" }, { "id": "9ab46ae4-4b2f-48fb-a495-70d32ca98f08", "created_at": "2022-03-30T20:01:23.689408Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_23", "currency": "ETH", "amount": 1, "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "charged_fee": 0, "network_name": "ETHEREUM" }, { "id": "2ca91a53-495c-451c-9624-011ce4c455cf", "created_at": "2022-03-30T20:02:08.292260Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_03", "currency": "ETH", "amount": 1, "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "charged_fee": 0, "network_name": "ETHEREUM" }, { "id": "e454cc55-f667-46c5-98f8-54ef6eea3697", "created_at": "2022-03-30T20:09:09.312063Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_14", "currency": "ETH", "amount": 1, "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "charged_fee": 0, "network_name": "ETHEREUM" }, { "id": "b47654b1-3c3f-41e0-b5d2-caffcbeb6970", "created_at": "2022-03-30T20:10:03.361006Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_01", "currency": "ETH", "amount": 1, "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "charged_fee": 0, "network_name": "ETHEREUM" }, { "id": "d9dd78c8-9715-41bf-8da7-4467ef7319c2", "created_at": "2022-03-31T10:23:51.835858Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_3", "currency": "ETH", "amount": 1, "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "charged_fee": 0, "network_name": "ETHEREUM" }, { "id": "7a093807-c185-4131-8b66-2df5c7384541", "created_at": "2022-03-31T10:37:52.896695Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_3", "currency": "ETH", "amount": 1, "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "charged_fee": 0, "network_name": "ETHEREUM" }, { "id": "2b2f6af9-0bdd-408b-b6fa-6f21f5dabe5b", "created_at": "2022-03-31T10:38:09.660408Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_3", "currency": "ETH", "amount": 1, "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "charged_fee": 0, "network_name": "ETHEREUM" }, { "id": "25b13f48-1a2a-4e66-a63e-27c9c8044347", "created_at": "2022-03-31T10:40:41.384611Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_3", "currency": "ETH", "amount": 1, "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "charged_fee": 0, "network_name": "ETHEREUM" }, { "id": "8df65b81-8227-4d03-950d-0d8d5fef9402", "created_at": "2022-03-31T10:55:41.281023Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_3", "currency": "ETH", "amount": 1, "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "charged_fee": 0, "network_name": "ETHEREUM" }, { "id": "a17f8c8e-bbc6-4e41-a5a9-3ea6f2174782", "created_at": "2022-03-31T10:58:30.702198Z", "confirmation_date": "2022-03-31T10:59:29.025919Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_3", "currency": "ETH", "amount": 1, "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "charged_fee": 0, "network_name": "ETHEREUM" }, { "id": "ee97030e-8a28-469d-9705-3c35cf63443e", "created_at": "2022-03-31T10:59:12.025919Z", "confirmation_date": "2022-03-31T10:59:12.025919Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_3", "currency": "ETH", "amount": 1, "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "charged_fee": 0, "network_name": "ETHEREUM" } ] } } } } }, "description": "Successful Response" } }, "description": "Endpoint that lists every withdrawal fees.", "tags": [ "Withdrawals" ], "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "network", "description": "Filters by name of the network in which the withdrawal fee was requested." }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "create_date_lte", "description": "Filters by create_date less than or equal to this date." }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "create_date_gte", "description": "Filters by create_date greater than or equal to this date." }, { "schema": { "type": "string" }, "in": "query", "name": "currency_code_in", "description": "Filter withdrawal fees by currency." } ], "x-stoplight": { "id": "jthvvhuycrwa6" } }, "parameters": [] }, "/api/v1/withdrawals/{withdrawal_id}/": { "get": { "summary": "Retrieve Withdrawal", "tags": [ "Withdrawals" ], "responses": { "200": { "description": "Successful Response", "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": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "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." }, "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": { "value": { "id": "ac243840-ac04-4b3a-9efb-176554d4a029", "created_at": "2022-03-30T19:38:39.765190Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_10", "currency": "BTC", "amount": 3, "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "charged_fee": 0, "network_name": "BITCOIN", "status": "COMPLETED", "transaction_id": "8df65b81-8227-4d03-950d-0d8d5fef9402", "provisory_transaction_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "risk_score": null, "is_blocked": false, "reason": "", "external_ref": "8df65b81-8227-4d03-950d-0d8d5fef9402", "debited_amount": "3.001" } } } } } } }, "operationId": "get-api-v1-withdrawals-withdrawal_id", "description": "Endpoint that retrieves a specific withdrawal given a withdrawal ID.", "x-stoplight": { "id": "vb7ewgkwi2t21" } }, "parameters": [ { "schema": { "type": "string" }, "name": "withdrawal_id", "in": "path", "required": true } ] }, "/api/v1/deposits/": { "get": { "summary": "List Deposits", "tags": [ "Deposits" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "example": 123, "description": "Indicates total count of deposits." }, "next": { "type": "string", "format": "uri", "example": "http://api.example.org/accounts/?page=4", "description": "Indicates next page by URL.", "nullable": true }, "previous": { "type": "string", "format": "uri", "example": "http://api.example.org/accounts/?page=2", "description": "Indicates previous page by URL.", "nullable": true }, "results": { "type": "array", "description": "List of fetched deposits.", "items": { "type": "object", "description": "", "properties": { "id": { "type": "string", "description": "Unique ID for this deposit." }, "hash": { "type": "string", "description": "Indicates TXN Hash in the blockchain. This hash is not unique, several outputs may exist on a single transaction. Read index field description." }, "index": { "type": "integer", "description": "Indicates the index on the output transaction. This is unique within a hash." }, "address_origin": { "type": "string" }, "create_date": { "type": "string", "minLength": 1, "description": "Indicates the creation date of the deposit in the blockchain." }, "update_date": { "type": "string", "minLength": 1, "description": "Indicates the creation date of the deposit in the blockchain." }, "confirmation_date": { "type": "string", "minLength": 1, "description": "Indicates the confirmation date of the deposit in the blockchain.", "nullable": true }, "currency_code": { "type": "string", "minLength": 1, "description": "Indicates the currency that has been deposited." }, "address_destination": { "type": "string", "description": "Indicates the deposit's destination address." }, "end_user_id": { "type": "string", "description": "Indicates the end user that has received the deposit." }, "amount": { "type": "string", "description": "Indicates the amount deposited." }, "network": { "type": "string", "description": "The crypto network" }, "status": { "type": "string", "enum": [ "PENDING", "COMPLETED", "ERROR" ] }, "risk_score": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH", "SEVERE" ] }, "is_blocked": { "type": "boolean", "description": "Indicates if the deposit is blocked.", "default": false }, "reason": { "type": "string", "description": "If the deposit is blocked this field will contain the reason.", "default": "" } }, "required": [ "hash", "address_origin", "create_date", "update_date", "confirmation_date", "currency_code", "address_destination", "end_user_id", "amount" ], "x-stoplight": { "id": "fv3y408ghzyum" } } } } }, "examples": { "Succesful Response": { "value": { "count": 123, "next": "http://api.example.org/accounts/?page=4", "previous": "http://api.example.org/accounts/?page=2", "results": [ { "id": "fa14c963-1afb-4f0d-af0d-e622e0c50297", "hash": "4f87d009d88524e627b60c6fbe4ebe671a99lk9ad72aab17e0963c5fbef118e2", "index": 0, "amount": "2.29999999", "create_date": "2017-10-12T22:40:08.273Z", "update_date": "2017-10-12T22:41:23.273Z", "confirmation_date": "2017-10-12T22:40:08.273Z", "currency_code": "BTC", "address_destination": "ajxS9ne12qx9pS9VojpwU5xtRd4T7X7ZUt", "address_origin": "BJxS9ne12qx9pS9VojpwU5xtRd4T7X7Z43t", "end_user_id": "CUST_2", "status": "COMPLETED", "network": "BTC", "risk_score": "MEDIUM", "is_blocked": false, "reason": "" }, { "id": "cacff7d9-a43f-4420-84e0-579decaacdf4", "hash": "1G87d009d88524e627b60c6fbe4ebe671a99lk9ad72aab17e0963c5fbef118g3", "index": 0, "amount": "2.29999999", "create_date": "2017-10-12T22:40:08.273Z", "confirmation_date": null, "update_date": "2017-10-12T22:40:08.273Z", "currency_code": "BTC", "address_destination": "bjxS9ne12qx9pS9VojpwU5xtRd4T7X7ZUt", "address_origin": "BJxS9ne12qx9pS9VojpwU5xtRd4T7X7Z43t", "end_user_id": "CUST_3", "status": "PENDING", "network": "BTC", "risk_score": "MEDIUM", "is_blocked": false, "reason": "" } ] } } } } }, "description": "" } }, "operationId": "get-api-v1-deposits", "description": "Endpoint that list all the deposits received.\n\n**Note**:\n\nThis endpoints allows to poll or reconcile deposited transactions. We offer the capability to set a Webhook URL in order to be notified in real time. Please note that you should expect a payload format similar to the one below (see results attribute in response's payload)\n", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "create_date_lte", "description": "Filter deposits by create_date less than or equal to this date." }, { "schema": { "type": "string" }, "in": "query", "name": "create_date_gte", "description": "Filter deposits by create_date greater than or equal to this date." }, { "schema": { "type": "string" }, "in": "query", "name": "confirmation_date_lte", "description": "Filter deposits by confirmation_date less than or equal to this date." }, { "schema": { "type": "string" }, "in": "query", "name": "confirmation_date_gte", "description": "Filter deposits by confirmation_date greater than or equal to this date." }, { "schema": { "type": "string" }, "in": "query", "name": "end_user_id", "description": "End User that has received deposits." }, { "schema": { "type": "array", "items": { "type": "string" } }, "in": "query", "name": "currency_code_in", "description": "Currency codes that has been deposited." }, { "schema": { "type": "string" }, "in": "query", "name": "page", "description": "Pagination QueryParam." }, { "schema": { "type": "string" }, "in": "query", "name": "update_date_lte", "description": "Filter deposits by update_date less than or equal to this date." }, { "schema": { "type": "string" }, "in": "query", "name": "update_date_gte", "description": "Filter deposits by update_date greater than or equal to this date." } ], "x-stoplight": { "id": "mbwx5c8bow6j2" } }, "parameters": [] }, "/api/v1/deposits/{deposit_id}/": { "parameters": [ { "schema": { "type": "string" }, "name": "deposit_id", "in": "path", "required": true } ], "get": { "summary": "Retrieve Deposit", "tags": [ "Deposits" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "description": "", "properties": { "id": { "type": "string", "description": "Unique ID for this deposit." }, "hash": { "type": "string", "description": "Indicates TXN Hash in the blockchain. This hash is not unique, several outputs may exist on a single transaction. Read index field description." }, "index": { "type": "integer", "description": "Indicates the index on the output transaction. This is unique within a hash." }, "address_origin": { "type": "string" }, "create_date": { "type": "string", "minLength": 1, "description": "Indicates the creation date of the deposit in the blockchain." }, "update_date": { "type": "string", "minLength": 1, "description": "Indicates the creation date of the deposit in the blockchain." }, "confirmation_date": { "type": "string", "minLength": 1, "description": "Indicates the confirmation date of the deposit in the blockchain.", "nullable": true }, "currency_code": { "type": "string", "minLength": 1, "description": "Indicates the currency that has been deposited." }, "address_destination": { "type": "string", "description": "Indicates the deposit's destination address." }, "end_user_id": { "type": "string", "description": "Indicates the end user that has received the deposit." }, "amount": { "type": "string", "description": "Indicates the amount deposited." }, "network": { "type": "string", "description": "The crypto network" }, "status": { "type": "string", "enum": [ "PENDING", "COMPLETED", "ERROR" ] }, "risk_score": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH", "SEVERE" ] }, "is_blocked": { "type": "boolean", "description": "Indicates if the deposit is blocked.", "default": false }, "reason": { "type": "string", "description": "If the deposit is blocked this field will contain the reason.", "default": "" } }, "required": [ "hash", "address_origin", "create_date", "update_date", "confirmation_date", "currency_code", "address_destination", "end_user_id", "amount" ], "x-stoplight": { "id": "fv3y408ghzyum" } }, "examples": { "example-1": { "value": { "id": "fa14c963-1afb-4f0d-af0d-e622e0c50297", "hash": "4f87d009d88524e627b60c6fbe4ebe671a99lk9ad72aab17e0963c5fbef118e2", "index": 0, "amount": "2.29999999", "create_date": "2017-10-12T22:40:08.273Z", "confirmation_date": "2017-10-12T22:40:08.273Z", "update_date": "2017-10-12T22:40:08.273Z", "currency_code": "BTC", "address_destination": "ajxS9ne12qx9pS9VojpwU5xtRd4T7X7ZUt", "address_origin": "BJxS9ne12qx9pS9VojpwU5xtRd4T7X7Z43t", "end_user_id": "CUST_2", "status": "PENDING", "network": "BTC", "risk_score": "MEDIUM", "is_blocked": false, "reason": "" } } } } } } }, "operationId": "get-api-v1-deposits-deposit_id", "description": "Endpoint that retrieves details of a received deposit by id.\n\n**Note**:\n\nWe offer the capability to set a Webhook URL in order to be notified in real time. Please note that you should expect a payload format similar to the one below.", "x-stoplight": { "id": "24fq9v7ws55hi" } } }, "/api/v1/ipn/webhooks/": { "post": { "summary": "Create IPN Webhook", "operationId": "post-api-v1-ipn-webhooks", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string", "minLength": 1 } }, "required": [ "id", "url" ], "x-examples": { "example-1": { "id": 1, "url": "https://my-test-endpoint/ipn/" } } }, "examples": { "Response": { "value": { "id": 1, "url": "https://my-test-endpoint/ipn/" } } } } } } }, "description": "Endpoint that performs the creation of an IPN Webhook for the current account.\n**Important**: This endpoint is only available in Sandbox.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ], "x-examples": { "example-1": { "url": "" } } }, "examples": { "Create an IPN Webhook": { "value": { "url": "https://my-test-site/api/ipn/" } } } } } }, "tags": [ "IPN Webhooks" ], "x-stoplight": { "id": "9ckcin96403qq" } }, "get": { "summary": "List Available IPN Webhooks", "tags": [ "IPN Webhooks" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "description": "", "minItems": 1, "uniqueItems": true, "items": { "type": "object", "required": [ "id", "url" ], "properties": { "id": { "type": "number" }, "url": { "type": "string", "minLength": 1 } } }, "x-examples": { "example-1": [ { "id": 1, "url": "https://test-url.com" } ] } }, "examples": { "Succesful Response": { "value": [ { "id": 1, "url": "https://my-test-endpoint/ipn/" } ] } } } } } }, "operationId": "get-api-v1-ipn-webhooks", "description": "Endpoint that list all the available IPN Webhooks for the current account.\n**Important**: This endpoint is only available in Sandbox.", "x-stoplight": { "id": "akr8c2yyvxdc8" } } }, "/api/v1/ipn/webhooks/{ipn_webhook_id}/": { "parameters": [ { "schema": { "type": "string" }, "name": "ipn_webhook_id", "in": "path", "required": true } ], "get": { "summary": "Retrieve IPN Webhooks", "tags": [ "IPN Webhooks" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string", "minLength": 1 } }, "required": [ "id", "url" ], "x-examples": { "example-1": { "id": 1, "url": "https://my-test-endpoint/ipn/" } } }, "examples": { "example-1": { "value": { "id": 1, "url": "https://my-test-endpoint/ipn/" } } } } } } }, "operationId": "get-api-v1-ipn-webhook-webhook_id", "description": "Endpoint that allows the retrieval of a given IPN Webhooks.\n**Important**: This endpoint is only available in Sandbox.", "x-stoplight": { "id": "bx6gci660bygm" } }, "put": { "summary": "Update IPN Webhook", "operationId": "put-api-v1-ipn-webhook-webhook_id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string", "minLength": 1 } }, "required": [ "id", "url" ], "x-examples": { "example-1": { "id": 1, "url": "https://my-test-endpoint/ipn/" } } }, "examples": { "example-1": { "value": { "id": 1, "url": "https://my-test-endpoint/ipn/" } } } } } } }, "description": "Endpoint that performs an update of an IPN Webhook for the current account.\n**Important**: This endpoint is only available in Sandbox.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "type": "object", "properties": { "url": { "type": "string", "minLength": 1 } }, "required": [ "url" ], "x-examples": { "example-1": { "url": "https://my-test-endpoint/ipn/" } } }, "examples": { "example-1": { "value": { "url": "https://my-test-endpoint/ipn/" } } } } } }, "tags": [ "IPN Webhooks" ], "x-stoplight": { "id": "2dvdqv4rjnwgr" } } }, "/api/v1/ipn/test/": { "post": { "summary": "Create Deposit IPN Notification for Testing", "operationId": "post-api-v1-ipn-test", "responses": { "200": { "description": "OK" } }, "description": "Endpoint that allows the creation of a dummy (but with proper format) deposit IPN Notification that will be sent to the registered IPN Webhooks created before.", "tags": [ "Deposit IPN" ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "type": "object", "x-examples": { "example-1": { "kind": "deposit", "ipn_webhook_id": 1 } }, "properties": { "kind": { "type": "string", "minLength": 1, "description": "Indicates the type of IPN Notification to generate. See availables options.", "enum": [ "deposit", "withdrawal", "swap" ] }, "ipn_webhook_id": { "type": "number", "description": "Indicates the id of IPN Webhook created." } }, "required": [ "kind", "ipn_webhook_id" ] }, "examples": { "Example 1": { "value": { "kind": "deposit", "ipn_webhook_id": 1 } } } } } }, "x-stoplight": { "id": "coxk5cp045v9x" } } }, "/end_users/{end_user_id}/wallets/": { "parameters": [ { "schema": { "type": "string" }, "name": "end_user_id", "in": "path", "required": true } ], "get": { "summary": "List End User's Wallets", "tags": [ "Wallets" ], "operationId": "get-end_users-end_user_id-wallets", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "description": "", "minItems": 1, "uniqueItems": true, "x-examples": { "example-1": [ { "wallet_number": 0, "addresses": [] } ] }, "items": { "type": "object", "properties": { "wallet_number": { "type": "number" }, "addresses": { "type": "array", "items": { "title": "Address", "type": "object", "properties": { "network": { "type": "string", "enum": [ "BITCOIN", "EHTEREUM" ] }, "end_user_id": { "type": "string" }, "address": { "type": "string" }, "address_type": { "type": "string", "enum": [ "LEGACY", "SEGWIT" ] }, "wallet_number": { "type": "integer", "description": "Represents the wallet number that will be associated with this new address." } }, "x-stoplight": { "id": "kpa5wfu4rfuag" } } } }, "required": [ "wallet_number", "addresses" ] } }, "examples": { "example-1": { "value": [ { "wallet_number": 0, "addresses": [ { "network": "BITCOIN", "end_user_id": "string", "address": "string", "address_type": "LEGACY", "wallet_number": 0 } ] } ] } } } } } }, "description": "This endpoint allows to fetch a list of the given end user's wallets.", "x-stoplight": { "id": "d7gdgctl1ioqb" } } }, "/api/v1/end-users/{end_user_id}/beneficiary-fiat-accounts/": { "parameters": [ { "schema": { "type": "string" }, "name": "end_user_id", "in": "path", "required": true, "description": "End user's external ref, usually a uuid." } ], "post": { "summary": "Create Beneficiary Fiat Account", "tags": [ "Beneficiary Fiat Accounts" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "title": "BeneficiaryFiatAccountResponse", "x-stoplight": { "id": "d9qpc1i58mwmt" }, "type": "object", "x-examples": { "Example 1": { "beneficiary_fiat_account_id": "123e4567-e89b-12d3-a456-4bedc4266abc", "created_at": "2019-08-24T14:15:22Z", "currency": "ARS", "account_fields": { "alias_or_cvu_destination": "0000465160000000013330" }, "status": "processing", "payment_method_type": "bank_transfer" } }, "properties": { "beneficiary_fiat_account_id": { "type": "string", "x-stoplight": { "id": "s81hi7swzftug" }, "example": "123e4567-e89b-12d3-a456-4bedc4266abc", "description": "UUID4 formated unique id.", "format": "uuid" }, "created_at": { "type": "string", "x-stoplight": { "id": "85bbhruk52d09" }, "format": "date-time", "description": "ISO DateTime indicating creation date of Beneficiary Fiat Account", "example": "2019-08-24T14:15:22Z" }, "currency": { "type": "string", "x-stoplight": { "id": "2rc25kzh0722j" }, "description": "It defines the currency that the Beneficiary Fiat Account accepts.", "example": "ARS", "minLength": 3, "maxLength": 3 }, "account_fields": { "type": "object", "x-stoplight": { "id": "4uked55vjse1q" }, "minProperties": 1, "description": "JSON fields with account identification details.\nIt varies based on the account type.\nExample:\n```json\n{“alias_or_cvu_destination”: “0000465160000000013330”}\n```", "properties": { "alias_or_cvu_destination": { "type": "string", "x-stoplight": { "id": "obshnce7b8ryz" }, "description": "Example for ARS Accounts." } } }, "status": { "type": "string", "x-stoplight": { "id": "dahq9n8ywumoo" }, "enum": [ "DISABLED", "PROCESSING", "ENABLED", "SUSPENDED" ], "description": "Indicates Beneficiary Fiat Account status.\nExpected values: `DISABLED`, `PROCESSING`, `ENABLED`, `SUSPENDED`" }, "payment_method_type": { "type": "string", "x-stoplight": { "id": "xuj8ekk9db8s8" }, "description": "Indicates the payment method type. Usually, bank_transfer." } } }, "examples": { "Example 1": { "value": { "beneficiary_fiat_account_id": "123e4567-e89b-12d3-a456-4bedc4266abc", "created_at": "2019-08-24T14:15:22Z", "currency": "ARS", "account_fields": { "alias_or_cvu_destination": "0000465160000000013330" }, "status": "ENABLED", "payment_method_type": "bank_transfer" } } } } } } }, "operationId": "post-api-v1-end-users-end_user_id-beneficiary-fiat-accounts", "x-stoplight": { "id": "zss3z009epn9b" }, "description": "This endpoint allows you to create an Beneficiary Fiat Account.\nAn Beneficiary Fiat Account represents a Fiat Account owned by the given end user, and will be used to [withdrawal fiat](#tag/Fiat-Withdrawals) money from user's balance.", "security": [ { "OAuth2": [ "write" ] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "payment_method_type": { "type": "string", "x-stoplight": { "id": "xejnxwsalnlsj" }, "description": "It indicates the account type. Usually bank_transfer." }, "currency": { "type": "string", "x-stoplight": { "id": "uar4osy4gpfzy" }, "description": "Beneficiary Fiat Account's currency." }, "account_fields": { "type": "object", "x-stoplight": { "id": "uepsmarjpxscg" }, "description": "Fields that defines the beneficiary fiat account details.", "properties": { "alias_or_cvu_destination": { "type": "string", "x-stoplight": { "id": "vagt9cg0rsjqc" } } } } } }, "examples": { "Example 1": { "value": { "payment_method_type": "bank_transfer", "currency": "ARS", "account_fields": { "alias_or_cvu_destination": "0000465160000000013330" } } } } } } } }, "get": { "summary": "List Beneficiary Fiat Account", "tags": [ "Beneficiary Fiat Accounts" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "BeneficiaryFiatAccountResponse", "x-stoplight": { "id": "d9qpc1i58mwmt" }, "type": "object", "x-examples": { "Example 1": { "beneficiary_fiat_account_id": "123e4567-e89b-12d3-a456-4bedc4266abc", "created_at": "2019-08-24T14:15:22Z", "currency": "ARS", "account_fields": { "alias_or_cvu_destination": "0000465160000000013330" }, "status": "processing", "payment_method_type": "bank_transfer" } }, "properties": { "beneficiary_fiat_account_id": { "type": "string", "x-stoplight": { "id": "s81hi7swzftug" }, "example": "123e4567-e89b-12d3-a456-4bedc4266abc", "description": "UUID4 formated unique id.", "format": "uuid" }, "created_at": { "type": "string", "x-stoplight": { "id": "85bbhruk52d09" }, "format": "date-time", "description": "ISO DateTime indicating creation date of Beneficiary Fiat Account", "example": "2019-08-24T14:15:22Z" }, "currency": { "type": "string", "x-stoplight": { "id": "2rc25kzh0722j" }, "description": "It defines the currency that the Beneficiary Fiat Account accepts.", "example": "ARS", "minLength": 3, "maxLength": 3 }, "account_fields": { "type": "object", "x-stoplight": { "id": "4uked55vjse1q" }, "minProperties": 1, "description": "JSON fields with account identification details.\nIt varies based on the account type.\nExample:\n```json\n{“alias_or_cvu_destination”: “0000465160000000013330”}\n```", "properties": { "alias_or_cvu_destination": { "type": "string", "x-stoplight": { "id": "obshnce7b8ryz" }, "description": "Example for ARS Accounts." } } }, "status": { "type": "string", "x-stoplight": { "id": "dahq9n8ywumoo" }, "enum": [ "DISABLED", "PROCESSING", "ENABLED", "SUSPENDED" ], "description": "Indicates Beneficiary Fiat Account status.\nExpected values: `DISABLED`, `PROCESSING`, `ENABLED`, `SUSPENDED`" }, "payment_method_type": { "type": "string", "x-stoplight": { "id": "xuj8ekk9db8s8" }, "description": "Indicates the payment method type. Usually, bank_transfer." } } } }, "examples": { "Example 1": { "value": [ { "beneficiary_fiat_account_id": "123e4567-e89b-12d3-a456-4bedc4266abc", "created_at": "2019-08-24T14:15:22Z", "currency": "ARS", "account_fields": { "alias_or_cvu_destination": "0000465160000000013330" }, "status": "ENABLED", "payment_method_type": "bank_transfer" }, { "beneficiary_fiat_account_id": "4567e123-e89b-12d3-a456-4bedc4266abc", "created_at": "2020-08-24T14:15:22Z", "currency": "ARS", "account_fields": { "alias_or_cvu_destination": "0000465160000000013331" }, "status": "DISABLED", "payment_method_type": "bank_transfer" } ] } } } } } }, "operationId": "get-api-v1-end-users-end_user_id-beneficiary-fiat-accounts", "x-stoplight": { "id": "0gh33uo33xxoj" }, "description": "This endpoint allows to fetch a list of the given user's beneficiary fiat accounts.", "x-extension-1": null, "security": [ { "OAuth2": [ "read" ] } ], "parameters": [ { "schema": { "type": "string", "example": "processing", "enum": [ "DISABLED", "PROCESSING", "ENABLED", "SUSPENDED" ] }, "in": "query", "name": "status", "description": "Filters results based on its statuses" }, { "schema": { "type": "string", "example": "bank_transfer" }, "in": "query", "name": "payment_method_type", "description": "Filters results based on its payment method type" } ] } }, "/api/v1/end-users/{end_user_id}/beneficiary-fiat-accounts/{beneficiary_fiat_account_id}": { "parameters": [ { "schema": { "type": "string" }, "name": "end_user_id", "in": "path", "required": true, "description": "End user's external ref, usually a uuid." }, { "schema": { "type": "string", "format": "uuid" }, "name": "beneficiary_fiat_account_id", "in": "path", "required": true, "description": "Beneficiary Fiat Account ID (UUID)" } ], "get": { "summary": "Retrieve Beneficiary Fiat Account", "tags": [ "Beneficiary Fiat Accounts" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "title": "BeneficiaryFiatAccountResponse", "x-stoplight": { "id": "d9qpc1i58mwmt" }, "type": "object", "x-examples": { "Example 1": { "beneficiary_fiat_account_id": "123e4567-e89b-12d3-a456-4bedc4266abc", "created_at": "2019-08-24T14:15:22Z", "currency": "ARS", "account_fields": { "alias_or_cvu_destination": "0000465160000000013330" }, "status": "processing", "payment_method_type": "bank_transfer" } }, "properties": { "beneficiary_fiat_account_id": { "type": "string", "x-stoplight": { "id": "s81hi7swzftug" }, "example": "123e4567-e89b-12d3-a456-4bedc4266abc", "description": "UUID4 formated unique id.", "format": "uuid" }, "created_at": { "type": "string", "x-stoplight": { "id": "85bbhruk52d09" }, "format": "date-time", "description": "ISO DateTime indicating creation date of Beneficiary Fiat Account", "example": "2019-08-24T14:15:22Z" }, "currency": { "type": "string", "x-stoplight": { "id": "2rc25kzh0722j" }, "description": "It defines the currency that the Beneficiary Fiat Account accepts.", "example": "ARS", "minLength": 3, "maxLength": 3 }, "account_fields": { "type": "object", "x-stoplight": { "id": "4uked55vjse1q" }, "minProperties": 1, "description": "JSON fields with account identification details.\nIt varies based on the account type.\nExample:\n```json\n{“alias_or_cvu_destination”: “0000465160000000013330”}\n```", "properties": { "alias_or_cvu_destination": { "type": "string", "x-stoplight": { "id": "obshnce7b8ryz" }, "description": "Example for ARS Accounts." } } }, "status": { "type": "string", "x-stoplight": { "id": "dahq9n8ywumoo" }, "enum": [ "DISABLED", "PROCESSING", "ENABLED", "SUSPENDED" ], "description": "Indicates Beneficiary Fiat Account status.\nExpected values: `DISABLED`, `PROCESSING`, `ENABLED`, `SUSPENDED`" }, "payment_method_type": { "type": "string", "x-stoplight": { "id": "xuj8ekk9db8s8" }, "description": "Indicates the payment method type. Usually, bank_transfer." } } }, "examples": { "Example 1": { "value": { "beneficiary_fiat_account_id": "123e4567-e89b-12d3-a456-4bedc4266abc", "created_at": "2019-08-24T14:15:22Z", "currency": "ARS", "account_fields": { "alias_or_cvu_destination": "0000465160000000013330" }, "status": "ENABLED", "payment_method_type": "bank_transfer" } } } } } } }, "operationId": "get-api-v1-end-users-end_user_id-beneficiary-fiat-accounts-beneficiary_fiat_account_id", "description": "This endpoint allows to retrieve an end user's beneficiary fiat accounts details.", "x-extension-1": null, "security": [ { "OAuth2": [ "read" ] } ], "x-stoplight": { "id": "a0bzn5l3ltsuz" } } }, "/api/v1/end-users/{end_user_id}/fiat-accounts/": { "parameters": [ { "schema": { "type": "string" }, "name": "end_user_id", "in": "path", "required": true, "description": "End user's external ref, usually a uuid." } ], "post": { "summary": "Create Fiat Account", "tags": [ "Fiat Accounts" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "x-stoplight": { "id": "d9qpc1i58mwmt" }, "type": "object", "x-examples": { "Enabled Fiat Account": { "fiat_account_id": "123e4567-e89b-12d3-a456-4bedc4266abc", "created_at": "2019-08-24T14:15:22Z", "currency": "ARS", "fiat_payment_instructions": { "cvu": "0000465160000000013330" }, "payment_method_type": "bank_transfer", "status": "ENABLED", "end_user_id": "customer_10" }, "Processing Fiat Account": { "fiat_account_id": "123e4567-e89b-12d3-a456-4bedc4266abc", "created_at": "2019-08-24T14:15:22Z", "currency": "ARS", "fiat_payment_instructions": { "cvu": null }, "payment_method_type": "bank_transfer", "status": "PROCESSING", "end_user_id": "customer_10" } }, "properties": { "fiat_account_id": { "type": "string", "x-stoplight": { "id": "s81hi7swzftug" }, "example": "123e4567-e89b-12d3-a456-4bedc4266abc", "description": "UUID4 formated unique id.", "format": "uuid" }, "created_at": { "type": "string", "x-stoplight": { "id": "85bbhruk52d09" }, "format": "date-time", "description": "ISO DateTime indicating Fiat Account creation date", "example": "2019-08-24T14:15:22Z" }, "currency": { "type": "string", "x-stoplight": { "id": "2rc25kzh0722j" }, "description": "It defines the currency that the Fiat Account accepts.", "example": "ARS", "minLength": 3, "maxLength": 3 }, "fiat_payment_instructions": { "type": "object", "x-stoplight": { "id": "4uked55vjse1q" }, "minProperties": 1, "description": "JSON fields with account identification details.\nIt varies based on the account type.\nExample:\n```json\n{\"cvu\": \"0000465160000000013330\"}\n```", "properties": { "cvu": { "type": "string", "x-stoplight": { "id": "obshnce7b8ryz" }, "description": "Example for ARS Accounts.", "nullable": true } } }, "payment_method_type": { "type": "string", "x-stoplight": { "id": "xuj8ekk9db8s8" }, "description": "Indicates the payment method type. Usually, bank_transfer." }, "status": { "x-stoplight": { "id": "c015x74kbx7v0" }, "enum": [ "PROCESSING", "ENABLED" ], "description": "Indicates the Fiat Account status. Only when \"ENABLED\", the fiat payment instructions will be provided." }, "end_user_id": { "type": "string", "description": "End user's external ref" } } }, "examples": { "Processing Fiat Account": { "value": { "fiat_account_id": "123e4567-e89b-12d3-a456-4bedc4266abc", "created_at": "2019-08-24T14:15:22Z", "currency": "ARS", "fiat_payment_instructions": { "cvu": null }, "payment_method_type": "bank_transfer", "status": "PROCESSING", "end_user_id": "customer_10" } } } } } } }, "operationId": "post-api-v1-end-users-end_user_id-fiat-accounts", "description": "This endpoint allows you to create a Fiat Account.\nA Fiat Account allows an end user to transfer FIAT money to ripio B2B environment.\nSuch money will be used, later, to fulfill orders.\nWhile a process or flow may be technically feasible, it does not necessarily mean it is legally, financially, or operationally viable. These aspects must be reviewed and validated by the respective areas before implementation.\nThis endpoint behaves asynchronously, don't expect the Fiat Account to be created after the request execution.\nTo check for its completion, use the [Retrieve Fiat Account endpoint](#operation/get-api-v1-end-users-end_user_id-fiat-accounts-fiat_account_id).\nWhen the fiat account is created, a webhook will be sent. See BaaS Webhook in the documentation.\n", "security": [ { "OAuth2": [ "write" ] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "payment_method_type": { "type": "string", "description": "It indicates the account type. Usually bank_transfer." } } }, "examples": { "Example 1": { "value": { "payment_method_type": "bank_transfer" } } } } } }, "x-stoplight": { "id": "pml9q8j0pwf0d" } }, "get": { "summary": "List Fiat Account", "tags": [ "Fiat Accounts" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "x-stoplight": { "id": "d9qpc1i58mwmt" }, "type": "object", "x-examples": { "Enabled Fiat Account": { "fiat_account_id": "123e4567-e89b-12d3-a456-4bedc4266abc", "created_at": "2019-08-24T14:15:22Z", "currency": "ARS", "fiat_payment_instructions": { "cvu": "0000465160000000013330" }, "payment_method_type": "bank_transfer", "status": "ENABLED", "end_user_id": "customer_10" }, "Processing Fiat Account": { "fiat_account_id": "123e4567-e89b-12d3-a456-4bedc4266abc", "created_at": "2019-08-24T14:15:22Z", "currency": "ARS", "fiat_payment_instructions": { "cvu": null }, "payment_method_type": "bank_transfer", "status": "PROCESSING", "end_user_id": "customer_10" } }, "properties": { "fiat_account_id": { "type": "string", "x-stoplight": { "id": "s81hi7swzftug" }, "example": "123e4567-e89b-12d3-a456-4bedc4266abc", "description": "UUID4 formated unique id.", "format": "uuid" }, "created_at": { "type": "string", "x-stoplight": { "id": "85bbhruk52d09" }, "format": "date-time", "description": "ISO DateTime indicating Fiat Account creation date", "example": "2019-08-24T14:15:22Z" }, "currency": { "type": "string", "x-stoplight": { "id": "2rc25kzh0722j" }, "description": "It defines the currency that the Fiat Account accepts.", "example": "ARS", "minLength": 3, "maxLength": 3 }, "fiat_payment_instructions": { "type": "object", "x-stoplight": { "id": "4uked55vjse1q" }, "minProperties": 1, "description": "JSON fields with account identification details.\nIt varies based on the account type.\nExample:\n```json\n{\"cvu\": \"0000465160000000013330\"}\n```", "properties": { "cvu": { "type": "string", "x-stoplight": { "id": "obshnce7b8ryz" }, "description": "Example for ARS Accounts.", "nullable": true } } }, "payment_method_type": { "type": "string", "x-stoplight": { "id": "xuj8ekk9db8s8" }, "description": "Indicates the payment method type. Usually, bank_transfer." }, "status": { "x-stoplight": { "id": "c015x74kbx7v0" }, "enum": [ "PROCESSING", "ENABLED" ], "description": "Indicates the Fiat Account status. Only when \"ENABLED\", the fiat payment instructions will be provided." }, "end_user_id": { "type": "string", "description": "End user's external ref" } } } }, "examples": { "Example 1": { "value": [ { "fiat_account_id": "123e4567-e89b-12d3-a456-4bedc4266abc", "created_at": "2019-08-24T14:15:22Z", "currency": "ARS", "fiat_payment_instructions": { "cvu": null }, "payment_method_type": "bank_transfer", "status": "PROCESSING", "end_user_id": "customer_10" }, { "fiat_account_id": "4567e123-e89b-12d3-a456-4bedc4266abc", "created_at": "2020-08-24T14:15:22Z", "currency": "ARS", "fiat_payment_instructions": { "cvu": "0000465160000000013330" }, "payment_method_type": "bank_transfer", "status": "ENABLED", "end_user_id": "customer_10" } ] } } } } } }, "operationId": "get-api-v1-end-users-end_user_id-fiat-accounts", "description": "This endpoint allows to fetch a list of the given user's fiat accounts.", "x-extension-1": null, "security": [ { "OAuth2": [ "read" ] } ], "parameters": [], "x-stoplight": { "id": "jl05qfqigsq8l" } } }, "/api/v1/end-users/{end_user_id}/fiat-accounts/{fiat_account_id}/": { "parameters": [ { "schema": { "type": "string" }, "name": "end_user_id", "in": "path", "required": true, "description": "End user's external ref, usually a uuid." }, { "schema": { "type": "string", "format": "uuid" }, "name": "fiat_account_id", "in": "path", "required": true, "description": "Fiat Account ID (UUID)" } ], "get": { "summary": "Retrieve Fiat Account", "tags": [ "Fiat Accounts" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "x-stoplight": { "id": "d9qpc1i58mwmt" }, "type": "object", "x-examples": { "Enabled Fiat Account": { "fiat_account_id": "123e4567-e89b-12d3-a456-4bedc4266abc", "created_at": "2019-08-24T14:15:22Z", "currency": "ARS", "fiat_payment_instructions": { "cvu": "0000465160000000013330" }, "payment_method_type": "bank_transfer", "status": "ENABLED", "end_user_id": "customer_10" }, "Processing Fiat Account": { "fiat_account_id": "123e4567-e89b-12d3-a456-4bedc4266abc", "created_at": "2019-08-24T14:15:22Z", "currency": "ARS", "fiat_payment_instructions": { "cvu": null }, "payment_method_type": "bank_transfer", "status": "PROCESSING", "end_user_id": "customer_10" } }, "properties": { "fiat_account_id": { "type": "string", "x-stoplight": { "id": "s81hi7swzftug" }, "example": "123e4567-e89b-12d3-a456-4bedc4266abc", "description": "UUID4 formated unique id.", "format": "uuid" }, "created_at": { "type": "string", "x-stoplight": { "id": "85bbhruk52d09" }, "format": "date-time", "description": "ISO DateTime indicating Fiat Account creation date", "example": "2019-08-24T14:15:22Z" }, "currency": { "type": "string", "x-stoplight": { "id": "2rc25kzh0722j" }, "description": "It defines the currency that the Fiat Account accepts.", "example": "ARS", "minLength": 3, "maxLength": 3 }, "fiat_payment_instructions": { "type": "object", "x-stoplight": { "id": "4uked55vjse1q" }, "minProperties": 1, "description": "JSON fields with account identification details.\nIt varies based on the account type.\nExample:\n```json\n{\"cvu\": \"0000465160000000013330\"}\n```", "properties": { "cvu": { "type": "string", "x-stoplight": { "id": "obshnce7b8ryz" }, "description": "Example for ARS Accounts.", "nullable": true } } }, "payment_method_type": { "type": "string", "x-stoplight": { "id": "xuj8ekk9db8s8" }, "description": "Indicates the payment method type. Usually, bank_transfer." }, "status": { "x-stoplight": { "id": "c015x74kbx7v0" }, "enum": [ "PROCESSING", "ENABLED" ], "description": "Indicates the Fiat Account status. Only when \"ENABLED\", the fiat payment instructions will be provided." }, "end_user_id": { "type": "string", "description": "End user's external ref" } } }, "examples": { "Enabled Fiat Account": { "value": { "fiat_account_id": "123e4567-e89b-12d3-a456-4bedc4266abc", "created_at": "2019-08-24T14:15:22Z", "currency": "ARS", "payment_inscructions": { "cvu": "0000465160000000013330" }, "payment_method_type": "bank_transfer", "status": "ENABLED", "end_user_id": "customer_10" } }, "Processing Fiat Accoount": { "value": { "fiat_account_id": "123e4567-e89b-12d3-a456-4bedc4266abc", "created_at": "2019-08-24T14:15:22Z", "currency": "ARS", "payment_inscructions": { "cvu": null }, "payment_method_type": "bank_transfer", "status": "PROCESSING", "end_user_id": "customer_10" } } } } } } }, "operationId": "get-api-v1-end-users-end_user_id-fiat-accounts-fiat_account_id", "description": "This endpoint allows to retrieve an end user's fiat accounts details.", "security": [ { "OAuth2": [ "read" ] } ], "x-stoplight": { "id": "225qmrbkf3s6b" } } }, "/api/v1/fiat-withdrawals/": { "post": { "summary": "Create Fiat Withdrawal", "operationId": "createFiatWithdrawal", "description": "This endpoint allows the creation of a Fiat withdrawal. It will debit from the end user's currency's balance and withdraw such amount to the specified [beneficiary account](#tag/Beneficiary-Fiat-Accounts).\nThis endpoint behaves asynchronously, don't expect the withdrawal to be completed after the request execution.\nTo check for its completion, use the [Retrieve Fiat Withdrawal endpoint](#operation/get-api-v1-fiat-withdrawals-fiat_withdrawal_id).\nUpdates for Fiat Withdrawals will be communicated via IPN webhooks. See IPN Webhooks in the documentation.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "end_user_id": { "type": "string", "description": "End user's external ref", "x-stoplight": { "id": "9z26glgp5758t" } }, "amount": { "type": "number", "description": "Amount to withdrawal. Is the amount that the destination account will receive." }, "external_ref": { "type": "string", "description": "An external identifier, usually a unique UUID" }, "beneficiary_fiat_account_id": { "type": "string", "description": "Indicates the beneficiary fiat account to be used as withdraw destination.", "x-stoplight": { "id": "pihzx5h7uqbf6" } } } }, "examples": { "Example 1": { "value": { "end_user_id": "customer_10", "amount": 12345.67, "external_ref": "ac243840-ac04-4b3a-9efb-176554d4a029", "beneficiary_fiat_account_id": "4123e456-e89b-12d3-a456-4bedc4266abc" } } } }, "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" } } } } }, "description": "" }, "tags": [ "Fiat Withdrawals" ], "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "x-stoplight": { "id": "0wbcetvw4kba3" }, "title": "Fiat Withdrawal Response", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as fiat withdrawal identifier." }, "transaction_id": { "type": "string", "format": "uuid", "description": "UUID used as fiat withdrawal's transaction identifier.", "x-stoplight": { "id": "6vus6y337rz80" } }, "created_at": { "type": "string", "format": "date-time", "description": "Indicates the fiat withdrawal creation date." }, "updated_at": { "type": "string", "format": "date-time", "description": "Indicates the fiat withdrawal's latest update date.", "x-stoplight": { "id": "jll5xu2mfb3wq" } }, "end_user_id": { "type": "string", "description": "End user's external ref, usually a uuid. Identifies the user that owns this operation." }, "currency_code": { "type": "string", "description": "Indicates the asset name involved in the fiat withdrawal." }, "amount": { "type": "string", "description": "Indicates the fiat amount withdrawed." }, "status": { "type": "string", "description": "Specifies the fiat withdrawal status.", "enum": [ "PENDING", "COMPLETED", "CANCELLED" ] }, "external_ref": { "type": "string", "maxLength": 128, "x-stoplight": { "id": "pgofwctmovzxm" }, "description": "Client side identification reference. Usually a UUID." }, "beneficiary_fiat_account_id": { "type": "string", "x-stoplight": { "id": "7ypgmzak2txsi" }, "format": "uuid", "description": "UUID used as beneficiary fiat account identifier." }, "is_fiat_deposit_refund": { "type": "boolean", "description": "Shows if the fiat withdrawal corresponds to the refund of a fiat deposit." }, "refunded_fiat_deposit": { "type": "string", "format": "uuid", "description": "UUID from a refunded fiat deposit, it could be null." } } }, "examples": { "Example 1": { "value": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "end_user_id": "customer_10", "amount": "12345.67", "currency_code": "ARS", "status": "PENDING", "external_ref": "ac243840-ac04-4b3a-9efb-176554d4a029", "beneficiary_fiat_account_id": "4123e456-e89b-12d3-a456-4bedc4266abc", "is_fiat_deposit_refund": false, "refunded_fiat_deposit": null } } } } } } }, "x-stoplight": { "id": "vw7uim8tlbqkg" }, "security": [ { "OAuth2": [ "write" ] } ] }, "get": { "summary": "List Fiat Withdrawals", "operationId": "get-api-v1-fiat-withdrawals", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "example": 123, "description": "Indicates total count of fiat withdrawals." }, "next": { "type": "string", "format": "uri", "example": "http://api.example.org/accounts/?page=4", "description": "Indicates next page by URL.", "nullable": true }, "previous": { "type": "string", "format": "uri", "example": "http://api.example.org/accounts/?page=2", "description": "Indicates previous page by URL.", "nullable": true }, "results": { "type": "array", "description": "List of fetched withdrawals.", "items": { "type": "object", "x-stoplight": { "id": "0wbcetvw4kba3" }, "title": "Fiat Withdrawal Response", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as fiat withdrawal identifier." }, "transaction_id": { "type": "string", "format": "uuid", "description": "UUID used as fiat withdrawal's transaction identifier.", "x-stoplight": { "id": "6vus6y337rz80" } }, "created_at": { "type": "string", "format": "date-time", "description": "Indicates the fiat withdrawal creation date." }, "updated_at": { "type": "string", "format": "date-time", "description": "Indicates the fiat withdrawal's latest update date.", "x-stoplight": { "id": "jll5xu2mfb3wq" } }, "end_user_id": { "type": "string", "description": "End user's external ref, usually a uuid. Identifies the user that owns this operation." }, "currency_code": { "type": "string", "description": "Indicates the asset name involved in the fiat withdrawal." }, "amount": { "type": "string", "description": "Indicates the fiat amount withdrawed." }, "status": { "type": "string", "description": "Specifies the fiat withdrawal status.", "enum": [ "PENDING", "COMPLETED", "CANCELLED" ] }, "external_ref": { "type": "string", "maxLength": 128, "x-stoplight": { "id": "pgofwctmovzxm" }, "description": "Client side identification reference. Usually a UUID." }, "beneficiary_fiat_account_id": { "type": "string", "x-stoplight": { "id": "7ypgmzak2txsi" }, "format": "uuid", "description": "UUID used as beneficiary fiat account identifier." }, "is_fiat_deposit_refund": { "type": "boolean", "description": "Shows if the fiat withdrawal corresponds to the refund of a fiat deposit." }, "refunded_fiat_deposit": { "type": "string", "format": "uuid", "description": "UUID from a refunded fiat deposit, it could be null." } } } } } }, "examples": { "Example 1": { "value": { "count": 123, "next": "https://sandbox-b2b.ripio.com/api/v1/fiat-withdrawals/?page=3", "previous": "https://sandbox-b2b.ripio.com/api/v1/fiat-withdrawals/?page=1", "results": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "end_user_id": "customer_10", "amount": "12345.67", "currency_code": "ARS", "status": "PENDING", "external_ref": "ac243840-ac04-4b3a-9efb-176554d4a029", "beneficiary_fiat_account_id": "4123e456-e89b-12d3-a456-4bedc4266abc", "is_fiat_deposit_refund": false, "refunded_fiat_deposit": null }, { "id": "62764993-497f-6f08-53cb-bfebbbba6eca", "transaction_id": "6c825224-99cf-5232-b197-18490fec1e58", "created_at": "2020-08-24T14:15:22Z", "updated_at": "2020-08-24T15:15:22Z", "end_user_id": "customer_11", "amount": "1234.56", "currency_code": "ARS", "status": "COMPLETED", "external_ref": "176554d4-a029-9efb-4b3a-ac243840ac04", "beneficiary_fiat_account_id": "a456e89b-e456-6abc-4123-12d34bedc426", "is_fiat_deposit_refund": false, "refunded_fiat_deposit": null } ] } } } } }, "description": "Successful Response" } }, "description": "Endpoint that lists every fiat withdrawal operation.", "tags": [ "Fiat Withdrawals" ], "parameters": [ { "schema": { "type": "string", "enum": [ "PENDING", "COMPLETED", "CANCELLED" ] }, "in": "query", "name": "status", "description": "Filters by status of the fiat withdrawal operations." }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "create_date_lte", "description": "Filter fiat withdrawal operations by create_date less than or equal to this date." }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "create_date_gte", "description": "Filter fiat withdrawal operations by create_date greater than or equal to this date." }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "update_date_lte", "description": "Filter fiat withdrawal operations by update_date less than or equal to this date." }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "update_date_gte", "description": "Filter fiat withdrawal operations by update_date greater than or equal to this date." }, { "schema": { "type": "string" }, "in": "query", "name": "end_user_id", "description": "Filter fiat withdrawal operations by end_user_id." } ], "x-stoplight": { "id": "dcogqwueapwnw" } }, "parameters": [] }, "/api/v1/fiat-withdrawals/{fiat_withdrawal_id}/": { "get": { "summary": "Retrieve Fiat Withdrawal", "tags": [ "Fiat Withdrawals" ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "x-stoplight": { "id": "0wbcetvw4kba3" }, "title": "Fiat Withdrawal Response", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as fiat withdrawal identifier." }, "transaction_id": { "type": "string", "format": "uuid", "description": "UUID used as fiat withdrawal's transaction identifier.", "x-stoplight": { "id": "6vus6y337rz80" } }, "created_at": { "type": "string", "format": "date-time", "description": "Indicates the fiat withdrawal creation date." }, "updated_at": { "type": "string", "format": "date-time", "description": "Indicates the fiat withdrawal's latest update date.", "x-stoplight": { "id": "jll5xu2mfb3wq" } }, "end_user_id": { "type": "string", "description": "End user's external ref, usually a uuid. Identifies the user that owns this operation." }, "currency_code": { "type": "string", "description": "Indicates the asset name involved in the fiat withdrawal." }, "amount": { "type": "string", "description": "Indicates the fiat amount withdrawed." }, "status": { "type": "string", "description": "Specifies the fiat withdrawal status.", "enum": [ "PENDING", "COMPLETED", "CANCELLED" ] }, "external_ref": { "type": "string", "maxLength": 128, "x-stoplight": { "id": "pgofwctmovzxm" }, "description": "Client side identification reference. Usually a UUID." }, "beneficiary_fiat_account_id": { "type": "string", "x-stoplight": { "id": "7ypgmzak2txsi" }, "format": "uuid", "description": "UUID used as beneficiary fiat account identifier." }, "is_fiat_deposit_refund": { "type": "boolean", "description": "Shows if the fiat withdrawal corresponds to the refund of a fiat deposit." }, "refunded_fiat_deposit": { "type": "string", "format": "uuid", "description": "UUID from a refunded fiat deposit, it could be null." } } }, "examples": { "Example 1": { "value": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:18:22Z", "end_user_id": "customer_10", "amount": "12345.67", "currency_code": "ARS", "status": "COMPLETED", "external_ref": "ac243840-ac04-4b3a-9efb-176554d4a029", "beneficiary_fiat_account_id": "4123e456-e89b-12d3-a456-4bedc4266abc", "is_fiat_deposit_refund": false, "refunded_fiat_deposit": null } } } } } } }, "operationId": "get-api-v1-fiat-withdrawals-fiat_withdrawal_id", "description": "Endpoint that retrieves an specific fiat withdrawal given a fiat withdrawal ID.\n\n**Note**:\nWe offer the capability to set a Webhook URL in order to be notified in real time. Please note that you should expect a payload format similar to the one below. See IPN Webhooks in the documentation.", "x-stoplight": { "id": "jmzbb8bdnxmkx" }, "security": [ { "OAuth2": [ "read" ] } ] }, "parameters": [ { "schema": { "type": "string" }, "name": "fiat_withdrawal_id", "in": "path", "required": true } ] }, "/api/v1/fiat-deposits/": { "get": { "summary": "List Fiat Deposits", "tags": [ "Fiat Deposits" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "example": 123, "description": "Indicates total count of fiat deposits." }, "next": { "type": "string", "format": "uri", "example": "http://api.example.org/accounts/?page=4", "description": "Indicates next page by URL.", "nullable": true }, "previous": { "type": "string", "format": "uri", "example": "http://api.example.org/accounts/?page=2", "description": "Indicates previous page by URL.", "nullable": true }, "results": { "type": "array", "description": "List of fetched fiat deposits.", "items": { "type": "object", "x-stoplight": { "id": "qze975pae5vz3" }, "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID for this fiat deposit." }, "created_at": { "type": "string", "minLength": 1, "description": "Indicates the creation date of the fiat deposit." }, "updated_at": { "type": "string", "minLength": 1, "description": "Indicates the update date of the fiat deposit." }, "currency_code": { "type": "string", "minLength": 1, "description": "Indicates the currency that has been deposited." }, "end_user_id": { "type": "string", "description": "End user's external ref, usually a uuid. Indicates the end user that has received the fiat deposit." }, "amount": { "type": "string", "description": "Indicates the amount deposited." }, "status": { "type": "string", "enum": [ "COMPLETED", "CANCELLED", "BLOCKED_LIMIT_EXCEEDED" ] }, "refunded": { "type": "boolean", "description": "Indicates if the fiat deposit was refunded." }, "refund_fiat_withdrawal_id": { "type": "string", "format": "uuid", "description": "Indicates the fiat withdrawal id associated with the refund, could be null." }, "origin_account_identifier": { "type": "string", "description": "Indicates the identifier of the fiat deposit's issuing account." }, "origin_account_holder_id": { "type": "string", "description": "Indicates the identification of the fiat deposit's issuing account holder." }, "origin_account_holder_name": { "type": "string", "description": "Indicates the name of the fiat deposit's issuing account holder." } } } } } }, "examples": { "Succesful Response": { "value": { "count": 123, "next": "https://sandbox-b2b.ripio.com/api/v1/fiat-deposits/?page=3", "previous": "https://sandbox-b2b.ripio.com/api/v1/fiat-deposits/?page=1", "results": [ { "id": "8142b065-79c4-4f48-9e33-11b17bc658d4", "created_at": "2024-04-23T14:48:33.895551Z", "updated_at": "2024-04-23T14:49:25.342111Z", "currency_code": "ARS", "end_user_id": "customer_10", "amount": "12345.67", "status": "PENDING", "refunded": false, "refund_fiat_withdrawal_id": null, "origin_account_identifier": "0000465160000000100092", "origin_account_holder_id": "20388003629", "origin_account_holder_name": "Carlos Pineda" }, { "id": "11b17bc6-58d4-9e33-4f48-8142b06579c4", "created_at": "2024-03-22T04:32:13.453726Z", "updated_at": "2024-03-22T04:33:45.748327Z", "currency_code": "ARS", "end_user_id": "customer_10", "amount": "1234.56", "status": "COMPLETED", "refunded": false, "refund_fiat_withdrawal_id": null, "origin_account_identifier": "0000465160000000100092", "origin_account_holder_id": "20388003629", "origin_account_holder_name": "Carlos Pineda" } ] } } } } }, "description": "" } }, "operationId": "get-api-v1-fiat-deposits", "description": "Endpoint that list all the fiat deposits received.\n\n**Note**:\n\nThis endpoints allows to poll or reconcile fiat deposited transactions.\nWe offer the capability to set a Webhook URL in order to be notified in real time. See IPN Webhooks in the documentation.\n", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "create_date_lte", "description": "Filter fiat deposit operations by create_date less than or equal to this date." }, { "schema": { "type": "string" }, "in": "query", "name": "create_date_gte", "description": "Filter fiat deposit operations by create_date greater than or equal to this date." }, { "schema": { "type": "string" }, "in": "query", "name": "end_user_id", "description": "End User that has received deposits." }, { "schema": { "type": "array", "items": { "type": "string" } }, "in": "query", "name": "currency_code_in", "description": "Currency codes that has been deposited." }, { "schema": { "type": "string" }, "in": "query", "name": "page", "description": "Pagination QueryParam." }, { "schema": { "type": "string" }, "in": "query", "name": "update_date_lte", "description": "Filter fiat deposit operations by update_date less than or equal to this date." }, { "schema": { "type": "string" }, "in": "query", "name": "update_date_gte", "description": "Filter fiat deposit operations by update_date greater than or equal to this date." } ], "x-stoplight": { "id": "bl1riyus8tm6r" } }, "parameters": [] }, "/api/v1/fiat-deposits/{fiat_deposit_id}/": { "parameters": [ { "schema": { "type": "string" }, "name": "fiat_deposit_id", "in": "path", "required": true } ], "get": { "summary": "Retrieve Fiat Deposit", "tags": [ "Fiat Deposits" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "x-stoplight": { "id": "qze975pae5vz3" }, "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID for this fiat deposit." }, "created_at": { "type": "string", "minLength": 1, "description": "Indicates the creation date of the fiat deposit." }, "updated_at": { "type": "string", "minLength": 1, "description": "Indicates the update date of the fiat deposit." }, "currency_code": { "type": "string", "minLength": 1, "description": "Indicates the currency that has been deposited." }, "end_user_id": { "type": "string", "description": "End user's external ref, usually a uuid. Indicates the end user that has received the fiat deposit." }, "amount": { "type": "string", "description": "Indicates the amount deposited." }, "status": { "type": "string", "enum": [ "COMPLETED", "CANCELLED", "BLOCKED_LIMIT_EXCEEDED" ] }, "refunded": { "type": "boolean", "description": "Indicates if the fiat deposit was refunded." }, "refund_fiat_withdrawal_id": { "type": "string", "format": "uuid", "description": "Indicates the fiat withdrawal id associated with the refund, could be null." }, "origin_account_identifier": { "type": "string", "description": "Indicates the identifier of the fiat deposit's issuing account." }, "origin_account_holder_id": { "type": "string", "description": "Indicates the identification of the fiat deposit's issuing account holder." }, "origin_account_holder_name": { "type": "string", "description": "Indicates the name of the fiat deposit's issuing account holder." } } }, "examples": { "Example 1": { "value": { "id": "8142b065-79c4-4f48-9e33-11b17bc658d4", "created_at": "2024-04-23T14:48:33.895551Z", "updated_at": "2024-04-23T14:49:25.342111Z", "currency_code": "ARS", "end_user_id": "customer_10", "amount": "12345.67", "status": "PENDING", "refunded": false, "refund_fiat_withdrawal_id": null, "origin_account_identifier": "0000465160000000100092", "origin_account_holder_id": "20388003629", "origin_account_holder_name": "Carlos Pineda" } } } } } } }, "operationId": "get-api-v1-fiat-deposits-deposit_id", "description": "Endpoint that retrieves details of a received fiat deposit by its id.\nWe offer the capability to set a Webhook URL in order to be notified in real time. See IPN Webhooks in the documentation.", "x-stoplight": { "id": "i71i0oejroq4c" }, "security": [ { "OAuth2": [ "read" ] } ] } }, "/api/v1/kyc-requirements": { "get": { "summary": "KYC Requirements", "tags": [ "KYC Requirements" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "examples": { "Example 1": { "value": { "kyc_required_fields": [ { "field_name": "country", "required": true, "type": "CHOICE", "choices": [ { "value": "AR", "label": "Argentina" } ] }, { "field_name": "first_name", "required": true, "type": "TEXT" }, { "field_name": "last_name", "required": true, "type": "TEXT" }, { "field_name": "gender", "required": true, "type": "CHOICE", "choices": [ { "value": "M", "label": "Male" }, { "value": "F", "label": "Female" } ] }, { "field_name": "birthday", "required": true, "type": "DATE" }, { "field_name": "nationality", "required": true, "type": "TEXT" }, { "field_name": "id_number", "required": true, "type": "NUMERIC" }, { "field_name": "address", "required": true, "type": "TEXT" }, { "field_name": "address_flat", "required": false, "type": "TEXT" }, { "field_name": "address_number", "required": true, "type": "NUMERIC" }, { "field_name": "postal_code", "required": true, "type": "TEXT" }, { "field_name": "city", "required": true, "type": "TEXT" }, { "field_name": "state", "required": true, "type": "CHOICE", "choices": [ { "value": "AR.BA", "label": "Buenos Aires" }, { "value": "AR.CT", "label": "Catamarca" }, { "value": "AR.CC", "label": "Chaco" }, { "value": "AR.CH", "label": "Chubut" }, { "value": "AR.DF", "label": "Ciudad de Buenos Aires" }, { "value": "AR.CB", "label": "Córdoba" }, { "value": "AR.CN", "label": "Corrientes" }, { "value": "AR.ER", "label": "Entre Ríos" }, { "value": "AR.FM", "label": "Formosa" }, { "value": "AR.JY", "label": "Jujuy" }, { "value": "AR.LP", "label": "La Pampa" }, { "value": "AR.LR", "label": "La Rioja" }, { "value": "AR.MZ", "label": "Mendoza" }, { "value": "AR.MN", "label": "Misiones" }, { "value": "AR.NQ", "label": "Neuquén" }, { "value": "AR.RN", "label": "Río Negro" }, { "value": "AR.SA", "label": "Salta" }, { "value": "AR.SJ", "label": "San Juan" }, { "value": "AR.SL", "label": "San Luis" }, { "value": "AR.SC", "label": "Santa Cruz" }, { "value": "AR.SF", "label": "Santa Fe" }, { "value": "AR.SE", "label": "Santiago del Estero" }, { "value": "AR.TF", "label": "Tierra del Fuego" }, { "value": "AR.TM", "label": "Tucumán" } ] }, { "field_name": "phone", "required": true, "type": "TEXT" }, { "field_name": "registered_tax_payer", "required": false, "type": "BOOLEAN" }, { "field_name": "cuit", "required": true, "type": "TEXT" }, { "field_name": "net_income", "required": false, "type": "CHOICE", "choices": [ { "label": "Menos de 3.000.000 ARS", "value": "AR.A" }, { "label": "3.000.000 a 5.000.000 ARS", "value": "AR.B" }, { "label": "5.000.000 a 8.000.000 ARS", "value": "AR.C" }, { "label": "8.000.000 a 11.000.000 ARS", "value": "AR.D" }, { "label": "11.000.000 a 15.000.000 ARS", "value": "AR.E" }, { "label": "Más de 15.000.000 ARS", "value": "AR.F" } ] }, { "field_name": "personal_activity", "required": true, "type": "CHOICE", "choices": [ { "value": "AR.1", "label": "Empleado del Sector Privado" }, { "value": "AR.2", "label": "Empleado del Sector Público" }, { "value": "AR.3", "label": "Monotributista" }, { "value": "AR.4", "label": "Autonomo" }, { "value": "AR.5", "label": "Jubilado/ Pensionado" }, { "value": "AR.6", "label": "Estudiante/ Ama de Casa/ Desempleado" } ] }, { "field_name": "personal_activity_other", "required": false, "type": "CHOICE", "choices": [ { "value": "AR.1", "label": "Fabricación de joyas finas, bijouterie y artículos conexos" }, { "value": "AR.2", "label": "Pompas fúnebres y servicios conexos" }, { "value": "AR.3", "label": "Servicio de transporte aéreo de pasajeros y/o de cargas" }, { "value": "AR.4", "label": "Servicio de transporte automotor de mercaderías a granel, cereales, animales y/o sustancias peligrosas" }, { "value": "AR.5", "label": "Servicio de transporte ferroviario/automotor" }, { "value": "AR.6", "label": "Servicio de transporte marítimo/fluvial y lacustre" }, { "value": "AR.7", "label": "Servicios auxiliares a la intermediación financiera" }, { "value": "AR.8", "label": "Servicios de administración de consorcios de edificios" }, { "value": "AR.9", "label": "Servicios de alojamiento por hora, temporal, en campings, pensiones, hoteles, hosterías y/o residenciales similares" }, { "value": "AR.10", "label": "Servicios de asociaciones" }, { "value": "AR.11", "label": "Servicios de centros de estética, spa y similares" }, { "value": "AR.12", "label": "Servicios de comidas \"fast food\", comida para llevar, helados, realizadas por/para vendedores ambulantes o para empresas y eventos" }, { "value": "AR.13", "label": "Servicios de consorcios de edificios" }, { "value": "AR.14", "label": "Servicios de cooperativas cuando realizan varias actividades" }, { "value": "AR.15", "label": "Servicios de desarrollo de software y/o portales web" }, { "value": "AR.16", "label": "Servicios de emergencias y traslados" }, { "value": "AR.17", "label": "Servicios de enseñanza" }, { "value": "AR.18", "label": "Servicios de entretenimiento" }, { "value": "AR.19", "label": "Servicios de financiación y actividades financieras, o fondos y sociedades de inversión y entidades financieras similares" }, { "value": "AR.20", "label": "Servicios de gestión de fondos a cambio de una retribución o por contratación" }, { "value": "AR.21", "label": "Servicios de intermediación financiera realizada por financieras, sociedades de ahorro y préstamo, o cajas de crédito" }, { "value": "AR.22", "label": "Servicios de la banca central, minorista, mayorista o de inversion" }, { "value": "AR.23", "label": "Servicios de limpieza de prendas prestado por tintorerías rápidas" }, { "value": "AR.24", "label": "Servicios de mudanza" }, { "value": "AR.25", "label": "Servicios de mutuales, excepto mutuales de salud y financieras" }, { "value": "AR.26", "label": "Servicios de organización de convenciones y exposiciones comerciales, excepto culturales y deportivos" }, { "value": "AR.27", "label": "Servicios de organización, dirección y gestión de prácticas deportivas en clubes, espectáculos deportivos" }, { "value": "AR.28", "label": "Servicios de organizaciones empresariales y de empleadores, o profesionales" }, { "value": "AR.29", "label": "Servicios de organizaciones políticas" }, { "value": "AR.30", "label": "Servicios de organizaciones religiosas" }, { "value": "AR.31", "label": "Servicios de organizaciones y órganos extraterritoriales" }, { "value": "AR.32", "label": "Servicios de parques de diversiones y parques temáticos" }, { "value": "AR.33", "label": "Servicios de peluquería o tratamientos de belleza" }, { "value": "AR.34", "label": "Servicios de producción de espectáculos artísticos, teatrales y musicales" }, { "value": "AR.35", "label": "Servicios de restaurantes, cantinas y/o bares" }, { "value": "AR.36", "label": "Servicios de salones de juegos" }, { "value": "AR.37", "label": "Servicios de seguridad e investigación" }, { "value": "AR.38", "label": "Servicios de seguros de salud, vida o patrimoniales excepto los de las aseguradoras de riesgo de trabajo (ART)" }, { "value": "AR.39", "label": "Servicios de sindicatos" }, { "value": "AR.40", "label": "Servicios empresariales" }, { "value": "AR.41", "label": "Servicios inmobiliarios realizados por cuenta propia, con bienes urbanos/rurales propios o arrendados" }, { "value": "AR.42", "label": "Servicios jurídicos" }, { "value": "AR.43", "label": "Servicios personales" }, { "value": "AR.44", "label": "Servicios prestados por deportistas y atletas para la realización de prácticas deportivas" }, { "value": "AR.45", "label": "Servicios prestados por profesionales y técnicos para la realización de prácticas deportivas" }, { "value": "AR.46", "label": "Servicios relacionados a activos virtuales y/o criptominería" }, { "value": "AR.47", "label": "Servicios relacionados a la construcción, reforma y/o reparación de edificios, obras relacionadas al transporte y/o redes de servicios públicos" }, { "value": "AR.48", "label": "Servicios relacionados a la fabricación d productos químicos, medicamentos de uso humano y productos de uso farmacéutico" }, { "value": "AR.49", "label": "Servicios relacionados a la minería, metales preciosos y no ferrosos" }, { "value": "AR.50", "label": "Servicios relacionados a los reaseguros" }, { "value": "AR.51", "label": "Servicios relacionados a obras sociales" }, { "value": "AR.52", "label": "Servicios relacionados al arrendamiento y gestión de bienes intangibles no financieros" }, { "value": "AR.53", "label": "Servicios relacionados al procesamiento/ hospedaje de datos" }, { "value": "AR.54", "label": "Servicios relacionados con juegos de azar y apuestas" }, { "value": "AR.55", "label": "Venta al por mayor en comisión o consignación de madera y materiales para la construcción" }, { "value": "AR.56", "label": "Venta al por mayor en comisión o consignación de maquinaria, equipo profesional industrial y comercial, embarcaciones y aeronaves" }, { "value": "AR.57", "label": "Venta al por mayor en comisión o consignación de alimentos, bebidas y tabaco" }, { "value": "AR.58", "label": "Venta al por mayor en comisión o consignación de combustibles" }, { "value": "AR.59", "label": "Venta al por mayor en comisión o consignación de papel, cartón, libros, revistas, diarios, materiales de embalaje y artículos de librería" }, { "value": "AR.60", "label": "Venta al por mayor en comisión o consignación de productos agrícolas y/o pecuarios" }, { "value": "AR.61", "label": "Venta al por menor de productos alimenticios en comercios especializados" }, { "value": "AR.62", "label": "Venta al por menor no realizada en establecimientos" }, { "value": "AR.63", "label": "Venta, mantenimiento y/o reparación de vehículos automotores/motocicletas nuevos o al por mayor de partes, piezas y accesorios" }, { "value": "AR.64", "label": "Otro" } ] } ] } } } } } } }, "operationId": "get-api-v1-kyc-requirements", "x-stoplight": { "id": "5jphwtd3t8pm7" }, "description": "This endpoint returns a list of fields that needs to be provided on a KYC submission.\nThe response is structured in a list of fields so that an UI can be constructed from it.\n\nEach field has the following structure:\n```json\n\"field_name\": string,\n\"required\": boolean,\n\"type\": string (TEXT, BOOLEAN, DATE, NUMERIC, CHOICE),\n\"choices\": array\n\"value\": label,\n\"label\": string\n```" }, "parameters": [] }, "/api/v1/end-users/{end_user_id}/kyc": { "parameters": [ { "schema": { "type": "string" }, "name": "end_user_id", "in": "path", "required": true } ], "post": { "summary": "Create KYC Submission", "tags": [ "KYC Submissions" ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "title": "KYCSubmission", "x-stoplight": { "id": "jlk4ouomalkcw" }, "type": "object", "properties": { "submission_id": { "type": "string", "x-stoplight": { "id": "o1wm9zdofe7ve" }, "format": "uuid", "description": "KYC Submission unique identifier" }, "status": { "x-stoplight": { "id": "apsidzbaxj0x9" }, "enum": [ "COMPLETED", "IN_REVIEW", "FAILED", "UPDATE_REQUIRED" ], "description": "KYC Submission status." }, "provider_url": { "type": "string", "x-stoplight": { "id": "gpwvv15b82r7p" }, "description": "URL to redirect users in order for them upload or fulfill extra information. E.g: ID photo, proof of life, etc.\nMay be null if no further information is required.", "nullable": true }, "created_at": { "type": "string", "x-stoplight": { "id": "mrg9dnm7bs2jm" }, "format": "date-time", "description": "ISO format creation datetime" } } }, "examples": { "Example 1": { "value": { "submission_id": "945dfedc-ad7f-4af7-b20c-06082ffa3cb3", "status": "COMPLETED", "provider_url": "http://example.com", "created_at": "2019-08-24T14:15:22Z" } } } } } } }, "operationId": "post-api-v1-end-users-end_user_id-kyc", "x-stoplight": { "id": "zwnkpjh4f3ikw" }, "description": "This endpoint allows you to submit user's kyc information.\nThis endpoint behaves asynchronously, don't expect the KYC Submission to be approved after the request execution.\nTo check for its completion, use the [Retrieve KYC Submission endpoint](#operation/get-api-v1-end-users-end_user_id-kyc-submission_id).\nWhen the verification submission is completed, a webhook will be sent. See BaaS Webhook in the documentation.", "security": [ { "OAuth2": [ "write" ] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "x-stoplight": { "id": "08qvc7bnvspbv" }, "description": "End User's unique email." }, "kyc_submission": { "type": "object", "x-stoplight": { "id": "zktj1qvrw8y9j" }, "description": "Json formatted data with the information detailed on [KYC Requirements](/kyc-requirements/kyc-requirements)" } } }, "examples": { "Example 1": { "value": { "email": "some_unique_email@domain.com" } } } } } } }, "get": { "summary": "List KYC Submissions", "tags": [ "KYC Submissions" ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "KYCSubmission", "x-stoplight": { "id": "jlk4ouomalkcw" }, "type": "object", "properties": { "submission_id": { "type": "string", "x-stoplight": { "id": "o1wm9zdofe7ve" }, "format": "uuid", "description": "KYC Submission unique identifier" }, "status": { "x-stoplight": { "id": "apsidzbaxj0x9" }, "enum": [ "COMPLETED", "IN_REVIEW", "FAILED", "UPDATE_REQUIRED" ], "description": "KYC Submission status." }, "provider_url": { "type": "string", "x-stoplight": { "id": "gpwvv15b82r7p" }, "description": "URL to redirect users in order for them upload or fulfill extra information. E.g: ID photo, proof of life, etc.\nMay be null if no further information is required.", "nullable": true }, "created_at": { "type": "string", "x-stoplight": { "id": "mrg9dnm7bs2jm" }, "format": "date-time", "description": "ISO format creation datetime" } } } }, "examples": { "Example 1": { "value": [ { "submission_id": "945dfedc-ad7f-4af7-b20c-06082ffa3cb3", "status": "COMPLETED", "provider_url": "http://example.com", "created_at": "2019-08-24T14:15:22Z" } ] } } } } } }, "operationId": "get-api-v1-end-users-end_user_id-kyc", "x-stoplight": { "id": "o6f85sntvv06a" }, "description": "Endpoint that list an end user's KYC Submissions", "security": [ { "OAuth2": [ "read" ] } ] } }, "/api/v1/end-users/{end_user_id}/kyc/{submission_id}/": { "parameters": [ { "schema": { "type": "string" }, "name": "end_user_id", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "submission_id", "in": "path", "required": true } ], "get": { "summary": "Retrieve KYC Submission", "tags": [ "KYC Submissions" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "KYCSubmission", "x-stoplight": { "id": "jlk4ouomalkcw" }, "type": "object", "properties": { "submission_id": { "type": "string", "x-stoplight": { "id": "o1wm9zdofe7ve" }, "format": "uuid", "description": "KYC Submission unique identifier" }, "status": { "x-stoplight": { "id": "apsidzbaxj0x9" }, "enum": [ "COMPLETED", "IN_REVIEW", "FAILED", "UPDATE_REQUIRED" ], "description": "KYC Submission status." }, "provider_url": { "type": "string", "x-stoplight": { "id": "gpwvv15b82r7p" }, "description": "URL to redirect users in order for them upload or fulfill extra information. E.g: ID photo, proof of life, etc.\nMay be null if no further information is required.", "nullable": true }, "created_at": { "type": "string", "x-stoplight": { "id": "mrg9dnm7bs2jm" }, "format": "date-time", "description": "ISO format creation datetime" } } }, "examples": { "Example 1": { "value": { "submission_id": "945dfedc-ad7f-4af7-b20c-06082ffa3cb3", "status": "COMPLETED", "provider_url": "http://example.com", "created_at": "2019-08-24T14:15:22Z" } } } } } } }, "operationId": "get-api-v1-end-users-end_user_id-kyc-submission_id", "x-stoplight": { "id": "voucphvnzl9iy" }, "description": "Endpoint that retrieves an specific KYC submission given a submission ID.\n\n**Note**:\nWe offer the capability to set a Webhook URL in order to be notified in real time. Please note that you should expect a payload format similar to the one below. See BaaS Webhook in the documentation.", "security": [ { "OAuth2": [ "read" ] } ] } }, "/api/v1/simulate-fiat-deposit": { "summary": "Simulate Fiat Deposit", "post": { "summary": "Simulate Fiat Deposit", "operationId": "post-api-v1-simulate-fiat-deposit", "responses": { "200": { "description": "OK", "content": { "text/plain": { "examples": { "Example 1": { "value": "" } } } } } }, "tags": [ "Simulate Fiat Deposit" ], "description": "Endpoint that simulates a fiat deposit in the fiat account with the cvu passed in the body of the request.", "security": [ { "OAuth2": [ "read" ] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "payment_method_type": { "type": "string", "description": "Fiat Account's payment method type." }, "amount": { "type": "integer", "description": "Amount of fiat deposit to simulate" }, "alias_or_cvu": { "type": "string", "description": "Fiat Account's alias or cvu." } } }, "examples": { "Example 1": { "value": { "payment_method_type": "bank_transfer", "amount": 200, "alias_or_cvu": "0000465160000000100504" } } } } } } } }, "/api/v1/end-users/{end_user_id}/billing/": { "parameters": [ { "schema": { "type": "string" }, "name": "end_user_id", "in": "path", "required": true } ], "put": { "summary": "Assign Billing Information for an End User", "tags": [ "Billing Information", "End User" ], "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "end_user_id": { "type": "string", "description": "Unique identifier for the end user." }, "billing_info": { "type": "object", "properties": { "info": { "type": "object", "description": "JSON object which can hold arbitrary data based on the negotiated requirements between the client and the system." } } } } }, "examples": { "Assign Billing Information": { "value": { "end_user_id": "customer_1", "billing_info": { "info": { "condición_extranjero": true, "cuit": "23404444189", "apellidos": "Doe", "nombres": "John", "tipo_documento": "DNI", "num_documento": "40444418", "nacionalidad": "Argentina", "fecha_nac": "01/01/1980", "fecha_alta": "01/01/2023", "fecha_baja": null, "es_pep": false } } } } } } } } }, "operationId": "put-api-v1-end-users-end_user_id-billing", "x-stoplight": { "id": "87j53ghox4w5j" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "info" ], "properties": { "info": { "type": "object", "x-stoplight": { "id": "s2826l1b4ug9g" }, "description": "JSON object which can hold arbitrary data based on the negotiated requirements between the client and the system." } } }, "examples": { "UIF Arg - Natural Person Example": { "value": { "info": { "condición_extranjero": true, "cuit": "23404444189", "apellidos": "Doe", "nombres": "John", "tipo_documento": "DNI", "num_documento": "40444418", "nacionalidad": "Argentina", "fecha_nac": "01/01/1980", "fecha_alta": "01/01/2023", "fecha_baja": null, "es_pep": false } } } } } } }, "description": "This endpoint is a flexible tool designed to collect additional information required for ad-hoc workflows, such as billing or regulatory reporting. The flexibility of the endpoint allows the payload format to be customized according to the specific use case, as agreed upon with the partner.\n\n**Key aspects:**\n\n* **Negotiated Format**: The info field format must be negotiated with the client before usage to ensure it meets the requirements of the specific use case.\n* **Validation**: Validation rules for the info payload may vary depending on the format and purpose of the data being submitted.\n* **Versatility**: This endpoint is not limited to billing information but can be repurposed for other ad-hoc workflows requiring custom data exchange.\n* **Support for Data Corrections**: This endpoint can also be invoked to rectify previously submitted data. If multiple rectifications are sent, the system will always use the most recent rectification received.\n\n**Use Case Example: Regulatory Reporting in Argentina**\n\nA common use case for this endpoint is to collect information for regulatory reporting, such as meeting compliance requirements for Argentina's Financial Information Unit (UIF). In this scenario, the required format for the `info` field is as follows:\n\nField Descriptions:\n- `condición_extranjero (boolean)`: Indicates if the person is a foreign resident (`true`) or not (`false`).\n- `cuit (string)`: Unique Tax Identification Code (Clave Única de Identificación Tributaria) of the person.\n- `apellidos (string)`: Last name(s) of the person.\n- `nombres (string)`: First name(s) of the person.\n- `tipo_documento (string)`: Type of document (DNI, PASAPORTE).\n- `num_documento (string)`: Document number.\n- `nacionalidad (string)`: Nationality of the person.\n- `fecha_nac (string)`: Date of birth in the format DD/MM/YYYY.\n- `fecha_alta (string)`: Registration date in the format `DD/MM/YYYY`.\n- `fecha_baja (string | null)`: Deregistration date in the format `DD/MM/YYYY` or `null` if not applicable.\n- `es_pep (boolean)`: Indicates if the person is a Politically Exposed Person (`true` or `false`)." } }, "/api/v1/opt-in/": { "get": { "summary": "List Opt Ins", "operationId": "get-api-v1-opt-in", "tags": [ "Yields" ], "parameters": [ { "name": "end_user_id", "description": "Filter opt ins by end_user_id.", "in": "query", "schema": { "type": "string" } }, { "name": "asset", "description": "Filter opt ins by asset symbol.", "in": "query", "schema": { "type": "string" } }, { "name": "is_active", "description": "Filter opt ins by is_active status.", "in": "query", "schema": { "type": "string" } }, { "name": "create_date_lte", "description": "Filter opt ins by create_date less than or equal to this date.", "in": "query", "schema": { "type": "string" } }, { "name": "create_date_gte", "description": "Filter opt ins by create_date greater than or equal to this date.", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "example": { "count": 1, "next": null, "previous": null, "results": [ { "id": "c468be09-3a1f-41aa-ad08-c7d715957105", "transaction_id": "e826023d-fddc-4ce1-bdac-7506ed17eb0e", "end_user_id": "75c741a2-c3c8-46b1-a807-4fa1f40bf051", "asset": "ETH", "created_at": "2025-04-10T15:53:11.847992Z", "opt_out_at": null, "is_active": true } ] }, "schema": { "type": "object", "properties": { "count": { "type": "integer", "example": 1, "description": "Indicates total count of opt ins." }, "next": { "type": "string", "format": "uri", "example": null, "description": "Indicates next page by URL.", "nullable": true }, "previous": { "type": "string", "format": "uri", "example": null, "description": "Indicates previous page by URL.", "nullable": true }, "results": { "type": "array", "description": "List of fetched opt ins.", "items": { "type": "object", "title": "Opt In Response", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as opt in identifier." }, "transaction_id": { "type": "string", "format": "uuid", "description": "UUID used as opt in's transaction identifier." }, "end_user_id": { "type": "string", "format": "uuid", "description": "Unique identifier used as end user's external ref." }, "asset": { "type": "string", "description": "Asset symbol." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO format creation datetime" }, "opt_out_at": { "type": "string", "format": "date-time", "description": "ISO format opt out datetime", "nullable": true }, "is_active": { "type": "boolean", "description": "Indicates if the opt in is active." } } } } } } } } } } }, "post": { "summary": "Yield Opt In", "operationId": "post-api-v1-opt-in", "tags": [ "Yields" ], "requestBody": { "content": { "application/json": { "example": { "end_user_id": "75c741a2-c3c8-46b1-a807-4fa1f40bf048" }, "schema": { "type": "object", "properties": { "end_user_id": { "type": "string", "description": "End user's external ref." } } } } } }, "responses": { "201": { "description": "Successful Creation", "content": { "application/json": { "example": [ { "id": "c468be09-3a1f-41aa-ad08-c7d715957105", "transaction_id": "e826023d-fddc-4ce1-bdac-7506ed17eb0e", "end_user_id": "75c741a2-c3c8-46b1-a807-4fa1f40bf051", "asset": "BTC", "created_at": "2025-04-10T15:53:11.847992Z", "opt_out_at": null, "is_active": true }, { "id": "c468be09-3a1f-41aa-ad08-c7d715957106", "transaction_id": "e826023d-fddc-4ce1-bdac-7506ed17eb01", "end_user_id": "75c741a2-c3c8-46b1-a807-4fa1f40bf052", "asset": "ETH", "created_at": "2025-04-10T15:53:11.847993Z", "opt_out_at": null, "is_active": true } ], "schema": { "type": "array", "description": "List of opt ins created for the end user.", "items": { "type": "object", "title": "Opt In Response", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as opt in identifier." }, "transaction_id": { "type": "string", "format": "uuid", "description": "UUID used as opt in's transaction identifier." }, "end_user_id": { "type": "string", "format": "uuid", "description": "Unique identifier used as end user's external ref." }, "asset": { "type": "string", "description": "Asset symbol." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO format creation datetime" }, "opt_out_at": { "type": "string", "format": "date-time", "description": "ISO format opt out datetime", "nullable": true }, "is_active": { "type": "boolean", "description": "Indicates if the opt in is active." } } } } } } }, "400": { "description": "EndUser Not Found", "content": { "application/json": { "example": { "code": 20000, "type": "ValidationError", "detail": { "non_field_errors": [ { "message": "Specified end_user_id 75c741a2-c3c8-46b1-a807-4fa1f40bf001 does not exist", "code": "invalid" } ] }, "status": 400 }, "schema": { "type": "object" } } } } } } }, "/api/v1/opt-in/{opt_in_id}/": { "get": { "summary": "Retrieve Opt In", "operationId": "get-api-v1-opt-in-opt_in_id", "tags": [ "Yields" ], "parameters": [ { "name": "opt_in_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "example": { "id": "c56eb572-9435-4643-91aa-337c7058bc86", "transaction_id": "da0cbef0-4cb1-40e3-bdd1-65247739a5e5", "end_user_id": "75c741a2-c3c8-46b1-a807-4fa1f40bf052", "asset": "ETH", "created_at": "2025-04-10T15:57:28.780194Z", "opt_out_at": null, "is_active": true }, "schema": { "type": "object", "description": "Opt In Response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as opt in identifier." }, "transaction_id": { "type": "string", "format": "uuid", "description": "UUID used as opt in's transaction identifier." }, "end_user_id": { "type": "string", "format": "uuid", "description": "Unique identifier used as end user's external ref." }, "asset": { "type": "string", "description": "Asset symbol." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO format creation datetime" }, "opt_out_at": { "type": "string", "format": "date-time", "description": "ISO format opt out datetime", "nullable": true }, "is_active": { "type": "boolean", "description": "Indicates if the opt in is active." } } } } } }, "404": { "description": "OptIn Not Found", "content": { "application/json": { "example": { "code": 40004, "type": "NotFound", "detail": { "message": "Not found.", "code": "not_found" }, "status": 404 }, "schema": { "type": "object" } } } } } } }, "/api/v1/opt-out/": { "get": { "summary": "List Opt Outs", "operationId": "get-api-v1-opt-out", "tags": [ "Yields" ], "parameters": [ { "name": "end_user_id", "description": "Filter opt outs by end_user_id.", "in": "query", "schema": { "type": "string" } }, { "name": "asset", "description": "Filter opt outs by asset symbol.", "in": "query", "schema": { "type": "string" } }, { "name": "create_date_lte", "description": "Filter opt outs by create_date less than or equal to this date.", "in": "query", "schema": { "type": "string" } }, { "name": "create_date_gte", "description": "Filter opt outs by create_date greater than or equal to this date.", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "example": { "count": 1, "next": null, "previous": null, "results": [ { "id": "c468be09-3a1f-41aa-ad08-c7d715957105", "transaction_id": "e826023d-fddc-4ce1-bdac-7506ed17eb0e", "end_user_id": "75c741a2-c3c8-46b1-a807-4fa1f40bf051", "opt_in_id": "c56eb572-9435-4643-91aa-337c7058bc86", "asset": "ETH", "created_at": "2025-04-10T15:53:11.847992Z" } ] }, "schema": { "type": "object", "properties": { "count": { "type": "integer", "example": 1, "description": "Indicates total count of opt outs." }, "next": { "type": "string", "format": "uri", "example": null, "description": "Indicates next page by URL.", "nullable": true }, "previous": { "type": "string", "format": "uri", "example": null, "description": "Indicates previous page by URL.", "nullable": true }, "results": { "type": "array", "description": "List of fetched opt outs.", "items": { "type": "object", "title": "Opt Out Response", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as opt out identifier." }, "transaction_id": { "type": "string", "format": "uuid", "description": "UUID used as opt out's transaction identifier." }, "end_user_id": { "type": "string", "format": "uuid", "description": "Unique identifier used as end user's external ref." }, "opt_in_id": { "type": "string", "format": "uuid", "description": "UUID identifier of the related opt in." }, "asset": { "type": "string", "description": "Asset symbol." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO format creation datetime" } } } } } } } } } } }, "post": { "summary": "Yield Opt Out", "operationId": "post-api-v1-opt-out", "tags": [ "Yields" ], "requestBody": { "content": { "application/json": { "example": { "end_user_id": "75c741a2-c3c8-46b1-a807-4fa1f40bf048" } } } }, "responses": { "201": { "description": "Successful Creation", "content": { "application/json": { "example": [ { "id": "c56eb572-9435-4643-91aa-337c7058bc86", "transaction_id": "da0cbef0-4cb1-40e3-bdd1-65247739a5e5", "end_user_id": "75c741a2-c3c8-46b1-a807-4fa1f40bf051", "opt_in_id": "c56eb572-9435-4643-91aa-337c7058bc86", "asset": "BTC", "created_at": "2025-04-10T15:57:28.780194Z" }, { "id": "c56eb572-9435-4643-91aa-337c7058bc87", "transaction_id": "da0cbef0-4cb1-40e3-bdd1-65247739a5e6", "end_user_id": "75c741a2-c3c8-46b1-a807-4fa1f40bf052", "opt_in_id": "c56eb572-9435-4643-91aa-337c7058bc87", "asset": "ETH", "created_at": "2025-04-10T15:57:28.780195Z" } ], "schema": { "type": "array", "description": "List of opt outs created for the end user.", "items": { "type": "object", "title": "Opt Out Response", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as opt out identifier." }, "transaction_id": { "type": "string", "format": "uuid", "description": "UUID used as opt out's transaction identifier." }, "end_user_id": { "type": "string", "format": "uuid", "description": "Unique identifier used as end user's external ref." }, "opt_in_id": { "type": "string", "format": "uuid", "description": "UUID identifier of the related opt in." }, "asset": { "type": "string", "description": "Asset symbol." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO format creation datetime" } } } } } } }, "400": { "description": "EndUser Not Found, or when the end-user hasn't opted for yields before.", "content": { "application/json": { "example": { "code": 20000, "type": "ValidationError", "detail": { "non_field_errors": [ { "message": "Specified end_user_id 75c741a2-c3c8-46b1-a807-4fa1f40bf001 does not exist", "code": "invalid" } ] }, "status": 400 }, "schema": { "type": "object" } } } } } } }, "/api/v1/opt-out/{opt_out_id}/": { "get": { "summary": "Retrieve Opt Out", "operationId": "get-api-v1-opt-out-opt_out_id", "tags": [ "Yields" ], "parameters": [ { "name": "opt_out_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "example": { "id": "c56eb572-9435-4643-91aa-337c7058bc86", "transaction_id": "da0cbef0-4cb1-40e3-bdd1-65247739a5e5", "end_user_id": "75c741a2-c3c8-46b1-a807-4fa1f40bf052", "opt_in_id": "c56eb572-9435-4643-91aa-337c7058bc86", "asset": "ETH", "created_at": "2025-04-10T15:57:28.780194Z" }, "schema": { "type": "object", "title": "Opt Out Response", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as opt out identifier." }, "transaction_id": { "type": "string", "format": "uuid", "description": "UUID used as opt out's transaction identifier." }, "end_user_id": { "type": "string", "format": "uuid", "description": "Unique identifier used as end user's external ref." }, "opt_in_id": { "type": "string", "format": "uuid", "description": "UUID identifier of the related opt in." }, "asset": { "type": "string", "description": "Asset symbol." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO format creation datetime" } } } } } }, "404": { "description": "OptOut Not Found", "content": { "application/json": { "example": { "code": 40004, "type": "NotFound", "detail": { "message": "Not found.", "code": "not_found" }, "status": 404 }, "schema": { "type": "object" } } } } } } }, "/api/v1/yield-credits/": { "get": { "summary": "List Yield Credits", "operationId": "get-api-v1-yield-credits", "tags": [ "Yields" ], "parameters": [ { "name": "end_user_id", "description": "Filter yield credits by end_user_id.", "in": "query", "schema": { "type": "string" } }, { "name": "asset", "description": "Filter yield credits by asset.", "in": "query", "schema": { "type": "string" } }, { "name": "defi_asset", "description": "Filter yield credits by defi_asset.", "in": "query", "schema": { "type": "string" } }, { "name": "protocol", "description": "Filter yield credits by protocol.", "in": "query", "schema": { "type": "string" } }, { "name": "network", "description": "Filter yield credits by network.", "in": "query", "schema": { "type": "string" } }, { "name": "accrued_date_lte", "description": "Filter yield credits by accrued_date less than or equal to this date.", "in": "query", "schema": { "type": "string" } }, { "name": "accrued_date_gte", "description": "Filter yield credits by accrued_date greater than or equal to this date.", "in": "query", "schema": { "type": "string" } }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "create_date_lte", "description": "Filter yield credits by create_date less than or equal to this date." }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "create_date_gte", "description": "Filter yield credits by create_date greater than or equal to this date." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "example": { "count": 1, "next": null, "previous": null, "results": [ { "id": "c468be09-3a1f-41aa-ad08-c7d715957105", "transaction_id": "e826023d-fddc-4ce1-bdac-7506ed17eb0e", "end_user_id": "75c741a2-c3c8-46b1-a807-4fa1f40bf051", "opt_in_id": "c56eb572-9435-4643-91aa-337c7058bc86", "asset": "ETH", "amount": 0.00001, "created_at": "2025-04-11T15:53:11.847992Z", "accrued_date": "2025-04-10T15:53:11.847992Z" } ] }, "schema": { "type": "object", "properties": { "count": { "type": "integer", "example": 1, "description": "Indicates total count of yield credits." }, "next": { "type": "string", "format": "uri", "example": null, "description": "Indicates next page by URL.", "nullable": true }, "previous": { "type": "string", "format": "uri", "example": null, "description": "Indicates previous page by URL.", "nullable": true }, "results": { "type": "array", "description": "List of fetched yield credits.", "items": { "type": "object", "title": "Yield Credit Response", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as yield credit identifier." }, "transaction_id": { "type": "string", "format": "uuid", "description": "UUID used as yield credit's transaction identifier." }, "end_user_id": { "type": "string", "format": "uuid", "description": "Unique identifier used as end user's external ref." }, "opt_in_id": { "type": "string", "format": "uuid", "description": "UUID identifier of the related opt in." }, "asset": { "type": "string", "description": "Asset symbol." }, "amount": { "type": "number", "format": "decimal", "description": "Yield credit amount." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO format created datetime" }, "accrued_date": { "type": "string", "format": "date", "description": "ISO format accrued date" } } } } } } } } } } } }, "/api/v1/yield-credits/{yield_credit_id}/": { "get": { "summary": "Retrieve Yield Credit", "operationId": "get-api-v1-yield-credits-yield_credit_id", "tags": [ "Yields" ], "parameters": [ { "name": "yield_credit_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "example": { "id": "c468be09-3a1f-41aa-ad08-c7d715957105", "transaction_id": "e826023d-fddc-4ce1-bdac-7506ed17eb0e", "end_user_id": "75c741a2-c3c8-46b1-a807-4fa1f40bf051", "opt_in_id": "c56eb572-9435-4643-91aa-337c7058bc86", "asset": "ETH", "amount": 0.00001, "accrued_date": "2025-04-10T15:53:11.847992Z" }, "schema": { "type": "object", "title": "Yield Credit Response", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as yield credit identifier." }, "transaction_id": { "type": "string", "format": "uuid", "description": "UUID used as yield credit's transaction identifier." }, "end_user_id": { "type": "string", "format": "uuid", "description": "Unique identifier used as end user's external ref." }, "opt_in_id": { "type": "string", "format": "uuid", "description": "UUID identifier of the related opt in." }, "asset": { "type": "string", "description": "Asset symbol." }, "amount": { "type": "number", "format": "decimal", "description": "Yield credit amount." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO format created datetime" }, "accrued_date": { "type": "string", "format": "date", "description": "ISO format accrued date" } } } } } }, "404": { "description": "YieldCredit Not Found", "content": { "application/json": { "example": { "code": 40004, "type": "NotFound", "detail": { "message": "Not found.", "code": "not_found" }, "status": 404 }, "schema": { "type": "object" } } } } } } }, "/api/v1/yield-apy/": { "get": { "summary": "List APYs", "operationId": "get-api-v1-yield-apys", "tags": [ "Yields" ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "example": [ { "asset": "USDC", "apy": "4.75093456045023490", "daily_fee": "0.00894%" }, { "asset": "ETH", "apy": "0.44428483265624250", "daily_fee": "0.00258%" }, { "asset": "BTC", "apy": "0.00259939966232195470", "daily_fee": "0.000005%" } ], "schema": { "type": "object", "title": "Yield APY Response", "properties": { "asset": { "type": "string", "description": "Asset symbol." }, "apy": { "type": "string", "format": "decimal", "description": "Annual Percentage Yield (APY) for the asset. This represents the gross yield and does not account for any applicable fee discounts." }, "daily_fee": { "type": "string", "format": "decimal", "description": "Daily fee for the asset." } } } } } } } } } }, "components": { "schemas": { "Trade": { "type": "object", "description": "If the transaction represents a BUY, SELL or SWAP operation, this object will detail the trade operation information.", "x-examples": { "example-1": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "quote_id": "3c071a1d-db86-46a7-9dc8-72ba3fbca992", "end_user_id": "string", "rate": "string", "chargeed_fee": "string", "base_amount": "string", "quote_amount": "string", "base_asset": "string", "quote_asset": "string", "created_at": "2019-08-24T14:15:22Z" } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as trade identifier." }, "txn_id": { "type": "string", "description": "UUID used as Transaction identifier. Useful to relate this object trade with a transaction object." }, "quote_id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "end_user_id": { "type": "string", "description": "Arbitrary string used as end_user identifier." }, "rate": { "type": "string", "description": "Indicates the exchange rate used for conversion." }, "charged_fee": { "type": "string", "description": "Indicates trade's applied fee." }, "base_amount": { "type": "string", "description": "Indicates the amount of units or equivalence in the quote for base currency." }, "quote_amount": { "type": "string", "description": "Indicates the amount of units or equivalence in the quote for quote currency." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of trade.", "readOnly": true } }, "required": [ "id", "txn_id", "quote_id", "end_user_id", "rate", "charged_fee", "base_amount", "quote_amount", "base_asset", "quote_asset", "created_at" ], "readOnly": true, "x-stoplight": { "id": "0vqlkdmhgi3f7" } }, "QuoteResponse": { "type": "object", "title": "QuoteResponse", "description": "", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "pair": { "type": "string", "description": "Indicates pair name involved in the quotation." }, "op_type": { "enum": [ "BUY", "SELL" ], "type": "string", "description": "Indicates whether the quote is for BUY or SELL." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "base_amount": { "type": "string", "format": "decimal", "description": "Indicates the amount of units or equivalence in the quote for base currency." }, "quote_amount": { "type": "string", "format": "decimal", "description": "Indicates the amount of units or equivalence in the quote for quote currency." }, "rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion." }, "charged_fee": { "type": "string", "format": "decimal", "description": "Indicates fee that will be applied when the execution of quote is effective." }, "external_ref": { "type": "string", "maxLength": 128, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date.", "readOnly": true }, "expires_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating expiration date of the quote. Quote will be invalid after that date." } }, "required": [ "id", "pair", "op_type", "base_asset", "quote_asset", "base_amount", "quote_amount", "rate", "charged_fee", "external_ref", "created_at", "expires_at" ], "x-examples": { "example-1": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "pair": "string", "op_type": "BUY", "base_asset": "string", "quote_asset": "string", "base_amount": "string", "quote_amount": "string", "rate": "string", "charged_fee": "string", "external_ref": "string", "created_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z" } }, "x-stoplight": { "id": "1rx0urcfjqrc9" } }, "SwapReusableQuoteResponse": { "type": "object", "title": "SwapReusableQuoteResponse", "description": "", "x-examples": { "example-1": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "pair": "string", "base_asset": "string", "quote_asset": "string", "buy_rate": "string", "sell_rate": "string", "external_ref": "string", "created_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z" } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "status": { "type": "string" }, "pair": { "type": "string", "description": "Indicates pair name involved in the quotation." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "swap_rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion." }, "usd_rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate between base_asset and USD currency, useful to calculate limits consumption." }, "external_ref": { "type": "string", "maxLength": 128, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date.", "readOnly": true }, "expires_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating expiration date of the quote. Quote will be invalid after that date." } }, "required": [ "id", "pair", "base_asset", "quote_asset", "swap_rate", "usd_rate", "external_ref", "created_at", "expires_at" ], "x-stoplight": { "id": "8dl9171wzqwnx" } }, "WithdrawalResponse": { "type": "object", "x-examples": { "Example": { "id": "ac243840-ac04-4b3a-9efb-176554d4a029", "created_at": "2022-03-30T19:38:39.765190Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_10", "currency": "BTC", "amount": "0.000000010000016378", "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "charged_fee": "0.00000000", "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 }, "charged_fee": { "type": "number", "format": "decimal", "description": "Indicates the fee amount charged for the withdrawal." }, "network_name": { "type": "string", "enum": [ "BITCOIN", "ETHEREUM" ] }, "status": { "type": "string", "description": "Specifies the withdrawal status." } }, "x-stoplight": { "id": "kb4zkahmkjw34" } }, "FiatWithdrawalResponse": { "type": "object", "x-stoplight": { "id": "0wbcetvw4kba3" }, "title": "Fiat Withdrawal Response", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as fiat withdrawal identifier." }, "transaction_id": { "type": "string", "format": "uuid", "description": "UUID used as fiat withdrawal's transaction identifier.", "x-stoplight": { "id": "6vus6y337rz80" } }, "created_at": { "type": "string", "format": "date-time", "description": "Indicates the fiat withdrawal creation date." }, "updated_at": { "type": "string", "format": "date-time", "description": "Indicates the fiat withdrawal's latest update date.", "x-stoplight": { "id": "jll5xu2mfb3wq" } }, "end_user_id": { "type": "string", "description": "End user's external ref, usually a uuid. Identifies the user that owns this operation." }, "currency_code": { "type": "string", "description": "Indicates the asset name involved in the fiat withdrawal." }, "amount": { "type": "string", "description": "Indicates the fiat amount withdrawed." }, "status": { "type": "string", "description": "Specifies the fiat withdrawal status.", "enum": [ "PENDING", "COMPLETED", "CANCELLED" ] }, "external_ref": { "type": "string", "maxLength": 128, "x-stoplight": { "id": "pgofwctmovzxm" }, "description": "Client side identification reference. Usually a UUID." }, "beneficiary_fiat_account_id": { "type": "string", "x-stoplight": { "id": "7ypgmzak2txsi" }, "format": "uuid", "description": "UUID used as beneficiary fiat account identifier." }, "is_fiat_deposit_refund": { "type": "boolean", "description": "Shows if the fiat withdrawal corresponds to the refund of a fiat deposit." }, "refunded_fiat_deposit": { "type": "string", "format": "uuid", "description": "UUID from a refunded fiat deposit, it could be null." } } }, "WithdrawalFeeResponse": { "type": "object", "x-examples": { "Example": { "id": "ac243840-ac04-4b3a-9efb-176554d4a029", "created_at": "2022-03-30T19:38:39.765190Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_10", "currency": "BTC", "amount": "0.000000010000016378", "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "charged_fee": "0.00000000", "network_name": "BITCOIN" } }, "title": "Withdrawal Fee Response", "description": "", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as withdrawal identifier." }, "expires_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating expiration date of the withdrawal fee. Fee will be invalid after that date." }, "amount": { "type": "number", "format": "decimal", "description": "It is the requested amount to withdrawal." }, "gas_price": { "type": "number", "format": "decimal", "description": "Indicates de basic cost on a withdrawal fee, the network gas price. It is expressed in the requested currency." }, "fee": { "type": "number", "format": "decimal", "description": "Indicates the basic fee that it is charged on the amount to be withdrawaled. It is expressed in the requested currency." }, "total_fee": { "type": "number", "format": "decimal", "description": "Indicates the total fee that will be charged in order to perform a withdrawal. Tipically, equivalent to gas_price + fee. It is expressed in the requested currency." }, "total_amount": { "type": "number", "format": "decimal", "description": "Indicates the total amount needed to perform a withdrawal for the requested amount. It is the amount that will be decreased on the user balance. Tipically, amount + total_fee. It is expressed in the requested currency." } }, "x-stoplight": { "id": "ww1qxcg7cpl4q" } }, "WithdrawalFee": { "type": "object", "x-examples": { "Example": { "id": "ac243840-ac04-4b3a-9efb-176554d4a029", "created_at": "2022-03-30T19:38:39.765190Z", "confirmation_date": "2022-03-30T19:38:39.765190Z", "txn_hash": "0x0923990f2j7cb207d3766e75730e8426d2fb3b6e896914f80a61943b1a8f29d2", "end_user_id": "customer_10", "currency": "BTC", "amount": "0.000000010000016378", "address": "0x36f672385c060290f4785F1ECFF58aE4aBB2FD15", "charged_fee": "0.00000000", "network_name": "BITCOIN" } }, "title": "Withdrawal Fee Response", "x-stoplight": { "id": "9r1odprfd9ccv" }, "properties": { "amount": { "type": "number", "format": "decimal", "description": "It is the requested amount to withdrawal." }, "currency": { "type": "string", "description": "It defines the curreency in which the amount is expressed. Example: ETH" }, "nerwork": { "format": "decimal", "description": "Indicates the network oveer which the fee will be estimated. Example: ethereum.", "type": "string" } } }, "ReusableQuoteResponse": { "type": "object", "title": "ReusableQuoteResponse", "description": "", "x-examples": { "example-1": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "pair": "string", "base_asset": "string", "quote_asset": "string", "buy_rate": "string", "sell_rate": "string", "external_ref": "string", "created_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z" } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "status": { "type": "string", "enum": [ "COM", "PEN", "EXP", "UNA_PRICE" ] }, "pair": { "type": "string", "description": "Indicates pair name involved in the quotation." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "buy_rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion." }, "sell_rate": { "type": "string", "format": "decimal", "description": "Indicates the exchange rate used for conversion." }, "external_ref": { "type": "string", "maxLength": 128, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date.", "readOnly": true }, "expires_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating expiration date of the quote. Quote will be invalid after that date." } }, "required": [ "id", "pair", "base_asset", "quote_asset", "buy_rate", "sell_rate", "external_ref", "created_at", "expires_at" ], "x-stoplight": { "id": "yjdne4mx325hn" } }, "Transaction": { "type": "object", "description": "", "title": "Transaction", "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as txn identifier." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of txn.", "readOnly": true }, "end_user": { "type": "string", "description": "Indicates which end user was involved in the transaction.", "readOnly": true }, "op_type": { "enum": [ "BUY", "SELL", "SWAP", "DEPOSIT", "WITHDRAWAL", "PEER_TO_PEER", "COIN_EARN", "COIN_BURN", "FIAT_DEPOSIT", "FIAT_WITHDRAWAL" ], "type": "string", "description": "Indicates whether the transaction is for `BUY`, `SELL`, `SWAP`, `DEPOSIT`, `WITHDRAWAL`, `PEER_TO_PEER`, `COIN_EARN`, `COIN_BURN`, `FIAT_DEPOSIT`, `FIAT_WITHDRAWAL`.", "readOnly": true }, "operation": { "oneOf": [ { "type": "object", "description": "If the transaction represents a `BUY` or `SELL` operation, this object will detail the information of the trade.", "x-examples": { "example-1": { "id": "636ed595-714b-4785-8d36-3dcac7d2567d", "external_ref": "71736720-4d62-473b-9916-015e59986e69", "quote_id": "02642013-9310-47c4-8e85-67cba34d60a5", "txn_id": "39402e8a-0f0e-49dc-928f-c72cf973383e", "end_user_id": "73aa41e6-8a97-45f8-8d20-b2bd0cc91193", "rate": "140.00000000", "market_rate": "140.00000000", "charged_fee": "0E-8", "fee_charged_in_fiat": true, "deferred_charged_fee": true, "crypto_charged_fee": "0E-20", "base_amount": "11.13622013", "quote_amount": "1559.07081820", "base_asset": "RTEST", "quote_asset": "ARS", "created_at": "2025-01-22T20:20:26.218009Z", "metadata": "{}", "invoice_pdf": null } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as trade identifier." }, "external_ref": { "type": "string", "description": "Arbitrary identifier used as external_ref when the quote was created." }, "quote_id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "txn_id": { "type": "string", "format": "uuid", "description": "UUID used as Transaction identifier. Useful to relate this object trade with a transaction object." }, "end_user_id": { "type": "string", "description": "Arbitrary string used as end_user identifier." }, "rate": { "type": "string", "description": "Indicates the exchange rate used for conversion." }, "market_rate": { "type": "string", "description": "Indicates the market rate when the trade was executed." }, "charged_fee": { "type": "string", "description": "Indicates trade's applied fee." }, "fee_charged_in_fiat": { "type": "boolean", "description": "Indicates if the fee was charged in fiat currency." }, "deferred_charged_fee": { "type": "boolean", "description": "Indicates if the fee was deferred." }, "crypto_charged_fee": { "type": "string", "description": "Indicates the fee charged in crypto currency." }, "base_amount": { "type": "string", "description": "Indicates the amount of units or equivalence in the quote for base currency." }, "quote_amount": { "type": "string", "description": "Indicates the amount of units or equivalence in the quote for quote currency." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of trade.", "readOnly": true } }, "required": [ "id", "external_ref", "quote_id", "txn_id", "end_user_id", "rate", "charged_fee", "fee_charged_in_fiat", "deferred_charged_fee", "base_amount", "quote_amount", "base_asset", "quote_asset", "created_at" ], "readOnly": true, "x-stoplight": { "id": "0vqlkdmhgi3f7" } }, { "type": "object", "description": "If the transaction represents a `SWAP` operation, this object will detail the information of the swap.", "x-examples": { "example-1": { "id": "e5151bb5-7bae-4013-b27b-0f49c2d65597", "external_ref": "71736720-4d62-473b-9916-015e59986e69", "quote_id": "02642013-9310-47c4-8e85-67cba34d60a5", "txn_id": "5f753809-062b-41e7-b048-7c5bc3948b94", "end_user_id": "73aa41e6-8a97-45f8-8d20-b2bd0cc91193", "rate": "140.00000000", "market_rate": "140.00000000", "charged_fee": "0E-8", "base_amount": "11.13622013", "quote_amount": "1559.07081820", "base_asset": "RTEST", "quote_asset": "ARS", "created_at": "2025-01-22T20:20:26.218009Z", "metadata": "{}", "invoice_pdf": "base64_encoded_pdf" } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used as trade identifier." }, "external_ref": { "type": "string", "description": "Arbitrary identifier used as external_ref when the quote was created." }, "quote_id": { "type": "string", "format": "uuid", "description": "UUID used as quote identifier." }, "txn_id": { "type": "string", "format": "uuid", "description": "UUID used as Transaction identifier. Useful to relate this object trade with a transaction object." }, "end_user_id": { "type": "string", "description": "Arbitrary string used as end_user identifier." }, "rate": { "type": "string", "description": "Indicates the exchange rate used for conversion." }, "market_rate": { "type": "string", "description": "Indicates the market rate when the trade was executed." }, "charged_fee": { "type": "string", "description": "Indicates trade's applied fee." }, "base_amount": { "type": "string", "description": "Indicates the amount of units or equivalence in the quote for base currency." }, "quote_amount": { "type": "string", "description": "Indicates the amount of units or equivalence in the quote for quote currency." }, "base_asset": { "type": "string", "description": "Indicates the base currency involved in the quotation." }, "quote_asset": { "type": "string", "description": "Indicates the quote currency involved in the quotation." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of trade.", "readOnly": true } }, "required": [ "id", "external_ref", "quote_id", "txn_id", "end_user_id", "rate", "charged_fee", "base_amount", "quote_amount", "base_asset", "quote_asset", "created_at" ], "readOnly": true, "x-stoplight": { "id": "0vqlkdmhgi3f7" } }, { "type": "object", "description": "If the transaction represents a `DEPOSIT` operation, this object will detail the information of the deposit.", "x-examples": { "example-1": { "id": "c6e5fb9b-b57e-46d1-b911-812c8e65e382", "hash": "0xd32844ded49dc0288dcfebd5229fc9535dd648992eaca66ee841af39e03db5cc", "index": 101, "amount": "0.000100000000000000", "create_date": "2024-11-14T19:18:11.635653Z", "created_at": "2024-11-14T19:18:11.635653Z", "update_date": "2024-11-14T19:20:46.353098Z", "updated_at": "2024-11-14T19:20:46.353098Z", "confirmation_date": "2024-11-14T19:20:46.330463Z", "currency_code": "RTEST", "is_blocked": false, "reason": "", "address_destination": "0x2642662552D718244240EadbC25514198791dc83", "address_origin": "0x05946b0d5E413e45069BeC923004F9A3c8F70B2B", "end_user_id": "86c741a2-c3c8-46b1-a807-4fa1f40bf069", "status": "COMPLETED", "network": "ethereum_sepolia", "risk_score": null } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used to identify the deposit." }, "hash": { "type": "string", "description": "Hash of the transaction on the blockchain." }, "index": { "type": "integer", "description": "Index of the transaction on the blockchain." }, "amount": { "type": "string", "description": "Amount of the deposit." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of the deposit.", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating last update date of the deposit.", "readOnly": true }, "confirmation_date": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating confirmation date of the deposit." }, "currency_code": { "type": "string", "description": "Currency of the deposit." }, "is_blocked": { "type": "boolean", "description": "Indicates if the deposit is blocked." }, "reason": { "type": "string", "description": "If the deposit is blocked this field will contain the reason." }, "address_destination": { "type": "string", "description": "Destination address of the deposit." }, "address_origin": { "type": "string", "description": "Origin address of the deposit." }, "end_user_id": { "type": "string", "description": "Arbitrary string used as end_user identifier." }, "status": { "type": "string", "description": "Indicates the status of the deposit." }, "network": { "type": "string", "description": "Indicates the network where the deposit was made." } }, "required": [ "id", "amount", "created_at", "updated_at", "currency_code", "is_blocked", "reason", "address_destination", "address_origin", "end_user_id", "status", "network" ], "readOnly": true, "x-stoplight": { "id": "0vqlkdmhgi3f7" } }, { "type": "object", "description": "If the transaction represents a `WITHDRAWAL` operation, this object will detail the information of the withdrawal.", "x-examples": { "example-1": { "id": "c749d1e0-47c1-4478-af0b-1149bdc1e594", "transaction_id": "d48d24f1-6801-44f6-a9ac-c5210ab700c5", "created_at": "2024-11-14T19:17:41.538960Z", "confirmation_date": "2024-11-14T19:20:02.547553Z", "txn_hash": "d32844ded49dc0288dcfebd5229fc9535dd648992eaca66ee841af39e03db5cc", "provisory_txn_hash": "d32844ded49dc0288dcfebd5229fc9535dd648992eaca66ee841af39e03db5cc", "end_user_id": "86c741a2-c3c8-46b1-a807-4fa1f40bf069", "currency": "RTEST", "amount": "0.000100000000000000", "debited_amount": "0.012857840000000000", "address": "0x2642662552D718244240EadbC25514198791dc83", "network_name": "ETHEREUM_SEPOLIA", "risk_score": null, "status": "COMPLETED", "is_blocked": false, "reason": "", "external_ref": "test_IPN_sandbox_1" } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used to identify the withdrawal." }, "transaction_id": { "type": "string", "format": "uuid", "description": "UUID used to identify the transaction." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of the withdrawal.", "readOnly": true }, "confirmation_date": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating confirmation date of the withdrawal." }, "txn_hash": { "type": "string", "description": "Hash of the transaction on the blockchain." }, "end_user_id": { "type": "string", "description": "Arbitrary string used as end_user identifier." }, "currency": { "type": "string", "description": "Currency of the withdrawal." }, "amount": { "type": "string", "description": "Amount of the withdrawal." }, "debited_amount": { "type": "string", "description": "Amount debited from the user." }, "address": { "type": "string", "description": "Destination address of the withdrawal." }, "network_name": { "type": "string", "description": "Indicates the network where the withdrawal was made." }, "status": { "type": "string", "description": "Indicates the status of the withdrawal." }, "is_blocked": { "type": "boolean", "description": "Indicates if the withdrawal is blocked." }, "reason": { "type": "string", "description": "If the withdrawal is blocked this field will contain the reason." }, "external_ref": { "type": "string", "description": "Arbitrary string used as external_ref when the withdrawal was created." } }, "required": [ "id", "transaction_id", "created_at", "txn_hash", "end_user_id", "currency", "amount", "debited_amount", "address", "status", "is_blocked", "reason", "external_ref" ], "readOnly": true, "x-stoplight": { "id": "0vqlkdmhgi3f7" } }, { "type": "object", "description": "If the transaction represents a `PEER_TO_PEER` operation, this object will detail the information of the peer to peer transaction.", "x-examples": { "example-1": { "id": "peer_to_peer_id_example", "sender": "sender_external_ref", "receiver": "receiver_external_ref", "sender_transaction_id": "sender_transaction_id_example", "receiver_transaction_id": "receiver_transaction_id_example", "currency": "RTEST", "amount": "100.00", "created_at": "2025-01-22T20:20:26.328972Z" } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used to identify the peer to peer transaction." }, "sender": { "type": "string", "description": "Arbitrary string used as end_user identifier for the one performing the transaction." }, "receiver": { "type": "string", "description": "Arbitrary string used as end_user identifier for the one receiving the transaction." }, "sender_transaction_id": { "type": "string", "format": "uuid", "description": "UUID used to identify the transaction of the sender." }, "receiver_transaction_id": { "type": "string", "format": "uuid", "description": "UUID used to identify the transaction of the receiver." }, "currency": { "type": "string", "description": "Currency of the peer to peer transaction." }, "amount": { "type": "string", "description": "Amount of the peer to peer transaction." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of the peer to peer transaction.", "readOnly": true } }, "required": [ "id", "sender", "receiver", "sender_transaction_id", "receiver_transaction_id", "currency", "amount", "created_at" ], "readOnly": true, "x-stoplight": { "id": "0vqlkdmhgi3f7" } }, { "type": "object", "description": "If the transaction represents a `COIN_EARN` operation, this object will detail the information of the coin earn transaction.", "x-examples": { "example-1": { "id": "coin_earn_id_example", "external_ref": "external_ref_example", "end_user": "end_user_external_ref", "transaction_id": "transaction_id_example", "currency": "RTEST", "amount": "50.00", "created_at": "2025-01-22T20:20:26.328972Z" } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used to identify the coin earn transaction." }, "external_ref": { "type": "string", "description": "Arbitrary string used as external_ref when the coin earn transaction was created." }, "end_user": { "type": "string", "description": "Arbitrary string used as end_user identifier." }, "transaction_id": { "type": "string", "format": "uuid", "description": "UUID used to identify the transaction." }, "currency": { "type": "string", "description": "Currency of the coin earn transaction." }, "amount": { "type": "string", "description": "Amount of the coin earn transaction." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of the coin earn transaction.", "readOnly": true } }, "required": [ "id", "external_ref", "end_user", "transaction_id", "currency", "amount", "created_at" ], "readOnly": true, "x-stoplight": { "id": "0vqlkdmhgi3f7" } }, { "type": "object", "description": "If the transaction represents a `COIN_BURN` operation, this object will detail the information of the coin burn transaction.", "x-examples": { "example-1": { "id": "coin_burn_id_example", "external_ref": "external_ref_example", "end_user": "end_user_external_ref", "transaction_id": "transaction_id_example", "currency": "RTEST", "amount": "25.00", "created_at": "2025-01-22T20:20:26.328972Z" } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used to identify the coin burn transaction." }, "external_ref": { "type": "string", "description": "Arbitrary string used as external_ref when the coin burn transaction was created." }, "end_user": { "type": "string", "description": "Arbitrary string used as end_user identifier." }, "transaction_id": { "type": "string", "format": "uuid", "description": "UUID used to identify the transaction." }, "currency": { "type": "string", "description": "Currency of the coin burn transaction." }, "amount": { "type": "string", "description": "Amount of the coin burn transaction." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of the coin burn transaction.", "readOnly": true } }, "required": [ "id", "external_ref", "end_user", "transaction_id", "currency", "amount", "created_at" ], "readOnly": true, "x-stoplight": { "id": "0vqlkdmhgi3f7" } }, { "type": "object", "description": "If the transaction represents a `FIAT_DEPOSIT` operation, this object will detail the information of the fiat deposit.", "x-examples": { "example-1": { "id": "fiat_deposit_id_example", "amount": "1000.00", "created_at": "2025-01-22T20:20:26.328972Z", "updated_at": "2025-01-22T20:25:00.414331Z", "currency_code": "ARS", "end_user_id": "end_user_external_ref", "status": "COMPLETED", "payment_method_type": "BANK_TRANSFER", "refunded": false, "refund_fiat_withdrawal_id": "refund_fiat_withdrawal_id_example" } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used to identify the fiat deposit." }, "amount": { "type": "string", "description": "Amount of the fiat deposit." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of the fiat deposit.", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating last update date of the fiat deposit.", "readOnly": true }, "currency_code": { "type": "string", "description": "Currency of the fiat deposit." }, "end_user_id": { "type": "string", "description": "Arbitrary string used as end_user identifier." }, "status": { "type": "string", "description": "Indicates the status of the deposit." }, "payment_method_type": { "type": "string", "description": "Indicates the payment method used for the deposit." }, "refunded": { "type": "boolean", "description": "Indicates if the deposit was refunded." }, "refund_fiat_withdrawal_id": { "type": "string", "format": "uuid", "description": "UUID used to identify the fiat withdrawal that refunded the deposit." } }, "required": [ "id", "amount", "created_at", "updated_at", "currency_code", "end_user_id", "status", "payment_method_type", "refunded" ], "readOnly": true, "x-stoplight": { "id": "0vqlkdmhgi3f7" } }, { "type": "object", "description": "If the transaction represents a `FIAT_WITHDRAWAL` operation, this object will detail the information of the fiat withdrawal.", "x-examples": { "example-1": { "id": "fiat_withdrawal_id_example", "transaction_id": "transaction_id_example", "created_at": "2025-01-22T20:20:26.328972Z", "updated_at": "2025-01-22T20:25:00.414331Z", "end_user_id": "end_user_external_ref", "currency_code": "ARS", "amount": "1000.00", "status": "COMPLETED", "external_ref": "external_ref_example", "beneficiary_fiat_account_id": "beneficiary_fiat_account_id_example", "is_fiat_deposit_refund": false, "refunded_fiat_deposit": "refunded_fiat_deposit_example" } }, "properties": { "id": { "type": "string", "format": "uuid", "description": "UUID used to identify the fiat withdrawal." }, "transaction_id": { "type": "string", "format": "uuid", "description": "UUID used to identify the transaction." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date of the fiat withdrawal.", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating last update date of the fiat withdrawal.", "readOnly": true }, "end_user_id": { "type": "string", "description": "Arbitrary string used as end_user identifier." }, "currency_code": { "type": "string", "description": "Currency of the fiat withdrawal." }, "amount": { "type": "string", "description": "Amount of the fiat withdrawal." }, "status": { "type": "string", "description": "Indicates the status of the withdrawal." }, "external_ref": { "type": "string", "description": "Arbitrary string used as external_ref when the fiat withdrawal was created." }, "beneficiary_fiat_account_id": { "type": "string", "format": "uuid", "description": "UUID used to identify the beneficiary fiat account." }, "is_fiat_deposit_refund": { "type": "boolean", "description": "Indicates if the withdrawal is a refund of a deposit." }, "refunded_fiat_deposit": { "type": "string", "format": "uuid", "description": "UUID used to identify the fiat deposit that was refunded." } }, "required": [ "id", "transaction_id", "created_at", "updated_at", "end_user_id", "currency_code", "amount", "status", "external_ref", "beneficiary_fiat_account_id", "is_fiat_deposit_refund" ], "readOnly": true, "x-stoplight": { "id": "0vqlkdmhgi3f7" } } ] }, "status": { "type": "string", "description": "Indicates the status of the transaction.", "readOnly": true, "example": "COMPLETED" } }, "required": [ "id", "created_at", "end_user", "op_type" ], "x-stoplight": { "id": "5671qhgh98enx" } }, "EndUser": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "ISO DateTime indicating creation date.", "readOnly": true }, "external_ref": { "type": "string", "maxLength": 250, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." } }, "required": [ "external_ref" ], "x-stoplight": { "id": "pgo4xowf0ebeo" } }, "Pair": { "type": "object", "properties": { "name": { "type": "string", "description": "Indicates pair name." } }, "required": [ "name" ], "x-stoplight": { "id": "y0def15tjagpl" } }, "QuoteRequest": { "description": "Object indicating the requirements for the quotation. **Beware** that you can ask for a quotation using either a `base_amount` or `quote_amount`, but **never both** in the same request.", "type": "object", "x-examples": { "Base Asset Quotation": { "pair": "USDT_USD", "op_type": "BUY", "external_ref": "op1", "base_amount": 5 }, "Quote Asset Quotatioin": { "pair": "USDT_USD", "op_type": "BUY", "external_ref": "op1", "quote_amount": 5 } }, "title": "QuoteRequest", "properties": { "pair": { "type": "string", "minLength": 1, "description": "Indicates pair name." }, "external_ref": { "type": "string", "minLength": 1, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." }, "op_type": { "type": "string", "enum": [ "BUY", "SELL" ], "description": "Indicates the operation type." }, "base_amount": { "type": "number", "description": "Specifies the amount of crypto to buy or sell." }, "quote_amount": { "type": "number", "description": "Specifies the amount of fiat to buy or sell." } }, "required": [ "pair", "external_ref", "op_type" ], "x-stoplight": { "id": "ywp6ryhj3vq9r" } }, "ReusableQuoteRequest": { "description": "", "type": "object", "x-examples": { "Example": { "pair": "USDT_USD", "external_ref": "op1" } }, "title": "ReusableQuoteRequest", "properties": { "pair": { "type": "string", "minLength": 1, "description": "Indicates pair name." }, "external_ref": { "type": "string", "minLength": 1, "description": "Arbitrary identifier issued by the partner. Serves as an external identifier for lookups." } }, "required": [ "pair", "external_ref" ], "x-stoplight": { "id": "qjmhiivfvn09m" } }, "Deposit": { "type": "object", "description": "", "properties": { "id": { "type": "string", "description": "Unique ID for this deposit." }, "hash": { "type": "string", "description": "Indicates TXN Hash in the blockchain. This hash is not unique, several outputs may exist on a single transaction. Read index field description." }, "index": { "type": "integer", "description": "Indicates the index on the output transaction. This is unique within a hash." }, "address_origin": { "type": "string" }, "create_date": { "type": "string", "minLength": 1, "description": "Indicates the creation date of the deposit in the blockchain." }, "update_date": { "type": "string", "minLength": 1, "description": "Indicates the creation date of the deposit in the blockchain." }, "confirmation_date": { "type": "string", "minLength": 1, "description": "Indicates the confirmation date of the deposit in the blockchain.", "nullable": true }, "currency_code": { "type": "string", "minLength": 1, "description": "Indicates the currency that has been deposited." }, "address_destination": { "type": "string", "description": "Indicates the deposit's destination address." }, "end_user_id": { "type": "string", "description": "Indicates the end user that has received the deposit." }, "amount": { "type": "string", "description": "Indicates the amount deposited." }, "network": { "type": "string", "description": "The crypto network" }, "status": { "type": "string", "enum": [ "PENDING", "COMPLETED", "ERROR" ] }, "risk_score": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH", "SEVERE" ] } }, "required": [ "hash", "address_origin", "create_date", "update_date", "confirmation_date", "currency_code", "address_destination", "end_user_id", "amount" ], "x-stoplight": { "id": "fv3y408ghzyum" } }, "FiatDeposit": { "type": "object", "x-stoplight": { "id": "qze975pae5vz3" }, "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID for this fiat deposit." }, "created_at": { "type": "string", "minLength": 1, "description": "Indicates the creation date of the fiat deposit." }, "updated_at": { "type": "string", "minLength": 1, "description": "Indicates the update date of the fiat deposit." }, "currency_code": { "type": "string", "minLength": 1, "description": "Indicates the currency that has been deposited." }, "end_user_id": { "type": "string", "description": "End user's external ref, usually a uuid. Indicates the end user that has received the fiat deposit." }, "amount": { "type": "string", "description": "Indicates the amount deposited." }, "status": { "type": "string", "enum": [ "COMPLETED", "CANCELLED", "BLOCKED_LIMIT_EXCEEDED" ] }, "refunded": { "type": "boolean", "description": "Indicates if the fiat deposit was refunded." }, "refund_fiat_withdrawal_id": { "type": "string", "format": "uuid", "description": "Indicates the fiat withdrawal id associated with the refund, could be null." }, "origin_account_identifier": { "type": "string", "description": "Indicates the identifier of the fiat deposit's issuing account." }, "origin_account_holder_id": { "type": "string", "description": "Indicates the identification of the fiat deposit's issuing account holder." }, "origin_account_holder_name": { "type": "string", "description": "Indicates the name of the fiat deposit's issuing account holder." } } }, "Limit": { "type": "object", "description": "", "x-examples": { "BUY ARS Yearly Example": { "type": "BUY", "currency": "ARS", "period": "YEARLY", "allowed_frequency": "5", "allowed_amount": "5.00", "consumed_frequency": "0", "consumed_amount": "0.00" }, "SELL ARS Yearly Example": { "type": "SELL", "currency": "ARS", "period": "YEARLY", "allowed_frequency": "5", "allowed_amount": "5.00", "consumed_frequency": "0", "consumed_amount": "0.00" } }, "properties": { "type": { "type": "string", "description": "Indicates limit type.", "enum": [ "BUY", "SELL" ] }, "currency": { "type": "string", "description": "Indicates the currency in which the limit has been expressed.", "enum": [ "ARS", "USD" ] }, "period": { "type": "string", "description": "Indicates the period in which the limit applies.", "enum": [ "DAILY", "MONTHLY", "YEARLY" ] }, "allowed_frequency": { "type": "string", "description": "Indicates the maximum frequency allowed per period for a given operation type and currency." }, "allowed_amount": { "type": "string", "description": "Indicates the maximum tradable amount allowed per period for a given operation type and currency." }, "consumed_frequency": { "type": "string", "description": "Indicates the spent frequency related to the allowed_frequency declared. It must comply with the following invariant: `allowed_frequency >= consumed_frequency`." }, "consumed_amount": { "type": "string", "description": "Indicates the spent tradable amount related to the allowed_frequency declared. It must comply with the following invariant: `allowed_amount >= consumed_amount`." } }, "required": [ "type", "currency", "period", "allowed_frequency", "allowed_amount", "consumed_frequency", "consumed_amount" ], "readOnly": true, "x-stoplight": { "id": "w06tn5ptzp6vf" } }, "Address": { "title": "Address", "type": "object", "properties": { "network": { "type": "string", "enum": [ "BITCOIN", "EHTEREUM" ] }, "end_user_id": { "type": "string", "description": "End user's external ref, usually a uuid." }, "address": { "type": "string", "description": "End User's Address." }, "xpub": { "type": "string", "description": "Last six characters of The Extended Public Key.", "nullable": true }, "derivation_path": { "type": "string", "description": "Address derivation path, for addresses generated before April 2025, this value will be null.", "nullable": true } }, "x-stoplight": { "id": "kpa5wfu4rfuag" } }, "AutoSwapAddress": { "title": "AutoSwapAddress", "type": "object", "x-stoplight": { "id": "bk6o44lae6rp8" }, "properties": { "network": { "type": "string", "enum": [ "BITCOIN", "ETHEREUM", "BITCOIN_TESTNET", "ETHEREUM_SEPOLIA", "POLYGON", "POLYGON_MUMBAI" ] }, "end_user_id": { "type": "string", "description": "End user's external ref, usually a uuid." }, "address": { "type": "string", "description": "Address where the assets for AutoSwap should be sent." }, "target_address": { "type": "string", "description": "Address where assets will be sent after AutoSwap process." }, "xpub": { "type": "string", "description": "Last six characters of The Extended Public Key.", "nullable": true }, "derivation_path": { "type": "string", "description": "Address derivation path, for addresses generated before April 2025, this value will be null.", "nullable": true } } }, "BeneficiaryFiatAccountResponse": { "title": "BeneficiaryFiatAccountResponse", "x-stoplight": { "id": "d9qpc1i58mwmt" }, "type": "object", "x-examples": { "Example 1": { "beneficiary_fiat_account_id": "123e4567-e89b-12d3-a456-4bedc4266abc", "created_at": "2019-08-24T14:15:22Z", "currency": "ARS", "account_fields": { "alias_or_cvu_destination": "0000465160000000013330" }, "status": "processing", "payment_method_type": "bank_transfer" } }, "properties": { "beneficiary_fiat_account_id": { "type": "string", "x-stoplight": { "id": "s81hi7swzftug" }, "example": "123e4567-e89b-12d3-a456-4bedc4266abc", "description": "UUID4 formated unique id.", "format": "uuid" }, "created_at": { "type": "string", "x-stoplight": { "id": "85bbhruk52d09" }, "format": "date-time", "description": "ISO DateTime indicating creation date of Beneficiary Fiat Account", "example": "2019-08-24T14:15:22Z" }, "currency": { "type": "string", "x-stoplight": { "id": "2rc25kzh0722j" }, "description": "It defines the currency that the Beneficiary Fiat Account accepts.", "example": "ARS", "minLength": 3, "maxLength": 3 }, "account_fields": { "type": "object", "x-stoplight": { "id": "4uked55vjse1q" }, "minProperties": 1, "description": "JSON fields with account identification details.\nIt varies based on the account type.\nExample:\n```json\n{“alias_or_cvu_destination”: “0000465160000000013330”}\n```", "properties": { "alias_or_cvu_destination": { "type": "string", "x-stoplight": { "id": "obshnce7b8ryz" }, "description": "Example for ARS Accounts." } } }, "status": { "type": "string", "x-stoplight": { "id": "dahq9n8ywumoo" }, "enum": [ "DISABLED", "PROCESSING", "ENABLED", "SUSPENDED" ], "description": "Indicates Beneficiary Fiat Account status.\nExpected values: `DISABLED`, `PROCESSING`, `ENABLED`, `SUSPENDED`" }, "payment_method_type": { "type": "string", "x-stoplight": { "id": "xuj8ekk9db8s8" }, "description": "Indicates the payment method type. Usually, bank_transfer." } } }, "FiatAccountResponse": { "x-stoplight": { "id": "d9qpc1i58mwmt" }, "type": "object", "x-examples": { "Enabled Fiat Account": { "fiat_account_id": "123e4567-e89b-12d3-a456-4bedc4266abc", "created_at": "2019-08-24T14:15:22Z", "currency": "ARS", "fiat_payment_instructions": { "cvu": "0000465160000000013330" }, "payment_method_type": "bank_transfer", "status": "ENABLED", "end_user_id": "customer_10" }, "Processing Fiat Account": { "fiat_account_id": "123e4567-e89b-12d3-a456-4bedc4266abc", "created_at": "2019-08-24T14:15:22Z", "currency": "ARS", "fiat_payment_instructions": { "cvu": null }, "payment_method_type": "bank_transfer", "status": "PROCESSING", "end_user_id": "customer_10" } }, "properties": { "fiat_account_id": { "type": "string", "x-stoplight": { "id": "s81hi7swzftug" }, "example": "123e4567-e89b-12d3-a456-4bedc4266abc", "description": "UUID4 formated unique id.", "format": "uuid" }, "created_at": { "type": "string", "x-stoplight": { "id": "85bbhruk52d09" }, "format": "date-time", "description": "ISO DateTime indicating Fiat Account creation date", "example": "2019-08-24T14:15:22Z" }, "currency": { "type": "string", "x-stoplight": { "id": "2rc25kzh0722j" }, "description": "It defines the currency that the Fiat Account accepts.", "example": "ARS", "minLength": 3, "maxLength": 3 }, "fiat_payment_instructions": { "type": "object", "x-stoplight": { "id": "4uked55vjse1q" }, "minProperties": 1, "description": "JSON fields with account identification details.\nIt varies based on the account type.\nExample:\n```json\n{\"cvu\": \"0000465160000000013330\"}\n```", "properties": { "cvu": { "type": "string", "x-stoplight": { "id": "obshnce7b8ryz" }, "description": "Example for ARS Accounts.", "nullable": true } } }, "payment_method_type": { "type": "string", "x-stoplight": { "id": "xuj8ekk9db8s8" }, "description": "Indicates the payment method type. Usually, bank_transfer." }, "status": { "x-stoplight": { "id": "c015x74kbx7v0" }, "enum": [ "PROCESSING", "ENABLED" ], "description": "Indicates the Fiat Account status. Only when \"ENABLED\", the fiat payment instructions will be provided." }, "end_user_id": { "type": "string", "description": "End user's external ref" } } }, "KYCSubmission": { "title": "KYCSubmission", "x-stoplight": { "id": "jlk4ouomalkcw" }, "type": "object", "properties": { "submission_id": { "type": "string", "x-stoplight": { "id": "o1wm9zdofe7ve" }, "format": "uuid", "description": "KYC Submission unique identifier" }, "status": { "x-stoplight": { "id": "apsidzbaxj0x9" }, "enum": [ "COMPLETED", "IN_REVIEW", "FAILED", "UPDATE_REQUIRED" ], "description": "KYC Submission status." }, "provider_url": { "type": "string", "x-stoplight": { "id": "gpwvv15b82r7p" }, "description": "URL to redirect users in order for them upload or fulfill extra information. E.g: ID photo, proof of life, etc.\nMay be null if no further information is required.", "nullable": true }, "created_at": { "type": "string", "x-stoplight": { "id": "mrg9dnm7bs2jm" }, "format": "date-time", "description": "ISO format creation datetime" } } }, "ApiError": { "title": "ApiError", "type": "object", "properties": { "code": { "type": "integer", "description": "Error code. See table of error codes." }, "type": { "type": "string", "description": "Error type." }, "detail": { "type": "object", "description": "Additional error description.", "properties": { "message": { "type": "string", "description": "Specific error message." } } }, "status": { "type": "integer", "description": "HTTP Error status." } } } }, "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:\n\n* **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.\n\nEvery 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.\n\nEvery request must be accompianed by an `Authorization` header with a value that follows the following schema: `Bearer ACCESS_TOKEN`\n" } } }, "servers": [ { "url": "https://sandbox-b2b.ripio.com" } ], "security": [ { "OAuth2": [] } ], "x-extension-2": null }