Create a Refund Request

This endpoint is used to create a Refund Request.

Refunds can only be created for successful payments made via a Pay Request. If a Pay Request has not yet been captured, then void the Pay Request instead.

Refunds can be made for the total or partial amount of the Pay Request. Multiple refunds can be created for the same Pay Request as long as the total refunds amount does not exceed the original Pay Request total.

Refunds can only be sent back to the original payment method used.

Request

Security:

JWT

header Parameters

Authorization required	string Default: Bearer {$$.env.access_token}
Content-Type required	string Value: "application/json"

Request Body schema: application/json

payRequestId required	string The id of the Pay Request to be refunded
	object The total amount to be refunded (in smallest currency unit). Defaults to the total of the Pay Request.

Responses

201

Created

400

When the provided payload is not valid.

403

When you don't have the right permissions to create a Refund Request.

post/pay/refunds

Request samples

Payload
curl
C#
Node.js

application/json

{"payRequestId": "0f448ac1-862a-4c7b-bdb4-a3b7cdbf6149",
"total": {"amount": 10000,
"currency": "AUD"
}
}

Response samples

application/json

{"id": "2d448ac1-862a-4c7b-bdb4-a3b7cdbf6148",
"payRequestId": "0f448ac1-862a-4c7b-bdb4-a3b7cdbf6149",
"status": "PROCESSING",
"total": {"amount": 10000,
"currency": "AUD"
},
"createdAt": "2022-11-23T22:39:54.765Z",
"updatedAt": "2022-11-23T22:39:55.045Z"
}