API Reference

Retrieve Deposits List

get
https://api-dev.prolifepayments.com/reports/v1/deposits
Query Params
date
required

The start date for the search, in format of YYYY-MM-DD. This applies to the deposits' creation date.

date
required

The source of the payment in the search. This can be either "card" or "ach" or as a comma separated array, "ach,card".

int32
Defaults to 10

The number of records to retrieve. If not provided it defaults to 10.

string

Keyset pagination is a method of retrieving a subset of results based on the last seen item; the next_result_token field returns a token to be used in the path parameters for accessing the next page of results.

Headers
string

Specifies the account for which the Deposits request retrieval is intended. This is used for scenarios where one partner retrieves deposits on behalf of another partner, such as in PayFac or related partner relationships.

Responses

Updated 6 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago