v0

Refund Purchase

Submit a request to refund a given Purchase.

post/refunds/{merchantId}/{purchaseId}

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

Path parameters

merchantIdstring required

merchantId

purchaseIdstring required

purchaseId

Request body

amountnumber

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

option'void' | 'refund' required

Option of the refund

reasonstring

Reason of the refund

Response

success

codeinteger

Code is the http status code

messagestring

Message is the message to return in response body

Changes

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