Merchant
A merchant for the account is created by default. You can also create multiple merchants associated to the same account.
Create Merchant
POST /accounts/{accountUUID}/merchants
curl --location '{API_BASE_URL}/accounts/{AccountUUID}/merchants' \
--header 'X-Api-Key: {API_KEY}' \
--header 'Content-Type: application/json' \
--data '{
"name": "{MERCHANT_NAME}",
"dba": "{DBA_NAME}",
"address1": "{STREET_ADDRESS_1}",
"address2": "{STREET_ADDRESS_2}",
"city": "{CITY}",
"region": "{REGION/STATE}",
"country": "{COUNTRY}",
"merchantDiscountRate": {MERCHANT_DISCOUNT_RATE},
"externalMID": "{EXTERNAL_MERCHANT_ID}",
"highThreshold": {HIGH_VALUE_THRESHOLD}, // OPTIONAL
"kycEnabled": {KYC_ENABLED}, // OPTIONAL
"kycThreshold": {KYC_THRESHOLD}, // OPTIONAL
"cryptoNetworkConfigs": { // OPTIONAL
"{NETWORK_NAME}": {
"cryptoAssetConfigs": {
"{ASSET_NAME}": {
"minConfirmsLow": {MIN_CONFIRMS_LOW},
"minConfirmsHigh": {MIN_CONFIRMS_HIGH},
"qrExpirationSeconds": {QR_EXPIRATION_SECONDS}
}
}
}
},
"travelRulesRegionalThreshold": { // OPTIONAL
"{REGION}": {THRESHOLD_IN_LOCAL_CURRENCY}
}
}'
Create Merchant Response
- Name
createdAt- Type
- string
- Description
Created at date time of the merchant.
- Name
updatedAt- Type
- string
- Description
Updated at date time of the merchant.
- Name
UUID- Type
- string
- Description
Unique identifier for the merchant.
- Name
name- Type
- string
- Description
Name of the merchant.
- Name
dba- Type
- string
- Description
Doing business as name of the merchant.
- Name
address1- Type
- string
- Description
Street address 1 of the merchant.
- Name
address2- Type
- string
- Description
Street address 2 of the merchant.
- Name
city- Type
- string
- Description
City of the merchant.
- Name
region- Type
- string
- Description
Region or state of the merchant.
- Name
country- Type
- string
- Description
Country of the merchant.
- Name
status- Type
- string
- Description
Status of the merchant. Status as 0 means the merchant is under review, 1 means the merchant is enabled, and -1 means the merchant is disabled.
- Name
descriptor- Type
- string
- Description
Descriptor of the merchant.
- Name
accountID- Type
- string
- Description
Account ID of the merchant.
- Name
externalMID- Type
- string
- Description
External merchant id of the merchant.
- Name
merchantDiscountRate- Type
- number
- Description
A floating point number representing the merchant discount rate percentage. For example 0.25 is equivalent to 25%
example response
{
"createdAt": "2025-08-12T03:20:02.769Z",
"updatedAt": "2025-08-12T03:20:02.769Z",
"UUID": "b9280199-ab1b-4545-a625-1728ba354abf",
"name": "Brimspire",
"dba": "Brimspire",
"address1": "75831 Marvin Lodge",
"address2": "",
"city": "Janyport",
"region": "VA",
"country": "US",
"status": 1,
"descriptor": "",
"accountID": "33c0dadc-bd86-45ae-b4d6-62f149313701",
"externalMID": "1ecf316f-0821-46d4-820c-5d9313a5569c",
"merchantDiscountRate": 0.25
}
Update Merchant
PUT /accounts/{accountUUID}/merchants/{merchantUUID}
curl --location '{API_BASE_URL}/accounts/{AccountUUID}/merchants/{merchantUUID}' \
--header 'X-Api-Key: {API_KEY}' \
--header 'Content-Type: application/json' \
--data '{
"name": "{MERCHANT_NAME}",
"dba": "{DBA_NAME}",
"address1": "{STREET_ADDRESS_1}",
"address2": "{STREET_ADDRESS_2}",
"city": "{CITY}",
"region": "{REGION/STATE}",
"country": "{COUNTRY}",
"appPayEnabled": {APP_PAY_ENABLED}, // OPTIONAL
"cryptoPayEnabled": {CRYPTO_PAY_ENABLED}, // OPTIONAL
"walletPayEnabled": {WALLET_PAY_ENABLED}, // OPTIONAL
"merchantDiscountRate": {MERCHANT_DISCOUNT_RATE}, // OPTIONAL
"allowedCrypto": "{COMMA_SEPARATED_LIST_OF_ALLOWED_CRYPTO}", // OPTIONAL
"cancelTransactionEnabled": {CANCEL_TRANSACTION_ENABLED}, // OPTIONAL
"highThreshold": {HIGH_VALUE_THRESHOLD}, // OPTIONAL
"kycEnabled": {KYC_ENABLED}, // OPTIONAL
"kycThreshold": {KYC_THRESHOLD}, // OPTIONAL
"cryptoNetworkConfigs": { // OPTIONAL
"{NETWORK_NAME}": {
"cryptoAssetConfigs": {
"{ASSET_NAME}": {
"minConfirmsLow": {MIN_CONFIRMS_LOW},
"minConfirmsHigh": {MIN_CONFIRMS_HIGH},
"qrExpirationSeconds": {QR_EXPIRATION_SECONDS}
}
}
}
},
"travelRulesRegionalThreshold": { // OPTIONAL
"{REGION}": {THRESHOLD_IN_LOCAL_CURRENCY}
}
}'
Update Merchant Response
- Name
createdAt- Type
- string
- Description
Created at date time of the merchant.
- Name
updatedAt- Type
- string
- Description
Updated at date time of the merchant.
- Name
UUID- Type
- string
- Description
Unique identifier for the merchant.
- Name
name- Type
- string
- Description
Name of the merchant.
- Name
dba- Type
- string
- Description
Doing business as name of the merchant.
- Name
address1- Type
- string
- Description
Street address 1 of the merchant.
- Name
address2- Type
- string
- Description
Street address 2 of the merchant.
- Name
city- Type
- string
- Description
City of the merchant.
- Name
region- Type
- string
- Description
Region or state of the merchant.
- Name
country- Type
- string
- Description
Country of the merchant.
- Name
status- Type
- string
- Description
Status of the merchant. Status as 0 means the merchant is under review, 1 means the merchant is enabled, and -1 means the merchant is disabled.
- Name
descriptor- Type
- string
- Description
Descriptor of the merchant.
- Name
accountID- Type
- string
- Description
Account ID of the merchant.
- Name
externalMID- Type
- string
- Description
External merchant id of the merchant.
- Name
merchantDiscountRate- Type
- number
- Description
A floating point number representing the merchant discount rate percentage. For example 0.25 is equivalent to 25%
example response
{
"createdAt": "2025-08-12T03:20:02.769Z",
"updatedAt": "2025-08-12T03:20:02.769Z",
"UUID": "b9280199-ab1b-4545-a625-1728ba354abf",
"name": "Brimspire",
"dba": "Brimspire",
"address1": "75831 Marvin Lodge",
"address2": "",
"city": "Janyport",
"region": "VA",
"country": "US",
"status": 1,
"descriptor": "",
"accountID": "33c0dadc-bd86-45ae-b4d6-62f149313701",
"externalMID": "1ecf316f-0821-46d4-820c-5d9313a5569c",
"merchantDiscountRate": 0.25
}
List Merchants
GET /accounts/{accountUUID}/merchants
curl --location '{API_BASE_URL}/accounts/{AccountUUID}/merchants?limit={LIMIT}&page={PAGE}' \
--header 'X-Api-Key: {API_KEY}' \
--header 'Content-Type: application/json'
List Merchants Response
- Name
merchants- Type
- array
- Description
List of merchants associated with this account.
Merchant Object- Name
createdAt- Type
- string
- Description
Created at date time of the merchant.
- Name
updatedAt- Type
- string
- Description
Updated at date time of the merchant.
- Name
UUID- Type
- string
- Description
Unique identifier for the merchant.
- Name
name- Type
- string
- Description
Name of the merchant.
- Name
dba- Type
- string
- Description
Doing business as name of the merchant.
- Name
address1- Type
- string
- Description
Street address 1 of the merchant.
- Name
address2- Type
- string
- Description
Street address 2 of the merchant.
- Name
city- Type
- string
- Description
City of the merchant.
- Name
region- Type
- string
- Description
Region or state of the merchant.
- Name
country- Type
- string
- Description
Country of the merchant.
- Name
status- Type
- string
- Description
Status of the merchant. Status as 0 means the merchant is under review, 1 means the merchant is enabled, and -1 means the merchant is disabled.
- Name
descriptor- Type
- string
- Description
Descriptor of the merchant.
- Name
accountID- Type
- string
- Description
Account ID of the merchant.
- Name
externalMID- Type
- string
- Description
External merchant id of the merchant.
- Name
merchantDiscountRate- Type
- number
- Description
A floating point number representing the merchant discount rate percentage. For example 0.25 is equivalent to 25%
- Name
metadata- Type
- object
- Description
Arbitrary key–value pairs for attaching custom, structured information to the merchants.
Metadata Object- Name
totalCount- Type
- number
- Description
Total number of items available across all pages for the query.
- Name
count- Type
- number
- Description
Number of items returned in the current page.
- Name
page- Type
- number
- Description
Current page number (1-based).
- Name
pageSize- Type
- number
- Description
Maximum number of items per page.
example response
{
"merchants": [
{
"createdAt": "2025-08-12T03:20:02.769Z",
"updatedAt": "2025-08-12T03:20:02.769Z",
"UUID": "b9280199-ab1b-4545-a625-1728ba354abf",
"name": "Brimspire",
"dba": "Brimspire",
"address1": "75831 Marvin Lodge",
"address2": "",
"city": "Janyport",
"region": "VA",
"country": "US",
"status": 1,
"descriptor": "",
"accountID": "33c0dadc-bd86-45ae-b4d6-62f149313701",
"externalMID": "1ecf316f-0821-46d4-820c-5d9313a5569c",
"merchantDiscountRate": 0.25
}
],
"metadata": {
"totalCount": 1,
"count": 1,
"page": 1,
"pageSize": 10
}
}
Get Merchant
GET /accounts/{accountUUID}/merchants/{MerchantUUID}
curl --location '{API_BASE_URL}/accounts/{AccountUUID}/merchants/{MerchantUUID}' \
--header 'X-Api-Key: {API_KEY}' \
--header 'Content-Type: application/json'
Get Merchant Response
The response is the same structure as the Create Merchant Response.
Archive Merchant
DELETE /accounts/{accountUUID}/merchants/{merchantUUID}
curl --location --request DELETE '{API_BASE_URL}/accounts/{AccountUUID}/merchants/{merchantUUID}' \
--header 'X-Api-Key: {API_KEY}' \
--header 'Content-Type: application/json'
Returns 204 No Content on success.
Upload Merchant Logo
POST /accounts/{accountUUID}/merchants/{merchantUUID}/uploadlogo
curl --location '{API_BASE_URL}/accounts/{AccountUUID}/merchants/{merchantUUID}/uploadlogo' \
--header 'X-Api-Key: {API_KEY}' \
--form 'file=@"{PATH_TO_LOGO_FILE}"'
Returns 200 OK on success.