Get a payment
curl --request GET \
--url https://{host}/v1/payments/{paymentId} \
--header 'X-Api-Key: <api-key>'const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://{host}/v1/payments/{paymentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/v1/payments/{paymentId}"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"message": "<string>",
"request_id": "01a1775167aa7693a7acd8df7b596118",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_number": "<string>",
"session_id": "<string>",
"amount_minor": 2500000,
"status": "<string>",
"paid_at": "2023-11-07T05:31:56Z",
"received_at": "2023-11-07T05:31:56Z",
"virtual_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"hold_reason": "<string>",
"sender_name": "<string>",
"sender_bank": "<string>",
"sender_account_number": "<string>",
"narration": "<string>",
"transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"resolution_transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"resolved_by": "<string>",
"resolved_at": "2023-11-07T05:31:56Z"
},
"code": "13"
}{
"success": true,
"message": "<string>",
"request_id": "01a1775167aa7693a7acd8df7b596118",
"data": null,
"code": "13"
}Payments
Get a payment
One payment and what it did: credited, held for a decision, accepted or returned.
Required permission: feature:VIRTUAL_ACCOUNTS, virtual-accounts:read
GET
/
v1
/
payments
/
{paymentId}
Get a payment
curl --request GET \
--url https://{host}/v1/payments/{paymentId} \
--header 'X-Api-Key: <api-key>'const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://{host}/v1/payments/{paymentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/v1/payments/{paymentId}"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"message": "<string>",
"request_id": "01a1775167aa7693a7acd8df7b596118",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_number": "<string>",
"session_id": "<string>",
"amount_minor": 2500000,
"status": "<string>",
"paid_at": "2023-11-07T05:31:56Z",
"received_at": "2023-11-07T05:31:56Z",
"virtual_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"hold_reason": "<string>",
"sender_name": "<string>",
"sender_bank": "<string>",
"sender_account_number": "<string>",
"narration": "<string>",
"transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"resolution_transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"resolved_by": "<string>",
"resolved_at": "2023-11-07T05:31:56Z"
},
"code": "13"
}{
"success": true,
"message": "<string>",
"request_id": "01a1775167aa7693a7acd8df7b596118",
"data": null,
"code": "13"
}