---
title: "Perform cash-out"
method: POST
path: "/v1/transfers/cashout"
tags: ["Transfer"]
---

# Perform cash-out

`POST /v1/transfers/cashout`

## Request

- Base URL: `https://sandbox.pismolabs.io/integrated-payments`
- URL: `https://sandbox.pismolabs.io/integrated-payments/v1/transfers/cashout`
- Auth: HTTP bearer

Perform an external transfer, using a provider to process the outgoing account resources.
This endpoint generates the following events:
* [Transfer-out created](https://developers.pismo.io/events/docs/integrated-payments-transfer-out-created-1) - Cash-out event.
* [Financial transaction status updated](https://developers.pismo.io/events/docs/integrated-payments-transaction-status-change-1) - Cash out status change. Status becomes `SETTLED` after clearing and accounts have been credited and debited.
* [Integrated payments financial reconciliation](https://developers.pismo.io/events/docs/integrated-payments-financial-reconciliation-1)- This event is generated after the transaction has been cleared and accounts debited or credited.

## Headers

- `Authorization` string, required
- `x-idempotency-key` string, required
- `x-skip-reconciliation` boolean
- `X-Signature` string

## Request body

- TransfersTransfersCashOutRequest
  - `account_id` integer, required: Pismo Platform client ID.
  - `amount` number, required: Dot-separated transfer amount in decimals.
  - `currency_code` string: ISO 4217 currency code. Can be either numeric or alphabetic.
  - `processing_code` string, required: Transfer processing code. Used to identify the type of transfer.
  - `creditor` TransfersClient
    - `account` TransfersAccount
      - `bank` TransfersBank
        - `branch` string, required: Bank branch.
        - `code` string, required: Alternative bank identifier, for example, in brazil is COMPE.
        - `identification` string, required: Bank identification. The main bank identifier, for example, in brazil is ISPB.
      - `identification` string, required: Account identification. Unique account identifier, for example a bank account number.
      - `type` string, required: Account type.
    - `identification` string, required: Identification. Document number or another unique identifier.
    - `name` string, required: Full name.
    - `type` string, required: Type required by provider; for example: F = Legal person.

## Response `202`

Response Body

- TransfersTransfersCashOutResponse
  - `correlation_id` string: Correlation ID.
  - `external_id` string: External ID of the provider.

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `409`: Conflict
- `500`: Internal Server Error
- `502`: Bad Gateway
- `504`: Gateway Timeout

---

[API](https://skmtc.dev/pismo/apis/banking-integrated-payments.md) - [All operations](https://skmtc.dev/pismo/apis/banking-integrated-payments/llms.txt) - [OpenAPI document](https://skmtc.dev/pismo/apis/banking-integrated-payments/revisions/a578004b933a?raw)
