Axiym

Confirm a payout

Confirms the exact prepared payment and starts compliance review, approval, settlement, and execution.

Funding effect

Axiym reserves totalPayable in the partner's funding account. The reserved amount cannot fund another payment. It becomes an account debit at settlement, or is released if the payment ends before settlement.

Confirmation requirements

  • The payment must have status PENDING_CONFIRMATION.
  • Confirmation must occur before confirmationExpiresAt.
  • The available balance must cover totalPayable.

Confirmation consumes the referenced quote. If the prepared payment or quote has expired, create a new payment.

Authorization

Default
AuthorizationBearer <token>

In: header

Path Parameters

payoutId*string
Formatuuid

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
Idempotency-Key*string

A 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.

Lengthlength <= 255

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json