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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

Selects a fiat settlement account.

Allowed:
string

Optional friendly name for the settlement account.

string
required
length between 3 and 3

ISO 4217 currency code (exactly 3 characters).

string
enum
required

Payment rail of the settlement account.

Allowed:
string
required

Payment method code. Obtain it from GET /v3/config/payment-methods?direction=withdraw&userType=business&currency=<currency>.

accountDetails
object

Bank / wallet details for the fiat settlement account. The required fields depend on the selected payment method — pass every field listed under the payment method's additionalDetails (from GET /v3/config/payment-methods?direction=withdraw&userType=business&currency=<currency>).

Headers
string
required

Merchant or sub-merchant MID

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json