Skip to main content

API reference overview

The Guardarian API lets partners request exchange data and create and track customer transactions.

Base URL​

https://api-payments.guardarian.com

Authentication​

Every protected request requires a partner API token. See Authentication for the header format and customer IP address precedence.

API reference sections​

  • Status: Check whether the Guardarian API is available.
  • Currency: Get supported fiat currencies, crypto assets and networks.
  • Transaction: Create transactions and request existing transactions.
  • Estimate: Calculate an estimated exchange result before creating a transaction.
  • Market info: Get minimum and maximum amounts for a currency pair.
  • Country: Get supported countries and payment categories by country.
  • Customer: Request customer risk status and import shared Know Your Customer (KYC) data.
  • Payment category: Get payment categories and their country availability.
  • Institutional exchanges: Create and manage business-to-business exchanges and payout accounts.

Error response format​

Error responses use the same three fields across endpoints:

{
  "statusCode": 400,
  "code": "BAD_REQUEST",
  "message": "Bad request error"
}

statusCode is the HTTP status code, code is a machine-readable error identifier and message describes the error.

  • PAIR_NOT_AVAILABLE (400): the selected currencies, networks and payment method cannot be exchanged together right now. Returned by GET /v1/estimate and POST /v1/transaction.