Fund a settlement (Finix→Brale instant payout)
Initiate an instant payout against a settlement. Wraps Finix's `POST /settlements/{id}/funding_transfer_attempts`. The destination must be a payment instrument owned by the authenticated company (debit card, typically a Brale-issued one). `amount` is in cents and cannot exceed the settlement's `net_amount`. This is the Finix→Brale movement that was missing from the API surface — see `tasks/transfer-endpoint-gap.md`.
Authorization
apiKey Merchant API key. Publishable keys (pk_test_* / pk_live_) are safe for browser/frontend use and carry a limited scope set (sessions, payment_instruments, customers, orders writes; products, product_prices, payment_links reads). Secret keys (sk_test_ / sk_live_*) grant full admin access and must only be used server-side.
In: header
Path Parameters
1 <= lengthRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://loading/v1/api/settlements/string/fund" \ -H "Content-Type: application/json" \ -d '{ "instrument_id": "PIxxxxxxxxxxxxxxxxxx", "amount": 50000 }'{
"success": true,
"timestamp": "2026-02-27T00:00:00.000Z",
"message": "Settlement funding transfer attempt created successfully",
"data": {
"id": "FTRxxxxxxxxxxxxxxxxxx",
"settlement_id": "STxxxxxxxxxxxxxxxxxx",
"instrument_id": "PIxxxxxxxxxxxxxxxxxx",
"amount": 50000,
"state": "PENDING",
"created_at": "2026-02-27T00:00:00.000Z"
}
}{
"success": false,
"timestamp": "2019-08-24T14:15:22Z",
"error": {
"code": "string",
"message": "string",
"details": null
}
}{
"success": false,
"timestamp": "2019-08-24T14:15:22Z",
"error": {
"code": "string",
"message": "string",
"details": null
}
}{
"success": false,
"timestamp": "2019-08-24T14:15:22Z",
"error": {
"code": "string",
"message": "string",
"details": null
}
}{
"success": false,
"timestamp": "2019-08-24T14:15:22Z",
"error": {
"code": "string",
"message": "string",
"details": null
}
}{
"success": false,
"timestamp": "2019-08-24T14:15:22Z",
"error": {
"code": "string",
"message": "string",
"details": null
}
}