api-transactions

Get Transaction by ID

This could be a completed Charge or a Refund object using the same ID i.e. prefixed with ch_ or re_

get/api/v1/transactions/{transactionId}

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/api/v1/transactions/{transactionId}
  • Auth: HTTP basic

Path parameters

transactionIdstring required

chargeId

Response

success

chargeSource'PAYMENT_LINK' | 'STORE_LINK' | 'QR_PROMPT_PAY_LINK' | 'API' | 'BOLT'

Is the source of where the Charge was created from. For Charges created via the CreateCharge endpoint, the source is ChargeSourceAPI.

createdAtstring

CreatedAt is the time when the transaction object was created.

currency'THB'
feeAmountinteger

FeeAmount is the total service fee for Beam in the smallest unit of the currency. For example, for THB, this would be in satang (1 THB = 100 satang).

feeStrategy'RATE' | 'MINIMUM_AMOUNT'
grossAmountinteger

GrossAmount is the gross amount of the transaction (the amount paid before deducted by fees) in the smallest unit of the currency. For example, for THB, this would be in satang (1 THB = 100 satang).

merchantIdstring

MerchantID is the unique identifier for the merchant.

netAmountinteger

NetAmount is the total net amount in the smallest unit of the currency. Calculated as GrossAmount - FeeAmount - VATAmount = NetAmount. For example, for THB, this would be in satang (1 THB = 100 satang).

referenceIdstring

ReferenceID is the reference ID as provided by the merchant when creating charge or charge source.

sourceIdstring

SourceID is the unique identifier for the source of the transaction. Has no value for QR_PROMPT_PAY_LINK or API source. Is equal to merchantId for STORE_LINK source Is equal to the ID of the payment link for PAYMENT_LINK source. Is equal to the ID of the Bolt intent for BOLT source.

transactionIdstring

TransactionID is the unique identifier for the transaction. For Payment transactions, this is the ID of the Charge associated. For Refund or Void transactions, this is the ID of the Refund associated.

transactionTimestring

TransactionTime is the time when the payment or refund is successfully processed.

transactionType'PAYMENT' | 'VOID' | 'REFUND' | 'CHARGEBACK'

The type of transaction. Classified as PAYMENT,VOID,REFUND and CHARGEBACK.

vatAmountinteger

VATAmount is the total 7% VAT amount in the smallest unit of the currency. For example, for THB, this would be in satang (1 THB = 100 satang).

Changes

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