Merchants API
Merchants API
Authentication
- HTTP: Bearer Auth
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | JWT |
Search merchants
Search and return a paginated list of merchants
Create merchant
Create a merchant object in the storage and return the id of the created object. If the configuration is enabled for KYC a KYC process will be started.
Get merchant by id
Get a merchant from the storage and return the object.
Update merchant
Update a merchant object in the storage. If the configuration is enabled and a KYB process is needed then it will be started.
Delete merchant
Remove a merchant object in the storage.
Get merchant stores
Get all the stores of a merchant
Create merchant store
Add a store for a merchant
Get merchant store
Get a specific store of a merchant
Update merchant store
Update a store for a merchant
Delete merchant store
Remove a merchant store from the storage
Update merchant store cover image
Update a cover image for a store
Update merchant store logo image
Update a logo image for a store
Get merchant documents
Get all the documents of a merchant
Create merchant document
Add a document for a merchant
Get merchant document
Get a specific document of a merchant
Update merchant document
Update a document for a merchant
Delete merchant document
Remove a merchant document from the storage
Get merchant metadatas
Get all the metadata of a merchant
Create Merchant metadata
Add a metadata for a Merchant
Get merchant metadata
Get a specific metadata of a merchant
Update Merchant metadata
Update a metadata for a Merchant
Delete Merchant metadata
Remove a Merchant metadata from the storage
Search Merchant beneficial owners
Search and return a paginated list of beneficial owners of a Merchant
Create Merchant beneficial owner
Add a beneficial owner for a Merchant
Get Merchant beneficial owner
Get a specific beneficial owner of a Merchant
Update Merchant beneficial owner
Update a beneficial owner for a Merchant
Delete Merchant beneficial owner
Remove a beneficial owner from a Merchant