Sign in

v1

latestOpenAPI 3.1.0Proprietary2026-07-24462215.9 KB
Settlement Accounts

Create Settlement Account

Creates a settlement account for the organization. A settlement account is the destination where settled funds are paid out.

Use the currencyType field to select the type of account to create:

  • currencyType: fiat — creates a fiat settlement account. Requires currency, paymentType, and paymentCode. The fields to pass inside accountDetails depend on the selected payment method: call GET /v3/config/payment-methods?direction=withdraw&userType=business&currency=<currency> and pass every field listed under the payment method's additionalDetails inside accountDetails.
  • currencyType: crypto — creates a crypto settlement account. Requires walletAddress plus the currency identification: either cryptoTicker, or both cryptoCurrency and cryptoNetwork.

The first settlement account created for a given type is marked as the default. If a matching settlement account already exists, the existing account is returned instead of creating a duplicate.

post/v3/settlement-account

Headers

MIDstring required
Example:SABCDEF_SCT8YW_NA

Merchant or sub-merchant MID

Request body

OR

Example request

{
  "currencyType": "fiat",
  "accountAlias": "Primary EUR payout account",
  "currency": "EUR",
  "paymentType": "bank_transfer",
  "paymentCode": "sepa_bank_va",
  "accountDetails": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "iban": "DE89370400440532013000"
  }
}

Response

Settlement account created successfully (or already exists)

statusstring
messagestring