Países habilitados para payout

O endpoint Payout Destinations retorna a lista de países disponíveis para receber payouts a partir de um país de origem especificado.

Ele é normalmente usado para determinar quais países de destino são suportados para um corredor de payout (que estão ativos na sua instalação) antes de prosseguir com a criação de cotação ou transação.

Exemplo de Requisição

curl --request GET \
  --url {api_endpoint}/organizations/{tenant}/payout/{sourceCountryIso2}/destinations \
  --header 'content-type: application/json' \
  --header 'x-agent-api-key: {agentApiKey}' \
  --header 'x-agent-id: {agentId}'

{
   "countryDestinations": [
      {
          "country": "BR",
          "countryName": "Brazil",
          "currency": "BRL",
          "currencyName": "Brazilian real",
          "currencySymbol": "R$",
          "emoji": ""
       },
      {
          "country": "DO",
          "countryName": "Dominican Republic",
          "currency": "DOP",
          "currencyName": "Dominican peso",
          "currencySymbol": "RD$",
          "emoji": ""
      }
    ]
}

Detalhes da Resposta

• country — Código ISO 3166-1 alpha-2 do país de destino.
• countryName — Nome completo do país de destino.
• currency — Código ISO 4217 da moeda de destino.
• currencyName — Nome completo da moeda.
• currencySymbol — Símbolo da moeda de destino (se disponível).
• emoji — (Opcional) Representação da bandeira em emoji.

Notas de Uso

• Use este endpoint para preencher listas suspensas ou validar corredores quando o usuário selecionar um país de origem.
• Depois que um par origem–destino válido for escolhido, você pode prosseguir com a solicitação de cotações e a criação de payouts.

GET /organizations/{tenant}/payout/{sourceCountryIso2}/destinations