---
title: "Transferência via Pix"
method: POST
path: "/pix/cash-out"
tags: ["Pagamentos instantâneos"]
---

# Transferência via Pix

`POST /pix/cash-out`

Realize transferências via Pix (manuais, por chave ou QR Code). Para isso, é necessário possuir uma conta aberta no Bankly.

## Headers

- `Idempotency-Key` string

## Parameters

- `#/paths/~1pix~1claims/get/parameters/0` — unresolved $ref
- `#/paths/~1pix~1claims/get/parameters/3` — unresolved $ref
- `#/paths/~1pix~1claims/get/parameters/1` — unresolved $ref

## Request body

- CreatePixCashOutTransactionRequest
  - `correlationId` string, nullable
  - `amount` number, double, required — Informe o valor a ser pago.<br /> Em caso de pagamento de QR Code para Pix Troco, informe o valor total a ser pago (valor da compra somado ao valor que se deseja obter em espécie). <br />Em caso de pagamento de QR Code para Pix Saque, <b>não</b> preencha este campo. O valor deverá ser enviado no campo <code>withdrawalAmount</code>.
  - `description` string, nullable — Campo que pode ser utilizado pelo usuário para enviar mensagens ao destinatário da transferência com informações sobre a transação. O texto pode conter no máximo 140 caracteres e não aceita nenhum caractere especial (exceto hífen).
  - `sender` PersonRequestSender, required
    - `account` AccountSender, required
      - `branch` string, required — Número da agência.
      - `number` string, required — Número da conta.
      - `type` 'CHECKING' | 'SALARY' | 'SAVINGS' | 'PAYMENT', required — Informe o tipo de conta.
    - `documentNumber` string, nullable, required — Número do documento (CPF ou CNPJ). `^([0-9]{11}|[A-Z0-9]{12}[0-9]{2})$`
    - `name` string, nullable, required — Nome de registro conforme consta no cadastro da conta.<br /> Quando pessoa física, trata-se do nome de registro, e quando pessoa jurídica, trata-se da razão social da empresa.
  - `initializationType` 'Manual' | 'Key' | 'StaticQrCode' | 'DynamicQrCode', required — Modo pelo qual se dará a transação.
  - `recipient` PersonRequestRecipient — Os dados do recebedor <b>não</b> devem ser enviados em caso de pagamento por chave Pix e QR Code.
    - `account` AccountRecipient
      - `branch` string — Campo obrigatório para <b>Pix <i>cash-out</i> Manual</b>. Só deve ser preenchido nesse caso.
      - `number` string — Campo obrigatório para <b>Pix <i>cash-out</i> Manual</b>. Só deve ser preenchido nesse caso.
      - `type` 'CHECKING' | 'SALARY' | 'SAVINGS' | 'PAYMENT' — Informe o tipo de conta.
    - `bank` BankRequestRecipient
      - `ispb` string, nullable — Campo obrigatório para <b>Pix <i>cash-out</i> Manual</b>. Só deve ser preenchido nesse caso. ISPB da instituição financeira. <b>Importante</b>: o campo deve conter oito caracteres. Portanto, se o ISPB do banco contiver apenas seis dígitos, por exemplo, complete-o com zeros à esquerda. Exemplo: "00123456".
    - `documentNumber` string, nullable — Número do documento (CPF ou CNPJ).<br /> Campo obrigatório para <b>Pix <i>cash-out</i> Manual</b>. Só deve ser preenchido nesse caso. `^([0-9]{11}|[A-Z0-9]{12}[0-9]{2})$`
    - `name` string, nullable — Nome de registro conforme consta no cadastro da conta. Quando pessoa física, trata-se do nome de registro, e quando pessoa jurídica, trata-se da razão social da empresa. <br /> Campo obrigatório para <b>Pix <i>cash-out</i> Manual</b>. Só deve ser preenchido nesse caso. Além disso, este campo <b>não</b> aceita caracteres especiais.
  - `endToEndId` string, nullable — Campo obrigatório para <i>cash-out</i> por <b>chave Pix</b> e <b>Pix QR Code</b>. Só deve ser preenchido nesses casos.
  - `withdrawalAmount` number, double — Informe o valor do saque. <br /> Preenchimento <b>exclusivo</b> e <b>obrigatório</b> em caso de pagamento de <b>QR Code para Pix Saque</b>.
  - `requestDateTime` string, date-time, nullable — Data e hora de recebimento da ordem de pagamento enviada pelo usuário pagador ao PSP pagador no formato ISO 8601.
  - `receiverReconciliationId` string — Deve ser preenchido com o valor do <code>conciliationId</code> quando esse campo retornar na leitura do QR Code. Sendo obrigatório para QR Code Dinâmico e opcional para QR Code Estático.
  - `changeAmount` number, double — Informe o valor do troco. <br /> Preenchimento <b>exclusivo</b> e <b>obrigatório</b> em caso de pagamento de <b>QR Code para Pix Troco</b>.

## Response `202`

Pagamento realizado com sucesso.

- CreatePixCashOutTransactionResponse
  - `amount` number, double — Valor enviado.
  - `withdrawalAmount` number, double — Valor do saque (retornado apenas em caso de pagamento de QR Code para Pix Saque).
  - `changeAmount` number, double — Valor do troco (retornado apenas em caso de pagamento de QR Code para Pix Troco).
  - `description` string, nullable — Campo que pode ser utilizado pelo usuário para enviar mensagens ao destinatário da transferência com informações sobre a transação.
  - `sender` PixPersonSender
    - `account` AccountSenderResponse
      - `branch` string — Número da agência.
      - `number` string — Número da conta.
      - `type` 'CHECKING' | 'SALARY' | 'SAVINGS' | 'PAYMENT' — Tipo de conta.
    - `bank` BankSenderResponse
      - `ispb` string, nullable — ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
      - `compe` string, nullable — Código do banco.
      - `name` string, nullable — Nome do banco.
    - `documentNumber` string, nullable — Número do documento (CPF ou CNPJ). `^([0-9]{11}|[A-Z0-9]{12}[0-9]{2})$`
    - `name` string, nullable — Nome de registro conforme consta no cadastro da conta.<br /> Quando pessoa física, trata-se do nome de registro, e quando pessoa jurídica, trata-se da razão social da empresa.
  - `recipient` PixPersonRecipient
    - `account` AccountRecipientResponse
      - `branch` string — Número da agência.
      - `number` string — Número da conta.
      - `type` 'CHECKING' | 'SALARY' | 'SAVINGS' | 'PAYMENT' — Tipo de conta.
    - `bank` BankRecipientResponse
      - `ispb` string, nullable — ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
      - `compe` string, nullable — Código do banco. Campo não retornado em caso de pagamento de QR Code para Pix Troco.
      - `name` string, nullable — Nome do banco. Campo não retornado em caso de pagamento de QR Code para Pix Troco.
    - `documentNumber` string, nullable — Número do documento (CPF ou CNPJ). `^([0-9]{11}|[A-Z0-9]{12}[0-9]{2})$`
    - `name` string, nullable — Nome de registro conforme consta no cadastro da conta.<br /> Quando pessoa física, trata-se do nome de registro, e quando pessoa jurídica, trata-se da razão social da empresa.
  - `authenticationCode` string — Identificador retornado nas operações de <i>cash-out</i>. Seu valor é utilizado para verificar os <i>status</i> da transação no <i>endpoint</i> de consulta de <i>status</i>.
  - `requestDateTime` string, date-time — Data e hora da ordem de pagamento enviada pelo usuário pagador ao PSP pagador.

## Other responses

- `400` — unresolved $ref
- `404` — unresolved $ref
- `422` — unresolved $ref
- `429` — A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido.
- `500` — unresolved $ref

---

[API](https://skmtc.net/bankly/apis/autentica-o.md) · [All operations](https://skmtc.net/bankly/apis/autentica-o/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bankly/autentica-o/revisions/e20afa10cd0e/schema)