Send payment instructions email

Sends payment instructions to the winner of an auction. This will send an email to the buyer and will make the payment instructions available on the Trade Me website, mobile apps and third-party tools. Payment instructions can only be sent once, and cannot be sent at all if the buyer has already paid via Pay Now. You can check if payment instructions have been sent using the InvoiceId field (in the sold items API) or the PaymentInstructions field (in the listing details API). You can check if the buyer has paid using Pay Now using the IsPayNowPurchase field (in the sold items API) or the HasPaidByCreditCard field (in the listing details API).

URL:	https://api.trademe.co.nz/v1/MyTradeMe/SendPaymentInstructions/{purchaseId}.{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

purchaseId

Integer (required)

The purchase ID that identifies the buyer and the auction that was purchased.

file_format

Enumeration (required)

The format of the response.

xml	Serialize responses into XML.
json	Serialize responses into JSON.

POST Data

Subject	String (required)	The subject line to use when sending the email. For example "Payment instructions (P12345678) - Bipedal droid".
Body	String (required)	The customizable part of the email. It is intended that this be sourced from the member's payment instructions template, but it can be completely different.
CopySeller	Boolean (optional)	If true, sends you a copy of the email. Defaults to false.

Returns

A PaymentInstructionsResponse containing details on whether the operation was successful.

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)

<SendPaymentInstructionsRequest xmlns="http://api.trademe.co.nz/v1">
  <Subject>ABC</Subject>
  <Body>ABC</Body>
  <CopySeller>false</CopySeller>
</SendPaymentInstructionsRequest>

Example JSON Request (switch to XML)

{
  "Subject": "ABC",
  "Body": "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"
}