Orders Pay and submit API

Route

POST

Purpose

Pay for and complete an order request.


Parameters


token string 1 required
Authentication token for either an application or session.
view string 2
View of object your would like to be returned.
payment_method_id integer 3
Id of payment_method used for payment.
promotion_code string 4
Promotional Code that can be used for a discount.
order parent 5 required
View of object your would like to be returned.
  • order.client parent
    View of object your would like to be returned.
  • order.primary_service parent
    View of object your would like to be returned.
  • order.add_on_services array
    View of object your would like to be returned.
  • order.property_info json
    View of object your would like to be returned.
  • order.property_access json
    View of object your would like to be returned.
  • order.appointments json
    View of object your would like to be returned.

session_view string 100
View of session object you would like returned.
application_view string 110
View of application object you would like returned.

Request Body Example: application/json

Responses

action-successful 200

This status indicates that the request was successful. If the request returns data, it can be found in the data key.

invalid-promotion 400

This status is returned when the promotional code passed was not recognized as a valid promotion code. This could mean the promotional code is inactive or belongs to a user of a different designation.

promotion-expended 400

This status is returned if the user making the request has already used the promotion code that is being validated.

declined-payment 400

This status is returned when the payment method identified by the payment_method_id was declined.

card-number-invalid 400

This status is returned when the payment method identified by the payment_method_id is an invalid card number.

failed-payment 400

This status is returned when the payment method identified by the payment_method_id failes.

invalid-token 401

This status is returned when the authentication token passed is invalid.

session-expired 401

This status is returned a session is older than seven days or hasn't been used in 72 hours. The user will need to reauthenticate. We allow our users to save a remember_me preference which will make there sessions last indefinitely.

client-required 401

This status is returned when the user makeing the request doesn't have a client, employee or liaison record. This means that they don't have any roles or permissions. Because we only allow our clients to register as a client, the user should be redirected to the PlanoAuth clients registration page where they can use the `/api/v1/users/client_register` API to register as a client. Eventhough the request will not be successful, this status will still return a `session` object because a session token is needed to register as a user.

missing-param 400

This status is returned when a required param was not passed with the request.

invalid-param 400

This status is returned when a param was invalid when passed. For example, passing an id that doesn't exist or passing an invalid email address.

application-crash 500

This status is returned when there is an internal server error. Please try again later.

mandrill-email-failed 500

This status is returned when there was an issue using Mandrill to send an email. Any time this response is returned, there will be a notification in the production notifications tab so the dev team will be away of the failure. These errors will most likely correlate with a data issue and will need to be invesigated.

invalid-content-type 400

This status is returned if the request was made with the incorrect content-type so the request params could not be read. For more infromation on content-type, please refer to https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type.

route-non-existent 500

Response returned when HTTP route does not exist.

Uncommon Responses

The responses below are not very common.

duplicate-payment Uncommon

This status is returned when the payment method identified by the payment_method_id is flagged as a duplicate payment. If you wait two minutes the API should work again.

no-params-decoded Uncommon

This status is returned the request body was decoded, but no params where found.

invalid-encoded-params Uncommon

This status is returned when the request body could not be decoded properly. This generally means that you are requesting a sensative_params API and your request body was not base64 encoded.

route-not-found Uncommon

This status is returned when the route record being requested hasn't been deployed yet.

identify-request-error Uncommon

This status is returned when there is an internal server error before the route could be identified. Please try again later.

service-not-found Uncommon

This status is returned when the route's API service record being requested hasn't been deployed yet.