Pull Voucher

POST

https://api.formaxpay.com/api/gift_voucher/pull_voucher

This API is used to purchase (pull) gift vouchers for a selected brand and denomination.
On successful transaction, voucher details such as voucher number, PIN, value, and expiry date are returned in the response.

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.formaxpay.com/api/gift_voucher/pull_voucher' \
--header 'Authorization: Basic UVRNRlRKckJjRWt5RnBETGtCSGpkV0dMYnFBclFwbkE6Rm9ybWF4QDEyMw==' \
--header 'Content-Type: application/json' \
--data-raw '{
    "brand_id": 3,
    "p_order_id": "TGV66455078125001EPRHD",
    "quantity": 1,
    "denomination": 500
}'

Response Example

{
    "status": "SUCCESS",
    "message": "Transaction Successful",
    "data": {
        "brand_id": 3,
        "brand_name": "Amazon Shopping",
        "quantity": 1,
        "denomination": 500,
        "order_id": "GV07397460937500CENUA",
        "p_order_id": "TGV66455078125001EPRHD",
        "order_amount": "500.00",
        "txn_type": "DR",
        "opening_bal": "780597.12",
        "closing_bal": "780106.62",
        "commercial_amount": "9.50",
        "timestamp": "2025-12-12 16:8:34",
        "vouchers": [
            {
                "voucher_no": "SV8Y-A957K4-NRN",
                "voucher_pin": "6014868794024248",
                "voucher_gc_code": "6014868794024248",
                "value": "500.00",
                "expiry_date": "11 Dec 2026"
            }
        ]
    }
}

Modified at 2025-12-24 17:42:36

Brand List

Transaction Status