Accepts redemptionText and other information about a redemption that has occurred.
The processing that occurs upon receiving data is 'implementation specific', e.g. 'Checks a 'Unique text' type code for the external venue AND flags the code as having been used.'
This operation does not provide any feedback on the success or failure of the redemption.
Attributes
|
Attribute |
Value |
|
Path |
/v3/redemptionAdvice |
|
Support Formats |
JSON, XML |
|
HTTP Method |
POST |
|
Secure |
Yes |
|
Rate Limited |
No |
|
Cache Timeout |
TBC |
|
HTTP Codes |
· 202 - Accepted · 400 - Bad Request. · 500 - Internal Server Error. |
Request
The following table contains the details of a typical HTTP Request for this service:
|
Type |
Value |
|
Header |
POST /v3/redemptionAdvice HTTP/1.1 Host: merchant.api.vmob.co Content-Type: application/json Accept-Language: en-US x-vmob-authorization: dm1vYi53aW5kb3dzLjE6 |
|
Body |
{ "redemptionText":"ABC-E6W5F", "externalVenueId": "921", "externalVenueSystemType": 10, "redemptionType": "NFC", "redemptionDate" : "2015-01-20T10:21:47Z", "redemptionAdviceTimezoneOffset": "-10:30" } |
Notes
- redemptionText is the code provided by the VMob platform at the time of in app redemption.
- externalVenueId is optional. If provided it is assumed this matches to an external venue ID stored by VMob against a specific venue.
- externalVenueSystemType is optional. It must be provided if externalVenueId is present and represents the system type of the venue.
- redemptionType is optional and is used to facilitate reporting.
- redemptionDate represents the utc date and time when the in app redemption occurred (yyyy-MM-ddTHH:mm:ssZ).
- redemptionAdviceTimezoneOffset represents the offset from GMT the redemption occurred in.
Successful Response
The following table contains the details of a typical successful HTTP Request for this service.
|
Type |
Value |
|
Header |
HTTP/1.1 202 Accepted Content-Type: application/json Cache-Control: no-store Pragma: no-cache |
|
Body |
(No response body)
|
Unsuccessful Response
The following table contains the details of a typical successful HTTP Request for this service.
|
Type |
Value |
|
Header |
HTTP/1.1 400 Bad Request Content-Type: application/json Cache-Control: no-store Pragma: no-cache |
|
Body |
{ "error" : "invalid_request", "error_description" : "The authorization grant type is not supported by the authorization server.", } |
Notes:
- This API does not validate the redemption text itself before returning, and will only validate authentication details and externalVenueID if provided.
0 Comments