Get Payment History

post

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

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

See Record-Set Pagination for instructions on using the paging parameters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Form Data

apiLogin

string

required

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

apiTransKey

string

required

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

providerId

int32

required

Galileo-issued provider identifier.
Pattern: Max 10 digits
Example: 9999

transactionId

string

required

1 to 60

A unique provider-generated ID to identify this API call. A UUID is preferred.
Pattern: 60 characters or less
Example: "9845dk-39fdk3fj3-4483483478"

accountNo

string

required

^.+$

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

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"

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"

includeRelated

int32 | null

enum

Defaults to 0

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

Allowed:

recordCnt

int32 | null

1 to 99999

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

page

int32 | null

1 to 999999

Defaults to 1

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

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

default