Cashout — Saque via PIX

Envie PIX do seu saldo ISolutionPay para qualquer chave PIX. O valor é debitado imediatamente do seu saldo e transferido via PicPay.

⚠️

A API de Cashout precisa estar habilitada na sua conta. Entre em contato com o suporte se precisar de acesso.

Modelo de cobrança

Você informa o valor bruto (amount) — a taxa da plataforma é descontada internamente e o destinatário recebe o valor líquido.

Você envia:    amount = 120  (R$ 1,20 debitado do seu saldo)
Taxa:                   20  (R$ 0,20 — cobrada internamente)
Destinatário recebe:   100  (R$ 1,00 via PIX)

O campo amount na resposta representa o valor líquido recebido pelo destinatário.

Solicitar cashout

POST /api/cashout
Authorization: Bearer {{api_key}}
Content-Type: application/json

Body

Campo	Tipo	Obrigatório	Descrição
`amount`	integer	✅	Valor bruto em centavos a debitar do seu saldo (mín. depende da taxa)
`pix_key`	string	✅	Chave PIX do destinatário
`pix_key_type`	string	✅	Tipo da chave — veja tabela abaixo
`info`	string	❌	Descrição da transferência (máx. 140 chars)

Tipos de chave PIX (`pix_key_type`)

Valor	Formato de `pix_key`	Exemplo
`cpf`	11 dígitos sem pontuação	`12345678901`
`cnpj`	14 dígitos sem pontuação	`12345678000195`
`email`	E-mail válido	`joao@email.com`
`phone`	Com ou sem `+55` — somente dígitos	`+5511999999999` ou `11999999999`
`evp`	UUID da chave aleatória	`123e4567-e89b-12d3-a456-426614174000`

Para phone: o +55 é adicionado automaticamente caso não seja informado.

Exemplos por tipo de chave

CPF

{
  "amount": 500,
  "pix_key": "12345678901",
  "pix_key_type": "cpf",
  "info": "Pagamento do pedido #42"
}

CNPJ

{
  "amount": 500,
  "pix_key": "12345678000195",
  "pix_key_type": "cnpj",
  "info": "Pagamento do pedido #42"
}

E-mail

{
  "amount": 500,
  "pix_key": "joao@email.com",
  "pix_key_type": "email",
  "info": "Pagamento do pedido #42"
}

Telefone

{
  "amount": 500,
  "pix_key": "+5511999999999",
  "pix_key_type": "phone",
  "info": "Pagamento do pedido #42"
}

Chave aleatória (EVP)

{
  "amount": 500,
  "pix_key": "123e4567-e89b-12d3-a456-426614174000",
  "pix_key_type": "evp",
  "info": "Pagamento do pedido #42"
}

Resposta `201 Created`

{
  "object": "cashout",
  "id": "31b972ce-4275-4dbb-a177-2dba6b8d9f37",
  "merchant_transaction_id": "6ea30d8f-9835-49bb-8086-1d2d93bcb046",
  "amount": 100,
  "status": "in_processing",
  "date_created": "2026-08-11T22:06:21.473585+00:00"
}

Buscar cashout por ID

GET /api/cashout/:id
Authorization: Bearer {{api_key}}

Resposta `200 OK`

{
  "object": "cashout",
  "id": "31b972ce-4275-4dbb-a177-2dba6b8d9f37",
  "merchant_transaction_id": "6ea30d8f-9835-49bb-8086-1d2d93bcb046",
  "picpay_transfer_id": "abc123",
  "amount": 100,
  "status": "processed",
  "pix_key": "+5511999999999",
  "pix_key_type": "phone",
  "end_to_end_id": "E60746948202608112206abcdef12345",
  "date_created": "2026-08-11T22:06:21.473585+00:00",
  "date_updated": "2026-08-11T22:07:05.000000+00:00"
}

Listar cashouts

GET /api/cashout
Authorization: Bearer {{api_key}}

Retorna os últimos 50 cashouts em ordem decrescente de criação.

Status

Status	Descrição
`in_processing`	PIX enviado — aguardando confirmação
`processed`	PIX liquidado com sucesso
`failed`	Falhou — saldo estornado automaticamente

Use GET /api/cashout/:id para verificar o status atual de um cashout.

Erros comuns

Código	Motivo
`400`	`amount` abaixo do mínimo ou maior que o saldo disponível
`403`	Conta sem acesso à API de Cashout
`409`	Transação duplicada (`merchant_transaction_id` já existe)
`502`	Erro na comunicação com a PicPay

Pagamento com Cartão Webhooks