Sign in

v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB
Settlements

Retrieve Settlements

Retrieves a list of Settlements.

get/settlements

Query parameters

fromstring required

The date to start from.

tostring required

The date to end at.

status'PENDING' | 'APPROVED' | 'SUCCESSFUL'

The current status of the settlement.

Example:PENDING

Filters, the settlements by the status.

settlementProfileIDstring

A settlement profile identifier that links to a specific bank account for fund settlement.

Example:settlement-profile-bank-account-1

Filters, the settlements by the settlement profile.

limitinteger

The number of items to return.

offsetstring

Used for pagination. Set this to the first/last id value of your payload to get the prev/next page of results respectively.

direction'prev' | 'next'

The direction of the pagination.

Response

Retrieving a list of Settlements was Successful.

pageSizeinteger

The amount of results on the page.

limitinteger

The maximum number of results per page.

Example response

{
  "pageSize": 1,
  "limit": 50,
  "settlements": [
    {
      "id": "sett_63ccb073-a7b6-4b33-af77-5baec5cc4494_settle-profile-usa_20221224",
      "settlementDate": "2022-12-25",
      "partnerID": "80f9b672-120d-4b73-9cc9-42fb3262c4b9",
      "status": "PENDING",
      "totalAmount": -14250,
      "createdAt": "2022-12-11T22:28:21.810Z",
      "updatedAt": "2022-12-11T22:28:21.810Z",
      "settlementProfileID": "settlement-profile-bank-account-1",
      "attestedAt": "2024-04-17T22:28:21.810Z"
    }
  ]
}