Sign in
Pagamentos instantâneos

Transferência via Pix

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

post/pix/cash-out

Headers

Idempotency-Keystring

Chave de idempotêcia para a requisição (UUID v4).

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

correlationIdstring nullable
amountnumber 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>.

descriptionstring 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).

initializationType'Manual' | 'Key' | 'StaticQrCode' | 'DynamicQrCode' required

Modo pelo qual se dará a transação.

endToEndIdstring 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.

withdrawalAmountnumber 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>.

requestDateTimestring date-time nullable

Data e hora de recebimento da ordem de pagamento enviada pelo usuário pagador ao PSP pagador no formato ISO 8601.

receiverReconciliationIdstring

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.

changeAmountnumber 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

Pagamento realizado com sucesso.

amountnumber double

Valor enviado.

withdrawalAmountnumber double

Valor do saque (retornado apenas em caso de pagamento de QR Code para Pix Saque).

changeAmountnumber double

Valor do troco (retornado apenas em caso de pagamento de QR Code para Pix Troco).

descriptionstring 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.

authenticationCodestring

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>.

requestDateTimestring date-time

Data e hora da ordem de pagamento enviada pelo usuário pagador ao PSP pagador.