Transferência via Pix

post

https://api-mtls.sandbox.bankly.com.br/pix/cash-out

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

stable

scope: pix.cashout.create

📘
Para mais informações, confira a documentação do Pix.

Body Params

amount

double

required

Informe o valor a ser pago.
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).
Em caso de pagamento de QR Code para Pix Saque, não preencha este campo. O valor deverá ser enviado no campo withdrawalAmount.

description

string | null

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

object

required

initializationType

string

enum

required

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

Allowed:

recipient

object

Os dados do recebedor não devem ser enviados em caso de pagamento por chave Pix e QR Code.

endToEndId

string | null

Campo obrigatório para cash-out por chave Pix e Pix QR Code. Só deve ser preenchido nesses casos.

withdrawalAmount

double

Informe o valor do saque.
Preenchimento exclusivo e obrigatório em caso de pagamento de QR Code para Pix Saque.

requestDateTime

date-time | null

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

double

Informe o valor do troco.
Preenchimento exclusivo e obrigatório em caso de pagamento de QR Code para Pix Troco.

Headers

api-version

string

required

Defaults to 1

Versão da API.
Atualmente estamos na 1.0.

Authorization

string

required

Token de autorização do tipo Bearer.

x-correlation-id

string

Informe um GUID v4. A cada requisição, deve-se gerar um novo GUID.

Idempotency-Key

string

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

Responses

202Pagamento realizado com sucesso.

400Há algum problema com a sua requisição.

404Recurso não encontrado.

422A sintaxe da requisição está correta, mas não foi possível processá-la devido a uma regra de negócio.

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

500Ocorreu algum erro inexperado em nosso servidor.