Create Account
Create a merchant or partner within your account hierarchy. Select the request variant matching type. Merchants require tax_id, mcc, and a US business address with city, state, and zip. Partners omit merchant tax and payment defaults. The parent defaults to the caller; an explicit parent_id must be an accessible account that can have children. Creation does not issue an API key.
Headers
- enumAcceptconst:application/jsonrequired
Response format. Must be
application/json. - enumContent
- Type const:application/jsonrequiredRequest payload format. Must be
application/jsonwhen a body is sent.
Body·
Create a merchant or partner within your account hierarchy. Select the request variant matching type. Merchants require tax_id, mcc, and a US business address with city, state, and zip. Partners omit merchant tax and payment defaults. The parent defaults to the caller; an explicit parent_id must be an accessible account that can have children. Creation does not issue an API key.
Create a merchant that accepts payments. Supply tax_id, mcc, and a US business address. Payment defaults apply to this merchant.
- Type: objectaddressrequiredProperties: 6
US merchant business address. City, state, and zip are required.
- Type: stringmccrequired
Merchant accounts only.
- Type: stringnamerequired
- Type: stringtax
_id min length:1requiredMerchant accounts only. Required on merchant creation; omit when creating a partner.
- typeconst:merchantrequired
- Type: stringnullableadmin
_email Optional billing contact email for the new account.
- Type: array of stringnullableavailable
_processor _configs - Type: stringdescription
- Type: array of InvitenullableinvitesProperties: 2
Array of invitation objects, each with an "email" field. Email strings alone are not accepted. The optional "role" is "org:admin" or "org:member" (default).
- Type: stringnullableparent
_id - Type: enumnullablesurcharge
_basis Merchant accounts only.
valuestotalsubtotalsubtotal_plus_taxsubtotal_plus_tip - Type: booleannullablesurcharge
_confirmation _required Merchant accounts only.
- Type: numbernullablesurcharge
_rate Merchant accounts only.
- Type: enumnullabletax
_basis Merchant accounts only.
valuestotalsubtotal - Type: numbernullabletax
_rate Merchant accounts only.
Responses
- application/json
- application/json
- application/json
- application/json
curl https://api.uat.koard.com/v2/accounts \
--request POST \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'x-koard-apikey: YOUR_SECRET_TOKEN' \
--data '{
"type": "merchant",
"parent_id": "",
"name": "",
"description": "",
"address": {
"street_line1": "",
"street_line2": "",
"city": "",
"country": "",
"state": "",
"zip": ""
},
"tax_id": "",
"mcc": "",
"available_processor_configs": [
""
],
"surcharge_rate": 1,
"surcharge_confirmation_required": true,
"surcharge_basis": "total",
"tax_rate": 1,
"tax_basis": "total",
"admin_email": "",
"invites": [
{
"email": "person@example.com",
"role": "org:member"
}
]
}'
{
"id": "string",
"available_processor_configs": [],
"tax_id": null,
"mcc": null,
"type": "psp",
"status": "active",
"name": "string",
"description": "",
"parent_account_ids": [],
"address": {
"street_line1": "",
"street_line2": "",
"city": "",
"country": "USA",
"state": "",
"zip": ""
},
"surcharge_rate": null,
"surcharge_confirmation_required": null,
"surcharge_basis": "total",
"tax_rate": null,
"tax_basis": "total",
"created_at": "2026-11-12T19:57:41.276Z",
"deleted_at": "2026-11-12T19:57:41.276Z",
"updated_at": "2026-11-12T19:57:41.276Z",
"children": [],
"transaction_stats": {
"current": {
"count": 0,
"volume": 0
},
"previous": {
"count": 0,
"volume": 0
}
},
"available_processors": [
{
"id": "string",
"owner_id": "string",
"processor": "string",
"gateway": "string",
"psp": "string",
"name": "string",
"description": "string",
"created_at": "2026-11-12T19:57:41.277Z",
"updated_at": "2026-11-12T19:57:41.277Z",
"is_active": true,
"kernel_profile_id": "string",
"tpid": "string"
}
]
}
