atlas

List Transactions

List Transactions

get/atlas/v1/transactions

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

Query parameters

merchantIdstring

filter on transactions whose merchantId expected equal to this value

txnTime_gtestring

filter on transactions whose txnTime is greater than or equal to this value

txnTime_ltestring

filter on transactions whose txnTime is less than or equal to this value

targetSettlementDate_gtestring

filter on transactions whose targetSettlementDate is greater than or equal to this value

targetSettlementDate_ltestring

filter on transactions whose targetSettlementDate is less than or equal to this value

offsetinteger

offset

limitinteger

limit

invoiceIdstring

filter on transactions whose invoiceId expected equal to this value

balanceIdstring

filter on transactions whose balanceId expected equal to this value

querystring

filter on transactions whose id,charge sourceId or charge referenceId contains this value (case sensitive)

paymentMethodType_instring[]

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

transactionType_instring[]

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

gatewayName_instring[]

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

chargeSource_instring[]

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

Response

success

totalCountinteger

Changes

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