/Orders/NPB/{orderID} POST

Allows you to send a payment reminder to a non-paying bidder

URL
/Orders/NPB/{orderID}
Verb
Post

Headers

Header Data Type Valid Values Required Description
Content-Type string application/json YES The format your data will be sent to our site.
X-DevKey string string YES The devkey assigned to the developer.
X-AccessToken string string YES The token acquired from a POST to Users/AccessToken.

Input

NOTE: Variables to place in the URI of the request.

Parameter Data Type Valid Values Description
OrderID integer positive # The OrderID for the order tied to the credit request

NOTE: Variables to place in the body of the request.

Parameter Data Type Valid Values Description
BccToMyself boolean true/false Specifies whether or not to send a blind carbon copy of the reminder to myself
Message string valid string Message to the user to include in the payment reminder

Output

If there are no errors with the input parameters, this call will respond with a 200 OK and a Message Response indicating the payment reminder was sent.

If the order ID is invalid or does not belong to the user, this call will respond with a 400 Bad Request and a Message Response indicating the error.

If the order is in an invalid state, this call will respond with a 403 Forbidden and a Message Response indicating the error.