Payment Link
Get payment link details
Changed onRetrieve details about a payment link for rendering a custom UI or checking payment status.
get/paymentlink/details
Request
- Base URLhttps://staging.api.mavapay.co/api/v1
- Auth
- API key in header X-API-KEY
- or HTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
idstring uuid required
The payment link ID (paymentRef) to get details for
Response
Payment link details
Example response
{
"status": "ok",
"message": "payment link details",
"data": {
"paymentLinkDetails": {
"id": "9f8bf7da-f1d8-4c78-8f93-28eebe17c35e",
"name": "Bitcoin Purchase",
"description": "On-chain Bitcoin payment",
"callbackUrl": "https://your-app.com/payment-success",
"settlementCurrency": "BTC",
"paymentLinkOrderId": "99366bb2-788f-4556-86db-d5063232a50a",
"paymentMethods": [
"BANKTRANSFER"
],
"account": {
"name": "Your Business Name"
},
"BANKTRANSFER": {
"ngnAccountName": "Mava Digital Solutions Limited",
"ngnBankName": "GLOBUS BANK",
"ngnBankAccountNumber": "3242569160",
"amount": 800000,
"expiresAt": "2025-11-20T20:47:41.528Z",
"targetAmount": 6034
}
}
}
}Changes
- info
endpoint added
- info