Create a Merchant Settlement Account

post

https://mapi-test.boomfi.xyz/v1/accounts

The Create a Merchant Settlement Account endpoint allows you to add a new settlement account to your organization. Provide necessary details such as account type, supported currencies, and blockchain network information. Uniqueness checks will be performed to ensure that the combination of org_id, reference, chain_id, and currency is unique. Use this endpoint to expand your settlement options and manage payouts effectively.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

The name assigned to the merchant settlement account. This name will help you identify the account within your organization.

reference

string

required

A reference code used to group and manage multiple merchant settlement accounts. This helps in bundling accounts for organizational purposes.

type

string

enum

required

The type of merchant settlement account, indicating the settlement method. Currently, only CryptoPayIn is supported. This defines how transactions will be processed for the account.

Allowed:

chain_id

number

required

The blockchain network identifier for the merchant settlement account. This specifies the network on which the account operates. Find the identifier for each network in the Network & Currencies guide.

address

string

required

The wallet address associated with the merchant settlement account. Ensure that this address is accurate to facilitate proper transaction settlements.

currencies

array of strings

required

A list of currency codes supported by this account. Please provide the currency codes that the settlement account can accept.

currencies*

Responses

400

Bad Request

500

Internal Server Error

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully creates merchant settlement account.