Sign in

v1

latestOpenAPI 3.0.02026-07-243678114.1 KB
Settlement Accounts

Create a Merchant Settlement Account

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.

post/v1/accounts

Request body

namestring string required

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

referencestring string required

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

type'CryptoPayIn' 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.

chain_idnumber 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.

addressstring string required

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

currenciesstring[] required

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

Example request

{
  "type": "CryptoPayIn"
}

Response

Successfully creates merchant settlement account.

messagestring

A message indicating the result of the operation.