Query Merchants

Return a paginated list of matching merchants.

SecurityMarketplace Api Key | Admin JWT | Merchant JWT | Marketplace JWT

Request

query Parameters

limit	integer <int32> Maximum results per page. Default to 20, must be between 1 and 500.
page	integer <int32> Page number of results to show (starting at page 1).
sort	string Comma-delimited list of fields to sort by with sort priority from first to last. Fields are sorted by their natural ordering unless prefixed with a `-` character.
businessName	string Filter by business name
isActivated	boolean Filter by whether the business is activated
marketplaceId	string Filter by marketplace

Responses

200

Matching items sorted as specified

400

401

403

404

405

406

409

422

429

500

503

get/merchants

Request samples

Curl
JavaScript

Response samples

application/json

[{"ServiceProviderMerchant": {"merchantId": "mcht_ZtqZhJAAVEu0G0pf",
"marketplaceId": "mktp_ZtqZhJAAVEu0G0po",
"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_ZtqZhJAAVEu0G0pr",
"companyBackFileId": "lfile_ZtqZhJAAVEu0G0pr",
"companyTaxIdFileId": "lfile_ZtqZhJAAVEu0G0pr",
"partnershipAgreementFileId": "lfile_ZtqZhJAAVEu0G0pr",
"trustDeedFileId": "lfile_ZtqZhJAAVEu0G0pr",
"trustDeedAmendmentFileIds": ["lfile_ZtqZhJAAVEu0G0pr"
]
}
},
"referenceMerchantId": "string",
"readableIdentifier": "string",
"status": "Pending",
"payoutDetails": {"payoutSettings": {"notificationEmails": ["lucy.diamond@star.com"
],
"notificationsEnabled": true
},
"payoutSchedule": "string"
},
"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_ZtqZhJAAVEu0G0pl"
},
"bankAccounts": [{"accountId": "xacc_ZtqZhZAAVEu0G0py",
"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": [{ }
]
}
]
}
}
]