Sign in

v1

latestOpenAPI 3.0.32026-07-2621102.1 MB
Transactions

Expire Authorization

Use the Expire Authorization endpoint to expire a pending authorization and return the hold amount to the cardholder account. The authorization must be eligible for expiry. Check for one of the following:

  • can_be_expired: 1 — <a href="ref:post_getauthhistory" target="_blank">Get Authorization History</a> response
  • AUTHORIZATION STATUS — <a href="doc:base-rdfs#authorized-transactions-rdf-fields" target="_blank">Authorized Transactions RDF</a>; status A or C

This endpoint expires the authorization in the system; the expiry is not communicated to the card network.

post/expireAuthorization

Response

status_codeinteger nullable required

The response status code. May return a string for some statuses.

statusstring nullable required

The condition of a process or response

processing_timenumber float nullable required

The time elapsed in processing the transaction

system_timestampstring date-time nullable required

A system generated timestamp

rtokenstring nullable required

A system-generated ID used for tracking

errorsstring[]

A list of errors generated while the request was processed

response_dataobject required

A structure for the response data. This endpoint does not return response data, so it will always be empty.