Payment Link
Get payment link orders
Retrieve orders associated with a payment link. Useful for getting the order ID for payment simulation in staging.
get/paymentlink/orders
Query parameters
idstring uuid required
The payment link ID (paymentRef) to get orders for
Response
Payment link order details
Example response
{
"status": "ok",
"message": "paymentlink order details",
"data": {
"id": "7e644e02-e652-42d8-8857-e8ae46bccd59",
"name": "Small payment for Solomon",
"description": "Small Payment for Demo Purposes",
"type": "ONE_TIME",
"amount": "2000000",
"settlementCurrency": "BTC",
"settlementMethod": "ONCHAIN",
"speed": "medium",
"paymentCurrency": "NGN",
"paymentMethods": [
"BANKTRANSFER"
],
"callbackUrl": "https://your-app.com/payment-success",
"channel": "API",
"status": "ACTIVE",
"accountId": "1a0f79fb-0f3e-4b5b-98f1-1e14324ca62e",
"beneficiaryId": "bc1q8yz7u50r4nne2q8wkuc4kyxx0s76fxsjlac5fxd8h7tzkh4rs82qnweuv5",
"createdAt": "2026-01-09T12:36:09.582Z",
"updatedAt": "2026-01-09T12:36:09.582Z",
"orders": [
{
"id": "eb1377a8-5afd-4888-a702-d510d070466b",
"status": "PENDING",
"orderId": "49508-6205",
"paymentLinkId": "7e644e02-e652-42d8-8857-e8ae46bccd59",
"paymentMethod": "BANKTRANSFER",
"createdAt": "2026-01-09T12:36:25.924Z",
"updatedAt": "2026-01-09T12:47:10.254Z"
}
]
}
}