Supermarket Vouchers Purchase

🔧 Purchase Supermarket Vouchers

Executes the purchase of a supermarket voucher using the provided request body. This method supports flexible delivery options and validates recipient documentation when applicable.

🔐 Authentication

Authentication is handled via custom header parameters, as defined in the API’s global configuration:

Header Name	Type	Required	Description
`U`	string	Yes	Username assigned by CSQ.
`ST`	string	Yes	Unix timestamp (valid for 30 seconds). Used as a salt for hashing.
`SH`	string	Yes	Salted hash. See Headers for more info.

Refer to the Auth configuration for implementation details.

📥 Request Body Parameters

Parameter	Type	Required	Description
`amountToSendX100`	integer	Conditional	Amount to send in cents. Cannot be used with `destinationAmountX100`.
`destinationAmountX100`	integer	Conditional	Destination amount in cents. Cannot be used with `amountToSendX100`.
`localDateTime`	string	Yes	Local timestamp of the transaction (`YYYY-MM-DDTHH:mm:ss`).
`beneficiaryPhoneNumber`	string	No	Phone number of the voucher recipient.
`dynamicProductId`	string/null	No	Optional product identifier.
`receiverEmail`	string/null	No	Email address for voucher delivery.
`receiverMessage`	string/null	No	Custom message to include with the voucher.
`documentNumber`	string	Yes	ID number of the recipient.
`documentType`	enum<string>	No	Type of document: `PASSPORT` or `ID_CARD`.
`firstName`	string	No	Recipient’s first name.
`surname`	string	No	Recipient’s surname.
`secondSurname`	string/null	No	Recipient’s second surname (if applicable).

📤 Response Example

{
  "rc": 0,
  "items": [
    {
      "finalstatus": 0,
      "resultcode": "10",
      "resultmessage": "Voucher purchase successful",
      "supplierreference": "SUP-REF-78910",
      "suppliertoken": "ABC123XYZ456TOKEN",
      "destinationcurrency": "DOP",
      "destinationamount": 150000
    }
  ]
}

🧾 Response Field Notes

rc: 0
Indicates that the operation was successfully processed.

finalstatus: 10
Suggests a successful outcome at the end of the transaction flow. The exact meaning may vary depending on internal status conventions.

destinationamount
Value is expressed in cents. For example, 150000 represents DOP 1,500.00.

supplierreference and suppliertoken
These fields are used to track the transaction with the external supplier.

application/json

Body

Example

{
    "rc": 0,
    "items": [
        {
            "finalstatus": 0,
            "resultcode": "string",
            "resultmessage": "string",
            "supplierreference": "string",
            "suppliertoken": "string",
            "destinationcurrency": "string",
            "destinationamount": 0
        }
    ]
}

Supermarket Vouchers Purchase

🔧 Purchase Supermarket Vouchers

🔐 Authentication

📥 Request Body Parameters

📤 Response Example

🧾 Response Field Notes

Request

Request Code Samples

Responses

Supermarket Vouchers Purchase

🔧 Purchase Supermarket Vouchers#

🔐 Authentication#

📥 Request Body Parameters#

📤 Response Example#

🧾 Response Field Notes#

Request

Request Code Samples

Responses

🔧 Purchase Supermarket Vouchers

🔐 Authentication

📥 Request Body Parameters

📤 Response Example

🧾 Response Field Notes