Update your payment instructions template

Updates your payment instructions template. If you don't have a payment instructions template, it will be created. 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. Note that buyers see the payment instructions as they were at the time of the sale; if you update the template it will only affect new sales.

URL:	https://api.trademe.co.nz/v1/mytrademe/PaymentInstructions.{file_format}
HTTP Method:	POST
Requires Authentication?	Yes
Permission Required:	MyTradeMeWrite: Maintain your watchlist, answer questions and post comments.
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.

POST Data

Template	String (required)	The payment instructions template. This should not include a salutation ("Hi John"). If payment instructions haven't been set up then this will be null.
CopySeller	Boolean (optional)	Indicates whether the seller's preference is to CC payment instructions emails. The default is false.

Returns

Details on whether the payment instructions template was successfully updated.

Success	Boolean	Indicates whether the operation was successful.
Description	String or null	The description of the error, if the operation failed.

Example XML Request (switch to JSON)

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

Example JSON Request (switch to XML)

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

Example XML Response (switch to JSON)

<PaymentInstructionsResponse xmlns="http://api.trademe.co.nz/v1">
  <Success>false</Success>
  <Description>ABC</Description>
</PaymentInstructionsResponse>

Example JSON Response (switch to XML)

{
  "Success": false,
  "Description": "ABC"
}