API Reference

Make Refund

post
https://uat-api.wpay.com.au/wpay-npp-payto/merchant-gateway/merchants//payments//refund

Used to make full or partial refunds.

Path Params
string
required

ID of the merchant. This unique value will be provided by Wpay as part of on-boarding.
Note: Wpay uses the UUID v4 format for all the unique IDs we provide.

string
required

ID of the original payment for which this refund is being initiated.

Body Params
string
required
length ≥ 1

Merchant's unique refund transaction identifier.

int32 | null

Refund amount in cents. Omit value when performing a full payment refund, and provide a value when performing a partial refund.

string | null

A refund reference can be provided to the buyer.
Note: this value is visible to buyers in their banking statements.

string | null

An additional free form refund description can also be provided to the buyer.
Note: this value is visible to buyers in their banking statements.

string | null

The Merchant's supplied URL that should receive webhooks for this refund.

merchantDefinedData
object | null

An optional object for passing any additional key-value pairs that might be useful to the merchant.

simulation
object

A sandbox only parameter than allows you to simulate the outcome of this refund. Please refer to the developer guide for more info.

Headers
string
required

Unique identifier for the request (GUID).
This id will be used for tracking and troubleshooting problems associated with the request.

Responses

401

Unauthorized

403

Forbidden

500

Internal Server Error

Callbacks

Updated over 1 year ago

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

Updated over 1 year ago