InícioReferência

[POST]/payment/withdraw/qrcode

Solicita uma transferência/saque via PIX Copia e Cola (Cash Out)

Para saber mais

Endpoint de produção

Método POST

https://api-gateway.firebanking.com.br/pix/v1/payment/withdraw/qrcode

Requisição

Headers

Campo

Valor

Tipo

Descrição

Content-Type

application/json

string

Define o conteúdo como JSON

x-api-key

123

string

Sua chave API

Saque via "Pix Copia e Cola"

Campos a serem enviados no Body

Campo

Tipo

Obrigatório

Descrição

type

string

Sim

Tipo da operação. Sempre enviar “PIX” como valor padrão

value

number

Sim

Valor da transação. Esse valor deve ser igual ao valor que espera-se pagar do QRCode.

Aceita valores quebrados, separados por ponto, como 123.45, representando R$123,45, por exemplo

details

object

Sim

Informações sobre o destino da transferência

details.qrCode

string

Sim

Valor do “Pix Copia e Cola”

details.name

string

Não

Nome do beneficiário

details.document

string

Não

CPF ou CNPJ do beneficiário

externalId

string

Não

Identificador único para ser usado como rastreio das transferências no envio do Webhook

Exemplo de Objeto JSON a ser enviado no Body

{
    "type":"PIX",
    "value":15,
    "details":{
        "qrCode": "00020126330014br.gov.bcb.pix01111335366962052040000530398654040.805802BR5",
        "name":"John Marvin",
        "document":"12312312387"
    },
    "externalId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

cURL 

curl --request POST \
  --url https://api-gateway.firebanking.com.br/pix/v1/payment/withdraw/qrcode \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <sua-chave-api>' \
  --data '{
  "type": "PIX",
  "value": 15,
  "details": {
    "qrCode": "00020126330014br.gov.bcb.pix01111335366962052040000530398654040.805802BR5",
    "name": "John Marvin",
    "document": "12312312387"
  },
  "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'

Exemplo de resposta

Campos a serem recebidos

Campo

Tipo

Descrição

transactionId

string

Identificador único gerado para transação de saque

status

string

Status da cobrança/transação.

Inicialmente, "WAITING_CONFIRMATION“ é o status padrão após gerar uma transferência e aguardar o pagamento, pois deve realizar todas as validações na conta, como por exemplo se há saldo na conta antes de realizar a transferência

JSON 

{
    "transactionId":"75906707-8c31-479c-b354-aa805c4cefbc",
    "status":"WAITING_CONFIRMATION"
}