Skip to main content
POST
CLI

Authorizations

Authorization
string
header
required

API Key in Bearer format (e.g., Bearer sk_test_...)

Headers

X-API-Key
string

API key

Idempotency-Key
string

Optional idempotency key (UUID) to prevent duplicate batch creation

Body

application/json
onBehalfOf
string
required

Customer ID on whose behalf the batch is created.

Example:

"cus_abc123"

source
object
required

Source funding details. Draws the chosen stablecoin from the customer's provider-held balance on the chosen network.

paymentReason
enum<string>
required

Reason for the payments (compliance/AML). Applied to every item.

Available options:
CAPITAL_CONTRIBUTIONS,
CHARITABLE_CONTRIBUTIONS,
CONSULTING_FEES,
CORPORATE_TAX_PAYMENTS,
DOWN_PAYMENTS_FOR_REAL_ESTATE,
EDUCATION_FEES,
EMPLOYEE_SALARIES_OR_WAGES,
EXPENSES_REIMBURSEMENT,
GIFTS,
GOVERNMENT_GRANTS,
INCOME_TAX_PAYMENTS,
INHERITANCE_PAYMENTS,
INSURANCE_CLAIM_PAYOUTS,
INSURANCE_PREMIUM_PAYMENTS,
INVESTMENTS,
LOAN_ADVANCES,
MORTGAGE_PAYMENTS,
OTHER,
PAYMENT_FOR_GOODS_AND_SERVICES,
PERSONAL_TRANSFERS,
REAL_ESTATE_PURCHASES,
REMITTANCES,
RENT,
REPAYMENT_OF_LOANS,
ROYALTIES,
SELF,
TRADE_SETTLEMENT,
TRUST_FUND_DISTRIBUTIONS,
UTILITY_BILLS,
WELFARE_OR_BENEFITS,
WINNINGS_AND_PRIZES
Example:

"PAYMENT_FOR_GOODS_AND_SERVICES"

items
object[]
required

Payout items (max 100). Each item pays the batch source stablecoin on the source network to an external wallet.

Required array length: 1 - 100 elements
confirm
boolean

If true, submit the batch for review immediately. If false or omitted, the batch is created in DRAFT and can be confirmed later.

Response

Global payout batch created

id
string
required
Example:

"pb_abc123"

organizationId
string
required
Example:

"org_abc123"

onBehalfOf
string
required
Example:

"cus_abc123"

source
object
required
status
enum<string>
required
Available options:
DRAFT,
PENDING_APPROVAL,
PROCESSING,
COMPLETED,
PARTIALLY_COMPLETED,
FAILED,
CANCELLED,
REJECTED
Example:

"DRAFT"

paymentReason
enum<string>
required
Available options:
CAPITAL_CONTRIBUTIONS,
CHARITABLE_CONTRIBUTIONS,
CONSULTING_FEES,
CORPORATE_TAX_PAYMENTS,
DOWN_PAYMENTS_FOR_REAL_ESTATE,
EDUCATION_FEES,
EMPLOYEE_SALARIES_OR_WAGES,
EXPENSES_REIMBURSEMENT,
GIFTS,
GOVERNMENT_GRANTS,
INCOME_TAX_PAYMENTS,
INHERITANCE_PAYMENTS,
INSURANCE_CLAIM_PAYOUTS,
INSURANCE_PREMIUM_PAYMENTS,
INVESTMENTS,
LOAN_ADVANCES,
MORTGAGE_PAYMENTS,
OTHER,
PAYMENT_FOR_GOODS_AND_SERVICES,
PERSONAL_TRANSFERS,
REAL_ESTATE_PURCHASES,
REMITTANCES,
RENT,
REPAYMENT_OF_LOANS,
ROYALTIES,
SELF,
TRADE_SETTLEMENT,
TRUST_FUND_DISTRIBUTIONS,
UTILITY_BILLS,
WELFARE_OR_BENEFITS,
WINNINGS_AND_PRIZES
Example:

"PAYMENT_FOR_GOODS_AND_SERVICES"

items
object[]
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
rejectionReason
string | null

Reason when the batch was rejected during review.