api-refunds

Create Refund

Create 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, QR_PROMPT_PAY, ALIPAY and WECHAT_PAY payment method types support refunds.

post/api/v1/refunds

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/refunds
  • Auth: HTTP basic

Request body

amountinteger

Amount to be refunded in the smallest units of the charged currency: 1 == 1 Satang == 0.01 THB. 2125 == 2125 Satang == 21.25 THB. If 0 or omitted, the system defaults to the max refundable amount. Partial refund is only supported for the CARD payment method.

chargeIdstring required

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

reasonstring

Reason of the refund. Optional.

Response

success

refundIdstring

Changes

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