Notifies the provider that a purchase was not completed successfully.

Notifies that a purchase was not completed successfully. This can occur if the original request timed out or if payment was unsuccessful. Many providers, however, do not support reversals and once a token has been issued the merchant becomes liable for the cost irrespective of payment failure or timeout. The token may still be retrieved by a reprint request, which merchants may use to help accommodate this scenario. A reversal request must be sent repeatedly until an HTTP response code indicating a final state has been received (i.e. either 202 or 400).

Request
Security:
path Parameters
purchaseId
required
string

The randomly generated UUID of the original purchase request.

reversalId
required
string

The randomly generated UUID of this reversal.

Request Body schema: application/json

A token purchase reversal.

id
required
string

The randomly generated UUID identifying this advice, as defined for a variant 4 UUID in RFC 4122

requestId
required
string

The UUID identifying the request that this advice relates to

time
required
string <date-time>

The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision

required
Array of objects (ThirdPartyIdentifier)

The unaltered thirdPartyIdentifiers array as supplied in the related BasicResponse message. Required if thirdPartyIdentifiers field was present in the BasicResponse. If no thirdPartyIdentifiers was received in the BasicResponse or no BasicResponse was received then this should be set to the thirdPartyIdentifiers sent in the original request.

stan
string

The System Trace Audit Number can be used to locate transactions across different systems.

rrn
string

This is a reference set by the original source of the transaction.

object (Amounts)

Amounts which make up the transaction. Absent amounts have zero value.

reversalReason
required
string

The reason for the reversal

Enum: "TIMEOUT" "CANCELLED" "RESPONSE_NOT_FINAL"
Responses
202

Accepted

400

Bad request

404

Not found

500

Internal Server Error

501

Not implemented

503

Service Unavailable

504

Gateway Timeout

post/tokenPurchases/{purchaseId}/reversals/{reversalId}
Request samples
application/json
{
  • "id": "string",
  • "requestId": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "thirdPartyIdentifiers": [
    ],
  • "stan": "string",
  • "rrn": "string",
  • "amounts": {
    },
  • "reversalReason": "TIMEOUT"
}
Response samples
application/json
{
  • "id": "string",
  • "requestId": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "thirdPartyIdentifiers": [
    ],
  • "stan": "string",
  • "rrn": "string",
  • "amounts": {
    }
}
Copyright © Electrum Payments (Pty) Ltd. 2019-2022. All right reserved.