dexpayswagger.json

{"openapi":"3.0.0","paths":{"/info":{"get":{"operationId":"BackofficeController_getBusinessInfo","parameters":[],"responses":{"200":{"description":""}},"security":[{"x-api-secret":[]},{"x-api-key":[]}],"summary":"Get business information","tags":[""]}},"/tokens":{"get":{"operationId":"BackofficeController_getTokens","parameters":[],"responses":{"200":{"description":""}},"security":[{"x-api-secret":[]},{"x-api-key":[]}],"summary":"Get list of tokens","tags":[""]}},"/banks":{"get":{"operationId":"BackofficeController_getAllBanks","parameters":[],"responses":{"200":{"description":""}},"security":[{"x-api-secret":[]},{"x-api-key":[]}],"summary":"Get list of supported banks","tags":[""]}},"/banks/resolve":{"post":{"operationId":"BackofficeController_resolveBank","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolveAccountDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"security":[{"x-api-secret":[]},{"x-api-key":[]}],"summary":"Resolve bank","tags":[""]}},"/rate/{asset}":{"get":{"operationId":"BackofficeController_getRate","parameters":[{"name":"asset","required":true,"in":"path","schema":{"type":"string"}},{"name":"fiatAmount","required":false,"in":"query","description":"amount in fiat","schema":{"example":100,"type":"number"}},{"name":"tokenAmount","required":false,"in":"query","description":"amount in token","schema":{"example":100,"type":"number"}},{"name":"chain","required":false,"in":"query","description":"chain","schema":{"example":"BSC","enum":["BSC","SOL","APE","HEDERA","BASE","LISK","TRON","ARBITRUM"],"type":"string"}},{"name":"targetUsername","required":false,"in":"query","description":"Restrict rate preview matching to ads owned by this username","schema":{"example":"merchant_user","type":"string"}}],"responses":{"200":{"description":""}},"security":[{"x-api-secret":[]},{"x-api-key":[]}],"summary":"Get rate","tags":[""]}},"/merchant-target/{username}":{"get":{"operationId":"BackofficeController_validateMerchantTarget","parameters":[{"name":"username","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"x-api-secret":[]},{"x-api-key":[]}],"summary":"Validate a targeted merchant username","tags":[""]}},"/quote":{"post":{"operationId":"BackofficeController_getQuote","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetQuoteDto"}}}},"responses":{"201":{"description":""}},"security":[{"x-api-secret":[]},{"x-api-key":[]}],"summary":"Request a quote","tags":[""]}},"/quote/{quoteId}":{"post":{"operationId":"BackofficeController_executeQuote","parameters":[{"name":"quoteId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}},"security":[{"x-api-secret":[]},{"x-api-key":[]}],"summary":"Execute a quote","tags":[""]}},"/quote/{quoteId}/pay":{"post":{"operationId":"BackofficeController_payForQuote","parameters":[{"name":"quoteId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}},"security":[{"x-api-secret":[]},{"x-api-key":[]}],"summary":"Pay for a quote","tags":[""]}},"/order":{"get":{"operationId":"BackofficeController_getOrder","parameters":[{"name":"orderId","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"x-api-secret":[]},{"x-api-key":[]}],"summary":"Get an order","tags":[""]}},"/orders":{"get":{"operationId":"BackofficeController_getOrders","parameters":[{"name":"status","required":false,"in":"query","description":"Status of the order","schema":{"enum":["INACTIVE","PENDING","PAID","COMPLETED","CANCELLED"],"type":"string"}},{"name":"userId","required":false,"in":"query","description":"Filter orders by external user ID (referenceId)","schema":{"example":"user-123","type":"string"}},{"name":"page","required":false,"in":"query","description":"Page number (default: 1)","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Limit number (default: 10)","schema":{"type":"number"}}],"responses":{"200":{"description":""}},"security":[{"x-api-secret":[]},{"x-api-key":[]}],"summary":"Query orders","tags":[""]}},"/balance/{chain}/{symbol}":{"get":{"operationId":"BackofficeController_getBalance","parameters":[{"name":"symbol","required":true,"in":"path","description":"asset","schema":{"example":"USDT","type":"string"}},{"name":"chain","required":true,"in":"path","description":"chain","schema":{"example":"BSC","enum":["BSC","SOL","APE","HEDERA","BASE","LISK","TRON","ARBITRUM"],"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"x-api-secret":[]},{"x-api-key":[]}],"summary":"Get balance","tags":[""]}}},"info":{"title":"DEXPAY","description":"DEXPAY B2B API","version":"1.0","contact":{}},"tags":[],"servers":[],"components":{"securitySchemes":{"x-api-key":{"type":"apiKey","in":"header","name":"x-api-key","description":"API Key for authentication"},"x-api-secret":{"type":"apiKey","in":"header","name":"x-api-secret","description":"API Secret for authentication"}},"schemas":{"ResolveAccountDto":{"type":"object","properties":{"accountNumber":{"type":"string"},"bankCode":{"type":"string"}},"required":["accountNumber","bankCode"]},"GetQuoteDto":{"type":"object","properties":{"tokenAmount":{"type":"number","example":100,"description":"amount in token (If tokenAmount is not specified, fiatAmount will be used)"},"fiatAmount":{"type":"number","example":100,"description":"amount in fiat (If fiatAmount is not specified, tokenAmount will be used)"},"asset":{"type":"string","example":"USDT","description":"asset"},"chain":{"enum":["BSC","SOL","APE","HEDERA","BASE","LISK","TRON","ARBITRUM"],"type":"string","example":"BSC","description":"chain"},"type":{"enum":["BUY","SELL"],"type":"string","example":"BUY"},"bankCode":{"type":"string","example":"044","description":"bank code gotten from getBanks endpoint"},"targetUsername":{"type":"string","example":"merchant_user","description":"Restrict quote matching to ads owned by this username"},"userId":{"type":"string","example":"user-123","description":"External user ID to attach on the trade order"},"accountName":{"type":"string"},"accountNumber":{"type":"string"},"receivingAddress":{"type":"string"}},"required":["asset","chain","type","bankCode","accountName","accountNumber"]}}}}