Skip to main content
POST
Create bank payout

Authorizations

Authorization
string
header
required

API Key for accessing management endpoints

Headers

Idempotency-Key
string

Idempotency key for safely retrying requests

Path Parameters

uid
string
required

User ID

aid
string
required

Account ID

Body

application/json

Payout details

amounts
object
required
recipient
object
required
description
string
Minimum string length: 3
Example:

"Payment for services rendered"

ownReference
string
Example:

"PAY-2025-001234"

Response

Created

canceledAt
string
Example:

"2025-01-15T10:35:00Z"

counterparty
string

Counterparty is the party on the other side of the order, resolved per operation type: sender/cardholder for incomes, recipient/destination for expenses. May be empty when not available.

Example:

"John Doe"

createdAt
string
Example:

"2025-01-15T10:30:00Z"

destination
object
detailUrl
string
Example:

"/api/v1/account/orders/e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a9b"

displayType
string
Example:

"Transaction Type"

failedAt
string
Example:

"2025-01-15T10:35:00Z"

fee
object
fx
object
id
string
Example:

"e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a9b"

isOTPRequired
boolean
Example:

true

origin
object
reference
string
Example:

"PAY-2025-001234"

reversedAt
string
Example:

"2025-01-15T10:35:00Z"

settledAt
string
Example:

"2025-01-15T10:35:00Z"

state
string
Example:

"PENDING"

type
string
Example:

"TRANSACTION_TYPE"

updatedAt
string
Example:

"2025-01-15T10:30:05Z"