Description
The voidTokenAuth request will void a transaction created by createToken and which had been authorized.
URL: https://secure.3gdirectpay.com/API/v6/
Response
The method will respond with the result of your request
Variables to send:
| Parameter | Data type | Description | Classification |
|---|---|---|---|
| Request | Text | voidTokenAuth | Mandatory |
| CompanyToken | Token | Token you got from DPO Pay to operate this API | Mandatory |
| TransactionToken | Token | Transaction token as accepted from the createToken. | Mandatory |
| voidDetails | Text | Reason for the void | Mandatory |
Request example:
request example
<API3G> <Request>voidTokenAuth</Request> <CompanyToken>57466282-EBD7-4ED5-B699-8659330A6996</CompanyToken> <TransactionToken>72983CAC-5DB1-4C7F-BD88-352066B71592</TransactionToken> <voidDetails>Booking Cancelled</voidDetails> </API3G>
Response:
The server will respond the voidTokenAuth request according to the following results:
Parameter | Data type | Description |
Result | 3 digits code | A code will be sent with the result of the request |
ResultExplanation | Text | Free text of the result |
Respond example:
response example
<?xml version="1.0" encoding="utf-8"?> <API3G> <Result>000</Result> <ResultExplanation>Transaction has been voided</ResultExplanation> </API3G>