finances

Get the settlements created from startDate to endDate in UTC, both days included: the account each one was sent to, the bank fee, the exchange rate and the amount taken from each wallet. These are the same settlements as on the Dashboard under Settlements.

Settlements are returned newest first. Account numbers and crypto wallet addresses are masked.

get/v2/settlements

Request

  • Base URL
    https://api.sandbox.pawapay.io
  • URL
    https://api.sandbox.pawapay.io/v2/settlements
  • Auth
    HTTP bearer

Query parameters

startDatestring date required
Example:2026-06-01

First UTC calendar day of the period, inclusive.

Format is YYYY-MM-DD. Date-times are rejected.

endDatestring date required
Example:2026-07-31

Last UTC calendar day of the period, inclusive. Must be on or after startDate and not in the future. The period from startDate to endDate, both days included, can be up to 365 days, for example 2026-01-01 to 2026-12-31.

Format is YYYY-MM-DD. Date-times are rejected.

Response

Request has been succesfully processed.

startDatestring date required

The startDate of the request.

endDatestring date required

The endDate of the request.

Example response

{
  "startDate": "2026-06-01",
  "endDate": "2026-07-31",
  "settlements": [
    {
      "settlementId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
      "status": "COMPLETED",
      "date": "2026-07-06",
      "destinations": [
        {
          "type": "BANK",
          "accountCurrency": "EUR",
          "bankAccount": {
            "bankName": "Standard Chartered",
            "accountName": "Remitex Ltd",
            "accountNumber": "****8900",
            "country": "GBR"
          },
          "cryptoAccount": {
            "walletAddress": "****9f3a"
          },
          "totalAmount": "20000",
          "bankFeeAmount": "25",
          "settledAmount": "19975",
          "wallets": [
            {
              "country": "ZMB",
              "currency": "ZMW",
              "status": "COMPLETED",
              "amount": "546400",
              "fxRate": "27.32",
              "settledAmount": "20000",
              "skippedReason": "Balance below the configured minimum settlement amount"
            }
          ]
        }
      ]
    }
  ]
}

Changes