atlas

List payment links with search filters

List payment links with search filters

get/atlas/v1/payment-links

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/v1/payment-links
  • Auth: OAuth 2 (implicit, authorization URL "")

Query parameters

merchantIdstring

filters on payment links whose merchantId is equal to this value

linkType_instring[]

filters on payment links whose linkType matches one of these values

querystring

filters on payment links whose paymentLinkId or referenceId contains with this value (case sensitive)

status_instring[]

filters on payment links whose status matches one of these values

createdAt_gtestring

filters on payment links whose createdAt is greater than or equal to this time

createdAt_ltestring

filters on payment links whose createdAt is less than or equal to this time

offsetinteger

offset

limitinteger

limit

Response

success

totalCountinteger

Changes

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