atlas

List Charges with filters and pagination

List Charges with filters and cursor-based pagination. Use afterCursor (from the previous page's endCursor) for forward pagination and beforeCursor (from the next page's startCursor) for backward pagination.

get/atlas/v1/ui/charges

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

Query parameters

merchantIdstring

filter on charges whose merchantId expected equal to this value

merchantId_likestring

Deprecated: will be removed. Treated as an exact match on merchantId (falls back only when merchantId is absent).

chargeIdstring

filter on charges whose chargeId exactly matches this value; returns at most one charge and takes precedence over other filters

chargeId_likestring

Deprecated alias of chargeId (exact match); falls back only when chargeId is absent.

sourceIdstring

filter on charges whose sourceId expected equal to this value

sourceId_likestring

Deprecated: will be removed. Treated as an exact match on sourceId (falls back only when sourceId is absent).

chargeCreatedAt_ltestring

filter on charges whose createdAt is less than or equal to this value

chargeCreatedAt_gtestring

filter on charges whose createdAt is greater than or equal to this value

chargeTransactionTime_ltestring

filter on charges whose transactionTime is less than or equal to this value

chargeTransactionTime_gtestring

filter on charges whose transactionTime is greater than or equal to this value

limitinteger

limit

afterCursorstring

cursor from endCursor of the previous page (forward pagination)

beforeCursorstring

cursor from startCursor of the next page (backward pagination)

displayStatus_instring[]

displayStatus_in as comma separated values (e.g. 'FAILED,PENDING')

paymentMethodType_instring[]

paymentMethodType_in as comma separated values (e.g. 'CREDIT_CARD,E_WALLET')

source_instring[]

source_in as comma separated values (e.g. 'API,PAYMENT_LINK')

gatewayName_instring[]

filter on transactions whose gatewayName is in one of the provided values

Response

success

endCursorstring
hasNextPageboolean
hasPrevPageboolean
startCursorstring

Changes

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