Transactions API

The Transactions API is read-only. Transactions are created by Beam when a charge or a refund succeeds, so there is nothing to create or update here. The following operations are available:

Get Transaction by ID (GET /api/v1/transactions/{transactionId}): read one transaction.
List Transactions (GET /api/v1/transactions): list transactions, with filters.

For request and response shapes, see the Transactions API Specification. For what a transaction is, the types, and how each one comes to exist, see Transactions.

Get a transaction

The transactionId is the id of the object the transaction was created from: the chargeId for a PAYMENT transaction, or the refundId for a REFUND or VOID transaction. Ids are prefixed, so ch_ is a charge and re_ is a refund.


GET https://api.beamcheckout.com/api/v1/transactions/{transactionId}
Authorization: Basic <base64(merchantId:apiKey)>

The response holds the transactionType, the amounts, and the source of the original payment. See Amounts on a transaction.

List transactions

GET /api/v1/transactions lists the transactions on your merchant account. Query parameters filter and page the results:

Parameter	Notes
`referenceId`	Your own order reference, as sent when the payment was created.
`offset`	How many results to skip. Starts at 0.
`limit`	How many results to return, from 1 to 100.


GET https://api.beamcheckout.com/api/v1/transactions?referenceId=order_190821&limit=100
Authorization: Basic <base64(merchantId:apiKey)>

The response has a data array of transactions and a totalCount of everything that matches the filter, so you can page through with offset and limit.

Tip

For daily reconciliation, listen for transaction.created instead of listing transactions on a schedule. The webhook carries the same object and reaches you as soon as the transaction exists. See Transactions webhook events.

Errors

See Error Handling. A 404 with NOT_FOUND_ERROR means there is no transaction for that id yet, which is what you get when the charge or refund has not succeeded.