Transactions

Get Authorization History

Changed on

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 <a href="ref:record-set-paging" target="_blank">Record-Set Pagination</a> for instructions on using the paging parameters.
  • Open the Recipe below to see a response example.
post/getAuthHistory

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/getAuthHistory
  • 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"

cardIdinteger nullable

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

endDatestring 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"

includeAllStatusesboolean nullable

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

Pattern: Boolean Example: 0

includeExtendedRiskDataboolean nullable

When true, include extended risk data.

Pattern: Boolean Example: 0

includeRelatedboolean nullable

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

pageinteger nullable

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

recordCntinteger nullable

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

startDatestring 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"

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",
  "endDate": "2016-01-01",
  "page": 3,
  "recordCnt": 100,
  "startDate": "2016-01-01",
  "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

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

    • breaking

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

    • warning

      the request property's maxLength was set to 60

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property format was generalized from int32 to no format

    • info

      added the success response with the status