Request Endpoint: https:\/\/sandbox.interswitchng.com\/api\/v2\/quickteller\/vouchers\/create <\/code><\/p><\/blockquote>\n\n\n\n

<\/p>\n\n\n\n

Request Body Description<\/h4>\n\n\n\n

Field#<\/th>	Field name<\/th>	Data type<\/th>	Max length<\/th>	Required<\/th>	Description<\/th><\/tr><\/thead>
1<\/td>	paymentCode<\/td>	string<\/td>	5<\/td>	False <\/td>	This is the payment  code<\/td><\/tr>
2<\/td>	CustomerId<\/td>	string<\/td>	MAX<\/td>	True<\/td>	This is the id of the customer who is trying to create the voucher<\/td><\/tr>
3<\/td>	Amount<\/td>	Long<\/td>	<\/td>	True<\/td>	This is the amount of voucher that needs to be created<\/td><\/tr>
4<\/td>	Type<\/td>	string<\/td>	10<\/td>	True<\/td>	This is the type of voucher been created; gift | recharge <\/td><\/tr>
5<\/td>	ExpiryDate<\/td>	datetime<\/td>	<\/td>	True<\/td>	This is the expiry date of the voucher<\/td><\/tr>
6<\/td>	StartDate<\/td>	dateTime<\/td>	<\/td>	True<\/td>	This is the start date of the voucher<\/td><\/tr>
7<\/td>	Redemption.Quantity<\/td>	int<\/td>	<\/td>	False<\/td>	This specifies the total number of time a user can redeem the voucher<\/td><\/tr>
8<\/td>	CodeConfig.allowedChar<\/td>	string<\/td>	50<\/td>	False<\/td>	This specifies the length and pattern of the voucher<\/td><\/tr><\/tbody><\/table>\n\n\n\n Request Header<\/strong><\/p>\n\n\n\n { \"terminalId\" :\" 3DMO0001 \", \"Content-Type\":\"application\/json\", \"authorization\":\"InterswitchAuth SUtJQUYzRDNGMkQyMEY1MTM2REVGNUExMjUwMzZDN0U0QjgzMzgwQjBGMjA=\", \"nonce\":\"a42a92fa5718bf480684cb75c3d25fb1\", \"timeStamp\":\"1588858522\", \"signature\":\"5+NUy30sMxQM3VzNIS\/CPTkjixo=\", \"signatureMethod\":\"SHA1\" } <\/code><\/p><\/blockquote>\n\n\n\n Request<\/strong> Body<\/strong><\/p>\n\n\n\n { \u00a0\u00a0\u00a0\u00a0\"customerId\":\u00a0\"081242267646\", \u00a0\u00a0\u00a0\u00a0\"amount\":\u00a0\"5000\", \u00a0\u00a0\u00a0\u00a0\"type\":\u00a0\"recharge\", \u00a0\u00a0\u00a0\u00a0\"startDate\":\u00a0\"2021-01-22\", \u00a0\u00a0\u00a0\u00a0\"expiryDate\":\u00a0\"2023-11-29\" } <\/code><\/p><\/blockquote>\n\n\n\n Sample Response (Success)<\/strong><\/p>\n\n\n\n {<\/code><\/p> \"TransactionRef\": \"PBL|Web|3PBL0001|VOS|261119122709|3BYAHU7EB3\", \"RechargePIN\": \"u865tO9ycr\", \"ApprovedAmount\": \"5000\", \"MiscData\": \"u865tO9ycr\", \"ResponseCode\": \"90000\", \"ResponseDescription\": \"Success\", \"ResponseCodeGrouping\": \"SUCCESSFUL\" <\/code><\/p> }<\/code><\/p><\/blockquote>\n\n\n\n Sample Response (Failed)<\/strong><\/p>\n\n\n\n {     \"errors\": [         {             \"code\": \"90009\",             \"message\": \"Transaction in Progress\",             \"responseCodeGrouping\": \"PENDING\"         }     ],     \"error\": {         \"code\": \"90009\",         \"message\": \"Transaction in Progress\",         \"responseCodeGrouping\": \"PENDING\"     } } <\/code><\/p><\/blockquote>\n\n\n\n Response Codes<\/h5>\n\n\n\n Response Code<\/th> Response Message<\/th><\/tr><\/thead> VS005<\/td> TYPE_CANNOT_BE_EMPTY<\/td><\/tr> VS007<\/td> UNRECOGNISED_TYPE<\/td><\/tr> VS008<\/td> VOUCHER_TYPE_NOT ALLOWED<\/td><\/tr> VS009<\/td> INVALID_START_DATE<\/td><\/tr> VS010<\/td> BAD_START_DATE_FORMAT<\/td><\/tr> VS011<\/td> BAD_EXPIRY_DATE_FORMAT<\/td><\/tr> VS012<\/td> GIFT_OBJECT_NOT_SPECIFIED<\/td><\/tr> VS013<\/td> DISCOUNT_OBJECT_NOT_SPECIFIED<\/td><\/tr> VS014<\/td> INVALID_GIFT_BALANCE<\/td><\/tr> VS015<\/td> INVALID_LENGTH<\/td><\/tr> VS016<\/td> INVALID_EXPIRY_DATE<\/td><\/tr> VS017<\/td> INVALID_REDEEM_QUANTITY<\/td><\/tr> VS019<\/td> INVALID_CODE_CONFIG_LENGTH<\/td><\/tr> VS021<\/td> NOT_AUTHORISED_TO_REDEEM_VOUCHER<\/td><\/tr><\/tbody><\/table>\n","protected":false},"author":169,"featured_media":0,"parent":3668,"menu_order":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"spay_email":""},"doc_tag":[],"_links":{"self":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/3671"}],"collection":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/users\/169"}],"replies":[{"embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/comments?post=3671"}],"version-history":[{"count":7,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/3671\/revisions"}],"predecessor-version":[{"id":3841,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/3671\/revisions\/3841"}],"up":[{"embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/3668"}],"next":[{"title":"Redeem Voucher","link":"https:\/\/sandbox.interswitchng.com\/docbase\/docs\/quickteller-sva\/epins\/redeem-voucher\/","href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/3674"}],"wp:attachment":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/media?parent=3671"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/doc_tag?post=3671"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}