Skip to main content
Use estes exemplos quando o seu serviço for dono da criação, cancelamento e reconciliação de payouts. Todos os exemplos assumem um client configurado a partir do Início rápido do SDK para TypeScript.

Métodos do recurso

Criar uma transferência

O amount da requisição e dos itens de listagem usa centavos numéricos. Nas respostas de criação, consulta e cancelamento, o valor bruto em data.amount é uma string decimal. Tipos de chave Pix suportados: CPF, CNPJ, EMAIL, PHONE e EVP.

Consultar e reconciliar

Use consultas para telas de back-office, jobs de reconciliação e checagens atrasadas de estado.

Listar transferências

Respostas de listagem incluem next_cursor, prev_cursor e total. Use esses campos ao construir sua própria UI paginada.

Listar com paginação automática

Use paginação automática para jobs de lote, exportações e tarefas de reconciliação que precisam consumir todas as páginas disponíveis.

Cancelar com segurança

O cancelamento está disponível apenas nos estados compatíveis. Se falhar, inspecione o erro tipado do SDK e reconcilie a transferência antes de tentar novamente.

Formato de resposta

Métodos de criação, consulta e cancelamento retornam { data, meta }. Métodos de listagem retornam { data, meta }, em que data é um envelope com cursor:

Regra comum

Use pix_key_type e pix_key_value nos exemplos de SDK e API. Não use campos de entrada não documentados como pix_key ou recipient_name.