API

BulkSettlement

A settlement journal.

Operations

Every route this entity exposes. Each route links to its own reference on this page.

Method	Route	SDK operation	Returns
`POST`	`/settlements`	`create`	Settlement journal received successfully. Empty response body

Examples

One example per SDK, generated from the API model. The argument names are the parameters and fields of this entity, and the values are placeholders. The examples are not compiled or executed.

Golang

Construct client as shown in the Golang setup, then call the operations:

created, err := client.BulkSettlement(nil).Create(map[string]any{"settlementDate": "example", "settlementReference": "example", "transfers": []any{}, "type": "example"}, nil)
if err != nil {
    panic(err)
}
fmt.Println(created)

Lua

Construct client as shown in the Lua setup, then call the operations:

local created, err = client:BulkSettlement():create({ settlementDate = "example", settlementReference = "example", transfers = {}, type = "example" })

PHP

Construct client as shown in the PHP setup, then call the operations:

$created = $client->BulkSettlement()->create(["settlementDate" => "example", "settlementReference" => "example", "transfers" => [], "type" => "example"]);

Python

Construct client as shown in the Python setup, then call the operations:

created = client.BulkSettlement().create({ "settlementDate": "example", "settlementReference": "example", "transfers": [], "type": "example" })

Ruby

Construct client as shown in the Ruby setup, then call the operations:

created = client.BulkSettlement.create({ "settlementDate" => "example", "settlementReference" => "example", "transfers" => [], "type" => "example" })

TypeScript

Construct client as shown in the TypeScript setup, then call the operations:

const created = await client.BulkSettlement().create({ settlementDate: "example", settlementReference: "example", transfers: [], type: "example" })

Fields

Field	Type	Required	Description
`balanceTransfer`	`number`	No	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.
`refundedTransfers`	`array`	No	Array of transfers for which refunds have been processed.
`settlementCurrency`	`string`	No	The currency in which the transfers in this journal will be settled.
`settlementDate`	`string`	Yes	The date you send the settlement funds, ISO 8601 format.
`settlementReference`	`string`	Yes	Reference used when paying the end of day settlement monies to Wise.
`transfers`	`array`	Yes	Array of transfers to be settled.
`type`	`string`	Yes	Type of settlement.

create

`POST` /settlements

Operation ID: bulkSettlementJournalCreate.

Authentication: bearer token (ClientCredentialsToken).

Parameters

Parameter	In	Type	Required	Description
`X-External-Correlation-Id`	`header`	`string (uuid)`	No	Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Request body

application/json

Property	Type	Required	Description
`balanceTransfer`	`number (decimal)`	No	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.
`refundedTransfers`	`array of object`	No	Array of transfers for which refunds have been processed. Only for Net Settlement.
`refundedTransfers[].exchangeRate`	`number (decimal)`	No	The exchange rate used for this transfer. Should be the same value as the one used for the original transfer settlement.
`refundedTransfers[].id`	`integer (int64)`	Yes	ID of the refunded transfer.
`refundedTransfers[].partnerReference`	`string`	Yes	The transaction/payment identifier in your system, uniquely identifies the transfer in your platform.
`settlementCurrency`	`string`	No	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.
`settlementDate`	`string (date-time)`	Yes	The date you send the settlement funds, ISO 8601 format.
`settlementReference`	`string`	Yes	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.
`transfers`	`array of object`	Yes	Array of transfers to be settled.
`transfers[].comment`	`string`	No	Other data about the transfer or sender. For USA, you should send the account refund information for the sending customer (account number, routing number, street address, etc.)
`transfers[].customerName`	`string`	Yes	Name of the customer. Helps identify customer when manual operation is required.
`transfers[].date`	`string (date-time)`	Yes	The date the transfer was created, ISO 8601 format.
`transfers[].exchangeRate`	`number (decimal)`	No	The exchange rate you used to calculate the settlement amount for this transfer. Required if `settlementCurrency` is set on the journal. You can set this value to be unique per transfer or the same for every transfer, depending on your settlement approach and agreements with Wise.
`transfers[].id`	`integer (int64)`	Yes	ID of the transfer to be settled.
`transfers[].partnerReference`	`string`	Yes	The transaction/payment identifier in your system, uniquely identifies the transfer in your platform.
`transfers[].sourceAmount`	`number (decimal)`	Yes	Transfer source amount with fee, always positive.
`transfers[].sourceCurrency`	`string`	Yes	Transfer source currency (ISO 4217).
`type`	`enum: TRUSTED_BULK_SETTLEMENT`	Yes	Type of settlement.

Responses

200: Settlement journal received successfully. Empty response body

429: Rate limit exceeded. Retry after the number of seconds specified in the `Retry-After` header