Settings for FIAT Gate

Getting list of merchant's settings

This request allows you to view the list of available payment gateway settings for fiat payments.

Production

GET https://api.xamax.io/fiat/v1/merchant/preferences HTTP/1.1
Authorization: Bearer {ACCESS_TOKEN}

Sandbox

GET https://api.sandbox.xamax.io/fiat/v1/merchant/preferences HTTP/1.1
Authorization: Bearer {ACCESS_TOKEN}

SwaggerAPI documentationHow to get access tokenContact to support

Response example

{
  "merchantPreferences": [
    {
      "key": "country",
      "value": "CHN",
      "created_at": "2023-06-18T10:05:02.000000Z",
      "updated_at": "2023-06-23T15:54:09.000000Z"
    },
    {
      "key": "currency",
      "value": "CNY",
      "created_at": "2023-06-18T10:05:02.000000Z",
      "updated_at": "2023-06-23T15:54:09.000000Z"
    },
    {
      "key": "additional_currency",
      "value": "EUR",
      "created_at": "2023-05-29T11:29:31.000000Z",
      "updated_at": "2023-07-04T18:06:08.000000Z"
    },
    {
      "key": "callback_url",
      "value": "https://localhost.ru",
      "created_at": "2023-05-29T11:29:31.000000Z",
      "updated_at": "2023-07-04T18:06:08.000000Z"
    },
    {
      "key": "risk",
      "value": "high",
      "created_at": "2023-05-29T11:29:31.000000Z",
      "updated_at": "2023-07-04T18:06:08.000000Z"
    },
    {
      "key": "type_of_fee_calculations",
      "value": "forward_without_fee",
      "created_at": "2023-05-29T11:29:31.000000Z",
      "updated_at": "2023-07-04T18:06:08.000000Z"
    },
    {
      "key": "additional_fee",
      "value": 5,
      "created_at": "2023-05-29T11:29:31.000000Z",
      "updated_at": "2023-07-04T18:06:08.000000Z"
    },
    {
      "key": "merchant_fee_percent",
      "value": 5,
      "created_at": "2023-05-29T11:29:31.000000Z",
      "updated_at": "2023-07-04T18:06:08.000000Z"
    },
    {
      "key": "merchant_fee_fix",
      "value": 0,
      "created_at": "2023-05-29T11:29:31.000000Z",
      "updated_at": "2023-07-04T18:06:08.000000Z"
    }
  ]
}

Parameter	Data type	Description	Example
country	string	Merchant's country in ISO 3166-1 alpha-2 code	CHN
currency	string	Default merchant's fiat currency in ISO 4217 three-letter alpha-3 code	CNY
additional_currency	string	Additional merchant's fiat currency in ISO 4217 three-letter alpha-3 code	CHN
risk	string	Level of risk for merchant's transactions. Available values are low, high	high
type_of_fee_calculations	string	Type of fee calculation. Available values are forward_without_fee, forward_with_fee	forward_without_fee
additional_fee	string	Merchant's additional fix fee in default currency
merchant_fee_percent *	string	Merchant's percent fee
merchant_fee_fix *	string	Merchant's fix fee
callback-url	string	URL where data is sent when a new transaction is received or its status changes	https://example.com

* - Configurable by manager

Change settings

Set callback URL from personal area

You can set callback through the settings in your account. To set a callback URL for fiat payments, you need to go to the settings in the Payment Gate tab and add the URL in the Callback URL (for Payment Gate) field

Set callback URL through API

A request will be sent to this URL when the payment status changes.

Production

PATCH https://api.xamax.io/fiat/v1/merchant/preferences HTTP/1.1
Authorization: Bearer {ACCESS_TOKEN}
Content-Type: application/json

{
    "key": "callback-url",
    "value": "https://example.com/callback"
}

Sandbox

PATCH https://api.sandbox.xamax.io/fiat/v1/merchant/preferences HTTP/1.1
Authorization: Bearer {ACCESS_TOKEN}
Content-Type: application/json

{
    "key": "callback-url",
    "value": "https://example.com/callback"
}

SwaggerAPI documentationHow to get access tokenContact to support

Callback example

POST https://youraddress.com/callback HTTP/1.1
Authorization: Bearer {CALLBACK_SIGN}
Content-Type: application/json
X-Resource-Type: invoice

{
    "merchant_transaction_id": 1719912817002,
    "amount": 550.44,
    "status": "transaction_status_pending",
    "substatus": "payin_pending",
    "substatus_description": "Waiting for payment",
    "currency": "INR",
    "country": "IND",
    "payment_method": "online_banking",
    "created_at": "2024-07-02 09:33:38",
    "message": "Transaction created successful"
}

Get available payment methods for selected country

The request allows you to see the list of available payment methods for the selected country

Production

POST https://api.xamax.io/fiat/v1/payment/methods HTTP/1.1
Authorization: Bearer {ACCESS_TOKEN}
Content-Type: application/json

{
  "country": "NGA",
  "currency": "NGN"
}

Sandbox

POST https://api.sandbox.xamax.io/fiat/v1/payment/methods HTTP/1.1
Authorization: Bearer {ACCESS_TOKEN}
Content-Type: application/json

{
  "country": "NGA",
  "currency": "NGN"
}

SwaggerAPI documentationHow to get access tokenContact to support

Response example

{
  "payment_methods": [
    {
      "payment_method": "virtual_bank_account",
      "currency": "NGN"
    }
  ]
}

Available currencies

symbol	link
eur	Euro
usd	US Dollar
local currencies*	Depends on supported countries