Remessas
A API de Remessas oferece uma solução completa, de ponta a ponta, para construir aplicações de pagamentos internacionais. Ela combina os Core Services da Inyo (infraestrutura regulatória e licenciamento de transmissão de dinheiro), a Plataforma de Conformidade (KYC, KYB, AML e antifraude) e o Payment Gateway (coleta e desembolso de fundos) em uma única integração unificada.
Como Funciona
Uma transação de remessa segue um ciclo de vida bem definido que garante conformidade regulatória em cada etapa:
flowchart TD
subgraph s1["1 - Remetente"]
A["Cadastro"] --> B["Conformidade"]
end
subgraph s2["2 - Preparação"]
C["Cotação"] --> D["Beneficiário"] --> E["Recursos"]
end
subgraph s3["3 - Liquidação"]
F["Execução"] --> G["Comprovante"]
end
s1 --> s2
s2 --> s3
Etapas da Integração
| Etapa | Ação | Endpoint | Descrição |
|---|---|---|---|
| 1 | Onboarding do Remetente | POST /people | Crie o remetente e acione a triagem de KYC/AML |
| 2 | Verificação de Conformidade | GET /participants/{id}/complianceLevels | Verifique se o remetente atingiu pelo menos o Nível 1 |
| 3 | Destinos | GET /payout/{country}/destinations | Consulte os corredores de payout disponíveis |
| 4 | Obter uma Cotação | POST /payout/quotes | Trave a taxa de câmbio e as tarifas |
| 5 | Cadastro do Destinatário | POST /people | Crie o beneficiário usando os schemas específicos do país |
| 6 | Conta do Destinatário | POST /payout/participants/{id}/recipientAccounts/gateway | Vincule a conta bancária do destinatário |
| 7 | Fonte de Financiamento | POST /payout/participants/{id}/fundingAccounts | Registre o cartão ou a conta ACH do remetente |
| 8 | Verificação de Limites | GET /fx/participants/{id}/limits | Verifique se o remetente não excedeu os limites de transação |
| 9 | Executar Transação | POST /fx/transactions | Envie a transação com todos os IDs vinculados |
| 10 | Webhooks | POST /webhooks | Registre-se para notificações de status em tempo real |
Padrão de Arquitetura
A Inyo exige uma arquitetura Backend-for-Frontend (BFF). Suas credenciais de API (x-api-key, x-agent-id, x-agent-api-key) nunca devem ser expostas a clients de frontend ou mobile.
flowchart TB
subgraph client["Client"]
F["Frontend<br/>(React, mobile)"]
end
subgraph yours["Sua infraestrutura"]
S["Seu servidor (BFF)<br/>guarda x-api-key, x-agent-id,<br/>x-agent-api-key"]
end
subgraph inyo["Inyo"]
A["API de remessas<br/>KYC, câmbio, payout, conformidade"]
end
F -->|"ações do usuário"| S
S -->|"chamadas autenticadas"| A
A -->|"resultados"| S
S -->|"nunca as credenciais"| F
Diretrizes de Cache
A API da Inyo aplica limites de requisições nos endpoints de data population. Implemente o cache da seguinte forma:
| Dados | Duração do Cache | Motivo |
|---|---|---|
| Destinos e bancos | 24 horas | Raramente mudam |
| Limites de conformidade | 24 horas (ou até ocorrer uma transação) | Semiestáticos |
| Schemas de destinatário/conta | 24 horas | Raramente mudam |
| Cotações | Nunca faça cache | Sensíveis ao tempo — válidas por 30 minutos por padrão; sempre verifique expireAt |
Requisitos de Rede
A API de Remessas é protegida na borda da rede: toda requisição deve apresentar um certificado de cliente TLS mútuo, e seu IP de saída deve estar na allowlist. Ambos são provisionados durante o onboarding — veja Conectividade.
Precisa de Ajuda?
- Implementação de referência: Projeto de Exemplo de Remessa — uma aplicação funcional em Node.js + React demonstrando a integração completa
- Suporte: Entre em contato com nossa equipe de vendas