Pré-requisitos
Antes de começar, certifique-se de ter:- Credenciais de API válidas com um token de acesso ativo.
- Uma ou mais transações de Payout com status
Completed. - O
internalIdouexternalIdde cada transação para a qual você deseja um POP.
Endpoint da API
Para baixar um POP de Payout, envie uma requisiçãoPOST para o endpoint Download Payout Proof of Payment.
Endpoint
Autenticação
Inclua seu token de acesso nos cabeçalhos da solicitação:Corpo da requisição
O corpo é um array JSON de identificadores de transação. Você pode misturar valores deinternalId e externalId na mesma requisição.
Exemplo de solicitação
curl
Tratamento de Respostas
Resposta bem-sucedida
Em caso de sucesso, o corpo da resposta é o próprio arquivo ZIP, codificado em base64 como texto simples. Ele não é encapsulado em um campo JSON: decodifique o corpo da resposta diretamente para obter o arquivo ZIP, que contém um PDF de Comprovante de Pagamento para cada transação solicitada.Respostas de erro
401 Não autorizado. O token de acesso está ausente, é inválido ou expirou.Completed.
Melhores práticas de implementação
- Valide que uma transação está com status
Completedantes de solicitar o POP dela. - Agrupe vários IDs de transação em uma única requisição, em vez de chamar o endpoint uma vez por transação.
- Armazene os tokens de acesso em local seguro e alterne-os regularmente.
Recursos e próximos passos
Maximize o sucesso da sua integração com estes recursos essenciais.Integração de Webhook
Configure notificações em tempo real para atualizações do status das transações.
Relatórios no Business Portal
Acesse análises detalhadas, ferramentas de geração de relatórios e recursos de conciliação.
Monitoramento de transações
Aprenda a consultar o status das transações e a implementar um rastreamento abrangente.
Referência da API
Documentação completa dos endpoints com exemplos interativos.
Dica profissionalSempre teste seu fluxo de trabalho em nosso ambiente de sandbox antes de implantá-lo em produção. Isso garante que o tratamento de erros, o processamento de webhooks e o rastreamento de status funcionem corretamente em todos os cenários.
Precisa de ajuda?Entre em contato com nossa equipe de suporte caso encontre algum problema ou precise de ajuda com a integração.

