v2

latestOpenAPI 3.1.12026-08-06856719.6 KB

Get Payment Request Status

This endpoint is to get the status of a specific payment request.

get/v1/payment-requests/{request_id}

Path parameters

request_idstring uuid required

It's required field

Headers

X-BUSINESS-API-KEYstring required
Example:b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d

Response

200

idstring
namestring
emailstring
phonestring
amountstring
currencystring
status'pending' | 'completed' | 'failed' | 'expired' | 'canceled' | 'inactive'

The status of the payment request. The value can be pending, completed, failed, expired, canceled or inactive. pending: Default when a payment request is created: open for payment. failed: Payment did not complete successfully. completed: Payment succeeded, the request is treated as paid.(unless allow_repeated_payments applies). expired: No longer payable because time ran out when either expiry_date or expires_after is set.. canceled: Manually or systematically voided (e.g. terminal flow canceling a pending request). inactive: Payment link deactivated by the merchant.

purposestring
reference_numberstring
payment_methodsstring[]
urlstring
redirect_urlstring
webhookstring
send_smsboolean
send_emailboolean
sms_statusstring
email_statusstring
allow_repeated_paymentsboolean
expiry_datestring
created_atstring
updated_atstring