Pular para o conteúdo principal
POST
/
api
/
pix
/
cash-out
Realizar pagamento PIX (Cash-Out)
curl --request POST \
  --url https://api.public.firebanking.com.br/api/pix/cash-out \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": 15.5,
  "details": {
    "key": "12312312387",
    "keyType": "DOCUMENT",
    "name": "John Marvin",
    "document": "12312312387"
  },
  "externalId": "external-teste-001",
  "description": "Pagamento fornecedor XYZ"
}
'
{
  "transactionId": "456",
  "externalId": "external-teste-001",
  "status": "PENDING",
  "generateTime": "2024-01-15T10:30:00.000Z"
}

Autorizações

​
Authorization
string
header
obrigatório

Enter JWT token

Corpo

application/json
​
value
number
obrigatório

Valor da transação em reais (até duas casas decimais)

Exemplo:

15.5

​
details
object
obrigatório

Informações da chave PIX de destino

​
externalId
string
obrigatório

Identificador externo único para a transação

Exemplo:

"external-teste-001"

​
description
string

Descrição opcional da transação

Exemplo:

"Pagamento fornecedor XYZ"

Resposta

Pagamento PIX iniciado com sucesso

​
transactionId
string
obrigatório

Identificador interno da transação gerada

Exemplo:

"456"

​
externalId
string
obrigatório

Identificador externo informado na requisição

Exemplo:

"external-teste-001"

​
status
enum<string>
obrigatório

Status atual da transação

Opções disponíveis:
PENDING,
CONFIRMED,
ERROR
Exemplo:

"PENDING"

​
generateTime
string
obrigatório

Data/hora de geração da transação (ISO 8601)

Exemplo:

"2024-01-15T10:30:00.000Z"