Skip to main content
POST
Batch ACH payout

Authorizations

Authorization
string
header
required

JWT obtained from /v2/auth/login or /v3/auth/login

Body

application/json
external_reference
string<uuid>
required

External batch reference in UUID v4 format.

Example:

"550e8400-e29b-41d4-a716-446655440000"

transactions
object[]
required

Bank payments in the batch, processed in the submitted order.

Minimum array length: 1

Response

Batch evaluated. May contain pending payments, payments failed due to insufficient funds, or both.

success
boolean
required

True when at least one payment was authorized, even if others fail due to insufficient funds.

Example:

true

message
string
required

Descriptive message for the batch result.

Example:

"Batch authorized successfully"

transaction_id
string
required

Batch identifier, equal to external_reference.

Example:

"550e8400-e29b-41d4-a716-446655440000"

external_reference
string
required

External reference sent in the request.

Example:

"550e8400-e29b-41d4-a716-446655440000"

batch_id
string | null
required

Provider batch identifier. Null when no payment has sufficient funds.

Example:

"ACH-123456"

transactions
object[]
required

Result for each payment in the same order as the request.