Vouchers Purchase
POST
/pre-paid/vouchers/purchase/{terminalId}/{operatorId}/{localReference}
prepaid-vouchers-controller
Request
Path Params
terminalId
integer <int32>
required
operatorId
integer <int32>
required
localReference
integer <int32>
required
Header Params
U
string
required
Default:
{{U}}
SH
string
required
Default:
{{SH}}
ST
string
required
Default:
{{ST}}
Body Params application/json
amountToSendX100
integer <int32>
optional
destinationAmountX100
integer <int32>
optional
localDateTime
string <date-time>
optional
beneficiaryPhoneNumber
string
optional
dynamicProductId
string | null
optional
receiverEmail
string | null
optional
receiverMessage
string | null
optional
documentNumber
string | null
optional
documentType
enum<string> | enum<null>
optional
Allowed values:
PASSPORTID_CARD
Example
{
"amountToSendX100": 0,
"destinationAmountX100": 0,
"localDateTime": "2019-08-24T14:15:22Z",
"beneficiaryPhoneNumber": "string",
"dynamicProductId": "string",
"receiverEmail": "string",
"receiverMessage": "string",
"documentNumber": "string",
"documentType": "PASSPORT"
}Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://evsbus.csqworld.com/pre-paid/vouchers/purchase///' \
--header 'U;' \
--header 'SH;' \
--header 'ST;' \
--header 'Content-Type: application/json' \
--data-raw '{
"amountToSendX100": 0,
"destinationAmountX100": 0,
"localDateTime": "2019-08-24T14:15:22Z",
"beneficiaryPhoneNumber": "string",
"dynamicProductId": "string",
"receiverEmail": "string",
"receiverMessage": "string",
"documentNumber": "string",
"documentType": "PASSPORT"
}'Responses
🟢200OK
application/json
Body
rc
integer <int32>
optional
items
array[object (VoucherSaleReceipt) {9}]
optional
finalstatus
integer <int32>
optional
resultcode
string
optional
resultmessage
string
optional
supplierreference
string
optional
suppliertoken
string
optional
extraInfo
object (VoucherExtraInfo)
optional
hasAdditionalData
boolean | null
optional
destinationcurrency
string | null
optional
destinationamount
number | null
optional
Example
{
"rc": 0,
"items": [
{
"finalstatus": 0,
"resultcode": "string",
"resultmessage": "string",
"supplierreference": "string",
"suppliertoken": "string",
"extraInfo": {
"resultcode": 0,
"resultmessage": "string",
"redeemAccount": "string",
"redeemInstructions": "string",
"redeemCode": "string",
"expiration": "string",
"additionalData": {
"key": "string",
"value": "string"
}
},
"hasAdditionalData": true,
"destinationcurrency": "string",
"destinationamount": 0
}
]
}