Get Interest

post

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

Use the Get Interest endpoint to retrieve accrual interest, interest year-to-date, and annual percentage yield for any type of interest bearing account (savings or non-savings).

The Get Interest endpoint is the preferred method for retrieving data on interest-bearing accounts.

Status codes

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

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 | null

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

interestMonth

date

required

The month to retrieve interest data for.
Pattern: YYYY-MM
Example: 2020-01.

includeRelated

int32

enum

Defaults to 0

Whether to return data for related accounts.

When accountNo contains a primary account:

0 — Default. Retrieve data only for the specified account.
1 — Also retrieve data for accounts that share the same balance or account owner.

When accountNo contains a secondary account:

0 — Default. Retrieve data only for the specified account.
1 — Also retrieve data for other secondary accounts of the primary (but not primary-account data).

Pattern: Integer
Example: 1

Allowed:

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

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/xml

Status codes

default