lookupVoucher

This operation is used to verify the validity of a voucher and possibly establish the value of a previously issued voucher (if supported by the server). This operation has no financial impact and is informative only.

SecurityhttpBasic or oauth2

Request

query Parameters

voucherCode	string The voucher code to be looked up.
provisionRequestId	string The provision request id that was part of the original provision request to obtain a voucher.
receiverInstId	string The institution which issued the voucher. This assists to direct the voucher lookup request if the destination cannot be determined from the voucher code alone.
settlementEntityInstId	string The institution via which the lookup should be processed. This serves to better direct the lookup request in the case that multiple upstream parties are able to process the request.
voucherSerialNumber	string The serial number of the voucher being looked up.

Responses

200

successful operation

202

Accepted

400

Bad request

404

Not found

500

Internal server error

503

Service unavailable

504

Gateway timeout

get/vouchers

Request samples

curl
Java
Node.js

Response samples

application/json

{"posInfo": {"entryMode": {"panEntryMode": "UNKNOWN",
"pinEntryCapability": "UNKNOWN"
},
"posConditionCode": "NORMAL_PRESENTMENT"
},
"settlementEntity": {"id": "string",
"name": "string"
},
"receiver": {"id": "string",
"name": "string"
},
"amounts": {"requestAmount": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
},
"approvedAmount": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
},
"feeAmount": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
},
"balanceAmount": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
},
"additionalAmounts": {"property1": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
},
"property2": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
}
}
},
"voucher": {"code": "string",
"expiryDate": "2019-08-24T14:15:22Z",
"redeemInstructions": ["string"
],
"serialNumber": "string",
"pin": {"type": "CLEAR_PIN"
}
},
"product": {"productId": "string",
"barcode": "string",
"name": "string",
"amount": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
},
"minAmount": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
},
"maxAmount": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
},
"description": "string",
"isFixedValue": false,
"receiver": {"id": "string",
"name": "string"
},
"channelProductListings": [{"channelName": "string",
"productDisplayName": "string",
"productDisplayCategory": "string",
"productDisplaySortOrder": 0,
"channelProductIdentifier": "string"
}
]
},
"thirdPartyIdentifiers": [{"institutionId": "string",
"transactionIdentifier": "string"
}
],
"rrn": "string"
}