Schema de transação

Cada país de destino exige um conjunto de informações diferentes para os dados adicionais da transação, e esse schema é descrito por

Parâmetro	Tipo	Obrigatório	Descrição
tenant	string	Sim	O identificador do tenant da sua organização.
destinationCountryIso2	string	Sim	Código ISO 3166-1 alpha-2 do país de destino (por exemplo, US, BR, MX).

Exemplo de Requisição

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

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Inyo Global Payout Additional Data - Morocco",
  "version": "1.0.0",
  "type": "object",
  "properties": {
    "additionalData": {
      "type": "object",
      "properties": {
        "statementNarrative": {
          "type": "string",
          "description": "Optional narrative text providing transaction details."
        }
      }
    }
  },
  "required": [
    "additionalData"
  ]
}

GET /organizations/{tenant}/payout/transactions/schema/{destinationCountryIso2}

Um endpoint relacionado, GET /organizations/{tenant}/fx/transactions/schema?countryCode={iso2}, retorna as listas requiredFields e optionalFields do payload de criação de transação (não um JSON Schema). Use o endpoint de schema de payout acima para os requisitos de additionalData específicos de cada país.