v1

latestOpenAPI 3.1.0UNLICENSED2026-07-2613101.1 MB
Payment Batches

Confirm a payment batch

Confirms processing of payment batch.

post/payment-batches/{paymentBatchId}/confirm

Path parameters

paymentBatchIdstring uuid required

The unique ID of the Payment Batch.

Query parameters

accountIdstring required

The ID of the account to work with.

Example:F50091

Request body

Example request

{
  "mfa": {
    "provider": "fx-mfa-service",
    "sessionId": "string",
    "token": "string"
  }
}

Response

OK

status'draft' | 'validated' | 'confirmed' | 'started' | 'completed' | 'failed' | 'cancelled' required

The status of the Payment Batch.

Example response

{
  "status": "draft"
}