Saques e transferências

Um payout move o saldo da conta no seu nome para a sua própria conta bancária (saque) ou para um vendedor cadastrado (transferência de split). A Diamond Pay nunca segura o dinheiro.

POST/api/v1/bank/payout/

Cria um saque ou transferência a partir da carteira para o destino informado em <tipo>_destination.

Requisição

POST /bank/payout/
Authorization: Bearer <token>
Content-Type: application/json

{
  "wallet_uuid": "00000000-0000-0000-0000-000000000000",
  "merchant_id": "MER-001",
  "type_payout": "pix",
  "value": 1500.00,
  "currency": "BRL",
  "description": "Withdrawal to bank account",
  "transaction_reference": "REF-0001",
  "pix_destination": {
    "pix_address_key": "12345678000199",
    "pix_address_key_type": "cnpj",
    "beneficiary_name": "Sua Loja LTDA",
    "beneficiary_tax_id": "12345678000199"
  },
  "webhook_url": "https://your-store.com/webhook/payout"
}

Resposta

{
  "payout_uuid": "1c2d3e4f-5a6b-7c8d-9e0f-a1b2c3d4e5f6",
  "status": "pending",
  "type_payout": "pix",
  "amount": 1500.00,
  "currency": "BRL",
  "description": "Withdrawal to bank account",
  "transaction_reference": "REF-0001",
  "fee": 2.50
}

Destinos suportados

type_payout	Destino	Campo do destino
pix	Chave Pix de conta no seu nome	pix_destination (pix_address_key + key_type)
bank_transfer	Conta bancária de mesma titularidade	bank_destination
ted	TED para conta de mesma titularidade	bank_destination
internal	Transferência de split entre contas da mesma entidade	internal_destination

Status de um payout

Status	O que significa
pending	Aguardando processamento.
issued	Payout emitido.
processing	Em processamento no intermediador.
realized	Concluído: valor entregue.
returned	Devolvido (chave inválida, dados incorretos).
canceled	Cancelado antes da execução.
error	Falha no processamento.

GET/api/v1/bank/payout/<payout_uuid>/<wallet_uuid>/

Consulta o status atual de um payout pelo identificador.