post https://prod.api.getborderless.com/payments/search
Introduction
This endpoint allows you to search created or received payments by different criterias.
Data Requirements
Provide the following data requirements when sending a POST request to the Search Payments endpoint.
Additional Header parameter:
| Parameter | Required? | Description | Type |
|---|---|---|---|
| Client-Id | No | Unique identifier of Child Account (required only for Partner). See Authentication Page to learn more. | String |
The url of this request can contain the following query parameters:
| Parameter | Required? | Description | Type |
|---|---|---|---|
| page | No | Positive number that indicates page to be accessed. Must be provided within a range of total pages. | Number |
The body of this request should contain the following parameters:
| Parameter | Required? | Description | Type |
|---|---|---|---|
| searchTerms | Yes | Search string that may include recipient display name, @handle, email, transaction reference number, client internal payment reference or description. | String |
| dateFrom | No | Date from which payments will be searched. Accepted format YYYY-MM-DD. Default value is for 30 days ago. | String |
| dateTo | No | Date to which payments will be searched. Accepted format YYYY-MM-DD. | String |
NOTE: If dateFrom and dateTo are not provided, payments will be searched in period of last 30 days.