Error is the object containing the details of the error, if any has occurred.
This object is expected if the Code is 4xx or 5xx.

Message is the message to return in response body

the request for ALIPAY payment method type. currently, no child attributes are required.

the request for CARD_INSTALLMENTS payment method type. installmentPeriod is the number of installments in months and is a required field

CardHolderName is the name shown on the card

Last4 is the last four digits of the provided PAN

the request for CARD payment method type.

This object represents a single attempt to pay into your Beam account.

TransactionTime is the time when the Charge is recorded as SUCCEEDED or FAILED.

the action required to complete the payment process. For ChargeActionNone, no further action is required. For ChargeActionRedirect, redirect the paying customer to the given URL to complete the process. For ChargeActionEncodedImage, decode the encoded image and present it to the paying customer to complete the process.

the response for ChargeActionRedirect. Redirect your customers to the provided RedirectURL to complete the payment process.

the response for ChargeActionEncodedImage. this contains the base64 encoded image that must be decoded and displayed to the user.

Expiry is the time when the content in this image expires

ImageBase64Encoded represents the image that is base64 encoded. Decode this image and display it to the user.

In the event that the ChargeStatus is ChargeStatusFailed, one of the following failure codes would be present. ChargeFailureCodeFailed denotes generic failure due to processing, please retry with a new Charge. ChargeFailureCodeInsufficientFunds denotes a failure due to insufficient funds from the customer's payment method. ChargeFailureCodeAuthenticationFailed denotes a failure due to the customer authentication.

TotalCount that matches the filter criteria

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

the request schema to create a new Charge.

Amount in the smallest units of that currency: 1 == 1 Satang == 0.01 THB. 2125 == 2125 Satang == 21.25 THB.

Currency to accept payments in.
Currently only `THB` is supported.

PaymentMethod contains the details of how the merchant wishes to deduct their customers' funds.

ReferenceID is a free text field for merchants to optionally provide for reconciliation purposes.
Beam does not provide any unique constraints for this field.
Maximum 100 characters.

ReturnURL is the URL to redirect customers back to after they authenticate or cancel their payment on the
payment method’s app or site.
If you’d prefer to redirect to a mobile app, you can supply an application URI scheme.
Required for charges that redirect out of Beam, such as `CARD` and `CARD_INSTALLMENT` payments.

the response for CreateCharge API. Use the returned chargeId to query for its status and follow the actionRequired steps.

ActionRequired determines the next steps required to complete the payment process.

the request schema to create a new Refund.

ChargeID the ID of the charge the refund is to be associated with. The charge must be paid.

the request for LINE_PAY payment method type. currently, no child attributes are required.

the request for QR_PROMPT_PAY payment method type.

ExpiresAt is the timestamp that the QR returned should expire by. Default is 30 minutes from creation time.

This object represents a single attempt to refund from your Beam account.

TransactionTime is the time when the Refund is recorded as SUCCEEDED or FAILED.

In the event that the RefundStatus is RefundStatusFailed, one of the following failure codes would be present. RefundFailureCodeFailed denotes generic failure due to processing, please retry with a new Refund.

the request for SHOPEE_PAY payment method type. currently, no child attributes are required.

the request for TRUE_MONEY payment method type. currently, no child attributes are required.

the request for WECHAT_PAY payment method type. currently, no child attributes are required.

Beam Payments API

Returns a list of Charges you previously created.
The charges are returned in sorted order, with the most recent charges appearing first.

referenceId

offset

limit

Create a Charge to attempt to pay into your Beam account by providing a valid PaymentMethod.

request

chargeId

Creates a Refund for a given paid Charge to attempt to reverse the payment made.
Refunds use your available balance, if you have insufficient balance, your request may be rejected.
Currently, CARD, CARD_INSTALLMENTS, ALIPAY and WECHAT_PAY payment method types support refunds.