atlas-verifast

Lists UI representation of MerchantV2 joined with VeriFast and KYM for atlas merchant list

Lists UI representation of MerchantV2 joined with VeriFast and KYM for atlas merchant list

get/atlas/v2/ui/merchants

Request

  • Base URL: https://api.beamcheckout.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.beamcheckout.com/atlas/v2/ui/merchants
  • Auth: OAuth 2 (implicit, authorization URL "")

Query parameters

querystring

filters on merchants whose merchantId, businessName or statementDescriptor starts with the query (case insensitive)

merchantStatus_instring[]

filters on merchants whose merchant status matches one of the provided values

veriFastStatus_instring[]

filters on merchants whose VeriFast status matches one of the provided values

kymStatus_instring[]

filters on merchants whose KYM status matches one of the provided values

veriFastDecisionMethod_instring[]

filters on merchants whose VeriFast decision method matches one of the provided values

partnerId_instring[]

filters on merchants whose partner id matches one of the provided values

allowPayoutboolean

filters on merchants whose allowPayout matches this value

isInWatchlistboolean

filters on merchants whose isInWatchlist matches this value

createdAt_gtestring

filters on merchants whose createdAt is greater than or equal to this value

createdAt_ltestring

filters on merchants whose createdAt is less than or equal to this value

offsetinteger

offset

limitinteger

limit

Response

MerchantList

totalCountinteger

Changes

No recorded changes to this operation across all 1 revision of this API.