Create Merchant

Create a new sub-merchant within the context of a marketplace.

SecurityMarketplace API Key | Admin JWT | Marketplace JWT

Request

header Parameters

Marketplace-Id

string

Perform operation in the context of the given marketplace. Usually not required — specify only if acting on behalf of a marketplace not implied by the credentials specified in the Authorization header.

Request Body schema: application/json
required

One of:

required

object (CreateServiceProviderSubmerchant1)

Request associated with the creation of a skeleton sub-merchant without full eCommerce due diligence requirements

Responses

200

400

401

403

404

405

406

409

422

429

500

503

post/merchants

Request samples

Payload
Curl
JavaScript

application/json

{"CreateServiceProviderSubmerchant": {"referenceMerchantId": "string",
"contactEmailAddress": "lucy.diamond@star.com",
"businessName": "string",
"taxCountry": "string",
"businessType": "company",
"companyType": "Private",
"industry": "AcRefrigerationRepair",
"taxId": "string",
"contactPerson": {"firstName": "string",
"lastName": "string",
"title": "string"
},
"phoneNumber": "+61401234567",
"address": {"unitNumber": "string",
"streetNumber": "string",
"streetName": "string",
"streetType": "string",
"suburb": "string",
"city": "string",
"postcode": "string",
"state": "string",
"country": "string"
},
"bankName": "string",
"bankAccountName": "string",
"bankAccountNumber": "string",
"bankCountry": "string",
"bankCurrency": "AUD",
"bankRoutingNumber": "string",
"metadata": { }
}
}

Response samples

application/json

{"ServiceProviderMerchant": {"merchantId": "mcht_Zz_j6R6IwWmwGetC",
"marketplaceId": "mktp_Zz_j6R6IwWmwGetM",
"businessProfile": {"timeZone": "Australia/Sydney",
"businessName": "string",
"businessType": "company",
"companyType": "Private",
"website": "string",
"supportSite": "string",
"industry": "AcRefrigerationRepair",
"taxCountry": "AU",
"tradingCountry": "AU",
"taxId": "string",
"contactPerson": {"title": "string",
"givenName": "string",
"familyName": "string"
},
"contactEmailAddress": "lucy.diamond@star.com",
"supportEmailAddress": "lucy.diamond@star.com",
"phoneNumber": "+61401234567",
"address": {"unitNumber": "string",
"streetNumber": "string",
"streetName": "string",
"streetType": "string",
"suburb": "string",
"city": "string",
"state": "string",
"postalCode": 2000,
"country": "AU"
},
"brandName": "string",
"cardStatementName": "Kates Deli",
"smsSenderName": "KatesDeli",
"verificationDocs": {"companyFrontFileId": "lfile_Zz_j6h6IwWmwGetQ",
"companyBackFileId": "lfile_Zz_j6h6IwWmwGetQ",
"companyTaxIdFileId": "lfile_Zz_j6h6IwWmwGetQ",
"partnershipAgreementFileId": "lfile_Zz_j6h6IwWmwGetQ",
"trustDeedFileId": "lfile_Zz_j6h6IwWmwGetQ",
"trustDeedAmendmentFileIds": ["lfile_Zz_j6h6IwWmwGetQ"
]
}
},
"referenceMerchantId": "string",
"readableIdentifier": "string",
"status": "Pending",
"payoutDetails": {"payoutSettings": {"notificationEmails": ["lucy.diamond@star.com"
],
"notificationsEnabled": true
},
"payoutSchedule": "string",
"automatedPayoutsEnabled": true,
"payoutStatus": "Enabled"
},
"billingDetails": {"billingNotificationEmails": ["lucy.diamond@star.com"
],
"billingNotificationsEnabled": true,
"billingAddress": {"unitNumber": "string",
"streetNumber": "string",
"streetName": "string",
"streetType": "string",
"suburb": "string",
"city": "string",
"state": "string",
"postalCode": 2000,
"country": "AU"
},
"billingPaymentSourceId": "psrc_Zz_j6R6IwWmwGetI"
},
"bankAccounts": [{"accountId": "xacc_Zz_j6x6IwWmwGetX",
"accountName": "string",
"bankName": "string",
"identifier": {"AuBankAccountIdentifier": {"bsb": "string",
"accountNumber": "string"
}
},
"currency": "AUD",
"country": "string",
"isPrimaryForCurrency": true
}
],
"payPlanSettings": {"maxPayPlanAmount": 0,
"minPayPlanAmount": 0
},
"publicToken": "string",
"sourceRules": [{"criterion": { },
"action": [{ }
]
}
]
}
}

Create Merchant

header Parameters

Request Body schema: application/jsonrequired

Request Body schema: application/json
required