curl --request POST \
--url https://api-sandbox.rinne.com.br/core/v1/banking/cashouts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"request_id": "req_123456789",
"origin_bank_account_id": "123e4567-e89b-12d3-a456-426614174000",
"destination_pix_key_id": "223e4567-e89b-12d3-a456-426614174002",
"amount": 10000,
"method": "PIX"
}
'{
"id": "123e4567-e89b-12d3-a456-426614174000",
"request_id": "req_123456789",
"external_request_id": "123e4567-e89b-12d3-a456-426614174000",
"company_id": "123e4567-e89b-12d3-a456-426614174000",
"origin_bank_account_id": "123e4567-e89b-12d3-a456-426614174000",
"amount": 10000,
"currency": "BRL",
"method": "PIX",
"status": "PROCESSING",
"created_at": "2025-01-01T10:00:00.000Z",
"updated_at": "2025-01-01T10:05:00.000Z",
"destination_bank_account_id": "123e4567-e89b-12d3-a456-426614174001",
"destination_bank_account_nickname": "Main operations account",
"destination_pix_key_id": "223e4567-e89b-12d3-a456-426614174002",
"fee": 150,
"cost": 100,
"fee_policy_id": "123e4567-e89b-12d3-a456-426614174002",
"cost_policy_id": "123e4567-e89b-12d3-a456-426614174003",
"error_message": "Insufficient funds",
"returned_amount": 5000,
"latest_return_at": "2025-01-01T11:00:00.000Z",
"returns": [
{
"id": "123e4567-e89b-12d3-a456-426614174004",
"cashout_id": "123e4567-e89b-12d3-a456-426614174000",
"provider_return_id": "b94150c9-7dad-4b21-8183-50c83f4c5dd8",
"amount": 1000,
"reason": "CUSTOMER_REQUEST",
"return_identification": "return_123456789",
"original_end_to_end_id": "E12345678202501011100000000001",
"original_id": "tx_123456789",
"created_at": "2025-01-01T11:00:00.000Z",
"updated_at": "2025-01-01T11:00:00.000Z"
}
],
"metadata": {
"custom_field": "value",
"order_id": "order_123"
},
"end_to_end_id": "E12345678202501271234567890123456"
}Create a new cashout request
Creates a new cashout request for the authenticated company. The cashout will be processed by the provider and status updates will be received via webhooks.
The destination is either a registered company bank account or PIX key (by id) or given
inline (destination_bank_account / destination_pix_key), in which case it is registered
as a company destination as part of this request — see CreateCashOutRequest.
Requires the banking.create permission.
curl --request POST \
--url https://api-sandbox.rinne.com.br/core/v1/banking/cashouts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"request_id": "req_123456789",
"origin_bank_account_id": "123e4567-e89b-12d3-a456-426614174000",
"destination_pix_key_id": "223e4567-e89b-12d3-a456-426614174002",
"amount": 10000,
"method": "PIX"
}
'{
"id": "123e4567-e89b-12d3-a456-426614174000",
"request_id": "req_123456789",
"external_request_id": "123e4567-e89b-12d3-a456-426614174000",
"company_id": "123e4567-e89b-12d3-a456-426614174000",
"origin_bank_account_id": "123e4567-e89b-12d3-a456-426614174000",
"amount": 10000,
"currency": "BRL",
"method": "PIX",
"status": "PROCESSING",
"created_at": "2025-01-01T10:00:00.000Z",
"updated_at": "2025-01-01T10:05:00.000Z",
"destination_bank_account_id": "123e4567-e89b-12d3-a456-426614174001",
"destination_bank_account_nickname": "Main operations account",
"destination_pix_key_id": "223e4567-e89b-12d3-a456-426614174002",
"fee": 150,
"cost": 100,
"fee_policy_id": "123e4567-e89b-12d3-a456-426614174002",
"cost_policy_id": "123e4567-e89b-12d3-a456-426614174003",
"error_message": "Insufficient funds",
"returned_amount": 5000,
"latest_return_at": "2025-01-01T11:00:00.000Z",
"returns": [
{
"id": "123e4567-e89b-12d3-a456-426614174004",
"cashout_id": "123e4567-e89b-12d3-a456-426614174000",
"provider_return_id": "b94150c9-7dad-4b21-8183-50c83f4c5dd8",
"amount": 1000,
"reason": "CUSTOMER_REQUEST",
"return_identification": "return_123456789",
"original_end_to_end_id": "E12345678202501011100000000001",
"original_id": "tx_123456789",
"created_at": "2025-01-01T11:00:00.000Z",
"updated_at": "2025-01-01T11:00:00.000Z"
}
],
"metadata": {
"custom_field": "value",
"order_id": "order_123"
},
"end_to_end_id": "E12345678202501271234567890123456"
}Body
Schema for creating a new cashout request.
Exactly one destination must be provided, either by reference to a destination the
company already registered — destination_bank_account_id or destination_pix_key_id —
or inline — destination_bank_account or destination_pix_key — in which case the
destination is registered (or matched to an existing one) as part of the cashout.
Inline destinations are the recommended way to pay to a key or account the company has
not registered yet: the cashout response carries the resulting destination_pix_key_id
or destination_bank_account_id.
Response
Cashout created successfully
Cashout response

