Refund a payment

Returns money from a successful payment to the customer's card, through Pay.on. You can refund all of it or part of it.

  • Applies to: a successful db (debit) or cp (capture). On a pre-authorised order, refund the cp, not the pa. A pa whose hold wasn't captured has nothing to refund: reverse it instead.
  • Partial refunds: send amount. You can refund again until nothing is left. refundable_amount on the payment shows how much remains.
  • Afterwards: the refund is a new rf payment with its own id. Its original_reference_id is the refunded payment's original_id. Once refunds add up to the full amount, the original payment's refunded is true.
  • The currency is always the payment's. You can't change it.

A refund can't be undone.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
≥ 1

Your merchant profile ID. Required in every request.

Find it in the BillPro dashboard address, after /profiles/. For example, in /profiles/1234/orders the profile ID is 1234.

string
required

ID of the payment.

Body Params
number | null

Optional. How much to refund. Leave it out, or send null, to refund everything that's left: the payment's amount minus earlier refunds. More than that returns 422.

Responses

Language
Credentials
Bearer
API token
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json