v0

GetRefundsOption

Fetches the current Purchase's available refund option

get/refunds/{merchantId}/{purchaseId}/option

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/refunds/{merchantId}/{purchaseId}/option
  • Auth: HTTP basic

Path parameters

merchantIdstring required

merchantId

purchaseIdstring required

purchaseId

Response

success

maxRefundableAmountnumber

MaxRefundableAmount for the refund. RefundRequest will be rejected if amount exceeds this value. if amount is -1, then RefundRequest.Amount field is not required as it will default to the full txn amount.

option'void' | 'refund' | 'none'

Option available for specifying refund type

Changes

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