Axiym

Test a payout

Validates representative payout data without first creating a quote. Use it with or without a Party Data Map to check party data, controlled-value normalization, and country- or corridor-specific requirements.

Without partyDataMapId, the party objects use Axiym's documented structure. With partyDataMapId, Axiym first applies the stored Party Data Map. In both modes, controlled values across sender, receiver, and transaction data are normalized and the result is validated against baseline and destination requirements selected by context.

This test does not create a quote or payout, check a rate or amount limit, reserve funds, or persist the submitted data. A structurally valid request returns 200 even when valid is false.

AuthorizationBearer <token>

In: header

Header Parameters

X-Request-Id?string

Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the X-Request-Id response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Representative payout data used to test party structure, optional Party Data Map application, controlled-value normalization, and destination-specific validation without creating a quote or payout. clientReference is omitted because no resource is created.

Tests a complete representative payload whose sender and receiver already use Axiym's documented field structure.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json