Acquiring HTTP API

[GET] Get a list of available currencies

/acquiring/{slug}/currencies

{slug} - unique instance name defined for payment page. Can be found on each payment page settings page in CRM.

Response Payload

{
  "currencies":[
    {
      "id":"44415cca-78a8-4df9-bc19-2409ab859a17",
      "precision":2,
      "icon":"https://media.whitepay.com/2509651f-d5bc-48fc-af2b-3e7d6fe12dd4/TRX.svg",
      "ticker":"TRX",
      "is_fiat":false,
      "limits":{
        "TRX":{
          "min":"10",
          "max":null
        }
      },
      "min":"100",
      "max":"0",
      "is_stable":false,
      "name":"Tron",
      "networks":{
        "TRX":{
          "min_amount":"10",
          "max_amount":"0",
          "fixed":"1",
          "flex":null
        }
      },
      "exchange_rate":"0.078042",
      "preset_donation_values":[

      ]
    }
  ]
}

Check out invoice currencies entity reference for detailed description.

[POST] Create an order

/acquiring/{slug}/pay

Name	Data type	Required	Description
amount	decimal	Y	order amount
currency_id	string	Y	order currency
network	string	Y	currency network
external_order_id	string	N	additional external invoice id

Request Payload

{
   "amount":5,
   "currency_id":"44415cca-78a8-4df9-bc19-2409ab859a17",
   "external_order_id": "order_id_2342423",
   "method":"WALLET",
   "network":"TRX"
}

Response Payload

{
  "order":{
    "id":"43a7afe4-9964-4c2d-967c-3a16c41db4d8"
  }
}

[GET] Receive order details

/acquiring/{slug}/order/{id}

{id} - id of previously created order

Response Payload

{
  "order": {
    "id": "43a7afe4-9964-4c2d-967c-3a16c41db4d8",
    "min_deposit_amount": "5",
    "amount": null,
    "expected_amount": "21",
    "network_fee": "1",
    "status": "OPEN",
    "order_type": "CRYPTO_DONATION",
    "exchange_rate": null,
    "received_total": "0",
    "invoice_reminder": "21",
    "payment_url": null,
    "successful_link": null,
    "failure_link": null,
    "fixated_at": "2024-07-17 13:07:07",
    "wallet": {
      "address": "TA9NT7kSgMt2PCe5geTaKhXm6V8DvRNZEu",
      "network": "TRC20",
      "memo": null
    },
    "currency": {
      "id": "d9da4bdc-1c0b-4835-8ec6-a7118247340f",
      "icon": "https://media.whitepay.com/c9409283-ed01-436f-bb6d-8763ff06ba54/USDT-(2).svg",
      "crm_icon": "https://media.whitepay.com/e2d19518-2d8e-4c95-9db0-89f64b792da9/AWS-S3-Bucket-Cost-(1).png",
      "limits": {
        "ARBITRUM": {
          "min": "5",
          "max": null
        },
        "BEP20": {
          "min": "9",
          "max": null
        }
      },
      "networks": [
        "POLYGON",
        "ARBITRUM"
      ],
      "precision": 2,
      "ticker": "USDT"
    },
    "currency_target": {
      "id": "d9da4bdc-1c0b-4835-8ec6-a7118247340f",
      "icon": "https://media.whitepay.com/c9409283-ed01-436f-bb6d-8763ff06ba54/USDT-(2).svg",
      "crm_icon": "https://media.whitepay.com/e2d19518-2d8e-4c95-9db0-89f64b792da9/AWS-S3-Bucket-Cost-(1).png",
      "precision": 2,
      "ticker": "USDT"
    },
    "merchant_fee": null,
    "merchant_fee_percentage": null,
    "merchant_fee_currency": {
      "id": "d9da4bdc-1c0b-4835-8ec6-a7118247340f",
      "icon": "https://media.whitepay.com/c9409283-ed01-436f-bb6d-8763ff06ba54/USDT-(2).svg",
      "crm_icon": "https://media.whitepay.com/e2d19518-2d8e-4c95-9db0-89f64b792da9/AWS-S3-Bucket-Cost-(1).png",
      "precision": 2,
      "ticker": "USDT"
    },
    "transactions": [],
    "created_at": "2024-07-17 13:07:07",
    "number": "296959894",
    "external_order_id": null,
    "is_able_to_express": true,
    "express_url": null,
    "express_date_updated_at": null,
    "calculated_value": null,
    "feedbacks": [],
    "required_params": []
  }
}

Check out order entity reference for detailed description.