Planned for development. Updates may be published periodically.
TABLE OF CONTENTS
- Voiding an Authorization
- VoidRequest Object
- VoidResponse Object
- Sample Request Body
- Sample Response Body
Voiding an Authorization
The void API is used to cancel an Authorization already received when a Capture has not yet occurred. If a capture has already occurred please use the Refund API.
POST v1/payment/{mid}/void
Request Parameters
The merchant id that the authorization belongs to
Request Body
Include a VoidRequest object as the body of the request.
Sample Request
POST https://sand10-api.acmeticketing.net/v1/payment/987-654-321/void
Response
Returns a VoidResponse object.
VoidRequest Object
Name | Type | Description | Required |
---|---|---|---|
authorizationId | string | The authorization id created by the previous auth call | yes |
VoidResponse Object
Name | Type | Description | Required |
---|---|---|---|
authorizationId | string | The authorization id created by the previous auth call | yes |
Sample Request Body
{
"authorizationId": "abc-123"
}
Sample Response Body
{
"authorizationId": "abc-123"
}