GAgalileo-ft
Transactions

Expire Authorization

Changed on

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

Request

  • Base URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/ (relative, and the document’s source URL is not known)
  • URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/expireAuthorization
  • Auth
    none declared

Request body application/x-www-form-urlencoded

accountNostring required

The <glossary:PRN> or <glossary:PAN> of the account. Pattern: PAN or PRN Example: "074103447228"

apiLoginstring required

Web service username, as provided by SoFi Tech Solutions. Pattern: Max 50 characters Example: "AbC123-9999"

apiTransKeystring required

Web service password, as provided by SoFi Tech Solutions. Pattern: Max 15 characters Example: "4sb62fh6w4h7w34g"

authIdinteger required

The system-generated authorization ID (auth_id) as returned by <a href="ref:post_getauthhistory" target="_blank">Get Authorization History</a>. Pattern: Positive integer Example: 58344373

expirationDatestring date nullable

Date that the authorization is eligible for expiration. Must be a date in the future. Leave this parameter empty to expire the authorization immediately. Pattern: YYYY-MM-DD Example: "2026-03-05"

transactionIdstring required

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for <a href="ref:idempotency#endpoints-that-use-transactionid-for-idempotency" target="_blank">idempotency</a>. A UUID is preferred. Pattern: Maximum 60 characters Example: "9845dk-39fdk3fj3-4483483478"

Example request

{
  "accountNo": "074103447228",
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "authId": 58344373,
  "expirationDate": "2026-03-05",
  "transactionId": "123e4567-e89b-12d3-a456-426614174000"
}

Response

Successful response

errorsstring[]

A list of errors generated while the request was processed

processing_timenumber nullable required

The time elapsed in processing the transaction

response_dataobject required

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

rtokenstring nullable required

A system-generated ID used for tracking

statusstring nullable required

The condition of a process or response

status_codeinteger nullable required

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

system_timestampstring date-time nullable required

A system generated timestamp

Changes

  • 1ede7567a879Revision changes
    • breaking

      the request property's minLength was increased from 0 to 1

    • breaking

      the request property format changed from date-time to date

    • warning

      the request property's maxLength was set to 60

    • info

      the request property format was generalized from int32 to no format

    • info

      added the success response with the status