v5

latestOpenAPI 3.1.02026-07-262421791.5 MB

bulk-settlement

Send a settlement journal

Sends the settlement journal to Wise. There are two types of settlement:

Same Currency Settlement — Settle in the same currency as the transfers (e.g., settle USD transfers with USD).
Cross Currency Settlement — Settle in a different currency (e.g., settle PHP transfers with USD). In this case, you must specify settlementCurrency and include exchangeRate on every transfer.

{% admonition type="info" %} You must use a client credentials token to authenticate this call. {% /admonition %}

post/v1/settlements

Headers

X-External-Correlation-Idstring uuid

Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Request body

type'TRUSTED_BULK_SETTLEMENT' required

Type of settlement.

settlementReferencestring required

Reference used when paying the end of day settlement monies to Wise. This should match so that Wise can link the payment.

Maximum 10 characters, must start with TPFB prefix.

settlementDatestring date-time required

The date you send the settlement funds, ISO 8601 format.

settlementCurrencystring

The currency in which the transfers in this journal will be settled. If included, the exchangeRate must be set on every transfer in the transfers array. Only include if you will settle in a currency different to the source currency of transfers.

balanceTransfernumber

The amount of money to be deducted from the expected settlement amount based on what is owed to you for previous days where the total settlement from you to Wise was negative.

This value must be 0 or negative.

Example request

{
  "type": "TRUSTED_BULK_SETTLEMENT",
  "settlementReference": "TPFB190322",
  "settlementDate": "2019-03-22T23:59:59-05:00",
  "settlementCurrency": "USD",
  "transfers": [
    {
      "id": 125678,
      "date": "2019-03-22T10:00:12-05:00",
      "sourceAmount": 23.24,
      "sourceCurrency": "USD",
      "customerName": "Joe Bloggs",
      "partnerReference": "11111",
      "comment": "Extra Data",
      "exchangeRate": 0.875469
    }
  ],
  "refundedTransfers": [
    {
      "id": 178880,
      "exchangeRate": 0.875469,
      "partnerReference": "11108"
    }
  ]
}

Response

Settlement journal received successfully. Empty response body.