InícioReferência

[POST] /payment/withdraw

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

Para saber mais

Envio e Pagamento (Cash Out)

O que muda nessa versão?

Em termos de propriedades a serem enviadas, nenhuma mudança ocorreu. Basta mudar o endpoint antigo para o novo.

Agora, em termos de performance, esse endpoint é bem mais rápido e suporta uma volumetria ainda maior.

Endpoint de produção

Método POST

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

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

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.

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

string

Sim

Chave PIX do beneficiário

details.keyType

string

Sim

Tipo da chave PIX do beneficiário.

Podendo ser dos tipos:

"RANDOM_KEY" (chave-aleatória)

"DOCUMENT" (CPF ou CNPJ)

"PHONE" (telefone)

"MAIL" (e-mail)

details.name

string

Sim

Nome do beneficiário

details.document

string

Sim

CPF ou CNPJ do beneficiário

externalId

string

Não

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

Saque via PIX

Exemplo de Objeto JSON a ser enviado no Body

{
	"type": "PIX",
	"value": 15,
	"details": {
		"key": "12312312387",
		"keyType": "DOCUMENT",
		"name": "John Marvin",
		"document": "12312312387"
	},
	"externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

cURL 

curl --request POST \
     --url https://api-gateway.firebanking.com.br/pix/v2/payment/withdraw \
     --header 'Accept: application/json'\
     --header'Content-Type: application/json' \
     --header 'x-api-key: <sua-chave-api>' \
     --data'{
	"type": "PIX",
	"value": 15,
	"details": {
		"key": "12312312387",
		"keyType": "DOCUMENT",
		"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"
}