Skip to main content

PIX OUT – Pagamentos via PIX

Use este tipo de transação quando você precisa enviar dinheiro para seus clientes ou parceiros.
Basta indicar o valor, a chave Pix de destino e, se desejar, um código próprio para rastreamento.

O que enviar no corpo da requisição:

amount
Valor em centavos (por exemplo, R$ 1,00 = 100).
pixKey
Chave Pix de destino (CPF, CNPJ, e‑mail, telefone ou chave aleatória).
pixKeyType
Tipo da chave Pix: CPF, CNPJ, phone, email ou random.
externalCode (opcional)
Identificador próprio para correlacionar transações no seu sistema.
baasPostbackUrl (opcional)
URL para receber notificações de status de pagamento.

Como testar no Swagger​

Authorize

  • Abra a barra lateral do Swagger e clique em Try it out.
  • Insira sua chave:
    • x-authorization-key: sua chave secreta
  • Clique em Authorize para liberar o sandbox.

Try it Out

  • Ajuste o corpo da requisição se necessário e depois clique no botão Execute abaixo.

Verifique a resposta

  • Role até o painel Response para ver o JSON de retorno.

🔍 Exemplo de Requisição​

curl --request POST \
  --url https://api.cashtime.com.br/v1/request/withdraw \
  --header 'Content-Type: application/json' \
  --header 'x-authorization-key: SUA_CHAVE_SECRETA' \
  --data '{
    "amount": 100,
    "pixKey": "66999893822",
    "pixKeyType": "phone",
    "externalCode": "pedido_123",
    "baasPostbackUrl": "https://seusistema.com.br/webhook"
  }'

✅ Exemplo de Resposta​

{
  "id": "64905df5-ee95-42f7-bc79-6bbff92ee055",
  "amount": 100,
  "taxes": 100.1,
  "pixKey": "66999893822",
  "pixKeyType": "phone",
  "externalCode": "pedido_123",
  "withdrawStatusId": "AwaitingAprove",
  "createdAt": "2025-03-05T18:55:22.919Z",
  "updatedAt": "2025-03-05T18:55:22.919Z"
}