GET
/
sender
/
orders
List payment orders
curl --request GET \
  --url https://api.paycrest.io/v1/sender/orders \
  --header 'API-Key: <api-key>'
{
  "status": "success",
  "message": "Operation successful",
  "data": {
    "totalRecords": 123,
    "page": 123,
    "pageSize": 123,
    "orders": [
      {
        "id": "<string>",
        "amount": 123,
        "amountPaid": 123,
        "amountReturned": 123,
        "token": "<string>",
        "senderFee": 123,
        "transactionFee": 123,
        "rate": 123,
        "network": "base",
        "gatewayId": "<string>",
        "recipient": {
          "institution": "<string>",
          "accountIdentifier": "<string>",
          "accountName": "<string>",
          "memo": "<string>",
          "providerId": "<string>",
          "metadata": {},
          "currency": "<string>"
        },
        "fromAddress": "<string>",
        "returnAddress": "<string>",
        "receiveAddress": "<string>",
        "feeAddress": "<string>",
        "reference": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "txHash": "<string>",
        "status": "<string>",
        "transactionLogs": [
          {
            "id": "<string>",
            "gateway_id": "<string>",
            "status": "<string>",
            "tx_hash": "<string>",
            "created_at": "2023-11-07T05:31:56Z"
          }
        ]
      }
    ]
  }
}
Retrieve a list of payment orders for the sender.

Authorizations

API-Key
string
header
required

Query Parameters

status
string
token
string
network
enum<string>

Network identifier for the blockchain

Available options:
base,
bnb-smart-chain,
lisk,
tron,
celo,
arbitrum-one,
polygon,
asset-chain
ordering
string

Response

200
application/json

List of payment orders

The response is of type object.