API Reference

Instrument Session

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

Used to create a new PayTo Instrument session and redirect the buyer to the Wpay PayTo experience.

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.

Body Params
string
required
length ≥ 1

The Merchant's supplied return URL where Wpay will re-direct the consumer once they are done.

buyer
object
required

This object contains the buyer details.

instrument
object
required

This object contains the PayTo instrument details.

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