GAgalileo-ft
Transactions

Get Bill Payment History

Use the Get Bill Payment History endpoint to retrieve bill payment transactions between the specified dates, including scheduled transactions. You can get the history for the specified account or for all related accounts.

See <a href="doc:managing-billpay-transactions" target="_blank">Managing Billpay Transactions</a> for instructions on using this endpoint.

post/getBillPayHistory

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

providerIdinteger required

Your unique provider identifier from SoFi Tech Solutions. Pattern: Max 10 digits Example: 9999

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"

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 from the same account holder (client_id).

  • 0 or blank — Retrieve only the transactions for the specified account.
  • 1 — Retrieve all transactions from the same account holder.

Pattern: Integer Example: 1

recordCntinteger nullable

The maximum number of records to be returned in the method response. Pattern: Positive integer value in the range of 1 and 99999. Example: 100

Example request

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

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.