Bulk Settlement
Type of settlement. Always TRUSTED_BULK_SETTLEMENT.
Reference used when paying the end of day settlement monies to TW to cover all transfers. This should match such that we can link the payment. It can have up to 10 characters and must start with TPFB four letter prefix.
The date you send the settlement funds, ISO8601 format.
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. Note: Only include if you will settle in a currency different to the source currency of transfers.
Array of transfers that happened on the settlementDate.
ID of the transfer to be settled.
The date the transfer was created, ISO8601 format.
Transfer source amount with fee, always positive.
Transfer source currency.
Name of the customer. Helps to identify customer when manual operation is required.
The transaction/payment identifier in your system, uniquely identifies the transfer in your platform.
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.)
The exchange rate you used to calculate the settlement amount for this transfer. This is only required if the source currency is different from the settlement currency. This is a required field if the settlementCurrency field has been set for the journal, and it must be set for all transfers. 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.
Array of transfers which refunds have been processed. Only for Net Settlement.
ID of the refunded transfer.
The exchange rate you used to calculate the settlement amount for this transfer. This should be the same value as the one used for the original transfer settlement.
The transaction/payment identifier in your system, uniquely identifies the transfer in you platform.
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.
{"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": "PHP","customerName": "Joe Bloggs","partnerReference": "11111","comment": "Extra Data","exchangeRate": 0.875469},{"id": 178889,"date": "2019-03-23T12:40:05-05:00","sourceAmount": 125.67,"sourceCurrency": "PHP","customerName": "Mat Newman","partnerReference": "11112","comment": "Extra Data","exchangeRate": 0.875469}],"refundedTransfers": [{"id": 178889,"partnerReference": "11112"},{"id": 124345,"partnerReference": "11102"}],"balanceTransfer": 0}
POST /v1/settlements
Sends the settlement journal. There are two types of settlement:
- Same Currency Settlement - If you settle in the same currency. e.g. settle USD account with USD
- Cross Currency Settlement - If you settle in a different currency. e.g. settle PHP account with USD. In this case, you will need to specify
settlementCurrencyandtransfers.exchangeRatefields. Settlement Currency will be the currency you plan to settle in or pay, which is USD for this example.
Type of settlement. Always TRUSTED_BULK_SETTLEMENT.
Reference used when paying the end of day settlement monies to Wise to cover all transfers. This should match such that we can link the payment. It can have up to 10 characters and must start with TPFB four letter prefix.
The date you send the settlement funds, ISO8601 format.
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. Note: Only include if you will settle in a currency different to the source currency of transfers.
Array of transfers that happened on the settlementDate.
ID of the transfer to be settled.
The date the transfer was created, ISO8601 format.
Transfer source amount with fee, always positive.
Transfer source currency.
Name of the customer. Helps to identify customer when manual operation is required.
The transaction/payment identifier in your system, uniquely identifies the transfer in your platform.
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.)
The exchange rate you used to calculate the settlement amount for this transfer. This is only required if the source currency is different from the settlement currency. This is a required field if the settlementCurrency field has been set for the journal, and it must be set for all transfers. 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.
Array of transfers which refunds have been processed. Only for Net Settlement.
ID of the refunded transfer.
The exchange rate you used to calculate the settlement amount for this transfer. This should be the same value as the one used for the original transfer settlement.
The transaction/payment identifier in your system, uniquely identifies the transfer in you platform.
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.
curl -X POST https://api.sandbox.transferwise.tech/v1/settlements \-H "Authorization: Bearer <your client credentials token>" \-H "Content-Type: application/json" \-d '{"type": "TRUSTED_BULK_SETTLEMENT","settlementReference": "TPFB190322","settlementDate": "2019-03-22T23:59:59-05:00","transfers": [{"id": 125678,"date": "2019-03-22T10:00:12-05:00","sourceAmount": 23.24,"sourceCurrency": "USD","customerName": "Joe Bloggs","partnerReference": "11111","comment": "Extra Data"},{"id": 178889,"date": "2019-03-23T12:40:05-05:00","sourceAmount": 125.67,"sourceCurrency": "USD","customerName": "Mat Newman","partnerReference": "11112","comment": "Extra Data"}],"refundedTransfers": [{"id": 178880,"partnerReference": "11108"}],"balanceTransfer": 0}'
curl -X POST https://api.sandbox.transferwise.tech/v1/settlements \-H "Authorization: Bearer <your client credentials token>" \-H "Content-Type: application/json" \-d '{"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": "PHP","customerName": "Joe Bloggs","partnerReference": "11111","comment": "Extra Data","exchangeRate": 0.875469},{"id": 178889,"date": "2019-03-23T12:40:05-05:00","sourceAmount": 125.67,"sourceCurrency": "PHP","customerName": "Mat Newman","partnerReference": "11112","comment": "Extra Data","exchangeRate": 0.875469}],"refundedTransfers": [{"id": 178880,"partnerReference": "11108"},{"id": 178881,"partnerReference": "11109"}],"balanceTransfer": 0}'
HTTP 200
Empty body