Saltar para o conteúdo principal
A API de Beneficiários permite salvar endereços de saque usados com frequência como beneficiários nomeados. Isso simplifica pagamentos recorrentes e reduz o risco de erros na digitação manual de endereços.

O que você pode fazer

  • Criar um beneficiário nomeado com endereço de carteira e rede
  • Listar, consultar, atualizar e excluir beneficiários
  • Referenciar um beneficiário por ID ao executar saques

Endpoints

MétodoEndpointDescrição
POST/beneficiariesCriar um beneficiário
GET/beneficiariesListar todos os beneficiários
GET/beneficiaries/{beneficiaryId}Obter um beneficiário específico
PATCH/beneficiaries/{beneficiaryId}Atualizar um beneficiário
DELETE/beneficiaries/{beneficiaryId}Excluir um beneficiário

Referência Completa da API

Veja todos os endpoints de beneficiários na aba Referência da API.