Expire Authorization

post

https://api-{corename}.{env}.gpsrv.com/intserv/4.0/expireAuthorization

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 — Get Authorization History response
AUTHORIZATION STATUS — Authorized Transactions RDF; status A or C

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

Status codes

See Global Response Statuses for status codes that are common across endpoints.

The table below lists status codes that apply to this specific endpoint.

Status code	Description
532-01	Card authorization could not be found
532-02	Card authorization could not be expired
532-03	System error encountered while attempting to expire authorization

Form Data

apiLogin

string

required

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

apiTransKey

string

required

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

transactionId

string

required

1 to 60

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for idempotency. A UUID is preferred.
Pattern: Maximum 60 characters
Example: "9845dk-39fdk3fj3-4483483478"

accountNo

string

required

^$|^([0-9]{12}|[0-9]{16})$

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

expirationDate

date-time | null

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"

authId

int32

required

The system-generated authorization ID (auth_id) as returned by Get Authorization History.
Pattern: Positive integer
Example: 58344373

Headers

response-content-type

string

enum

Defaults to json

Use this header instead of the standard accept header to specify the response format.

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/xml

Status codes

default