v0

Get Purchase Public View

Returns a Purchase entity given an ID. Marks the Purchase as beamed

get/purchases/{merchantId}/{purchaseId}

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/purchases/{merchantId}/{purchaseId}
  • Auth: HTTP basic

Path parameters

merchantIdstring required

merchantId

purchaseIdstring required

purchaseId

Response

success

createdstring
expirystring
genericPurchaseIdstring
isDisabledboolean
lastUpdatedstring
merchantIdstring
paymentIdstring
paymentLinkstring
purchaseIdstring
redirectUrlstring
requiredFieldsFormIdstring
state'initiated' | 'beamed' | 'paying' | 'complete' | 'failed'
timePaidstring

Example response

{
  "order": {
    "currencyCode": "THB",
    "description": "1 Cookies Box",
    "merchantReference": "cookies order 1",
    "merchantReferenceId": "merchantRef1",
    "netAmount": 900,
    "orderItems": [
      {
        "product": {
          "name": "Cookies",
          "price": 1000
        }
      }
    ],
    "totalAmount": 1000,
    "totalDiscount": 100
  }
}

Changes

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