api-refunds

Get Refund by ID

Get Refund by ID by refundId

get/api/v1/refunds/{refundId}

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

Path parameters

refundIdstring required

refundId

Response

success

amountinteger
chargeIdstring
createdAtstring
currency'THB'
failureCode'RE_PROCESSING_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.

merchantIdstring
referenceIdstring
refundIdstring
refundReasonstring
status'PENDING' | 'SUCCEEDED' | 'FAILED'
transactionTimestring

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

updatedAtstring

Changes

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