Create a payout
Prepares a payment using a partner-owned account and active quote.
Choose the party-data structure
- Without
partyDataMapId,senderandreceiveruse Axiym's documented field structure. - With
partyDataMapId,senderandreceivermay use the partner-defined structure associated with that map. Axiym maps their field paths before validation.
Normalization and validation
Values that use an Axiym-controlled vocabulary are normalized for this payment. Exact Axiym values pass through unchanged. Axiym then validates the complete instruction against the baseline and corridor requirements.
Review before committing
The response contains the prepared instruction and its final normalized values. Its status is PENDING_CONFIRMATION, and no funds move until the payment is confirmed.
Authorization
Default In: header
Header Parameters
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.
uuidA unique key that makes a resource-creating or funds-moving request safe to retry. Reusing the key returns the original result instead of creating a duplicate. A UUID is recommended.
length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Choose one party-data mode. Without partyDataMapId, use Axiym's documented sender and receiver structure. With partyDataMapId, use the partner structures linked to that map. Both modes normalize allowed-value fields and apply the same payment and corridor validation.
Use this variant when sender and receiver follow Axiym's documented field structure. Do not provide partyDataMapId. Axiym normalizes allowed-value fields before validation.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json