Esquema de transacción
Cada país de destino requiere un conjunto de información diferente para los datos adicionales de la transacción, y ese esquema se describe mediante
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
| tenant | string | Sí | El identificador de tenant de su organización. |
| destinationCountryIso2 | string | Sí | Código ISO 3166-1 alpha-2 del país de destino (por ejemplo, US, BR, MX). |
Ejemplo de Solicitud
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}
Un endpoint relacionado,
GET /organizations/{tenant}/fx/transactions/schema?countryCode={iso2}, devuelve las listasrequiredFieldsyoptionalFieldsdel payload de creación de la transacción (no un JSON Schema). Use el endpoint de esquema de payout anterior para los requisitos deadditionalDataespecíficos de cada país.
