Website logo

Retrieve your payment instructions template

Retrieves your payment instructions template. The payment instructions template affects the behaviour of listings with the SendPaymentInstructions flag set. Specifically if a listing with that flag sells, the buyer will be sent a payment instructions email that contains the text of your payment instructions template and the buyer can view the payment instructions from the Trade Me website, mobile apps or third-party tools.

URL: https://api.trademe.co.nz/v1/mytrademe/PaymentInstructions.{file_format}
HTTP Method: GET
Requires Authentication? Yes
Permission Required: MyTradeMeRead: Read your membership & listing data.
Supported Formats: XML, JSON
Rate Limited? Yes

URL parameters

file_format Enumeration (required) The format of the response.
xml Serialize responses into XML.
json Serialize responses into JSON.

Returns

<PaymentInstructionsTemplate>

The payment instructions template.

Template String or null Template
CopySeller Boolean CopySeller

Example XML Response (switch to JSON) 

<PaymentInstructionsTemplate xmlns="http://api.trademe.co.nz/v1">
  <Template>ABC</Template>
  <CopySeller>false</CopySeller>
</PaymentInstructionsTemplate>

Example JSON Response (switch to XML) 

{
  "Template": "ABC",
  "CopySeller": false
}