Payment Methods Create API

Route

POST

Purpose

Create/POST new payment method.

Parameters sensitive params

view string 2

View of object your would like to be returned.

payment_method parent 3 required

View of object your would like to be returned.

Show child params

payment_method.name_on_card string
Name of owner as it appears on the payment method.
payment_method.card_number string
Card number of payment method.
payment_method.cvc string
Cvc of payment method.
payment_method.exp_month integer
Expiration month of payment method in numerical form with no leading 0s, e.g., 11, 5, 12.
payment_method.exp_year integer
Expiration year of payment method in four digits, e.g., 2022, 2030.
payment_method.name string
Optional custom nickname of payment method.
payment_method.active boolean
You can choose make the card active or not.
payment_method.default boolean
Make new payment method your default payment method.
payment_method.street string
Street of billing address.
payment_method.street2 string
Option second line of street of billing address.
payment_method.city string
City of billing address.
payment_method.province_iso string
ISO code for the province of the billing address in snake_case, e.g., us_co, us_ca, us_fl. For a full list of US province codes, please checkout this <a href='https://en.wikipedia.org/wiki/ISO_3166-2:US'>List of province ISO code</a>.
payment_method.postal_code string
Postal code of billing address.

token string 100 required

Authentication token for either an application or session.

application_view string 110

View of application object you would like returned.

application string 200

Slug of application being requested. This is used to determine the role being used to make the request and therefore evaluate if the requester has the correct permissions.

Possible values

planoauth
planoorder
planox2

session_view string 300

View of session object you would like returned.

Request Body Example: text/plain

          {"view": null, "payment_method": {"name_on_card": "Francisco Ziemann", "card_number": "4242424242424242", "cvc": "123", "exp_month": 2, "exp_year": 2029, "name": "Rich's Amex", "active": true, "default": true, "street": "27989 Roberts Wells", "street2": "Suite 161", "city": "Hermistonport", "province_iso": "us_il", "postal_code": "30996"}, "token": "Sw543vdfgswWg98", "application_view": null, "application": "planoauth", "session_view": null}

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.

  {"code": 200, "data": {}, "status": "action-successful", "message": "..."}

invalid-token 401

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

  {"code": 401, "status": "invalid-token", "message": "..."}

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.

  {"code": 401, "status": "session-expired", "message": "..."}

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.

  {"code": 401, "status": "client-required", "message": "...", "session": {}}

missing-param 400

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

  {"code": 400, "status": "missing-param", "message": "...", "missing_param": "email"}

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.

  {"code": 400, "status": "invalid-param", "message": "...", "invalid_param": "email"}

application-crash 500

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

  {"code": 500, "errors": "...", "status": "application-crash", "message": "..."}

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.

  {"code": 500, "errors": "...", "status": "mandrill-email-failed", "message": "..."}

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.

  {"code": 400, "status": "invalid-content-type", "message": "...", "content_type_passed": "application/json", "content_type_required": "text/plain"}

route-non-existent 500

Response returned when HTTP route does not exist.

  {"code": 500, "status": "route-non-existent", "message": "..."}

Uncommon Responses

The responses below are not very common.

no-params-decoded Uncommon

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

  {"code": 400, "status": "no-params-decoded", "message": "..."}

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.

  {"code": 400, "errors": "...", "status": "invalid-encoded-params"}

route-not-found Uncommon

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

  {"code": 404, "path": "...", "status": "route-not-found", "message": "...", "http_method": "..."}

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.

  {"code": 500, "errors": "...", "status": "identify-request-error", "message": "..."}

service-not-found Uncommon

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

  {"code": 404, "status": "service-not-found", "message": "...", "route_id": "...", "api_service_key": "..."}