Creating FIAT withdrawals

Withdrawal flow

You can withdraw your funds through personal area providing the merchant's account ID from bank or other wallets.

Creating withdrawal through personal area

1. In the Payment Gateway section, click on New withdrawal
2. In the new New withdrawal window, you must fill in the required fields:

• amount of withdrawal
• withdrawal currency
• bank name
• bank account
• beneficiary first and last name
• company name
• phone

3. XAMAX creates a withdrawal transaction and execute it

tip

XAMAX payment processing is instant. But the money will go to the bank account after the payment is processed by the bank, which takes T+3 days

4. After creating a withdrawal, the transaction appears in the list of withdrawals in the Pending status. Merchant can track all created withdrawals and their status

5. Merchant can view detailed information on each withdrawal

Creating withdrawal through API

Creating withdrawal

The merchant can create an withdrawal through a XAMAX API:

Production

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

{
  "amount": 700000,
  "currency": "NGN",
  "bank_account_number": "123445643232",
  "bank_name": "Kapital",
  "name": "John",
  "surname": "Doe",
  "organisation_name": "Google",
  "phone": "+996123456789",
  "ifsc_number": "SBIN0000123"
}

Sandbox

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

{
  "amount": 700000,
  "currency": "NGN",
  "bank_account_number": "123445643232",
  "bank_name": "Kapital",
  "name": "John",
  "surname": "Doe",
  "organisation_name": "Google",
  "phone": "+996123456789",
  "ifsc_number": "SBIN0000123"
}

SwaggerAPI documentationHow to get access tokenContact to support

Parameter	Type	Description	Default value	Example
bank_account_number *	string	Bank account number (IBAN, BBAN)		123456789
currency *	string	Currency code in ISO 4217 alfa-3 format		USD
bank_name *	string	Bank name		Cambridge bank
amount *	string	Amount for transaction		100.00
name *	string	Beneficiary first name		John
surname *	string	Beneficiary last name		Doe
organisation_name *	string	Company name		Google
phone *	string	Beneficiary phone number		+996123456789
ifsc_number	string	ISFC code of bank branch. ONLY FOR INR withdrawal		SBIN0000123

* - Required parameter

Response example

{
  "withdrawal_id": 1,
  "amount": "70",
  "currency": "NGN",
  "bank_account_number": "123445643232",
  "bank_name": "Kapital",
  "name": "John",
  "surname": "Doe",
  "organisation_name": "Organization Name",
  "phone": "+996123456789",
  "status": "withdrawal_status_pending",
  "date": "2023-08-14T12:41:51.733509Z"
}

List of withdrawals

Production

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

Sandbox

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

SwaggerAPI documentationHow to get access tokenContact to support

Request contains query parameters

Parameter	Type	Description	Default value	Example
order_direction *	string	Direction of sorting. Available values : asc, desc	asc	asc
order	string	Order by field		status
page *	string	Page number		1
per_page *	string	Number of transactions on one page	20	20
status	string	Filter by status. Available values : withdrawal_status_pending, withdrawal_status_complete, withdrawal_status_failed, withdrawal_status_waiting, withdrawal_status_canceled		withdrawal_status_canceled
payment_method	string	Filter by payment methods. Available values : bank_transfer		go_pay_ewallet
since	string	Filter from creating transaction's date
till	string	Filter to creating transaction's date

* - Required parameter

Response example

{
  "withdrawals": [
    {
      "withdrawal_id": 12,
      "created_at": "2023-06-02T07:07:51.000000Z",
      "status": "withdrawal_status_pending",
      "amount": 700,
      "currency": "NGN",
      "payment_type": "bank_transfer"
    }
  ]
}

Detailed information of withdrawal

Production

GET https://api.xamax.io/fiat/v1/withdrawal?withdrawal_id={ID} HTTP/1.1
Authorization: Bearer {ACCESS_TOKEN}

Sandbox

GET https://api.sandbox.xamax.io/fiat/v1/withdrawal?withdrawal_id={ID} HTTP/1.1
Authorization: Bearer {ACCESS_TOKEN}

SwaggerAPI documentationHow to get access tokenContact to support

Request contains query parameters

Parameter	Type	Description	Default value	Example
withdrawal_id *	string	Withdrawal's Identifier		100

* - Required parameter

Response example

{
  "withdrawal_id": 1,
  "created_at": "2023-05-30T14:23:55.000000Z",
  "updated_at": "2023-05-30T14:23:55.000000Z",
  "amount": 700,
  "currency": "NGN",
  "payment_type": "bank_transfer",
  "status": "withdrawal_status_pending",
  "bank_account_number": "12312354564646",
  "bank_name": "Capital",
  "name": "John",
  "surname": "Doe",
  "organisation_name": "Google"
}