Get Authorization History

post

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

Use the Get Authorization History endpoint to retrieve a list of authorizations. By default it returns authorizations that have not settled, expired, or been reversed.
You can return authorizations in any status by setting includeAllStatuses.

See Record-Set Pagination for instructions on using the paging parameters.
Open the Recipe below to see a response example.

Status codes

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

Form Data

accountNo

string

required

^.+$

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

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"

cardId

integer | null

Supply the cardId (CAD) to filter authorization history to those transactions performed on the provided card.

endDate

date

required

The end date for the date range, either a date or a date-time. Must be equal to or later than startDate. Max 1098 days (~3 years) after startDate.
Pattern: YYYY-MM-DD or YYYY-MM-DD hh:mm:ss
Example: "2016-01-01"

includeAllStatuses

boolean | null

When true, include transactions in all statuses. When not set, return transactions in the "pending" statuses.

Pattern: Boolean
Example: 0

includeExtendedRiskData

boolean | null

When true, include extended risk data.

Pattern: Boolean
Example: 0

includeRelated

boolean | null

Whether to return transactions from accounts that share the same balance (galileo_account_number).

When accountNo contains a primary account:

0 or 1 — Retrieve all transactions from accounts that share the same balance.
blank — Retrieve all transactions from the specified account only.

When accountNo contains a secondary account:

0 — Retrieve all transactions from the specified account only.
1 — Retrieve all transactions from accounts that share the same balance.

Pattern: Boolean
Example: 0

page

integer | null

1 to 999999

Defaults to 1

The number of the page to retrieve.
Pattern: Integer value of 1 or greater
Example: 3

recordCnt

integer | null

1 to 99999

The maximum number of records per page to be returned.
Pattern: Positive integer 1-99999
Example: 100

startDate

date

required

The beginning date for the date range, either a date or a date-time.
Pattern: YYYY-MM-DD or YYYY-MM-DD hh:mm:ss
Example: "2016-01-01"

transactionId

string

required

length between 1 and 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"

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

200Successful response