API Reference

Make Payment

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

Make payments using an existing agreement.

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 PayTo instrument under which this payment will be initiated.
Note: this value is retrieved from the Get Buyer Wallet API.

Body Params
string
required
length ≥ 1

Merchant's unique payment identifier.

int32
required
1 to 100000000

Payment amount in cents. Value must be greater than zero.

string | null

The order or purchase or reference number that is provided to consumer during checkout.
Note: this value will be visible to consumers in their banking statements.

string | null

Additional free form payment description that can be included for the consumer in the payment.
Note: this value will be visible to consumers in their banking statements.

string | null

A backoffice only reference that can be used to aid in creditor's reconciliation activities.
Note: this value will only be visible in creditor's corporate banking statement.

string | null

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

simulation
object

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

merchantDefinedData
object | null

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

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