Misc - Docs

[GET] Show Order Details

/private-api/orders/{slug}/{orderId}

Attribute	Type	Required	Description
slug	string	Y	unique instance name defined for payment page. Can be found on each payment page settings page in CRM.
orderId	string	Y	unique identifier of order

Response Payload

{
  "order":{
    "id":"9d05ffbb-0f89-488a-ad58-2a9bc207d3ab",
    "currency":"USDC",
    "order_number":"934600839",
    "value":"100",
    "expected_amount":null,
    "received_total":"0",
    "exchange_rate":null,
    "clean_exchange_rate":null,
    "is_internal":null,
    "deposited_currency":"USDT",
    "received_currency":"USDC",
    "status":"INIT",
    "external_order_id":null,
    "created_at":"2024-09-16 12:48:28",
    "completed_at":null,
    "acquiring_url":null,
    "successful_link":null,
    "failure_link":null,
    "transactions":[

    ]
  }
}

Check out order entity reference for detailed description.

[GET] Show Orders List

/private-api/orders/{slug}

Attribute	Type	Required	Description
slug	string	Y	unique instance name defined for payment page. Can be found on each payment page settings page in CRM.

Response Payload

{
  "orders": [
    {
      "id": "effc4486-b288-4e57-bb12-d2ae196f5daf",
      "currency": "EUR",
      "order_number": "538188474",
      "value": "12.12",
      "expected_amount": "13.5",
      "received_total": "13.37",
      "exchange_rate": "0.89777",
      "clean_exchange_rate": "1",
      "is_internal": true,
      "deposited_currency": "USDT",
      "received_currency": "USDT",
      "status": "COMPLETE",
      "external_order_id": null,
      "created_at": "2024-09-19 09:45:14",
      "completed_at": "2024-09-19 09:46:19",
      "acquiring_url": "https://merchant.pay.payplay.io/crypto-orders/effc4486-b288-4e57-bb12-d2ae196f5daf",
      "successful_link": null,
      "failure_link": null,
      "transactions": [
        {
          "id": "8da6dc9b-276a-4eb9-9260-edb754a02018",
          "type": "CRYPTO_INVOICE",
          "currency": "USDT",
          "value": "13.5",
          "status": "COMPLETE",
          "hash": "f81557d3-fcc2-4dcf-8c63-0faeb69cd5ff",
          "is_internal": true,
          "created_at": "2024-09-19 09:46:19",
          "completed_at": "2024-09-19 09:46:19"
        }
      ]
    },
    {
      "id": "eb96d127-eb6b-4ea6-b927-14ed11568dc0",
      "currency": "USDT",
      "order_number": "169174110",
      "value": "123",
      "expected_amount": "11.236",
      "received_total": "0",
      "exchange_rate": "10.9469",
      "clean_exchange_rate": "10.959",
      "is_internal": null,
      "deposited_currency": "ETH",
      "received_currency": "USDT",
      "status": "DECLINED",
      "external_order_id": null,
      "created_at": "2024-09-19 09:36:25",
      "completed_at": null,
      "acquiring_url": "https://merchant.pay.payplay.io/crypto-orders/eb96d127-eb6b-4ea6-b927-14ed11568dc0",
      "successful_link": null,
      "failure_link": null,
      "transactions": []
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 2,
    "total": 27
  }
}

Filters

Param	Type	Required	Description
page	int	N	Page number
per_page	int	N	Count of items per page
date_from	date	N	Format: 2022-06-01+00:00:00
date_to	date	N	Format: 2022-06-01+00:00:00
completed_at_from	date	N	Format: 2022-06-01+00:00:00
completed_at_to	date	N	Format: 2022-06-01+00:00:00
order_status_id	uuid	N	Ref. Order Status ID
external_order_id	string	N	Ref. External Order ID

Check out pagination entity reference for detailed description.

[GET] Order Statuses List

/private-api/order-statuses

Response Payload

{
  "order_statuses": [
    {
      "id": "5af96312-b7b9-4d21-9958-30285a54f4c8",
      "label": "CANCELED"
    },
    {
      "id": "7f8550ad-11da-4060-8d1d-54a6d9c08e10",
      "label": "INIT"
    },
    {
      "id": "f46218e8-e883-4478-abac-f5b8c94f97c2",
      "label": "PARTIALLY_FULFILLED"
    },
    {
      "id": "ab306dbd-b837-413a-add5-3bd76542c1c4",
      "label": "COMPLETE"
    },
    {
      "id": "1ca06987-ede3-44e3-be1c-f883e82d267b",
      "label": "DECLINED"
    },
    {
      "id": "984617f8-81fc-4971-b5d0-acebbc6d9d9c",
      "label": "OPEN"
    }
  ]
}

Check out order status entity reference for detailed description.

[GET] Show Transaction Details

/private-api/transactions/{transaction_id}

Response Payload

{
  "transaction": {
    "id": "23d2ca58-20bf-416f-960b-8eae02224653",
    "type": "WITHDRAWAL_EXTERNAL",
    "currency": "USDT",
    "value": "10",
    "status": "COMPLETE",
    "hash": "b3f79c32-525f-46ea-848e-ae172c13697d",
    "is_internal": true,
    "created_at": "2022-03-23 14:40:53",
    "completed_at": "2022-03-23 14:45:53"
  }
}

Check out Transaction entity reference for detailed description.

[GET] Get USDT/USD exchange rate

/rates

Response Payload

{
  "USDT_USD":"1,00"
}

[GET] Exchange Rates for External Currencies

/private-api/exchange-rates/{currencyTicker}

Returns exchange rate for external currencies in pair to USDT

Response Payload

{
  "ticker": "NGN", 
  "exchange_rate": "1660.2759444311"
}