API Reference

Refund a Payment Request

post
https://api.clik2pay.com/open/v1/payment-requests//refunds

Refund a payment request in PAID or SETTLED status.

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

The identifier of the payment request.

Body Params

Represents refunds for payment requests

double
required
≥ 0.01

The amount in Canadian dollars.

recipient
object
required

The email and mobile number of the person or organization receiving the refund. Both values are required.

string
length between 3 and 250

The message presented to the recipient on Interac's Gateway page. If not set, a default message in the format agreed upon with the merchant will be displayed.

Responses

401

Unauthorized

Updated 19 days ago

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

Updated 19 days ago