Skip to main content

​
Resumo

  • Método: POST
  • Rota: /api/pix/cash-out
  • Autenticação: Authorization: Bearer <seu_api_token>

​
Corpo (exemplo documentado)

{
  "transaction": {
    "value": 500.00,
    "externalId": "saque-789",
    "description": "Pagamento Fornecedor ABC"
  },
  "recipient": {
    "name": "Maria Oliveira",
    "document": "987.654.321-00",
    "pixKey": "maria@email.com",
    "pixKeyType": "email"
  }
}

​
Resposta 201

{
    "id": "977a38e8-4004-41a0-8ce0-08daaf337e8f",
    "externalId": "aaa00335-5f00-4697-b30b-88948dfb5d23",
    "status": "RESERVED",
    "valueCents": 2,
    "description": "cash-out",
    "recipient": {
        "name": "Lulu",
        "pixKey": "87a9b91f-f1f0-4acf-963d-fc58172fe412"
    },
    "createdAt": "2026-04-22T20:37:48.336039168Z"
}
CampoDescrição
idUUID do cash-out — persista para polling e reconciliação.
externalIdSeu identificador enviado no request.
statusRESERVED logo após a criação (reserva de saldo efetuada). O estado final chega via webhook.
valueCentsValor em centavos (ex.: 2 = R$ 0,02).
descriptionDescrição enviada no request.
recipient.nameNome do destinatário.
recipient.pixKeyChave Pix usada (EVP no exemplo).
createdAtTimestamp ISO 8601 UTC da criação.

​
HTTP

  • 201 Criado.
  • 400/422/409 Conforme regras.
  • 401 Não autenticado.
  • 500 Interno.

​
Relacionado