{"openapi":"3.0.0","info":{"version":"0.2.1","title":"El Dorado - API","description":"## Welcome to our API Documentation\n\nEl Dorado API provides a comprehensive solution for seamless conversion between fiat currencies and cryptocurrencies in Latin American markets. \n                \nOur secure, compliant trading platform enables developers to integrate fiat-to-crypto and crypto-to-fiat trading capabilities with built-in KYC verification, real-time pricing, instant order execution, and support for multiple payment methods across Argentina, Bolivia, Brazil, Colombia, Panama, and Peru. \n\nThe API supports trading between major fiat currencies (USD, ARS, BOB, BRL, COP, PEN, PAB) and USDT, with different trading levels based on KYC verification status and secure token-based authentication."},"servers":[{"url":"/api"}],"tags":[{"name":"pricing","description":"By leveraging the /prices and /currencies endpoints in our API, you gain access to real-time pricing information and a comprehensive list of supported currencies. Whether you are building a trading platform, portfolio tracker, or any other financial application, integrating these endpoints will enable you to provide accurate and up-to-date pricing data to your users."},{"name":"requests","description":"The /requests endpoint in our API allows you to programmatically create and manage payment requests. Whether you are building a payment gateway, invoicing system, or any other financial application, integrating this endpoint will enable you to initiate and manage payment requests on behalf of your users."}],"components":{"securitySchemes":{"Authorization":{"type":"apiKey","scheme":"bearer","bearerFormat":"JWT","name":"Authorization"}},"schemas":{"ClockResponse":{"type":"object","properties":{"time":{"type":"string","format":"date-time","example":"2025-06-14T16:27:05.646Z"}},"required":["time"]},"InternalServerError":{"type":"object","properties":{"errorCode":{"type":"string","enum":["INTERNAL_SERVER_ERROR"]},"message":{"type":"string"},"reason":{"type":"string"}},"required":["errorCode","message"],"example":{"errorCode":"INTERNAL_SERVER_ERROR","message":"An unexpected error occurred. Please try again later."}},"CurrenciesEnum":{"type":"string","enum":["USD","COP","ARS","CLP","PEN","BRL","PYG","BOB","VES","MXN","DOP","ECU"]},"PricesResponse":{"type":"object","properties":{"SELL":{"type":"object","properties":{"USD":{"type":"object","properties":{"limits":{"type":"object","properties":{"in":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}},"out":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}}},"required":["in","out"]},"price":{"type":"string"}},"required":["limits","price"]},"COP":{"type":"object","properties":{"limits":{"type":"object","properties":{"in":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}},"out":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}}},"required":["in","out"]},"price":{"type":"string"}},"required":["limits","price"]},"ARS":{"type":"object","properties":{"limits":{"type":"object","properties":{"in":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}},"out":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}}},"required":["in","out"]},"price":{"type":"string"}},"required":["limits","price"]},"CLP":{"type":"object","properties":{"limits":{"type":"object","properties":{"in":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}},"out":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}}},"required":["in","out"]},"price":{"type":"string"}},"required":["limits","price"]},"PEN":{"type":"object","properties":{"limits":{"type":"object","properties":{"in":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}},"out":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}}},"required":["in","out"]},"price":{"type":"string"}},"required":["limits","price"]},"BRL":{"type":"object","properties":{"limits":{"type":"object","properties":{"in":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}},"out":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}}},"required":["in","out"]},"price":{"type":"string"}},"required":["limits","price"]},"PYG":{"type":"object","properties":{"limits":{"type":"object","properties":{"in":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}},"out":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}}},"required":["in","out"]},"price":{"type":"string"}},"required":["limits","price"]},"BOB":{"type":"object","properties":{"limits":{"type":"object","properties":{"in":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}},"out":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}}},"required":["in","out"]},"price":{"type":"string"}},"required":["limits","price"]},"VES":{"type":"object","properties":{"limits":{"type":"object","properties":{"in":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}},"out":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}}},"required":["in","out"]},"price":{"type":"string"}},"required":["limits","price"]},"MXN":{"type":"object","properties":{"limits":{"type":"object","properties":{"in":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}},"out":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}}},"required":["in","out"]},"price":{"type":"string"}},"required":["limits","price"]},"DOP":{"type":"object","properties":{"limits":{"type":"object","properties":{"in":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}},"out":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}}},"required":["in","out"]},"price":{"type":"string"}},"required":["limits","price"]},"ECU":{"type":"object","properties":{"limits":{"type":"object","properties":{"in":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}},"out":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}}},"required":["in","out"]},"price":{"type":"string"}},"required":["limits","price"]}}},"BUY":{"type":"object","properties":{"USD":{"type":"object","properties":{"limits":{"type":"object","properties":{"in":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}},"out":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}}},"required":["in","out"]},"price":{"type":"string"}},"required":["limits","price"]},"COP":{"type":"object","properties":{"limits":{"type":"object","properties":{"in":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}},"out":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}}},"required":["in","out"]},"price":{"type":"string"}},"required":["limits","price"]},"ARS":{"type":"object","properties":{"limits":{"type":"object","properties":{"in":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}},"out":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}}},"required":["in","out"]},"price":{"type":"string"}},"required":["limits","price"]},"CLP":{"type":"object","properties":{"limits":{"type":"object","properties":{"in":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}},"out":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}}},"required":["in","out"]},"price":{"type":"string"}},"required":["limits","price"]},"PEN":{"type":"object","properties":{"limits":{"type":"object","properties":{"in":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}},"out":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}}},"required":["in","out"]},"price":{"type":"string"}},"required":["limits","price"]},"BRL":{"type":"object","properties":{"limits":{"type":"object","properties":{"in":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}},"out":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}}},"required":["in","out"]},"price":{"type":"string"}},"required":["limits","price"]},"PYG":{"type":"object","properties":{"limits":{"type":"object","properties":{"in":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}},"out":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}}},"required":["in","out"]},"price":{"type":"string"}},"required":["limits","price"]},"BOB":{"type":"object","properties":{"limits":{"type":"object","properties":{"in":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}},"out":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}}},"required":["in","out"]},"price":{"type":"string"}},"required":["limits","price"]},"VES":{"type":"object","properties":{"limits":{"type":"object","properties":{"in":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}},"out":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}}},"required":["in","out"]},"price":{"type":"string"}},"required":["limits","price"]},"MXN":{"type":"object","properties":{"limits":{"type":"object","properties":{"in":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}},"out":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}}},"required":["in","out"]},"price":{"type":"string"}},"required":["limits","price"]},"DOP":{"type":"object","properties":{"limits":{"type":"object","properties":{"in":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}},"out":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}}},"required":["in","out"]},"price":{"type":"string"}},"required":["limits","price"]},"ECU":{"type":"object","properties":{"limits":{"type":"object","properties":{"in":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}},"out":{"type":"object","properties":{"min":{"type":["string","null"]},"max":{"type":["string","null"]}}}},"required":["in","out"]},"price":{"type":"string"}},"required":["limits","price"]}}}},"required":["SELL","BUY"]},"NotFound":{"type":"object","properties":{"errorCode":{"type":"string","enum":["NOT_FOUND"]},"message":{"type":"string"},"reason":{"type":"string"}},"required":["errorCode","message"],"example":{"errorCode":"NOT_FOUND","message":"Order or user not found."}},"Currencies":{"type":"object","properties":{"currencies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","enum":["USD","COP","ARS","CLP","PEN","BRL","PYG","BOB","VES","MXN","DOP","ECU"]},"type":{"type":"string","enum":["FIAT"]},"description":{"type":"object","properties":{"es":{"type":"string"},"en":{"type":"string"},"pt":{"type":"string"}}},"symbol":{"type":"string"},"symbolShort":{"type":"string"},"iconUrl":{"type":"string"}},"required":["id","type","description","symbol","symbolShort","iconUrl"]}}},"required":["currencies"]},"Countries":{"type":"object","properties":{"countries":{"type":"array","items":{"type":"string"}}},"required":["countries"]},"Chains":{"type":"object","properties":{"chains":{"type":"array","items":{"type":"string"}}},"required":["chains"]},"Tokens":{"type":"object","properties":{"tokens":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"symbol":{"type":"string"},"decimals":{"type":"number"},"chainId":{"type":"string"},"logo":{"type":"string"},"priceUSD":{"type":"string"}},"required":["address","symbol","decimals","chainId"]}}},"required":["tokens"]},"InvalidParameters":{"type":"object","properties":{"errorCode":{"type":"string","enum":["INVALID_PARAMETERS"]},"message":{"type":"string"},"reason":{"type":"string"}},"required":["errorCode","message"],"example":{"errorCode":"INVALID_PARAMETERS","message":"Invalid order details provided.","reason":"Missing required field: amount"}},"PaymentMethodsResponse":{"type":"object","properties":{"paymentMethods":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"country":{"type":"string"},"logo":{"type":"string"},"active":{"type":"boolean"},"currency":{"type":"string"},"schema":{"type":"object","additionalProperties":{}},"iconUrl":{"type":"string"}},"required":["id","name","country","logo","currency","schema","iconUrl"]}}},"required":["paymentMethods"]},"PaymentDetailsResponseSchema":{"type":"object","properties":{"paymentDetails":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"userId":{"type":"string"},"paymentMethodId":{"type":"string"},"currencyId":{"type":"string"},"description":{"type":"string"},"details":{"type":"object","additionalProperties":{"type":"string"}},"ownershipType":{"type":"string","enum":["SELF","THIRD_PARTY","BUSINESS","FAMILY"]},"updated_at":{"type":"string"}},"required":["id","userId","paymentMethodId","currencyId","description","details","ownershipType"]}}},"required":["paymentDetails"]},"Unauthorized":{"type":"object","properties":{"errorCode":{"type":"string","enum":["UNAUTHORIZED","SESSION_EXPIRED"]},"message":{"type":"string"},"reason":{"type":"string"}},"required":["errorCode","message"],"example":{"errorCode":"UNAUTHORIZED","message":"Invalid or missing authentication token."}},"LoginSendOTPRequest":{"type":"object","properties":{"email":{"type":"string","minLength":4,"format":"email","example":"email@example.com"},"language":{"type":"string","enum":["es","en","pt","es-AR"],"default":"es","example":"es"}},"required":["email"]},"LoginTokenSentResponse":{"type":"object","properties":{"ok":{"type":"boolean","example":true},"otpIdentifier":{"type":"string","example":"019fa01a-d010-7514-bf14-5d305815a216"},"action":{"type":"string","enum":["LOGIN","REGISTER"],"example":"LOGIN"}},"required":["ok","otpIdentifier","action"]},"UnauthorizedErrorResponse":{"type":"object","properties":{"errorCode":{"type":"string","enum":["UNAUTHORIZED","SESSION_EXPIRED"]},"message":{"type":"string"},"reason":{"type":"string"}},"required":["errorCode","message"],"example":{"errorCode":"UNAUTHORIZED","message":"Invalid or missing authentication token."}},"RateLimitExceeded":{"type":"object","properties":{"errorCode":{"type":"string","enum":["ACCOUNT_LOCKED"]},"message":{"type":"string"},"reason":{"type":"string"},"lockedUntil":{"type":"string","format":"date-time"}},"required":["errorCode","message"],"example":{"errorCode":"ACCOUNT_LOCKED","message":"Rate limit exceeded. Please try again later.","lockedUntil":"2025-06-14T05:26:00Z"}},"LoginVerifyOTPRequest":{"type":"object","properties":{"otp":{"type":"string","minLength":8,"pattern":"^[A-Za-z0-9]+$","example":"123456AB"},"otpIdentifier":{"type":"string","example":"019fa01a-d013-73ca-b66b-81ed52b2ec93"},"username":{"type":"string","minLength":3,"maxLength":20,"example":"example"}},"required":["otp","otpIdentifier"]},"LoginTokenVerifiedResponse":{"type":"object","properties":{"ok":{"type":"boolean","example":true},"token":{"type":"string","example":"123123123123123123123123"},"expiresAt":{"type":"string","example":"2023-10-01T00:00:00Z"},"user":{"type":"object","properties":{"userId":{"type":"string"},"email":{"type":"string"},"username":{"type":"string"},"kyc_status":{"type":"string","enum":["started","pending","passed","rejected"],"description":"KYC status of the user","example":"started"},"kyc_level":{"type":"string","enum":["L0","L1","L2","L3","L4","L5"],"description":"KYC level of the user","example":"L0"},"createdAt":{"type":"string","format":"date-time"},"disabled":{"type":"boolean"}},"required":["userId","username","createdAt"],"description":"User information"}},"required":["ok","token","expiresAt","user"]},"ForbiddenErrorResponse":{"type":"object","properties":{"errorCode":{"type":"string","enum":["UNABLE_TO_SIGNUP","INVALID_OTP","INVALID_ALIAS"]},"message":{"type":"string"},"reason":{"type":"string"}},"required":["errorCode","message"],"example":{"errorCode":"UNABLE_TO_SIGNUP","message":"Unable to register with the provided credentials. Please check your username or email."}},"AccountLocked":{"type":"object","properties":{"errorCode":{"type":"string","enum":["ACCOUNT_LOCKED"]},"message":{"type":"string"},"reason":{"type":"string"},"lockedUntil":{"type":"string","format":"date-time"}},"required":["errorCode","message"],"example":{"errorCode":"ACCOUNT_LOCKED","message":"Account is locked due to too many failed attempts. Please try again later.","lockedUntil":"2025-06-14T05:26:00Z"}},"StatusResponse":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true]},"expiresAt":{"type":"string"}},"required":["ok","expiresAt"]},"GetKYCResponse":{"type":"object","properties":{"kyc":{"type":"object","properties":{"userId":{"type":"string"},"kycStatus":{"type":"string","enum":["started","pending","passed","rejected","needed"]},"kycLevel":{"type":"string","enum":["L0","L1","L2","L3","L4","L5"],"description":"KYC verification level"},"kycNextLevel":{"type":"string","enum":["L0","L1","L2","L3","L4","L5"],"description":"Next KYC verification level"},"kycNextLevelStatus":{"type":"string","enum":["started","pending","passed","rejected","needed"]},"kycNextLevelError":{"type":"string","enum":["PHONE_NUMBER_EXIST","PHONE_NUMBER_INVALID"],"description":"KYC next level error"},"action":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["url"]},"value":{"type":"string","format":"uri"}},"required":["type","value"]},{"type":"object","properties":{"type":{"type":"string","enum":["form"]},"value":{"type":"object","additionalProperties":{}}},"required":["type","value"]}]}},"required":["userId","kycStatus","kycLevel"],"description":"KYC status information for a user","example":{"userId":"123e4567-e89b-12d3-a456-426614174000","kycStatus":"needed","kycLevel":"L0","action":{"type":"url","value":"https://kyc.example.com/verify"}}}},"required":["kyc"]},"UpdateKycDataRequest":{"type":"object","properties":{"data":{"oneOf":[{"type":"object","properties":{"level":{"type":"string","enum":["L1"]},"values":{"type":"object","properties":{"countryOfResidence":{"type":"string","enum":["CO","PE","BR","AR","PA","BO","PY","DO","GT","EC","CR","HN","TT"],"description":"Country of residence (ISO2 code)"},"cityOfResidence":{"type":"string","minLength":1,"example":"Bogotá"},"phoneNumber":{"type":"string","minLength":1,"example":"+571234567890"}},"required":["countryOfResidence","cityOfResidence","phoneNumber"]}},"required":["level","values"]}]}},"required":["data"]},"UpdateKycDataResponse":{"type":"object","properties":{"ok":{"type":"boolean"}},"required":["ok"]},"PhoneVerificationRequest":{"type":"object","properties":{"code":{"type":"string","minLength":4,"maxLength":4,"example":"1234"}},"required":["code"]},"PhoneVerificationResponse":{"type":"object","properties":{"ok":{"type":"boolean"}},"required":["ok"]},"GetApiOrderResponse":{"type":"object","properties":{"order":{"anyOf":[{"type":"object","properties":{"userId":{"type":"string"},"apiOrderId":{"type":"string"},"orderStatus":{"type":"string","enum":["WAITING_FOR_FUNDS","REQUESTED","ACCEPTED","FIAT_PAID","FIAT_RECEIVED","COMPLETED","CANCELLED","DISPUTED"]},"type":{"type":"string","enum":["SELL"]},"createdDate":{"type":"string"},"updatedDate":{"type":"string"},"quote":{"anyOf":[{"type":"object","properties":{"fixedAmountSide":{"type":"string","enum":["IN"]},"orderType":{"type":"string","enum":["SELL"]},"txData":{"type":"object","properties":{"data":{"type":"string"},"value":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"chainId":{"type":"string","enum":["1","10","14","25","30","40","50","56","88","100","106","122","130","137","146","196","204","232","250","252","288","324","480","999","1088","1101","1135","1284","1285","1329","1480","1625","1868","1923","2020","2741","5000","8217","8453","9001","13371","32659","33139","34443","42161","42170","42220","42793","43114","55244","57073","59144","60808","80002","80094","81457","84532","98866","167000","421614","534352","747474","21000000","1313161554","1666600000","1151111081099710","1161011141099710","111971151099710","9270000000000000","20000000000001","20000000000002","20000000000003","20000000000004"]},"gasPrice":{"type":"string"},"gasLimit":{"type":"string"},"fromToken":{"type":"string"},"toToken":{"type":"string"},"fromAmount":{"type":"string"}},"required":["data","value","from","to","chainId","gasPrice","gasLimit","fromToken","toToken","fromAmount"]},"quoteId":{"type":"string"},"createdAt":{"type":"string"},"expiresAt":{"type":"string"},"out":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"},"paymentMethodId":{"type":"string"},"min":{"type":"string"}},"required":["amount","currency","paymentMethodId","min"]},"fees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"breakdown":{"type":"object","properties":{"platformFees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"rate":{"type":"string"}},"required":["amountInToken","amountInFiat","rate"]},"integratorFees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"rate":{"type":"string"}},"required":["amountInToken","amountInFiat","rate"]}},"required":["platformFees","integratorFees"]}},"required":["amountInToken","amountInFiat","breakdown"]},"in":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"},"chain":{"type":"string"}},"required":["amount","currency","chain"]},"kind":{"type":"string","enum":["estimate","executed"]}},"required":["fixedAmountSide","orderType","quoteId","createdAt","expiresAt","out","fees","in","kind"]},{"type":"object","properties":{"fixedAmountSide":{"type":"string","enum":["OUT"]},"orderType":{"type":"string","enum":["SELL"]},"txData":{"type":"object","properties":{"data":{"type":"string"},"value":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"chainId":{"type":"string","enum":["1","10","14","25","30","40","50","56","88","100","106","122","130","137","146","196","204","232","250","252","288","324","480","999","1088","1101","1135","1284","1285","1329","1480","1625","1868","1923","2020","2741","5000","8217","8453","9001","13371","32659","33139","34443","42161","42170","42220","42793","43114","55244","57073","59144","60808","80002","80094","81457","84532","98866","167000","421614","534352","747474","21000000","1313161554","1666600000","1151111081099710","1161011141099710","111971151099710","9270000000000000","20000000000001","20000000000002","20000000000003","20000000000004"]},"gasPrice":{"type":"string"},"gasLimit":{"type":"string"},"fromToken":{"type":"string"},"toToken":{"type":"string"},"fromAmount":{"type":"string"}},"required":["data","value","from","to","chainId","gasPrice","gasLimit","fromToken","toToken","fromAmount"]},"quoteId":{"type":"string"},"createdAt":{"type":"string"},"expiresAt":{"type":"string"},"out":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"},"paymentMethodId":{"type":"string"}},"required":["amount","currency","paymentMethodId"]},"fees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"breakdown":{"type":"object","properties":{"platformFees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"rate":{"type":"string"}},"required":["amountInToken","amountInFiat","rate"]},"integratorFees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"rate":{"type":"string"}},"required":["amountInToken","amountInFiat","rate"]}},"required":["platformFees","integratorFees"]}},"required":["amountInToken","amountInFiat","breakdown"]},"in":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"},"chain":{"type":"string"}},"required":["amount","currency","chain"]},"platformResidual":{"type":"boolean","enum":[true]},"kind":{"type":"string","enum":["estimate","executed"]}},"required":["fixedAmountSide","orderType","quoteId","createdAt","expiresAt","out","fees","in","platformResidual","kind"]}]},"fiatDetails":{"type":"object","properties":{"paymentMethodId":{"type":"string"},"payerDetails":{"type":"object","additionalProperties":{"type":"string"}},"payerDetailsId":{"type":"string"},"payeeDetails":{"type":"object","additionalProperties":{"type":"string"}},"payeeDetailsId":{"type":"string"}},"required":["paymentMethodId"]},"cryptoDetails":{"type":"object","properties":{"tokenAddress":{"type":"string"},"chainId":{"type":"string"},"depositAddress":{"type":"string"}},"required":["tokenAddress","chainId","depositAddress"]},"dueDate":{"type":"string"},"externalReferenceId":{"type":"string"}},"required":["userId","apiOrderId","orderStatus","type","createdDate","updatedDate","quote","fiatDetails","dueDate"],"title":"APISellOrderSchema","example":{"userId":"user_123","apiOrderId":"order_123","orderStatus":"WAITING_FOR_FUNDS","type":"SELL","createdDate":"2023-01-01T00:00:00Z","updatedDate":"2023-01-01T00:00:00Z","quote":{"quoteId":"quote_123","createdAt":"2023-01-01T00:00:00Z","expiresAt":"2023-01-01T00:00:00Z","fixedAmountSide":"IN","orderType":"SELL","fees":{"amountInToken":"0.02","amountInFiat":"0.02","breakdown":{"platformFees":{"amountInToken":"0.01","amountInFiat":"0.01","rate":"0.5"},"integratorFees":{"amountInToken":"0.01","amountInFiat":"0.01","rate":"0.5"}}},"out":{"amount":"100","currency":"USD","paymentMethodId":"pm_123","min":"100"},"in":{"amount":"0.1","currency":"BTC","chain":"BTC"},"kind":"estimate"},"fiatDetails":{"paymentMethodId":"pm_123","payerDetails":{"name":"John Doe","email":"john.doe@example.com"},"payerDetailsId":"payer_123","payeeDetails":{"name":"Jane Doe","email":"jane.doe@example.com"},"payeeDetailsId":"payee_123"},"cryptoDetails":{"tokenAddress":"0x1234567890abcdef","chainId":"1","depositAddress":"0xabcdef1234567890"},"dueDate":"2023-01-01T00:00:00Z","externalReferenceId":"123e4567-e89b-12d3-a456-426614174000"}},{"type":"object","properties":{"userId":{"type":"string"},"apiOrderId":{"type":"string"},"orderStatus":{"type":"string","enum":["WAITING_FOR_FUNDS","REQUESTED","ACCEPTED","FIAT_PAID","FIAT_RECEIVED","COMPLETED","CANCELLED","DISPUTED"]},"type":{"type":"string","enum":["BUY"]},"createdDate":{"type":"string"},"updatedDate":{"type":"string"},"quote":{"anyOf":[{"type":"object","properties":{"fixedAmountSide":{"type":"string","enum":["IN"]},"orderType":{"type":"string","enum":["BUY"]},"quoteId":{"type":"string"},"createdAt":{"type":"string"},"expiresAt":{"type":"string"},"fees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"breakdown":{"type":"object","properties":{"platformFees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"rate":{"type":"string"}},"required":["amountInToken","amountInFiat","rate"]},"integratorFees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"rate":{"type":"string"}},"required":["amountInToken","amountInFiat","rate"]}},"required":["platformFees","integratorFees"]}},"required":["amountInToken","amountInFiat","breakdown"]},"in":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"},"paymentMethodId":{"type":"string"}},"required":["amount","currency","paymentMethodId"]},"out":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"},"chain":{"type":"string"},"min":{"type":"string"}},"required":["amount","currency","chain","min"]},"kind":{"type":"string","enum":["estimate","executed"]}},"required":["fixedAmountSide","orderType","quoteId","createdAt","expiresAt","fees","in","out","kind"]},{"type":"object","properties":{"fixedAmountSide":{"type":"string","enum":["OUT"]},"orderType":{"type":"string","enum":["BUY"]},"quoteId":{"type":"string"},"createdAt":{"type":"string"},"expiresAt":{"type":"string"},"fees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"breakdown":{"type":"object","properties":{"platformFees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"rate":{"type":"string"}},"required":["amountInToken","amountInFiat","rate"]},"integratorFees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"rate":{"type":"string"}},"required":["amountInToken","amountInFiat","rate"]}},"required":["platformFees","integratorFees"]}},"required":["amountInToken","amountInFiat","breakdown"]},"in":{"type":"object","properties":{"amount":{"type":"string"},"max":{"type":"string"},"currency":{"type":"string"},"paymentMethodId":{"type":"string"}},"required":["amount","max","currency","paymentMethodId"]},"out":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"},"chain":{"type":"string"},"max":{"type":"string"}},"required":["amount","currency","chain","max"]},"kind":{"type":"string","enum":["estimate","executed"]}},"required":["fixedAmountSide","orderType","quoteId","createdAt","expiresAt","fees","in","out","kind"]}]},"fiatDetails":{"type":"object","properties":{"paymentMethodId":{"type":"string"},"payerDetails":{"type":"object","additionalProperties":{"type":"string"}},"payerDetailsId":{"type":"string"},"payeeDetails":{"type":"object","additionalProperties":{"type":"string"}},"payeeDetailsId":{"type":"string"}},"required":["paymentMethodId"]},"cryptoDetails":{"type":"object","properties":{"tokenAddress":{"type":"string"},"chainId":{"type":"string"},"recipientAddress":{"type":"string"}},"required":["tokenAddress","chainId","recipientAddress"]},"dueDate":{"type":"string"},"externalReferenceId":{"type":"string"},"transferInfo":{"type":"object","properties":{"txHash":{"type":"string"},"txHashDestination":{"type":"string"},"transferDate":{"type":"string"},"amountOut":{"type":"string"}},"required":["txHash","transferDate","amountOut"]}},"required":["userId","apiOrderId","orderStatus","type","createdDate","updatedDate","quote","fiatDetails","dueDate"],"title":"APIBuyOrderSchema","example":{"userId":"user_123","apiOrderId":"order_123","orderStatus":"REQUESTED","type":"BUY","createdDate":"2023-01-01T00:00:00Z","updatedDate":"2023-01-01T00:00:00Z","quote":{"quoteId":"quote_123","createdAt":"2023-01-01T00:00:00Z","expiresAt":"2023-01-01T00:00:00Z","fixedAmountSide":"IN","orderType":"BUY","fees":{"amountInToken":"0.02","amountInFiat":"0.02","breakdown":{"platformFees":{"amountInToken":"0.01","amountInFiat":"0.01","rate":"0.5"},"integratorFees":{"amountInToken":"0.01","amountInFiat":"0.01","rate":"0.5"}}},"in":{"amount":"100","currency":"USD","paymentMethodId":"pm_123"},"out":{"amount":"0.1","currency":"BTC","chain":"BTC","min":"0.1"},"kind":"estimate"},"fiatDetails":{"paymentMethodId":"pm_123","payerDetails":{"name":"John Doe","email":"john.doe@example.com"},"payerDetailsId":"payer_123","payeeDetails":{"name":"Jane Doe","email":"jane.doe@example.com"},"payeeDetailsId":"payee_123"},"cryptoDetails":{"tokenAddress":"0x1234567890abcdef","chainId":"1","recipientAddress":"0xabcdef1234567890"},"dueDate":"2023-01-01T00:00:00Z","externalReferenceId":"123e4567-e89b-12d3-a456-426614174000","transferInfo":{"txHash":"0x1234567890abcdef","txHashDestination":"0xabcdef1234567890","transferDate":"2023-01-01T00:00:00Z","amountOut":"100"}}}]}},"required":["order"]},"ApiOrdersResponse":{"type":"object","properties":{"orders":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"userId":{"type":"string"},"apiOrderId":{"type":"string"},"orderStatus":{"type":"string","enum":["WAITING_FOR_FUNDS","REQUESTED","ACCEPTED","FIAT_PAID","FIAT_RECEIVED","COMPLETED","CANCELLED","DISPUTED"]},"type":{"type":"string","enum":["SELL"]},"createdDate":{"type":"string"},"updatedDate":{"type":"string"},"quote":{"anyOf":[{"type":"object","properties":{"fixedAmountSide":{"type":"string","enum":["IN"]},"orderType":{"type":"string","enum":["SELL"]},"txData":{"type":"object","properties":{"data":{"type":"string"},"value":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"chainId":{"type":"string","enum":["1","10","14","25","30","40","50","56","88","100","106","122","130","137","146","196","204","232","250","252","288","324","480","999","1088","1101","1135","1284","1285","1329","1480","1625","1868","1923","2020","2741","5000","8217","8453","9001","13371","32659","33139","34443","42161","42170","42220","42793","43114","55244","57073","59144","60808","80002","80094","81457","84532","98866","167000","421614","534352","747474","21000000","1313161554","1666600000","1151111081099710","1161011141099710","111971151099710","9270000000000000","20000000000001","20000000000002","20000000000003","20000000000004"]},"gasPrice":{"type":"string"},"gasLimit":{"type":"string"},"fromToken":{"type":"string"},"toToken":{"type":"string"},"fromAmount":{"type":"string"}},"required":["data","value","from","to","chainId","gasPrice","gasLimit","fromToken","toToken","fromAmount"]},"quoteId":{"type":"string"},"createdAt":{"type":"string"},"expiresAt":{"type":"string"},"out":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"},"paymentMethodId":{"type":"string"},"min":{"type":"string"}},"required":["amount","currency","paymentMethodId","min"]},"fees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"breakdown":{"type":"object","properties":{"platformFees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"rate":{"type":"string"}},"required":["amountInToken","amountInFiat","rate"]},"integratorFees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"rate":{"type":"string"}},"required":["amountInToken","amountInFiat","rate"]}},"required":["platformFees","integratorFees"]}},"required":["amountInToken","amountInFiat","breakdown"]},"in":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"},"chain":{"type":"string"}},"required":["amount","currency","chain"]},"kind":{"type":"string","enum":["estimate","executed"]}},"required":["fixedAmountSide","orderType","quoteId","createdAt","expiresAt","out","fees","in","kind"]},{"type":"object","properties":{"fixedAmountSide":{"type":"string","enum":["OUT"]},"orderType":{"type":"string","enum":["SELL"]},"txData":{"type":"object","properties":{"data":{"type":"string"},"value":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"chainId":{"type":"string","enum":["1","10","14","25","30","40","50","56","88","100","106","122","130","137","146","196","204","232","250","252","288","324","480","999","1088","1101","1135","1284","1285","1329","1480","1625","1868","1923","2020","2741","5000","8217","8453","9001","13371","32659","33139","34443","42161","42170","42220","42793","43114","55244","57073","59144","60808","80002","80094","81457","84532","98866","167000","421614","534352","747474","21000000","1313161554","1666600000","1151111081099710","1161011141099710","111971151099710","9270000000000000","20000000000001","20000000000002","20000000000003","20000000000004"]},"gasPrice":{"type":"string"},"gasLimit":{"type":"string"},"fromToken":{"type":"string"},"toToken":{"type":"string"},"fromAmount":{"type":"string"}},"required":["data","value","from","to","chainId","gasPrice","gasLimit","fromToken","toToken","fromAmount"]},"quoteId":{"type":"string"},"createdAt":{"type":"string"},"expiresAt":{"type":"string"},"out":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"},"paymentMethodId":{"type":"string"}},"required":["amount","currency","paymentMethodId"]},"fees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"breakdown":{"type":"object","properties":{"platformFees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"rate":{"type":"string"}},"required":["amountInToken","amountInFiat","rate"]},"integratorFees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"rate":{"type":"string"}},"required":["amountInToken","amountInFiat","rate"]}},"required":["platformFees","integratorFees"]}},"required":["amountInToken","amountInFiat","breakdown"]},"in":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"},"chain":{"type":"string"}},"required":["amount","currency","chain"]},"platformResidual":{"type":"boolean","enum":[true]},"kind":{"type":"string","enum":["estimate","executed"]}},"required":["fixedAmountSide","orderType","quoteId","createdAt","expiresAt","out","fees","in","platformResidual","kind"]}]},"fiatDetails":{"type":"object","properties":{"paymentMethodId":{"type":"string"},"payerDetails":{"type":"object","additionalProperties":{"type":"string"}},"payerDetailsId":{"type":"string"},"payeeDetails":{"type":"object","additionalProperties":{"type":"string"}},"payeeDetailsId":{"type":"string"}},"required":["paymentMethodId"]},"cryptoDetails":{"type":"object","properties":{"tokenAddress":{"type":"string"},"chainId":{"type":"string"},"depositAddress":{"type":"string"}},"required":["tokenAddress","chainId","depositAddress"]},"dueDate":{"type":"string"},"externalReferenceId":{"type":"string"}},"required":["userId","apiOrderId","orderStatus","type","createdDate","updatedDate","quote","fiatDetails","dueDate"],"title":"APISellOrderSchema","example":{"userId":"user_123","apiOrderId":"order_123","orderStatus":"WAITING_FOR_FUNDS","type":"SELL","createdDate":"2023-01-01T00:00:00Z","updatedDate":"2023-01-01T00:00:00Z","quote":{"quoteId":"quote_123","createdAt":"2023-01-01T00:00:00Z","expiresAt":"2023-01-01T00:00:00Z","fixedAmountSide":"IN","orderType":"SELL","fees":{"amountInToken":"0.02","amountInFiat":"0.02","breakdown":{"platformFees":{"amountInToken":"0.01","amountInFiat":"0.01","rate":"0.5"},"integratorFees":{"amountInToken":"0.01","amountInFiat":"0.01","rate":"0.5"}}},"out":{"amount":"100","currency":"USD","paymentMethodId":"pm_123","min":"100"},"in":{"amount":"0.1","currency":"BTC","chain":"BTC"},"kind":"estimate"},"fiatDetails":{"paymentMethodId":"pm_123","payerDetails":{"name":"John Doe","email":"john.doe@example.com"},"payerDetailsId":"payer_123","payeeDetails":{"name":"Jane Doe","email":"jane.doe@example.com"},"payeeDetailsId":"payee_123"},"cryptoDetails":{"tokenAddress":"0x1234567890abcdef","chainId":"1","depositAddress":"0xabcdef1234567890"},"dueDate":"2023-01-01T00:00:00Z","externalReferenceId":"123e4567-e89b-12d3-a456-426614174000"}},{"type":"object","properties":{"userId":{"type":"string"},"apiOrderId":{"type":"string"},"orderStatus":{"type":"string","enum":["WAITING_FOR_FUNDS","REQUESTED","ACCEPTED","FIAT_PAID","FIAT_RECEIVED","COMPLETED","CANCELLED","DISPUTED"]},"type":{"type":"string","enum":["BUY"]},"createdDate":{"type":"string"},"updatedDate":{"type":"string"},"quote":{"anyOf":[{"type":"object","properties":{"fixedAmountSide":{"type":"string","enum":["IN"]},"orderType":{"type":"string","enum":["BUY"]},"quoteId":{"type":"string"},"createdAt":{"type":"string"},"expiresAt":{"type":"string"},"fees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"breakdown":{"type":"object","properties":{"platformFees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"rate":{"type":"string"}},"required":["amountInToken","amountInFiat","rate"]},"integratorFees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"rate":{"type":"string"}},"required":["amountInToken","amountInFiat","rate"]}},"required":["platformFees","integratorFees"]}},"required":["amountInToken","amountInFiat","breakdown"]},"in":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"},"paymentMethodId":{"type":"string"}},"required":["amount","currency","paymentMethodId"]},"out":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"},"chain":{"type":"string"},"min":{"type":"string"}},"required":["amount","currency","chain","min"]},"kind":{"type":"string","enum":["estimate","executed"]}},"required":["fixedAmountSide","orderType","quoteId","createdAt","expiresAt","fees","in","out","kind"]},{"type":"object","properties":{"fixedAmountSide":{"type":"string","enum":["OUT"]},"orderType":{"type":"string","enum":["BUY"]},"quoteId":{"type":"string"},"createdAt":{"type":"string"},"expiresAt":{"type":"string"},"fees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"breakdown":{"type":"object","properties":{"platformFees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"rate":{"type":"string"}},"required":["amountInToken","amountInFiat","rate"]},"integratorFees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"rate":{"type":"string"}},"required":["amountInToken","amountInFiat","rate"]}},"required":["platformFees","integratorFees"]}},"required":["amountInToken","amountInFiat","breakdown"]},"in":{"type":"object","properties":{"amount":{"type":"string"},"max":{"type":"string"},"currency":{"type":"string"},"paymentMethodId":{"type":"string"}},"required":["amount","max","currency","paymentMethodId"]},"out":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"},"chain":{"type":"string"},"max":{"type":"string"}},"required":["amount","currency","chain","max"]},"kind":{"type":"string","enum":["estimate","executed"]}},"required":["fixedAmountSide","orderType","quoteId","createdAt","expiresAt","fees","in","out","kind"]}]},"fiatDetails":{"type":"object","properties":{"paymentMethodId":{"type":"string"},"payerDetails":{"type":"object","additionalProperties":{"type":"string"}},"payerDetailsId":{"type":"string"},"payeeDetails":{"type":"object","additionalProperties":{"type":"string"}},"payeeDetailsId":{"type":"string"}},"required":["paymentMethodId"]},"cryptoDetails":{"type":"object","properties":{"tokenAddress":{"type":"string"},"chainId":{"type":"string"},"recipientAddress":{"type":"string"}},"required":["tokenAddress","chainId","recipientAddress"]},"dueDate":{"type":"string"},"externalReferenceId":{"type":"string"},"transferInfo":{"type":"object","properties":{"txHash":{"type":"string"},"txHashDestination":{"type":"string"},"transferDate":{"type":"string"},"amountOut":{"type":"string"}},"required":["txHash","transferDate","amountOut"]}},"required":["userId","apiOrderId","orderStatus","type","createdDate","updatedDate","quote","fiatDetails","dueDate"],"title":"APIBuyOrderSchema","example":{"userId":"user_123","apiOrderId":"order_123","orderStatus":"REQUESTED","type":"BUY","createdDate":"2023-01-01T00:00:00Z","updatedDate":"2023-01-01T00:00:00Z","quote":{"quoteId":"quote_123","createdAt":"2023-01-01T00:00:00Z","expiresAt":"2023-01-01T00:00:00Z","fixedAmountSide":"IN","orderType":"BUY","fees":{"amountInToken":"0.02","amountInFiat":"0.02","breakdown":{"platformFees":{"amountInToken":"0.01","amountInFiat":"0.01","rate":"0.5"},"integratorFees":{"amountInToken":"0.01","amountInFiat":"0.01","rate":"0.5"}}},"in":{"amount":"100","currency":"USD","paymentMethodId":"pm_123"},"out":{"amount":"0.1","currency":"BTC","chain":"BTC","min":"0.1"},"kind":"estimate"},"fiatDetails":{"paymentMethodId":"pm_123","payerDetails":{"name":"John Doe","email":"john.doe@example.com"},"payerDetailsId":"payer_123","payeeDetails":{"name":"Jane Doe","email":"jane.doe@example.com"},"payeeDetailsId":"payee_123"},"cryptoDetails":{"tokenAddress":"0x1234567890abcdef","chainId":"1","recipientAddress":"0xabcdef1234567890"},"dueDate":"2023-01-01T00:00:00Z","externalReferenceId":"123e4567-e89b-12d3-a456-426614174000","transferInfo":{"txHash":"0x1234567890abcdef","txHashDestination":"0xabcdef1234567890","transferDate":"2023-01-01T00:00:00Z","amountOut":"100"}}}]}}},"required":["orders"]},"CreateSellOrderRequest":{"type":"object","properties":{"fiatDetails":{"anyOf":[{"type":"object","properties":{"details":{"type":"object","additionalProperties":{"type":"string"},"description":"Where the fiat is going to be transferred to. This is a dynamic object that depends on the payment method id.\nPersonal information like name, id, etc, will be added automatically according to our KYC records","example":{"bankName":"SuperBank","accountNumber":"1000AB12345"}}},"required":["details"]},{"type":"object","properties":{"detailsId":{"type":"string","description":"The ID of a previously saved payment method details, which will be used to create the order.\nThis is useful for recurring payments or when you want to use the same payment method details again.","example":"123e4567-e89b-12d3-a456-426614174000"}},"required":["detailsId"]}]},"quoteId":{"type":"string","example":"123e4567-e89b-12d3-a456-426614174000","description":"The ID of the quote to use to create the order. Obtaining a quote is a prerequisite for creating an order. \n\nThe quote must be a sell quote and the fixed amount side must be IN. Quote must still be valid."},"externalReferenceId":{"type":"string","pattern":"^[a-zA-Z0-9-]+$","description":"An external reference ID to help identify the order (only letters, numbers, and hyphens allowed)","example":"123e4567-e89b-12d3-a456-426614174000"}},"required":["fiatDetails","quoteId"]},"CreateSellOrderResponse":{"type":"object","properties":{"order":{"type":"object","properties":{"userId":{"type":"string"},"apiOrderId":{"type":"string"},"orderStatus":{"type":"string","enum":["WAITING_FOR_FUNDS","REQUESTED","ACCEPTED","FIAT_PAID","FIAT_RECEIVED","COMPLETED","CANCELLED","DISPUTED"]},"type":{"type":"string","enum":["SELL"]},"createdDate":{"type":"string"},"updatedDate":{"type":"string"},"quote":{"anyOf":[{"type":"object","properties":{"fixedAmountSide":{"type":"string","enum":["IN"]},"orderType":{"type":"string","enum":["SELL"]},"txData":{"type":"object","properties":{"data":{"type":"string"},"value":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"chainId":{"type":"string","enum":["1","10","14","25","30","40","50","56","88","100","106","122","130","137","146","196","204","232","250","252","288","324","480","999","1088","1101","1135","1284","1285","1329","1480","1625","1868","1923","2020","2741","5000","8217","8453","9001","13371","32659","33139","34443","42161","42170","42220","42793","43114","55244","57073","59144","60808","80002","80094","81457","84532","98866","167000","421614","534352","747474","21000000","1313161554","1666600000","1151111081099710","1161011141099710","111971151099710","9270000000000000","20000000000001","20000000000002","20000000000003","20000000000004"]},"gasPrice":{"type":"string"},"gasLimit":{"type":"string"},"fromToken":{"type":"string"},"toToken":{"type":"string"},"fromAmount":{"type":"string"}},"required":["data","value","from","to","chainId","gasPrice","gasLimit","fromToken","toToken","fromAmount"]},"quoteId":{"type":"string"},"createdAt":{"type":"string"},"expiresAt":{"type":"string"},"out":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"},"paymentMethodId":{"type":"string"},"min":{"type":"string"}},"required":["amount","currency","paymentMethodId","min"]},"fees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"breakdown":{"type":"object","properties":{"platformFees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"rate":{"type":"string"}},"required":["amountInToken","amountInFiat","rate"]},"integratorFees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"rate":{"type":"string"}},"required":["amountInToken","amountInFiat","rate"]}},"required":["platformFees","integratorFees"]}},"required":["amountInToken","amountInFiat","breakdown"]},"in":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"},"chain":{"type":"string"}},"required":["amount","currency","chain"]},"kind":{"type":"string","enum":["estimate","executed"]}},"required":["fixedAmountSide","orderType","quoteId","createdAt","expiresAt","out","fees","in","kind"]},{"type":"object","properties":{"fixedAmountSide":{"type":"string","enum":["OUT"]},"orderType":{"type":"string","enum":["SELL"]},"txData":{"type":"object","properties":{"data":{"type":"string"},"value":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"chainId":{"type":"string","enum":["1","10","14","25","30","40","50","56","88","100","106","122","130","137","146","196","204","232","250","252","288","324","480","999","1088","1101","1135","1284","1285","1329","1480","1625","1868","1923","2020","2741","5000","8217","8453","9001","13371","32659","33139","34443","42161","42170","42220","42793","43114","55244","57073","59144","60808","80002","80094","81457","84532","98866","167000","421614","534352","747474","21000000","1313161554","1666600000","1151111081099710","1161011141099710","111971151099710","9270000000000000","20000000000001","20000000000002","20000000000003","20000000000004"]},"gasPrice":{"type":"string"},"gasLimit":{"type":"string"},"fromToken":{"type":"string"},"toToken":{"type":"string"},"fromAmount":{"type":"string"}},"required":["data","value","from","to","chainId","gasPrice","gasLimit","fromToken","toToken","fromAmount"]},"quoteId":{"type":"string"},"createdAt":{"type":"string"},"expiresAt":{"type":"string"},"out":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"},"paymentMethodId":{"type":"string"}},"required":["amount","currency","paymentMethodId"]},"fees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"breakdown":{"type":"object","properties":{"platformFees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"rate":{"type":"string"}},"required":["amountInToken","amountInFiat","rate"]},"integratorFees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"rate":{"type":"string"}},"required":["amountInToken","amountInFiat","rate"]}},"required":["platformFees","integratorFees"]}},"required":["amountInToken","amountInFiat","breakdown"]},"in":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"},"chain":{"type":"string"}},"required":["amount","currency","chain"]},"platformResidual":{"type":"boolean","enum":[true]},"kind":{"type":"string","enum":["estimate","executed"]}},"required":["fixedAmountSide","orderType","quoteId","createdAt","expiresAt","out","fees","in","platformResidual","kind"]}]},"fiatDetails":{"type":"object","properties":{"paymentMethodId":{"type":"string"},"payerDetails":{"type":"object","additionalProperties":{"type":"string"}},"payerDetailsId":{"type":"string"},"payeeDetails":{"type":"object","additionalProperties":{"type":"string"}},"payeeDetailsId":{"type":"string"}},"required":["paymentMethodId"]},"cryptoDetails":{"type":"object","properties":{"tokenAddress":{"type":"string"},"chainId":{"type":"string"},"depositAddress":{"type":"string"}},"required":["tokenAddress","chainId","depositAddress"]},"dueDate":{"type":"string"},"externalReferenceId":{"type":"string"}},"required":["userId","apiOrderId","orderStatus","type","createdDate","updatedDate","quote","fiatDetails","dueDate"],"title":"APISellOrderSchema","example":{"userId":"user_123","apiOrderId":"order_123","orderStatus":"WAITING_FOR_FUNDS","type":"SELL","createdDate":"2023-01-01T00:00:00Z","updatedDate":"2023-01-01T00:00:00Z","quote":{"quoteId":"quote_123","createdAt":"2023-01-01T00:00:00Z","expiresAt":"2023-01-01T00:00:00Z","fixedAmountSide":"IN","orderType":"SELL","fees":{"amountInToken":"0.02","amountInFiat":"0.02","breakdown":{"platformFees":{"amountInToken":"0.01","amountInFiat":"0.01","rate":"0.5"},"integratorFees":{"amountInToken":"0.01","amountInFiat":"0.01","rate":"0.5"}}},"out":{"amount":"100","currency":"USD","paymentMethodId":"pm_123","min":"100"},"in":{"amount":"0.1","currency":"BTC","chain":"BTC"},"kind":"estimate"},"fiatDetails":{"paymentMethodId":"pm_123","payerDetails":{"name":"John Doe","email":"john.doe@example.com"},"payerDetailsId":"payer_123","payeeDetails":{"name":"Jane Doe","email":"jane.doe@example.com"},"payeeDetailsId":"payee_123"},"cryptoDetails":{"tokenAddress":"0x1234567890abcdef","chainId":"1","depositAddress":"0xabcdef1234567890"},"dueDate":"2023-01-01T00:00:00Z","externalReferenceId":"123e4567-e89b-12d3-a456-426614174000"}}},"required":["order"]},"InvalidQuote":{"type":"object","properties":{"errorCode":{"type":"string","enum":["INVALID_QUOTE"]},"message":{"type":"string"},"reason":{"type":"string"}},"required":["errorCode","message"],"example":{"errorCode":"INVALID_QUOTE","message":"Invalid quote.","reason":"Quote not found or invalid"}},"QuoteNotFound":{"type":"object","properties":{"errorCode":{"type":"string","enum":["QUOTE_NOT_FOUND"]},"message":{"type":"string"},"reason":{"type":"string"}},"required":["errorCode","message"],"example":{"errorCode":"QUOTE_NOT_FOUND","message":"The requested quote was not found.","reason":"The quote ID is invalid or does not exist"}},"ExpiredQuote":{"type":"object","properties":{"errorCode":{"type":"string","enum":["EXPIRED_QUOTE"]},"message":{"type":"string"},"reason":{"type":"string"}},"required":["errorCode","message"],"example":{"errorCode":"EXPIRED_QUOTE","message":"Expired quote.","reason":"The quote has expired and is no longer valid"}},"TooManyActiveOrders":{"type":"object","properties":{"errorCode":{"type":"string","enum":["TOO_MANY_ACTIVE_ORDERS"]},"message":{"type":"string"},"reason":{"type":"string"}},"required":["errorCode","message"],"example":{"errorCode":"TOO_MANY_ACTIVE_ORDERS","message":"You have too many active orders. Please complete or wait for them to cancel before creating a new one."}},"CreateBuyOrderRequest":{"type":"object","properties":{"fiatDetails":{"anyOf":[{"type":"object","properties":{"details":{"type":"object","additionalProperties":{"type":"string"},"description":"Details of the payment method used for the fiat transaction, aiding verification by the counterparty.\nThe structure depends on the paymentMethodId.\nPersonal information like name, id, etc, will be added automatically according to our KYC records","example":{"bankName":"SuperBank","accountNumber":"1000AB12345"}}},"required":["details"]},{"type":"object","properties":{"detailsId":{"type":"string","description":"The ID of a previously saved payment method details, which will be used to create the order.\nThis is useful for recurring payments or when you want to use the same payment method details again.","example":"123e4567-e89b-12d3-a456-426614174000"}},"required":["detailsId"]}]},"cryptoDetails":{"type":"object","properties":{"recipientAddress":{"type":"string","example":"0x1234567890","description":"The cryptocurrency address where funds will be sent."},"tokenAddress":{"type":"string","example":"0x1234567890","description":"The address of the contract of the token to be received."},"chainId":{"type":"string","enum":["1","10","14","25","30","40","50","56","88","100","106","122","130","137","146","196","204","232","250","252","288","324","480","999","1088","1101","1135","1284","1285","1329","1480","1625","1868","1923","2020","2741","5000","8217","8453","9001","13371","32659","33139","34443","42161","42170","42220","42793","43114","55244","57073","59144","60808","80002","80094","81457","84532","98866","167000","421614","534352","747474","21000000","1313161554","1666600000","1151111081099710","1161011141099710","111971151099710","9270000000000000","20000000000001","20000000000002","20000000000003","20000000000004"],"example":"0x1","description":"A hexadecimal string starting with '0x' that identifies a blockchain network (e.g., '0x1' for Ethereum mainnet, '0x89' for Polygon). It must represent a positive integer less than or equal to 4,294,967,295 (32-bit unsigned integer)."}},"required":["recipientAddress","tokenAddress","chainId"]},"quoteId":{"type":"string","example":"123e4567-e89b-12d3-a456-426614174000","description":"The ID of the quote to use for the order."},"externalReferenceId":{"type":"string","pattern":"^[a-zA-Z0-9-]+$","description":"An external reference ID to help identify the order (only letters, numbers, and hyphens allowed)","example":"123e4567-e89b-12d3-a456-426614174000"}},"required":["fiatDetails","cryptoDetails","quoteId"]},"CreateBuyOrderResponse":{"type":"object","properties":{"order":{"type":"object","properties":{"userId":{"type":"string"},"apiOrderId":{"type":"string"},"orderStatus":{"type":"string","enum":["WAITING_FOR_FUNDS","REQUESTED","ACCEPTED","FIAT_PAID","FIAT_RECEIVED","COMPLETED","CANCELLED","DISPUTED"]},"type":{"type":"string","enum":["BUY"]},"createdDate":{"type":"string"},"updatedDate":{"type":"string"},"quote":{"anyOf":[{"type":"object","properties":{"fixedAmountSide":{"type":"string","enum":["IN"]},"orderType":{"type":"string","enum":["BUY"]},"quoteId":{"type":"string"},"createdAt":{"type":"string"},"expiresAt":{"type":"string"},"fees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"breakdown":{"type":"object","properties":{"platformFees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"rate":{"type":"string"}},"required":["amountInToken","amountInFiat","rate"]},"integratorFees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"rate":{"type":"string"}},"required":["amountInToken","amountInFiat","rate"]}},"required":["platformFees","integratorFees"]}},"required":["amountInToken","amountInFiat","breakdown"]},"in":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"},"paymentMethodId":{"type":"string"}},"required":["amount","currency","paymentMethodId"]},"out":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"},"chain":{"type":"string"},"min":{"type":"string"}},"required":["amount","currency","chain","min"]},"kind":{"type":"string","enum":["estimate","executed"]}},"required":["fixedAmountSide","orderType","quoteId","createdAt","expiresAt","fees","in","out","kind"]},{"type":"object","properties":{"fixedAmountSide":{"type":"string","enum":["OUT"]},"orderType":{"type":"string","enum":["BUY"]},"quoteId":{"type":"string"},"createdAt":{"type":"string"},"expiresAt":{"type":"string"},"fees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"breakdown":{"type":"object","properties":{"platformFees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"rate":{"type":"string"}},"required":["amountInToken","amountInFiat","rate"]},"integratorFees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"rate":{"type":"string"}},"required":["amountInToken","amountInFiat","rate"]}},"required":["platformFees","integratorFees"]}},"required":["amountInToken","amountInFiat","breakdown"]},"in":{"type":"object","properties":{"amount":{"type":"string"},"max":{"type":"string"},"currency":{"type":"string"},"paymentMethodId":{"type":"string"}},"required":["amount","max","currency","paymentMethodId"]},"out":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"},"chain":{"type":"string"},"max":{"type":"string"}},"required":["amount","currency","chain","max"]},"kind":{"type":"string","enum":["estimate","executed"]}},"required":["fixedAmountSide","orderType","quoteId","createdAt","expiresAt","fees","in","out","kind"]}]},"fiatDetails":{"type":"object","properties":{"paymentMethodId":{"type":"string"},"payerDetails":{"type":"object","additionalProperties":{"type":"string"}},"payerDetailsId":{"type":"string"},"payeeDetails":{"type":"object","additionalProperties":{"type":"string"}},"payeeDetailsId":{"type":"string"}},"required":["paymentMethodId"]},"cryptoDetails":{"type":"object","properties":{"tokenAddress":{"type":"string"},"chainId":{"type":"string"},"recipientAddress":{"type":"string"}},"required":["tokenAddress","chainId","recipientAddress"]},"dueDate":{"type":"string"},"externalReferenceId":{"type":"string"},"transferInfo":{"type":"object","properties":{"txHash":{"type":"string"},"txHashDestination":{"type":"string"},"transferDate":{"type":"string"},"amountOut":{"type":"string"}},"required":["txHash","transferDate","amountOut"]}},"required":["userId","apiOrderId","orderStatus","type","createdDate","updatedDate","quote","fiatDetails","dueDate"],"title":"APIBuyOrderSchema","example":{"userId":"user_123","apiOrderId":"order_123","orderStatus":"REQUESTED","type":"BUY","createdDate":"2023-01-01T00:00:00Z","updatedDate":"2023-01-01T00:00:00Z","quote":{"quoteId":"quote_123","createdAt":"2023-01-01T00:00:00Z","expiresAt":"2023-01-01T00:00:00Z","fixedAmountSide":"IN","orderType":"BUY","fees":{"amountInToken":"0.02","amountInFiat":"0.02","breakdown":{"platformFees":{"amountInToken":"0.01","amountInFiat":"0.01","rate":"0.5"},"integratorFees":{"amountInToken":"0.01","amountInFiat":"0.01","rate":"0.5"}}},"in":{"amount":"100","currency":"USD","paymentMethodId":"pm_123"},"out":{"amount":"0.1","currency":"BTC","chain":"BTC","min":"0.1"},"kind":"estimate"},"fiatDetails":{"paymentMethodId":"pm_123","payerDetails":{"name":"John Doe","email":"john.doe@example.com"},"payerDetailsId":"payer_123","payeeDetails":{"name":"Jane Doe","email":"jane.doe@example.com"},"payeeDetailsId":"payee_123"},"cryptoDetails":{"tokenAddress":"0x1234567890abcdef","chainId":"1","recipientAddress":"0xabcdef1234567890"},"dueDate":"2023-01-01T00:00:00Z","externalReferenceId":"123e4567-e89b-12d3-a456-426614174000","transferInfo":{"txHash":"0x1234567890abcdef","txHashDestination":"0xabcdef1234567890","transferDate":"2023-01-01T00:00:00Z","amountOut":"100"}}}},"required":["order"]},"UpdateApiOrderStatusResponse":{"type":"object","properties":{"order":{"anyOf":[{"type":"object","properties":{"userId":{"type":"string"},"apiOrderId":{"type":"string"},"orderStatus":{"type":"string","enum":["WAITING_FOR_FUNDS","REQUESTED","ACCEPTED","FIAT_PAID","FIAT_RECEIVED","COMPLETED","CANCELLED","DISPUTED"]},"type":{"type":"string","enum":["SELL"]},"createdDate":{"type":"string"},"updatedDate":{"type":"string"},"quote":{"anyOf":[{"type":"object","properties":{"fixedAmountSide":{"type":"string","enum":["IN"]},"orderType":{"type":"string","enum":["SELL"]},"txData":{"type":"object","properties":{"data":{"type":"string"},"value":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"chainId":{"type":"string","enum":["1","10","14","25","30","40","50","56","88","100","106","122","130","137","146","196","204","232","250","252","288","324","480","999","1088","1101","1135","1284","1285","1329","1480","1625","1868","1923","2020","2741","5000","8217","8453","9001","13371","32659","33139","34443","42161","42170","42220","42793","43114","55244","57073","59144","60808","80002","80094","81457","84532","98866","167000","421614","534352","747474","21000000","1313161554","1666600000","1151111081099710","1161011141099710","111971151099710","9270000000000000","20000000000001","20000000000002","20000000000003","20000000000004"]},"gasPrice":{"type":"string"},"gasLimit":{"type":"string"},"fromToken":{"type":"string"},"toToken":{"type":"string"},"fromAmount":{"type":"string"}},"required":["data","value","from","to","chainId","gasPrice","gasLimit","fromToken","toToken","fromAmount"]},"quoteId":{"type":"string"},"createdAt":{"type":"string"},"expiresAt":{"type":"string"},"out":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"},"paymentMethodId":{"type":"string"},"min":{"type":"string"}},"required":["amount","currency","paymentMethodId","min"]},"fees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"breakdown":{"type":"object","properties":{"platformFees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"rate":{"type":"string"}},"required":["amountInToken","amountInFiat","rate"]},"integratorFees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"rate":{"type":"string"}},"required":["amountInToken","amountInFiat","rate"]}},"required":["platformFees","integratorFees"]}},"required":["amountInToken","amountInFiat","breakdown"]},"in":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"},"chain":{"type":"string"}},"required":["amount","currency","chain"]},"kind":{"type":"string","enum":["estimate","executed"]}},"required":["fixedAmountSide","orderType","quoteId","createdAt","expiresAt","out","fees","in","kind"]},{"type":"object","properties":{"fixedAmountSide":{"type":"string","enum":["OUT"]},"orderType":{"type":"string","enum":["SELL"]},"txData":{"type":"object","properties":{"data":{"type":"string"},"value":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"chainId":{"type":"string","enum":["1","10","14","25","30","40","50","56","88","100","106","122","130","137","146","196","204","232","250","252","288","324","480","999","1088","1101","1135","1284","1285","1329","1480","1625","1868","1923","2020","2741","5000","8217","8453","9001","13371","32659","33139","34443","42161","42170","42220","42793","43114","55244","57073","59144","60808","80002","80094","81457","84532","98866","167000","421614","534352","747474","21000000","1313161554","1666600000","1151111081099710","1161011141099710","111971151099710","9270000000000000","20000000000001","20000000000002","20000000000003","20000000000004"]},"gasPrice":{"type":"string"},"gasLimit":{"type":"string"},"fromToken":{"type":"string"},"toToken":{"type":"string"},"fromAmount":{"type":"string"}},"required":["data","value","from","to","chainId","gasPrice","gasLimit","fromToken","toToken","fromAmount"]},"quoteId":{"type":"string"},"createdAt":{"type":"string"},"expiresAt":{"type":"string"},"out":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"},"paymentMethodId":{"type":"string"}},"required":["amount","currency","paymentMethodId"]},"fees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"breakdown":{"type":"object","properties":{"platformFees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"rate":{"type":"string"}},"required":["amountInToken","amountInFiat","rate"]},"integratorFees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"rate":{"type":"string"}},"required":["amountInToken","amountInFiat","rate"]}},"required":["platformFees","integratorFees"]}},"required":["amountInToken","amountInFiat","breakdown"]},"in":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"},"chain":{"type":"string"}},"required":["amount","currency","chain"]},"platformResidual":{"type":"boolean","enum":[true]},"kind":{"type":"string","enum":["estimate","executed"]}},"required":["fixedAmountSide","orderType","quoteId","createdAt","expiresAt","out","fees","in","platformResidual","kind"]}]},"fiatDetails":{"type":"object","properties":{"paymentMethodId":{"type":"string"},"payerDetails":{"type":"object","additionalProperties":{"type":"string"}},"payerDetailsId":{"type":"string"},"payeeDetails":{"type":"object","additionalProperties":{"type":"string"}},"payeeDetailsId":{"type":"string"}},"required":["paymentMethodId"]},"cryptoDetails":{"type":"object","properties":{"tokenAddress":{"type":"string"},"chainId":{"type":"string"},"depositAddress":{"type":"string"}},"required":["tokenAddress","chainId","depositAddress"]},"dueDate":{"type":"string"},"externalReferenceId":{"type":"string"}},"required":["userId","apiOrderId","orderStatus","type","createdDate","updatedDate","quote","fiatDetails","dueDate"],"title":"APISellOrderSchema","example":{"userId":"user_123","apiOrderId":"order_123","orderStatus":"WAITING_FOR_FUNDS","type":"SELL","createdDate":"2023-01-01T00:00:00Z","updatedDate":"2023-01-01T00:00:00Z","quote":{"quoteId":"quote_123","createdAt":"2023-01-01T00:00:00Z","expiresAt":"2023-01-01T00:00:00Z","fixedAmountSide":"IN","orderType":"SELL","fees":{"amountInToken":"0.02","amountInFiat":"0.02","breakdown":{"platformFees":{"amountInToken":"0.01","amountInFiat":"0.01","rate":"0.5"},"integratorFees":{"amountInToken":"0.01","amountInFiat":"0.01","rate":"0.5"}}},"out":{"amount":"100","currency":"USD","paymentMethodId":"pm_123","min":"100"},"in":{"amount":"0.1","currency":"BTC","chain":"BTC"},"kind":"estimate"},"fiatDetails":{"paymentMethodId":"pm_123","payerDetails":{"name":"John Doe","email":"john.doe@example.com"},"payerDetailsId":"payer_123","payeeDetails":{"name":"Jane Doe","email":"jane.doe@example.com"},"payeeDetailsId":"payee_123"},"cryptoDetails":{"tokenAddress":"0x1234567890abcdef","chainId":"1","depositAddress":"0xabcdef1234567890"},"dueDate":"2023-01-01T00:00:00Z","externalReferenceId":"123e4567-e89b-12d3-a456-426614174000"}},{"type":"object","properties":{"userId":{"type":"string"},"apiOrderId":{"type":"string"},"orderStatus":{"type":"string","enum":["WAITING_FOR_FUNDS","REQUESTED","ACCEPTED","FIAT_PAID","FIAT_RECEIVED","COMPLETED","CANCELLED","DISPUTED"]},"type":{"type":"string","enum":["BUY"]},"createdDate":{"type":"string"},"updatedDate":{"type":"string"},"quote":{"anyOf":[{"type":"object","properties":{"fixedAmountSide":{"type":"string","enum":["IN"]},"orderType":{"type":"string","enum":["BUY"]},"quoteId":{"type":"string"},"createdAt":{"type":"string"},"expiresAt":{"type":"string"},"fees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"breakdown":{"type":"object","properties":{"platformFees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"rate":{"type":"string"}},"required":["amountInToken","amountInFiat","rate"]},"integratorFees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"rate":{"type":"string"}},"required":["amountInToken","amountInFiat","rate"]}},"required":["platformFees","integratorFees"]}},"required":["amountInToken","amountInFiat","breakdown"]},"in":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"},"paymentMethodId":{"type":"string"}},"required":["amount","currency","paymentMethodId"]},"out":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"},"chain":{"type":"string"},"min":{"type":"string"}},"required":["amount","currency","chain","min"]},"kind":{"type":"string","enum":["estimate","executed"]}},"required":["fixedAmountSide","orderType","quoteId","createdAt","expiresAt","fees","in","out","kind"]},{"type":"object","properties":{"fixedAmountSide":{"type":"string","enum":["OUT"]},"orderType":{"type":"string","enum":["BUY"]},"quoteId":{"type":"string"},"createdAt":{"type":"string"},"expiresAt":{"type":"string"},"fees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"breakdown":{"type":"object","properties":{"platformFees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"rate":{"type":"string"}},"required":["amountInToken","amountInFiat","rate"]},"integratorFees":{"type":"object","properties":{"amountInToken":{"type":"string"},"amountInFiat":{"type":"string"},"rate":{"type":"string"}},"required":["amountInToken","amountInFiat","rate"]}},"required":["platformFees","integratorFees"]}},"required":["amountInToken","amountInFiat","breakdown"]},"in":{"type":"object","properties":{"amount":{"type":"string"},"max":{"type":"string"},"currency":{"type":"string"},"paymentMethodId":{"type":"string"}},"required":["amount","max","currency","paymentMethodId"]},"out":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"},"chain":{"type":"string"},"max":{"type":"string"}},"required":["amount","currency","chain","max"]},"kind":{"type":"string","enum":["estimate","executed"]}},"required":["fixedAmountSide","orderType","quoteId","createdAt","expiresAt","fees","in","out","kind"]}]},"fiatDetails":{"type":"object","properties":{"paymentMethodId":{"type":"string"},"payerDetails":{"type":"object","additionalProperties":{"type":"string"}},"payerDetailsId":{"type":"string"},"payeeDetails":{"type":"object","additionalProperties":{"type":"string"}},"payeeDetailsId":{"type":"string"}},"required":["paymentMethodId"]},"cryptoDetails":{"type":"object","properties":{"tokenAddress":{"type":"string"},"chainId":{"type":"string"},"recipientAddress":{"type":"string"}},"required":["tokenAddress","chainId","recipientAddress"]},"dueDate":{"type":"string"},"externalReferenceId":{"type":"string"},"transferInfo":{"type":"object","properties":{"txHash":{"type":"string"},"txHashDestination":{"type":"string"},"transferDate":{"type":"string"},"amountOut":{"type":"string"}},"required":["txHash","transferDate","amountOut"]}},"required":["userId","apiOrderId","orderStatus","type","createdDate","updatedDate","quote","fiatDetails","dueDate"],"title":"APIBuyOrderSchema","example":{"userId":"user_123","apiOrderId":"order_123","orderStatus":"REQUESTED","type":"BUY","createdDate":"2023-01-01T00:00:00Z","updatedDate":"2023-01-01T00:00:00Z","quote":{"quoteId":"quote_123","createdAt":"2023-01-01T00:00:00Z","expiresAt":"2023-01-01T00:00:00Z","fixedAmountSide":"IN","orderType":"BUY","fees":{"amountInToken":"0.02","amountInFiat":"0.02","breakdown":{"platformFees":{"amountInToken":"0.01","amountInFiat":"0.01","rate":"0.5"},"integratorFees":{"amountInToken":"0.01","amountInFiat":"0.01","rate":"0.5"}}},"in":{"amount":"100","currency":"USD","paymentMethodId":"pm_123"},"out":{"amount":"0.1","currency":"BTC","chain":"BTC","min":"0.1"},"kind":"estimate"},"fiatDetails":{"paymentMethodId":"pm_123","payerDetails":{"name":"John Doe","email":"john.doe@example.com"},"payerDetailsId":"payer_123","payeeDetails":{"name":"Jane Doe","email":"jane.doe@example.com"},"payeeDetailsId":"payee_123"},"cryptoDetails":{"tokenAddress":"0x1234567890abcdef","chainId":"1","recipientAddress":"0xabcdef1234567890"},"dueDate":"2023-01-01T00:00:00Z","externalReferenceId":"123e4567-e89b-12d3-a456-426614174000","transferInfo":{"txHash":"0x1234567890abcdef","txHashDestination":"0xabcdef1234567890","transferDate":"2023-01-01T00:00:00Z","amountOut":"100"}}}]}},"required":["order"]},"ForbiddenResponse":{"type":"object","properties":{"errorCode":{"type":"string","enum":["INVALID_ORDER_STATUS"]},"message":{"type":"string"},"reason":{"type":"string"}},"required":["errorCode","message"],"example":{"errorCode":"INVALID_ORDER_STATUS","message":"Invalid order status transition."}},"OpenOrderIssueRequest":{"type":"object","properties":{"description":{"type":"string","minLength":10,"maxLength":1000,"example":"Order issue description"},"language":{"type":"string","enum":["es","en","pt","es-AR"],"default":"es","example":"es"}},"required":["description"]},"UpdateOrderStatusResponse":{"type":"object","properties":{"ok":{"type":"boolean"}},"required":["ok"]},"NotFoundError":{"type":"object","properties":{"errorCode":{"type":"string","enum":["NOT_FOUND"]},"message":{"type":"string"},"reason":{"type":"string"}},"required":["errorCode","message"],"example":{"errorCode":"NOT_FOUND","message":"Order or user not found."}},"InternalError":{"type":"object","properties":{"errorCode":{"type":"string","enum":["INTERNAL_SERVER_ERROR"]},"message":{"type":"string"},"reason":{"type":"string"}},"required":["errorCode","message"],"example":{"errorCode":"INTERNAL_SERVER_ERROR","message":"An unexpected error occurred. Please try again later."}},"ProfileNotReady":{"type":"object","properties":{"errorCode":{"type":"string","enum":["PROFILE_NOT_READY"]},"message":{"type":"string"},"reason":{"type":"string"}},"required":["errorCode","message"],"example":{"errorCode":"PROFILE_NOT_READY","message":"Profile not ready. Please try again later."}},"CancelApiOrderResponse":{"type":"object","properties":{"ok":{"type":"boolean"}},"required":["ok"]},"RequestsResponse":{"type":"object","properties":{"requests":{"type":"array","items":{"type":"object","properties":{"requestId":{"type":"string"},"userId":{"type":"string"},"requestStatus":{"type":"string"},"description":{"type":"string"},"reference":{"type":"string"}},"required":["requestId","userId","requestStatus","description"]}}},"required":["requests"]},"CreateRequestRequest":{"type":"object","properties":{"cryptoCurrencyId":{"type":"string","example":"TRON-USDT"},"amount":{"type":"string","example":"100"},"description":{"type":"string","example":"Pay 100 USDT. Invoice #203581"},"reference":{"type":"string","example":"987654321","description":"Used to track external references withing the payment system"}},"required":["cryptoCurrencyId","amount","description"]},"CreateRequestResponse":{"type":"object","properties":{"request":{"type":"object","properties":{"requestId":{"type":"string"},"userId":{"type":"string"},"requestStatus":{"type":"string"},"cryptoCurrencyId":{"type":"string"},"amount":{"type":"string"},"description":{"type":"string"},"reference":{"type":"string"}},"required":["requestId","userId","requestStatus","cryptoCurrencyId","amount","description"]}},"required":["request"]},"GetUserInfoResponse":{"type":"object","properties":{"profile":{"type":["object","null"],"properties":{"userId":{"type":"string"},"fullName":{"type":"string"},"username":{"type":"string"},"email":{"type":"string"},"dateOfBirth":{"type":"string"},"countryOfResidence":{"type":"string"},"hashedPIN":{"type":"string"},"kyc_status":{"type":["string","null"],"enum":["started","pending","passed","rejected",null]},"kyc_rejectReason":{"type":"string","enum":["PHONE","COUNTRY_RESIDENCE","AGE","PHONE_NUMBER_VERIFICATION","ECONOMIC_ACTIVITY_OR_PEP","OTHER"]},"kyc_level":{"type":"string","enum":["L0","L1","L2","L3","L4","L5"]},"kyc_verifiedAt":{"type":"string"},"reputation":{"type":"number"},"userSource":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"disabled":{"type":"boolean"}},"required":["userId","fullName","username","dateOfBirth","createdAt","updatedAt"]},"account":{"type":"object","properties":{"userId":{"type":"string"},"currencyId":{"type":"string"},"amount":{"type":"string"},"status":{"type":"string","enum":["PENDING","CREATING","PAUSED","CREATED","ERROR"]}},"required":["userId","currencyId"]},"allowance":{"type":"object","properties":{"user_id":{"type":"string"},"level":{"type":"number"},"month_allowance_usd":{"type":"string"},"week_allowance_usd":{"type":"string"},"day_allowance_usd":{"type":"string"},"month_consumed_usd":{"type":"string"},"week_consumed_usd":{"type":"string"},"day_consumed_usd":{"type":"string"}},"required":["user_id","level","month_allowance_usd","week_allowance_usd","day_allowance_usd"]}},"required":["profile"]},"GetJWKSResponse":{"type":"object","properties":{"keys":{"type":"array","items":{"type":"object","properties":{"kty":{"type":"string"},"use":{"type":"string"},"alg":{"type":"string"},"kid":{"type":"string"},"n":{"type":"string"},"e":{"type":"string"}},"required":["kty","use","alg","kid","n","e"]}}},"required":["keys"]},"CreateSellQuoteRequest":{"type":"object","properties":{"token":{"anyOf":[{"type":"string"},{"type":"string","pattern":"^[A-Za-z0-9]{1,10}$"}],"description":"The address/symbol of the token to be sold","example":"0xFd086bC7CD5C481DCC9C85ebE478A1C0b69FCbb9"},"chainId":{"type":"string","enum":["1","10","14","25","30","40","50","56","88","100","106","122","130","137","146","196","204","232","250","252","288","324","480","999","1088","1101","1135","1284","1285","1329","1480","1625","1868","1923","2020","2741","5000","8217","8453","9001","13371","32659","33139","34443","42161","42170","42220","42793","43114","55244","57073","59144","60808","80002","80094","81457","84532","98866","167000","421614","534352","747474","21000000","1313161554","1666600000","1151111081099710","1161011141099710","111971151099710","9270000000000000","20000000000001","20000000000002","20000000000003","20000000000004"],"description":"The chain id of the token to be sold","example":"42161"},"fiatCurrencyId":{"type":"string","enum":["USD","COP","ARS","CLP","PEN","BRL","PYG","BOB","VES","MXN","DOP","ECU"],"description":"The unique identifier for the fiat currency to be received","example":"USD"},"paymentMethodId":{"type":"string","description":"The unique identifier for the payment method to be used. Get /payment-methods to obtain the list of supported payment methods.","example":"app_zelle"},"addressFrom":{"type":"string","description":"The address from which the funds will be sent. If not provided, the quote will be readonly.","example":"0xFd086bC7CD5C481DCC9C85ebE478A1C0b69FCbb9"},"amount":{"type":"string","description":"The token amount to be sold (IN) or the fiat amount to be received (OUT)","example":"100.00"},"fixedAmountSide":{"type":"string","enum":["IN","OUT"],"description":"Specifies whether the amount is fixed on the input (IN) or output (OUT) side","example":"IN"}},"required":["token","chainId","fiatCurrencyId","paymentMethodId","amount","fixedAmountSide"]},"GetSellQuoteResponse":{"anyOf":[{"type":"object","properties":{"amountIn":{"type":"string","description":"The exact token amount to be sold (in string format)","example":"100.00"},"amountOut":{"type":"string","description":"The maximum fiat amount to be received (in string format)","example":"100.00"},"minAmountOut":{"type":"string","description":"The minimum fiat amount to be received (in string format)","example":"99.98"},"fixedAmountSide":{"type":"string","enum":["IN"],"description":"Specifies whether the amount is fixed on the input (IN) or output (OUT) side","example":"IN"},"chainId":{"type":"string","description":"The chain id of the token to be sold","example":"42161"},"token":{"type":"string","description":"The symbol of the token to be sold","example":"USDT"},"quoteId":{"type":"string","description":"Unique identifier for the quote","example":"quote_123e4567-e89b-12d3-a456-426614174000"},"createdAt":{"type":"string","description":"ISO 8601 timestamp when the quote was created","example":"2024-01-15T10:30:00.000Z"},"expiresAt":{"type":"string","description":"ISO 8601 timestamp when the quote expires","example":"2024-01-15T10:35:00.000Z"},"exchangeRate":{"type":"string","description":"The fiat to crypto exchange rate of the quote (how many fiat for one crypto i.e. 1ETH = 1500USD)","example":"1409.23"},"fee":{"type":"object","properties":{"amountInToken":{"type":"string","description":"The fee amount in the same currency as the quote token","example":"0.50"},"amountInFiat":{"type":"string","description":"The fee amount in fiat","example":"704.61"},"breakdown":{"type":"object","properties":{"platformFees":{"type":"object","properties":{"amountInToken":{"type":"string","description":"The fee amount in the same currency as the quote token","example":"0.50"},"amountInFiat":{"type":"string","description":"The fee amount in fiat","example":"704.61"},"rate":{"type":"string","description":"The fee rate","example":"0.50"}},"required":["amountInToken","amountInFiat","rate"]},"integratorFees":{"type":"object","properties":{"amountInToken":{"type":"string","description":"The fee amount in the same currency as the quote token","example":"0.50"},"amountInFiat":{"type":"string","description":"The fee amount in fiat","example":"704.61"},"rate":{"type":"string","description":"The fee rate","example":"0.50"}},"required":["amountInToken","amountInFiat","rate"]}},"required":["platformFees","integratorFees"]}},"required":["amountInToken","amountInFiat","breakdown"]},"readonly":{"type":"boolean","enum":[true],"description":"Whether the quote is readonly. If true, the quote can not be used to create an order.","example":true}},"required":["amountIn","amountOut","minAmountOut","fixedAmountSide","chainId","token","quoteId","createdAt","expiresAt","exchangeRate","fee"],"description":"The sell quote containing all necessary details for the transaction"},{"type":"object","properties":{"amountIn":{"type":"string","description":"The exact token amount to be sold (in string format)","example":"100.00"},"amountOut":{"type":"string","description":"The exact fiat amount to be received (in string format)","example":"100.00"},"fixedAmountSide":{"type":"string","enum":["OUT"],"description":"Specifies whether the amount is fixed on the input (IN) or output (OUT) side","example":"OUT"},"chainId":{"type":"string","description":"The chain id of the token to be sold","example":"42161"},"token":{"type":"string","description":"The symbol of the token to be sold","example":"USDT"},"quoteId":{"type":"string","description":"Unique identifier for the quote","example":"quote_123e4567-e89b-12d3-a456-426614174000"},"createdAt":{"type":"string","description":"ISO 8601 timestamp when the quote was created","example":"2024-01-15T10:30:00.000Z"},"expiresAt":{"type":"string","description":"ISO 8601 timestamp when the quote expires","example":"2024-01-15T10:35:00.000Z"},"exchangeRate":{"type":"string","description":"The fiat to crypto exchange rate of the quote (how many fiat for one crypto i.e. 1ETH = 1500USD)","example":"1409.23"},"fee":{"type":"object","properties":{"amountInToken":{"type":"string","description":"The fee amount in the same currency as the quote token","example":"0.50"},"amountInFiat":{"type":"string","description":"The fee amount in fiat","example":"704.61"},"breakdown":{"type":"object","properties":{"platformFees":{"type":"object","properties":{"amountInToken":{"type":"string","description":"The fee amount in the same currency as the quote token","example":"0.50"},"amountInFiat":{"type":"string","description":"The fee amount in fiat","example":"704.61"},"rate":{"type":"string","description":"The fee rate","example":"0.50"}},"required":["amountInToken","amountInFiat","rate"]},"integratorFees":{"type":"object","properties":{"amountInToken":{"type":"string","description":"The fee amount in the same currency as the quote token","example":"0.50"},"amountInFiat":{"type":"string","description":"The fee amount in fiat","example":"704.61"},"rate":{"type":"string","description":"The fee rate","example":"0.50"}},"required":["amountInToken","amountInFiat","rate"]}},"required":["platformFees","integratorFees"]}},"required":["amountInToken","amountInFiat","breakdown"]},"readonly":{"type":"boolean","enum":[true],"description":"Whether the quote is readonly. If true, the quote can not be used to create an order.","example":true}},"required":["amountIn","amountOut","fixedAmountSide","chainId","token","quoteId","createdAt","expiresAt","exchangeRate","fee"],"description":"The sell quote containing all necessary details for the transaction"}]},"Unprocessable":{"type":"object","properties":{"errorCode":{"type":"string","enum":["QUOTE_NOT_AVAILABLE"]},"message":{"type":"string"},"reason":{"type":"string"}},"required":["errorCode","message"],"description":"The request was well-formed but could not be processed.","example":{"errorCode":"QUOTE_NOT_AVAILABLE","message":"Unprocessable entity.","reason":"The provided parameters are invalid or incomplete."}},"SwapRouteNotAvailable":{"type":"object","properties":{"errorCode":{"type":"string","enum":["SWAP_ROUTE_NOT_AVAILABLE"]},"message":{"type":"string"},"reason":{"type":"string"}},"required":["errorCode","message"],"example":{"errorCode":"SWAP_ROUTE_NOT_AVAILABLE","message":"No swap route available for the selected tokens.","reason":"The selected tokens currently do not have a valid swap route"}},"CreateBuyQuoteRequest":{"type":"object","properties":{"token":{"anyOf":[{"type":"string"},{"type":"string","pattern":"^[A-Za-z0-9]{1,10}$"}],"description":"The address/symbol of the token to be bought","example":"0xFd086bC7CD5C481DCC9C85ebE478A1C0b69FCbb9"},"chainId":{"type":"string","enum":["1","10","14","25","30","40","50","56","88","100","106","122","130","137","146","196","204","232","250","252","288","324","480","999","1088","1101","1135","1284","1285","1329","1480","1625","1868","1923","2020","2741","5000","8217","8453","9001","13371","32659","33139","34443","42161","42170","42220","42793","43114","55244","57073","59144","60808","80002","80094","81457","84532","98866","167000","421614","534352","747474","21000000","1313161554","1666600000","1151111081099710","1161011141099710","111971151099710","9270000000000000","20000000000001","20000000000002","20000000000003","20000000000004"],"description":"The chain id of the token to be bought","example":"42161"},"fiatCurrencyId":{"type":"string","enum":["USD","COP","ARS","CLP","PEN","BRL","PYG","BOB","VES","MXN","DOP","ECU"],"description":"The unique identifier for the fiat currency to be sent","example":"USD"},"paymentMethodId":{"type":"string","description":"The unique identifier for the payment method to be used. Get /payment-methods to obtain the list of supported payment methods.","example":"app_zelle"},"addressTo":{"type":"string","description":"The address to which the funds will be sent. If not provided, the quote will be readonly.","example":"0xFd086bC7CD5C481DCC9C85ebE478A1C0b69FCbb9"},"amount":{"type":"string","description":"The token amount to be sold (IN) or the fiat amount to be received (OUT)","example":"100.00"},"fixedAmountSide":{"type":"string","enum":["IN","OUT"],"description":"Specifies whether the amount is fixed on the input (IN) or output (OUT) side","example":"IN"}},"required":["token","chainId","fiatCurrencyId","paymentMethodId","amount","fixedAmountSide"]},"GetBuyQuoteResponse":{"anyOf":[{"type":"object","properties":{"amountIn":{"type":"string","description":"The exact fiat amount to be sent (in string format)","example":"100.00"},"amountOut":{"type":"string","description":"The maximum token amount to be received (in string format)","example":"100.00"},"minAmountOut":{"type":"string","description":"The minimum token amount to be received (in string format)","example":"99.98"},"fixedAmountSide":{"type":"string","enum":["IN"],"description":"Specifies whether the amount is fixed on the input (IN) or output (OUT) side","example":"IN"},"chainId":{"type":"string","description":"The chain id of the token to be bought","example":"42161"},"token":{"type":"string","description":"The symbol of the token to be bought","example":"USDT"},"quoteId":{"type":"string","description":"Unique identifier for the quote","example":"quote_123e4567-e89b-12d3-a456-426614174000"},"createdAt":{"type":"string","description":"ISO 8601 timestamp when the quote was created","example":"2024-01-15T10:30:00.000Z"},"expiresAt":{"type":"string","description":"ISO 8601 timestamp when the quote expires","example":"2024-01-15T10:35:00.000Z"},"exchangeRate":{"type":"string","description":"The fiat to crypto exchange rate of the quote (how many fiat for one crypto i.e. 1ETH = 1500USD)","example":"1409.23"},"fee":{"type":"object","properties":{"amountInToken":{"type":"string","description":"The fee amount in the same currency as the quote token","example":"0.50"},"amountInFiat":{"type":"string","description":"The fee amount in fiat","example":"704.61"},"breakdown":{"type":"object","properties":{"platformFees":{"type":"object","properties":{"amountInToken":{"type":"string","description":"The fee amount in the same currency as the quote token","example":"0.50"},"amountInFiat":{"type":"string","description":"The fee amount in fiat","example":"704.61"},"rate":{"type":"string","description":"The fee rate","example":"0.50"}},"required":["amountInToken","amountInFiat","rate"]},"integratorFees":{"type":"object","properties":{"amountInToken":{"type":"string","description":"The fee amount in the same currency as the quote token","example":"0.50"},"amountInFiat":{"type":"string","description":"The fee amount in fiat","example":"704.61"},"rate":{"type":"string","description":"The fee rate","example":"0.50"}},"required":["amountInToken","amountInFiat","rate"]}},"required":["platformFees","integratorFees"]}},"required":["amountInToken","amountInFiat","breakdown"]},"readonly":{"type":"boolean","enum":[true],"description":"Whether the quote is readonly. If true, the quote can not be used to create an order.","example":true}},"required":["amountIn","amountOut","minAmountOut","fixedAmountSide","chainId","token","quoteId","createdAt","expiresAt","exchangeRate","fee"],"description":"The buy quote containing all necessary details for the transaction"},{"type":"object","properties":{"amountIn":{"type":"string","description":"The exact fiat amount to be sent (in string format)","example":"100.00"},"amountOut":{"type":"string","description":"The exact token amount to be received (in string format)","example":"100.00"},"fixedAmountSide":{"type":"string","enum":["OUT"],"description":"Specifies whether the amount is fixed on the input (IN) or output (OUT) side","example":"OUT"},"chainId":{"type":"string","description":"The chain id of the token to be bought","example":"42161"},"token":{"type":"string","description":"The symbol of the token to be bought","example":"USDT"},"quoteId":{"type":"string","description":"Unique identifier for the quote","example":"quote_123e4567-e89b-12d3-a456-426614174000"},"createdAt":{"type":"string","description":"ISO 8601 timestamp when the quote was created","example":"2024-01-15T10:30:00.000Z"},"expiresAt":{"type":"string","description":"ISO 8601 timestamp when the quote expires","example":"2024-01-15T10:35:00.000Z"},"exchangeRate":{"type":"string","description":"The fiat to crypto exchange rate of the quote (how many fiat for one crypto i.e. 1ETH = 1500USD)","example":"1409.23"},"fee":{"type":"object","properties":{"amountInToken":{"type":"string","description":"The fee amount in the same currency as the quote token","example":"0.50"},"amountInFiat":{"type":"string","description":"The fee amount in fiat","example":"704.61"},"breakdown":{"type":"object","properties":{"platformFees":{"type":"object","properties":{"amountInToken":{"type":"string","description":"The fee amount in the same currency as the quote token","example":"0.50"},"amountInFiat":{"type":"string","description":"The fee amount in fiat","example":"704.61"},"rate":{"type":"string","description":"The fee rate","example":"0.50"}},"required":["amountInToken","amountInFiat","rate"]},"integratorFees":{"type":"object","properties":{"amountInToken":{"type":"string","description":"The fee amount in the same currency as the quote token","example":"0.50"},"amountInFiat":{"type":"string","description":"The fee amount in fiat","example":"704.61"},"rate":{"type":"string","description":"The fee rate","example":"0.50"}},"required":["amountInToken","amountInFiat","rate"]}},"required":["platformFees","integratorFees"]}},"required":["amountInToken","amountInFiat","breakdown"]},"readonly":{"type":"boolean","enum":[true],"description":"Whether the quote is readonly. If true, the quote can not be used to create an order.","example":true}},"required":["amountIn","amountOut","fixedAmountSide","chainId","token","quoteId","createdAt","expiresAt","exchangeRate","fee"],"description":"The buy quote containing all necessary details for the transaction"}]}},"parameters":{}},"paths":{"/clock":{"get":{"tags":["general"],"summary":"Get current server time","description":"Returns the current server time in ISO 8601 format. Ensure your client’s datetime is synchronized to avoid issues with signature operations.","responses":{"200":{"description":"Current server time","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClockResponse"}}}},"500":{"description":"Internal server error. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}}},"/prices":{"get":{"tags":["General"],"summary":"Get current market prices and limits for exchanges","description":"To obtain real-time pricing data and limits for exchanges, you can make a GET request to this endpoint. \n        This endpoint provides you with the current market prices for all of the supported currencies vs USDT.\n        Our API always uses USDT as the base currency. All prices are in USDT.\n\n        If selling crypto, the in limit is the crypto amount and the out limit is the fiat amount.\n        If buying crypto, the in limit is the fiat amount and the out limit is the crypto amount.\n        \n        i.e.\n        - If you are SELLING CRYPTO (USDT) with ARS: you can see the current price of the ARS vs USDT and the limits for the exchange.\n          in limit: min and max limits in USDT.\n          out limit: min and max limits in ARS.\n\n        - If you are BUYING CRYPTO (USDT) with COP: you can see the current price of the COP vs USDT and the limits for the exchange.\n          in limit: min and max limits in COP.\n          out limit: min and max limits in USDT.\n          \n        \n          ","responses":{"200":{"description":"Current price","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PricesResponse"}}}},"404":{"description":"Pricing data not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"500":{"description":"Internal server error. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}}},"/currencies":{"get":{"tags":["General"],"summary":"Get currencies","description":"To fetch a list of available currencies supported by our API, you can utilize the GET /currencies endpoint. \nThis endpoint provides a comprehensive list of both cryptocurrencies and fiat currencies that you can work with in your applications.","responses":{"200":{"description":"Currencies","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Currencies"}}}},"404":{"description":"Currencies not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"500":{"description":"Internal server error. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}}},"/countries":{"get":{"tags":["General"],"summary":"Get supported countries","description":"To fetch a list of available countries supported by our API, you can utilize the GET /countries endpoint.","responses":{"200":{"description":"Countries","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Countries"}}}},"404":{"description":"Countries not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"500":{"description":"Internal server error. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}}},"/chains":{"get":{"tags":["General"],"summary":"Get supported chains","description":"To fetch a list of available chains supported by our API, you can utilize the GET /chains endpoint.","responses":{"200":{"description":"Chains","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Chains"}}}},"404":{"description":"Chains not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"500":{"description":"Internal server error. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}}},"/chains/{chainId}/tokens":{"get":{"tags":["General"],"summary":"Get supported tokens by chain","description":"To fetch a list of available tokens supported by our API, you can utilize the GET /chains/{chainId}/tokens endpoint.","parameters":[{"schema":{"type":"string","enum":["1","10","14","25","30","40","50","56","88","100","106","122","130","137","146","196","204","232","250","252","288","324","480","999","1088","1101","1135","1284","1285","1329","1480","1625","1868","1923","2020","2741","5000","8217","8453","9001","13371","32659","33139","34443","42161","42170","42220","42793","43114","55244","57073","59144","60808","80002","80094","81457","84532","98866","167000","421614","534352","747474","21000000","1313161554","1666600000","1151111081099710","1161011141099710","111971151099710","9270000000000000","20000000000001","20000000000002","20000000000003","20000000000004"],"description":"The chain id of the token to be bought","example":"42161"},"required":true,"description":"The chain id of the token to be bought","name":"chainId","in":"path"}],"responses":{"200":{"description":"Tokens","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tokens"}}}},"400":{"description":"Invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameters"}}}},"404":{"description":"Tokens not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"500":{"description":"Internal server error. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}}},"/payment-methods":{"get":{"tags":["General"],"summary":"","description":"Retrieves all payment methods","responses":{"200":{"description":"Retrieves all payment methods","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethodsResponse"}}}},"404":{"description":"No payment methods found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}}},"/payment-details":{"get":{"tags":["Account"],"summary":"","description":"Retrieves all payment details from the user's account","parameters":[{"schema":{"type":"string","description":"Filter by payment method ID"},"required":false,"description":"Filter by payment method ID","name":"paymentMethodId","in":"query"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Client-ID","in":"header"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Referral-ID","in":"header"},{"schema":{"type":"string"},"required":false,"name":"User-Agent","in":"header"},{"schema":{"type":"string","description":"Bearer token"},"required":true,"description":"Bearer token","name":"Authorization","in":"header"}],"responses":{"200":{"description":"Retrieves all payment details from the user's account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentDetailsResponseSchema"}}}},"400":{"description":"Invalid parameters. Please check your request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameters"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}}},"/auth/login/send-otp":{"post":{"security":[],"tags":["Authentication"],"summary":"Login or register","description":"Sends an OTP to the email address provided. If the email address is not registered, a new user is created","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Client-ID","in":"header"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Referral-ID","in":"header"},{"schema":{"type":"string"},"required":false,"name":"User-Agent","in":"header"}],"requestBody":{"description":"Login Request body","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginSendOTPRequest"}}}},"responses":{"200":{"description":"OTP sent successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginTokenSentResponse"}}}},"400":{"description":"Invalid parameters. Please check your request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameters"}}}},"401":{"description":"Unauthorized. Invalid or missing authentication token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"429":{"description":"Rate limit exceeded. Please try again later","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceeded"}}}},"500":{"description":"Internal server error. Please try again later","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}}},"/auth/login/verify-otp":{"post":{"security":[],"tags":["Authentication"],"summary":"Login or register","description":"Validates the OTP and returns a token to use in the rest of the API","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Client-ID","in":"header"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Referral-ID","in":"header"},{"schema":{"type":"string"},"required":false,"name":"User-Agent","in":"header"}],"requestBody":{"description":"Login Request body","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginVerifyOTPRequest"}}}},"responses":{"200":{"description":"Cookie to use in the rest of the API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginTokenVerifiedResponse"}}}},"400":{"description":"Invalid parameters. Please check your request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameters"}}}},"401":{"description":"Unauthorized. Invalid or missing authentication token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Unable to signup or invalid credentials. Please check your request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorResponse"}}}},"429":{"description":"Account locked due to too many failed attempts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountLocked"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}}},"/login/status":{"get":{"tags":["Authentication"],"operationId":"getLoginStatus","summary":"Get login status","description":"Retrieves the login status for the authenticated user.","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Client-ID","in":"header"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Referral-ID","in":"header"},{"schema":{"type":"string"},"required":false,"name":"User-Agent","in":"header"},{"schema":{"type":"string","description":"Bearer token"},"required":true,"description":"Bearer token","name":"Authorization","in":"header"}],"responses":{"200":{"description":"Order history","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"}}}},"400":{"description":"Invalid request headers or parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameters"}}}},"401":{"description":"Unauthorized or session expired. Please authenticate again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized"}}}},"500":{"description":"Internal server error. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}}},"/kyc":{"get":{"tags":["account"],"summary":"Get KYC Status","description":"Retrieves the KYC (Know Your Customer) status for the authenticated user, including their verification level and any required actions.","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Client-ID","in":"header"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Referral-ID","in":"header"},{"schema":{"type":"string"},"required":false,"name":"User-Agent","in":"header"},{"schema":{"type":"string","description":"Bearer token"},"required":true,"description":"Bearer token","name":"Authorization","in":"header"}],"responses":{"200":{"description":"KYC Status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetKYCResponse"}}}},"400":{"description":"Invalid request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameters"}}}},"401":{"description":"Unauthorized or session expired. Please authenticate again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"KYC status not found for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"500":{"description":"Internal server error. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}},"post":{"tags":["account"],"summary":"Update KYC Status","description":"Updates the user’s KYC (Know Your Customer) information for level L1, including personal and identification details. Level L1 is the first step in the KYC process, requiring basic personal information. L2, L3, and L4 levels are handled through external providers and can be accessed via the KYC status endpoint.","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Client-ID","in":"header"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Referral-ID","in":"header"},{"schema":{"type":"string"},"required":false,"name":"User-Agent","in":"header"},{"schema":{"type":"string","description":"Bearer token"},"required":true,"description":"Bearer token","name":"Authorization","in":"header"}],"requestBody":{"description":"KYC information update request body","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateKycDataRequest"}}}},"responses":{"200":{"description":"KYC information updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateKycDataResponse"}}}},"400":{"description":"Invalid request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameters"}}}},"401":{"description":"Unauthorized or session expired. Please authenticate again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized"}}}},"500":{"description":"Internal server error. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}}},"/kyc/phone":{"post":{"tags":["account"],"summary":"Phone Verification","description":"Verifies the user’s phone number using a one-time verification code as part of the KYC (Know Your Customer) process.","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Client-ID","in":"header"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Referral-ID","in":"header"},{"schema":{"type":"string"},"required":false,"name":"User-Agent","in":"header"},{"schema":{"type":"string","description":"Bearer token"},"required":true,"description":"Bearer token","name":"Authorization","in":"header"}],"requestBody":{"description":"Phone verification request body","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneVerificationRequest"}}}},"responses":{"200":{"description":"Phone verification successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneVerificationResponse"}}}},"400":{"description":"Invalid request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameters"}}}},"401":{"description":"Unauthorized or session expired. Please authenticate again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized"}}}},"500":{"description":"Internal server error. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}}},"/orders/{id}":{"get":{"tags":["Orders"],"operationId":"getApiOrderById","summary":"Get order by ID","description":"Retrieves the details of a specific buy or sell order for the authenticated user by its ID.","parameters":[{"schema":{"type":"string","example":"123e4567-e89b-12d3-a456-426614174000"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Client-ID","in":"header"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Referral-ID","in":"header"},{"schema":{"type":"string"},"required":false,"name":"User-Agent","in":"header"},{"schema":{"type":"string","description":"Bearer token"},"required":true,"description":"Bearer token","name":"Authorization","in":"header"}],"responses":{"200":{"description":"Order details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApiOrderResponse"}}}},"400":{"description":"Invalid request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameters"}}}},"401":{"description":"Unauthorized or session expired. Please authenticate again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Order or user not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"500":{"description":"Internal server error. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}},"post":{"tags":["Orders"],"operationId":"updateApiOrderStatus","summary":"Update order status","description":"Updates the status of an order to either FIAT_PAID or FIAT_RECEIVED for the authenticated user, reflecting the progress of the fiat transaction.","parameters":[{"schema":{"type":"string","example":"123e4567-e89b-12d3-a456-426614174000"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Client-ID","in":"header"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Referral-ID","in":"header"},{"schema":{"type":"string"},"required":false,"name":"User-Agent","in":"header"},{"schema":{"type":"string","description":"Bearer token"},"required":true,"description":"Bearer token","name":"Authorization","in":"header"}],"responses":{"200":{"description":"Updated order details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateApiOrderStatusResponse"}}}},"400":{"description":"Invalid request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameters"}}}},"401":{"description":"Unauthorized or session expired. Please authenticate again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized"}}}},"403":{"description":"Invalid order status transition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"Order or user not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"500":{"description":"Internal server error. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}}},"/orders":{"get":{"tags":["Orders"],"operationId":"getApiOrders","summary":"Get orders history","description":"Retrieves the history of buy and sell orders for the authenticated user.","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Client-ID","in":"header"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Referral-ID","in":"header"},{"schema":{"type":"string"},"required":false,"name":"User-Agent","in":"header"},{"schema":{"type":"string","description":"Bearer token"},"required":true,"description":"Bearer token","name":"Authorization","in":"header"}],"responses":{"200":{"description":"Order history","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiOrdersResponse"}}}},"400":{"description":"Invalid request headers or parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameters"}}}},"401":{"description":"Unauthorized or session expired. Please authenticate again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized"}}}},"500":{"description":"Internal server error. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}}},"/orders/sell":{"post":{"tags":["Orders"],"operationId":"createSellOrder","summary":"Create a Sell Order","description":"Creates a sell (off-ramp) order request for exchanging cryptocurrency for fiat currency, specifying payment and cryptocurrency details.","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Client-ID","in":"header"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Referral-ID","in":"header"},{"schema":{"type":"string"},"required":false,"name":"User-Agent","in":"header"},{"schema":{"type":"string","description":"Bearer token"},"required":true,"description":"Bearer token","name":"Authorization","in":"header"}],"requestBody":{"description":"Order request body","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSellOrderRequest"}}}},"responses":{"200":{"description":"New order details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSellOrderResponse"}}}},"400":{"description":"Invalid parameters. Please check your request","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidParameters"},{"$ref":"#/components/schemas/InvalidQuote"}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuoteNotFound"}}}},"410":{"description":"The quote has expired and is no longer valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpiredQuote"}}}},"429":{"description":"Too many active orders. Please complete or wait for them to cancel before creating a new one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyActiveOrders"}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}}},"/orders/buy":{"post":{"tags":["Orders"],"operationId":"createBuyOrder","summary":"Create a Buy Order","description":"Creates a buy order request for exchanging fiat currency for cryptocurrency, specifying payment and cryptocurrency details.","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Client-ID","in":"header"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Referral-ID","in":"header"},{"schema":{"type":"string"},"required":false,"name":"User-Agent","in":"header"},{"schema":{"type":"string","description":"Bearer token"},"required":true,"description":"Bearer token","name":"Authorization","in":"header"}],"requestBody":{"description":"Buy order request body","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBuyOrderRequest"}}}},"responses":{"200":{"description":"New order details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBuyOrderResponse"}}}},"400":{"description":"Invalid parameters. Please check your request","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidParameters"},{"$ref":"#/components/schemas/InvalidQuote"}]}}}},"401":{"description":"Unauthorized or session expired. Please authenticate again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"A resource was not found. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuoteNotFound"}}}},"410":{"description":"The quote has expired and is no longer valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpiredQuote"}}}},"429":{"description":"Too many active orders. Please complete or wait for them to cancel before creating a new one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyActiveOrders"}}}},"500":{"description":"Internal server error. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}}},"/orders/{id}/issue":{"post":{"tags":["Orders"],"operationId":"createOrderIssue","summary":"Create an issue for an order","description":"Changes the status of an order to \"disputed\". This is used when the user has a problem with the order and wants to report it. A description of the issue must be provided in the request body. The order ID must be provided in the URL path. An email will be sent to the user with the details of the issue, and that will be used as a communication channel with the support team to resolve the issue.","parameters":[{"schema":{"type":"string","example":"19"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Client-ID","in":"header"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Referral-ID","in":"header"},{"schema":{"type":"string"},"required":false,"name":"User-Agent","in":"header"},{"schema":{"type":"string","description":"Bearer token"},"required":true,"description":"Bearer token","name":"Authorization","in":"header"}],"requestBody":{"description":"Order request body","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenOrderIssueRequest"}}}},"responses":{"200":{"description":"New order details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOrderStatusResponse"}}}},"400":{"description":"Invalid request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameters"}}}},"401":{"description":"Unauthorized or session expired. Please authenticate again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"404":{"description":"Order or user not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}},"503":{"description":"Profile not ready. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileNotReady"}}}}}}},"/orders/{id}/cancel":{"post":{"tags":["Orders"],"operationId":"cancelApiOrder","summary":"Cancel an order","description":"Cancels an existing order for the authenticated user, provided the order is in a cancellable state.","parameters":[{"schema":{"type":"string","example":"123e4567-e89b-12d3-a456-426614174000"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Client-ID","in":"header"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Referral-ID","in":"header"},{"schema":{"type":"string"},"required":false,"name":"User-Agent","in":"header"},{"schema":{"type":"string","description":"Bearer token"},"required":true,"description":"Bearer token","name":"Authorization","in":"header"}],"responses":{"200":{"description":"Cancelled order details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelApiOrderResponse"}}}},"400":{"description":"Invalid request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameters"}}}},"401":{"description":"Unauthorized access.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized"}}}},"403":{"description":"Forbidden action.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ForbiddenResponse"},{"example":{"errorCode":"ORDER_CANNOT_BE_CANCELLED","message":"The order cannot be cancelled in its current status.","reason":"Order is already shipped"}}]}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}}},"/requests":{"get":{"tags":["Requests"],"summary":"Get requests history","description":"Retrieves the history of payment requests for the authenticated user.","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Client-ID","in":"header"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Referral-ID","in":"header"},{"schema":{"type":"string"},"required":false,"name":"User-Agent","in":"header"},{"schema":{"type":"string","description":"Bearer token"},"required":true,"description":"Bearer token","name":"Authorization","in":"header"}],"responses":{"200":{"description":"Request history","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestsResponse"}}}},"400":{"description":"Invalid request headers or parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameters"}}}},"401":{"description":"Unauthorized or session expired. Please authenticate again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized"}}}},"500":{"description":"Internal server error. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}},"post":{"tags":["Requests"],"summary":"Create a request","description":"// TODO: ","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Client-ID","in":"header"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Referral-ID","in":"header"},{"schema":{"type":"string"},"required":false,"name":"User-Agent","in":"header"},{"schema":{"type":"string","description":"Bearer token"},"required":true,"description":"Bearer token","name":"Authorization","in":"header"}],"requestBody":{"description":"Request request body","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRequestRequest"}}}},"responses":{"200":{"description":"New request details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRequestResponse"}}}},"400":{"description":"Invalid parameters. Please check your request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameters"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized"}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}}},"/user-info":{"get":{"tags":["account"],"summary":"Get User information","description":"Obtains the user's information, including their profile, balance, and allowance.","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Client-ID","in":"header"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Referral-ID","in":"header"},{"schema":{"type":"string"},"required":false,"name":"User-Agent","in":"header"},{"schema":{"type":"string","description":"Bearer token"},"required":true,"description":"Bearer token","name":"Authorization","in":"header"}],"responses":{"200":{"description":"User information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUserInfoResponse"}}}},"400":{"description":"Invalid request headers or parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameters"}}}},"401":{"description":"Unauthorized or session expired. Please authenticate again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized"}}}},"404":{"description":"User not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"500":{"description":"Internal server error. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}}},"/.well-known/jwks.json":{"get":{"tags":["JWKs"],"summary":"Get the JWKs (JSON Web Key Set)","description":"Retrieves the JSON Web Key Set (JWKS) used for verifying JWTs issued by the API. This endpoint provides the public key in JWK format, which can be used to verify the signatures of JWTs issued by the API.","responses":{"200":{"description":"JWKs retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetJWKSResponse"}}}},"500":{"description":"Internal server error. Please try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}}},"/quote/sell":{"post":{"tags":["Quote"],"summary":"Get a quote for selling assets","description":"Obtains a quote for selling assets. This endpoint is used to get the current exchange rate and other details for a specific asset pair.\n\nIf the asset pair is not supported, an error will be returned. Assets can go through multiple exchange layers (e.g., from TATUM to USDT, then to USDC), and the quote will reflect the final exchange rate after all conversions.\n\nThis endpoint is typically used in the process of exchanging assets, where a user wants to know the current exchange rate before proceeding with the transaction.","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Client-ID","in":"header"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Referral-ID","in":"header"},{"schema":{"type":"string"},"required":false,"name":"User-Agent","in":"header"},{"schema":{"type":"string","description":"Bearer token. If not provided will be readonly"},"required":false,"description":"Bearer token. If not provided will be readonly","name":"Authorization","in":"header"}],"requestBody":{"description":"Create Sell Quote Request body","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSellQuoteRequest"}}}},"responses":{"200":{"description":"Successful response with quote details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSellQuoteResponse"}}}},"400":{"description":"InvalidParameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameters"}}}},"401":{"description":"Unauthorized. Invalid or missing authentication token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/Unprocessable"},{"$ref":"#/components/schemas/SwapRouteNotAvailable"}]}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}}},"/quote/buy":{"post":{"tags":["Quote"],"summary":"Get a quote for buying assets","description":"Obtains a quote for buying assets. This endpoint is used to get the current exchange rate and other details for a specific asset pair.\n\nIf the asset pair is not supported, an error will be returned. Assets can go through multiple exchange layers (e.g., from TATUM to USDT, then to USDC), and the quote will reflect the final exchange rate after all conversions.\n\nThis endpoint is typically used in the process of exchanging assets, where a user wants to know the current exchange rate before proceeding with the transaction.","parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Client-ID","in":"header"},{"schema":{"type":"string","minLength":1},"required":true,"name":"X-Referral-ID","in":"header"},{"schema":{"type":"string"},"required":false,"name":"User-Agent","in":"header"},{"schema":{"type":"string","description":"Bearer token. If not provided will be readonly"},"required":false,"description":"Bearer token. If not provided will be readonly","name":"Authorization","in":"header"}],"requestBody":{"description":"Create Buy Quote Request body","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBuyQuoteRequest"}}}},"responses":{"200":{"description":"Successful response with quote details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBuyQuoteResponse"}}}},"400":{"description":"InvalidParameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameters"}}}},"401":{"description":"Unauthorized. Invalid or missing authentication token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/Unprocessable"},{"$ref":"#/components/schemas/SwapRouteNotAvailable"}]}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}}}}}}},"webhooks":{}}