Axiym

Confirm a payout

Confirms a payout in PENDING_CONFIRMATION, reserves sourceAmount from the funding account, and starts processing the stored payment instruction.

The request has no body and confirms the stored instruction and commercial terms. Use a new Idempotency-Key for confirmation; reuse that key when retrying the same request.

The terms must not have expired, and the funding account must be active, enabled for payouts, and sufficiently funded. Insufficient funds return 422 and leave the payout in PENDING_CONFIRMATION with no reservation. At termsExpireAt, an unconfirmed payout automatically moves to CANCELED with reasonCode: TERMS_EXPIRED; confirmation after that returns 422.

View MarkdownView complete reference

Authorization

Default
AuthorizationBearer <token>

In: header

Path Parameters

paymentId*string

Payment identifier (UUID).

Formatuuid

Header Parameters

X-Request-Id?string

Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in X-Request-Id, or generates one when omitted.

Formatuuid
Idempotency-Key*string

Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.

Lengthlength <= 255

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json