Apply Payment Method
Apply a payment method to a cart given its cart_id
.
You have the following options for payments:
- Stripe.js V3 (recommended) - You can use this option by passing in the field
intent_based_payment : true
in the request body. Using this option will not automatically apply payment details. Please follow this guide to enable Stripe v3 Payments. - Raw Credit Card information (deprecation path) - You can use this option by passing in
card_cvc
,card_exp_month
,card_exp_year
,card_number
andcard_postal_code
. - Tokenized credit card information (deprecation path) - You can use this by passing in a Tokenized card in the
token
field.
Headers
Path Parameters
Query Parameters
Body
Payment Token generated on a specific payment provider. When a token is provided, payment_provider must also be specified in the request.
Unique identifier of the Customer in the payment provider that the payment method is associated to. When a customer_id is provided, payment_provider must also be specified in the request.
Trigger payment intent based capture
Payment provider that this payment method was created on, if any.
IP address of the device from which this Payment Method originates.
Type of the payment method being passed in.
SINGLE_USE_CARD_TOKEN
, MULTI_USE_CARD_TOKEN
, BANK_TOKEN
Number on the credit or debit card.
CVC code on the credit or debit card.
Expiration month of the credit or debit card.
Expiration year of the credit or debit card.
Postal Code of the credit or debit card.
Submit cart immediately after applying the payment method. Cannot be combined with intent_based_checkout.
Map the order in Violet to an order record within your system.
Response
Errors on the Order. During checkout, if there was an error or issue on one of the order's bags, there will be an error added to this list describing the issue. The checkout API will return 200 with the order object in the response even if there was an issue with a bag so you must always check the response for errors in this list to know if there was an issue on the order.
ID of the User placing the order
ID of the App creating the order
ID of the Developer who placed
The Customer Placing the Order
Bags in the Order
The shipping or billing address of a user placing an order
The shipping or billing address of a user placing an order
Payment Method belonging to an Order
The price of the Order in the base currency before discounts, shipping, duties, taxes, and tips. In Cents.
The sum of all shipping methods applied to the Order in the base currency. In Cents.
The sum of all the taxes applied to the Order in the base currency. In Cents.
The total discounts applied to the price of the Order in the base currency. In Cents.
The sum of all item prices, discounts, shipping, and taxes applied to the Order in the base currency. In Cents.
App Customer ID. This should be used to map the order to the ID of the customer in your application.
App Order ID. This should be set to a unique identifier in your system. While not enforced unique in Violet's system, it is strongly recommended that unique values are used for each cart to help correlate identifiers between Violet's system and yours.
Status of the Order
IN_PROGRESS
, PROCESSING
, COMPLETED
, CANCELED
, PARTIALLY_REFUNDED
, REFUNDED
, REQUIRES_ACTION
Order is Guest
Date of order creation
Date of last order update
Is the cart priced
Is this cart going to be placed through wallet-based checkout
Base currency of cart
Optional value used to represent an identifier in your system. This value is not required to represent a referral. It can represent the ID of anything in your system and can be used to filter order lookup results. Max length of 128 characters.
Symbol representing the desired currency
Name of app that originated the order. Use the "extended" query param when looking up orders to include this value.
Stripe publishable key. Use for tokenizing payment methods.
Payment intent client secret. Use for payment intent based payment capture and external captures
Payment Transactions associated to the bags on this Cart
IN_PROGRESS
, PROCESSING
, COMPLETED
, CANCELED
, PARTIALLY_REFUNDED
, REFUNDED
, REQUIRES_ACTION
Boolean indicating if the cart/order will be payed using a payment intent.
Was this page helpful?