Get Deposit History

post

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

Use the Get Deposit History endpoint to retrieve deposit history for either your entire program or for a specified customer. Omit the accountNo parameter to get the history for your entire program.

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

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 SoFi Tech Solutions.
Pattern: Max 50 characters
Example: "AbC123-9999"

apiTransKey

string

required

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

providerId

int32

required

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

transactionId

string

required

1 to 60

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for idempotency. A UUID is preferred.
Pattern: Maximum 60 characters
Example: "9845dk-39fdk3fj3-4483483478"

accountNo

string | null

^$|^([0-9]{12}|[0-9]{16})$

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"

recordCnt

int32 | null

1 to 99999

The maximum number of records per page to be returned.
Pattern: Integer
Example: 100

page

int32

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

Status codes

default