Skip to main content
GET
Verify & Retrieve Gift Card Order

Overview

The /gift-cards/verify/{reference} endpoint queries the fulfillment state of a gift card order using its unique client or transaction reference. If an order was initially in "PROCESSING" state, calling this endpoint triggers automated Transaction Status Query (TSQ) reconciliation with the upstream issuance network and returns the unlocked voucherCode and voucherPin.

Real-World Use Cases

Order Status Polling

Poll this endpoint if your client connection dropped during the initial POST /gift-cards/purchase call to recover the voucher code without double-charging.

Voucher Retrieval on User Request

Allow users to revisit their order history page inside your mobile app to re-copy their voucher PIN and view redemption instructions.

Path Parameters


Code Examples


Response Structure

Success Response (200 OK)


Error Handling

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

reference
string
required

Response

200

Gift card order details, verification status, and voucher PIN