bolt

Create Refund

Create Refund

post/bolt/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/bolt/v1/refunds
  • Auth: OAuth 2 (implicit, authorization URL "")

Headers

x-beam-merchant-idstring required

x-beam-merchant-id

Request body

amountinteger required

Amount intended to refund or void. Required if type provided is refund, enter charge amount if void.

chargeIdstring required

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

currency'THB' required
reasonstring

Reason of the refund

refundOption'NONE' | 'VOID' | 'REFUND' required

Example request

{
  "amount": 10000
}

Response

success

refundIdstring

Changes

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