Skip to main content
Retrieve a gift card order by its PayVessel order ID. Use this to poll for the final status and retrieve the redemption code.

Usage

curl https://api.payvessel.com/api/v1/gift-cards/orders/{order_id} \
  -H "api-key: YOUR_API_KEY" \
  -H "api-secret: YOUR_SECRET_KEY"

Response fields

FieldTypeDescription
idstring (uuid)PayVessel order ID
business_idstringYour business ID
referencestringYour merchant reference
billpoint_transaction_idinteger or nullProvider transaction ID
operator_idstringProduct/operator ID
product_idstringDenomination ID
product_namestringGift card name
countrystringCountry
amount_nairanumberAmount in NGN
amount_usdnumberAmount in USD
redeem_codestring or nullGift card redemption code
serial_numberstring or nullGift card serial number
statusstringpending, processing, completed, or cancelled
error_messagestring or nullError details if the order failed
wallet_transaction_idstring or nullAssociated wallet transaction
created_datetimedatetimeWhen the order was created
updated_datetimedatetimeLast status update
completed_datetimedatetime or nullWhen the order was fulfilled

API Reference

Full request/response details and Try it