Antes de começar
- Credenciais de API válidas (token de acesso).
- Uma conta dedicada, financiada para o pagamento de impostos e contas.
- O
billTypeque você pretende pagar, validado em relação ao catálogo de BillType. - A referência da conta (por exemplo, uma referência de pagamento do SAT para o México) obtida junto ao contribuinte ou ao emissor da cobrança.
Endpoint
Para criar um Payout de pagamento de imposto, conta ou serviço, envie uma requisiçãoPOST ao endpoint Create a Payout com paymentMethod.type definido como "BillPay".
Cabeçalhos obrigatórios
Requisição
curl
Parâmetros-chave da solicitação
A requisição exige vários objetos principais. Consulte a referência Create a Payout para a lista completa de campos, incluindosender e merchant.
Tratamento da resposta
Resposta bem-sucedida
Campos de resposta principais
Resposta de erro
Considerações sobre a referência da conta
Para o México, obillReference é a referência de pagamento do SAT: uma chave alfanumérica de 20 caracteres que identifica de forma única o conceito de imposto, o contribuinte e o período fiscal.
Testando no Stage
Para permitir que você valide o fluxo de ponta a ponta antes de entrar em produção, a Localpayment simula a resposta do emissor da cobrança no Stage sempre que obeneficiary.billReference enviado corresponder a uma das linhas de captura fixas do catálogo abaixo.
Veja Payout Status and Error Codes para a lista completa.
Webhooks
A Localpayment notifica você sobre o status final da transação por webhook, usando a mesma estrutura de payload da resposta acima. A notificação inclui ostatus final, o externalId e o objeto beneficiary com billType e billReference. Consulte Webhooks para ver exemplos de payload, validação de assinatura e configuração.
Novas tentativas
- A Localpayment tenta novamente uma entrega de webhook com falha até 3 vezes, com backoff exponencial.
- Seu endpoint deve responder com HTTP 200 para confirmar o recebimento. Qualquer outro código de status conta como falha de entrega.
- Se as 3 novas tentativas falharem, a transação permanece no status final e você pode recuperá-la manualmente por meio da API.
Próximos passos
Visão geral de impostos, contas e pagamentos de serviços
Escopo, fluxo de pagamento e estados da transação.
Aprovações e dupla assinatura
Aprenda como autorizar um Payout criado com requireAuth.

