GET
/
sender
/
orders
/
{id}
Get payment order by ID
curl --request GET \
  --url https://api.paycrest.io/v1/sender/orders/{id} \
  --header 'API-Key: <api-key>'
{
  "status": "success",
  "message": "Operation successful",
  "data": {
    "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 payment order by its unique ID.

Authorizations

API-Key
string
header
required

Path Parameters

id
string
required

Response

200
application/json

Payment order

The response is of type object.