GAgalileo-ft
Transactions

Get Payment History

Use the Get Payment History endpoint to retrieve payments (credits) for a customer account during a specified period.

See <a href="ref:record-set-paging" target="_blank">Record-Set Pagination</a> for instructions on using the paging parameters.

post/getPaymentHistory

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/getPaymentHistory
  • Auth
    none declared

Request body application/x-www-form-urlencoded

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"

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>. Pattern: Maximum 60 characters Example: "9845dk-39fdk3fj3-4483483478"

accountNostring required

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

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"

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"

includeRelated0 | 1 nullable

Whether to return transactions for all accounts that share the same account holder (client_id) or balance (bal_id).

When accountNo contains a primary account:

  • 0 — Default. Retrieve all transactions that share the same balance.
  • 1 — Retrieve all transactions from the same account holder.

When accountNo contains a secondary account:

  • 0 — Default. Retrieve all transactions from the specified account only.
  • 1 — Retrieve all transactions from the same account holder.

Pattern: Integer Example: 1

recordCntinteger nullable

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

pageinteger nullable

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

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "accountNo": "074103447228",
  "startDate": "2016-01-01",
  "endDate": "2016-01-01",
  "includeRelated": 1,
  "recordCnt": 100,
  "page": 3
}

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

Changes

No recorded changes to this operation across all 2 revisions of this API.