Skip to main content

Payment Link

Payment link provide to You easy way to receive payment from the client.
On the payment link page the client can select availbale and simple, for him, option of payment and pay the transaction. At this moment at payment link available next payment methods:

  • Scan QR and pay by crypto wallet
  • Pay by card

Preparation

Before you can start crate a payment link and accepting payments, you need to make settings and specify callback URL.

To create a payment link, you need to use the request /v1/payment-link (Production or Sandbox).
It is enough to specify the reference identifier txId from the merchant system.
You may not specify the currency code code, the amount amount, urlRedirectSuccess, urlRedirectFail or invoice type

The merchant creating invoice by API or at private area and share the link to payment. The merchant knows crypto currency and amount at the currency for transaction, and client cannot change it.

Example: Merchant wants to receive 50 USDT. See values in blockchain units in crypto settings

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

{
"txId": "120229",
"code": [ "usdt" ],
"amount": "50000000",
"urlRedirectSuccess": "https://YourUrlAddress",
"urlRedirectFail": "https://YourUrlAddress"
}
Parametres
  1. txId - Unique transaction identifier of the merchant (platform)
  2. code - Code of invoice currency
  3. amount - Amount of transaction from merchant
  4. urlRedirectSuccess - URL address, where the customer to be redirected after success processing
  5. urlRedirectFail - URL address, where the customer to be redirected after falied processing

The merchant creating payment link at USD and indicate only one crypto currency for payment

Example: Merchant wants to receive 1000 USD at ETH only

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

{
"txId": "120230",
"code": [ "eth" ],
"urlRedirectSuccess": "https://YourUrlAddress",
"urlRedirectFail": "https://YourUrlAddress",
"fiat": {
"amount": 1000,
"currency": "usd"
}
}
Parametres
  1. txId - Unique transaction identifier of the merchant (platform)
  2. code - Code of invoice currency
  3. Fiat amount - Amount of transaction at fiat currency
  4. Fiat currecny - Fiat currency for payment
  5. urlRedirectSuccess - URL address, where the customer to be redirected after success processing
  6. urlRedirectFail - URL address, where the customer to be redirected after falied processing

The merchant creating payment link at USD and don't indicate crypto currencies for payment.

Example: Merchant wants to receive 1000 USD at any currencies

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

{
"txId": "120231",
"urlRedirectSuccess": "https://YourUrlAddress",
"urlRedirectFail": "https://YourUrlAddress",
"fiat": {
"amount": 1000,
"currency": "usd"
}
}
Parametres
  1. txId - Unique transaction identifier of the merchant (platform)
  2. Fiat amount - Amount of transaction at fiat currency
  3. Fiat currecny - Fiat currency for payment
  4. urlRedirectSuccess - URL address, where the customer to be redirected after success processing
  5. urlRedirectFail - URL address, where the customer to be redirected after falied processing

The merchant creating payment link, but don't indicated amount (at crypto or fiat), and indicated list of crypto currencies, available for payment

Example: Merchant wants to receive some amount ( which client put at payment link form), at selected, from merchant's side, crypto currencies.

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

{
"txId": "120232",
"code": [ "usdt", "eth", "btc", "usdt_trc20", "bnb", "zec" ],
"urlRedirectSuccess": "https://YourUrlAddress",
"urlRedirectFail": "https://YourUrlAddress"
}
Parametres
  1. txId - Unique transaction identifier of the merchant (platform)
  2. code - Code of available currencies on payment link
  3. urlRedirectSuccess - URL address, where the customer to be redirected after success processing
  4. urlRedirectFail - URL address, where the customer to be redirected after falied processing

The merchant creating payment link, but don't indicate amount (at crypto or fiat) and list of crypto currencies

Example: Merchant wants to receive some amount ( which client put at payment link form) at any currencies

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

{
"txId": "120233",
"urlRedirectSuccess": "https://YourUrlAddress",
"urlRedirectFail": "https://YourUrlAddress"
}
Parametres
  1. txId - Unique transaction identifier of the merchant (platform)
  2. urlRedirectSuccess - URL address, where the customer to be redirected after success processing
  3. urlRedirectFail - URL address, where the customer to be redirected after falied processing

The merchant creating payment link, but don't indicate amount (at crypto or fiat) and indicate receiving currency - BTC

Example: Merchant wants to receive some amount ( which client put at payment link form) at BTC

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

{
"txId": "120234",
"code": [ "btc" ],
"urlRedirectSuccess": "https://YourUrlAddress",
"urlRedirectFail": "https://YourUrlAddress"
}
Parametres
  1. txId - Unique transaction identifier of the merchant (platform)
  2. code - Code of invoice currency
  3. urlRedirectSuccess - URL address, where the customer to be redirected after success processing
  4. urlRedirectFail - URL address, where the customer to be redirected after falied processing