Query Platform Merchants

Query merchants of a platform

SecurityLimepay-Token

Request

query Parameters

from	string <date-time> Merchant state updated from timestamp
to	string <date-time> Merchant state updated to timestamp
businessType	string (BusinessType) Business type of the merchant Enum: "company" "individual" "soletrader" "partnership" "trust"
businessName	string Business Name of the merchant
status	string (MerchantDashboardStatus) Current status of the merchant Enum: "Pending" "Active" "Suspended"
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.

Responses

200

Matching items sorted as specified

400

401

403

404

405

406

409

422

429

500

503

get/marketplaces/merchants

Request samples

Curl
JavaScript

Response samples

application/json

[{"marketplaceId": "mktp_Z0brNquEXQJwUSoo",
"merchantId": "mcht_Z0brNquEXQJwUSoe",
"payoutSchedule": "daily",
"state": "Unknown",
"status": "Pending",
"stateUpdatedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"businessProfile": {"timeZone": "Australia/Sydney",
"businessName": "string",
"businessType": "company",
"companyType": "Private",
"website": "string",
"supportSite": "string",
"industry": "AcRefrigerationRepair",
"taxCountry": "AU",
"tradingCountry": "AU",
"taxId": "string",
"contactPerson": {"firstName": "string",
"lastName": "string",
"title": "string"
},
"contactEmail": "lucy.diamond@star.com",
"supportEmail": "lucy.diamond@star.com",
"phoneNo": "+61401234567",
"address": {"unitNumber": "string",
"streetNumber": "string",
"streetName": "string",
"streetType": "string",
"suburb": "string",
"city": "string",
"state": "string",
"postalCode": 2000,
"country": "AU"
},
"brandName": "string",
"cardStatementName": "string",
"smsSenderName": "string",
"verificationDocs": {"companyBackFileId": "lfile_Z0brN6uEXQJwUSos",
"companyFrontFileId": "lfile_Z0brN6uEXQJwUSos",
"companyTaxIdFileId": "lfile_Z0brN6uEXQJwUSos",
"partnershipAgreementFileId": "lfile_Z0brN6uEXQJwUSos",
"trustDeedFileId": "lfile_Z0brN6uEXQJwUSos",
"trustDeedAmendmentFileIds": ["lfile_Z0brN6uEXQJwUSos"
]
}
},
"verificationResult": {"status": "Pending",
"errorCodes": ["InvalidAddress"
],
"details": ["string"
]
}
}
]