Apply Payment Method - Violet Documentation

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 and card_postal_code.
Tokenized credit card information (deprecation path) - You can use this by passing in a Tokenized card in the token field.

Headers

X-Violet-Token

string

X-Violet-App-Secret

string

X-Violet-App-Id

integer

Path Parameters

cart_id

integer

required

Query Parameters

price_cart

boolean

default:

false

Body

application/json

The payment method request for a cart. If the token is provided no card data is required.

app_order_id

string

Map the order in Violet to an order record within your system.

card_cvc

integer

CVC code on the credit or debit card.

card_exp_month

integer

Expiration month of the credit or debit card.

card_exp_year

integer

Expiration year of the credit or debit card.

card_number

string

Number on the credit or debit card.

card_postal_code

string

Postal Code of the credit or debit card.

complete_checkout

boolean

Submit cart immediately after applying the payment method. Cannot be combined with intent_based_checkout.

customer_id

string

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.

intent_based_capture

boolean

Trigger payment intent based capture

ip_v4

string

IP address of the device from which this Payment Method originates.

payment_provider

string

Payment provider that this payment method was created on, if any.

token

string

Payment Token generated on a specific payment provider. When a token is provided, payment_provider must also be specified in the request.

type

enum<string>

Type of the payment method being passed in.

Available options:

SINGLE_USE_CARD_TOKEN,

MULTI_USE_CARD_TOKEN,

BANK_TOKEN,

PAYMENT_INTENT,

VIOLET_PAYMENT_METHOD_ID

Response

200 - application/json

Violet Order Entity

app_customer_id

string | null

App Customer ID. This should be used to map the order to the ID of the customer in your application.

app_id

integer

ID of the App responsible for the creation and submission of this Order.

app_name

string

Name of app that originated the order. Use the "extended" query param when looking up orders to include this value.

app_order_id

string | null

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.

bags

object[]

One or more Bags that make up the Order. Each Bag will contain the Sku's, shipping methods, and totals unique to a merchant. Each merchant in an Order will have their own Bag.

bags.app_id

integer

required

ID of the App responsible for the creation and submission of this Order.

bags.merchant_id

integer

required

ID of the merchant the Bag is related to.

bags.order_id

integer

required

ID of the parent order the Bag is a child of.

bags.app_name

string

Name of app that originated the order. Use the "extended" query param when looking up orders to include this value.

bags.app_order_id

string | null

Optional ID of the Order in the channels system. Automatically obtained through the app_order_id applied to the Order.

bags.bag_id

integer

bags.bag_status

enum<string>

Available options:

IN_PROGRESS,

SUBMITTED,

ACCEPTED,

COMPLETED,

PARTIALLY_REFUNDED,

REFUNDED,

REJECTED,

CANCELED,

BACKORDERED

bags.channel

enum<string>

The type of Channel that originated this Bag.

Available options:

APP,

MARKETPLACE,

FACEBOOK,

INSTAGRAM,

WALMART,

GOOGLE,

TIKTOK,

SNAPCHAT,

PINTEREST

bags.commission_rate

number

The rate used to calculate the apps commission rate for the Bag.

bags.currency

string

Base currency of the Bag.

bags.currency_exchange_rate

number | null

Exchange rate of currency and external currency, if different, at the time the Bag was last priced.

bags.date_created

string

Date the Bag was created in Violet.

bags.date_last_consolidated

string

Date the Bag was last checked for updates. This is a part of Order Parity and is used to discover missed or unsent webhooks from the external commerce platforms.

bags.date_last_modified

string

Date the Bag was last modified in Violet.

bags.discount_total

integer

The total discounts applied to the price of the Bag in the base currency. In Cents

bags.discounts

array | null

A list of discounts, if any, that have been applied to this Bag.

bags.dispute_status

enum<string>

default:

UNDISPUTED

Dispute status of the Bag.

Available options:

UNDISPUTED,

IN_DISPUTE,

DISPUTE_WON,

DISPUTE_LOST

bags.external_checkout

boolean

default:

true

If the Bag is attached to an external cart in the commerce platform.

bags.external_currency

string

Currency of the equivalent cart on external commerce platform.

bags.external_id

string | null

ID of the Order on the external commerce platform. This value will be null until the Order submitted.

bags.financial_status

enum<string>

Financial status of the Bag.

Available options:

UNPAID,

AUTHORIZED,

PENDING,

PAID,

PARTIALLY_PAID,

REFUNDED,

PARTIALLY_REFUNDED,

VOIDED

bags.fulfillment_status

enum<string>

Fulfillment status of the Bag.

Available options:

PROCESSING,

SHIPPED,

PARTIALLY_SHIPPED,

DELIVERED,

COULD_NOT_DELIVER,

RETURNED

bags.fulfillments

array | null

A list of fulfillments, if any, that have been applied to this Bag.

bags.id

integer

Unique ID of the Bag.

bags.merchant_name

string

Name of the merchant the Bag is related to.

bags.platform

enum<string>

The commerce platform used by this merchant.

Available options:

OTHER,

SHOPIFY,

MAGENTO,

MAGENTO_ONE,

WOOCOMMERCE,

BIGCOMMERCE,

LIGHTSPEED,

ECWID,

YAAS,

SPREECOMMERCE,

DEMANDWARE,

VOLUSION,

PRESTASHOP,

THREEDCART,

SYLIUS,

WIX,

SWELL,

MIVA,

WEBSPHERE,

ORACLECC,

SAPCC,

SQUARESPACE,

SHOPWARE,

COMMERCETOOLS,

MEDUSA,

ABICART,

SPRYKER,

MYSTORE,

CENTRA,

XCART,

VTEX,

KIBO,

SALEOR,

VENDO,

CHORD,

DIGITALRIVER,

SQUARE,

AMAZON,

BIGCARTEL,

CUSTOM

bags.remorse_period_ends

string

Date when the Bag can no longer be refunded.

bags.shipping_method

object | null

Shipping Methods belonging to an Order

bags.shipping_total

integer

The sum of all shipping methods applied to the Bag in the base currency. In Cents

bags.skus

object[]

Sku's (line items) that have been added to the Bag.

bags.skus.sku_id

integer

required

ID of the referenced Sku from the Violet catalog.

bags.skus.app_id

integer

ID of the App responsible for the creation and submission of this Order.

bags.skus.available

boolean

Is the product still available for purchase. If a Sku becomes unavailable it likely means that the product became out of stock after it was added to the cart. Unavailable Sku's cannot be purchased.

bags.skus.brand

string

Name of the brand selling this Sku.

bags.skus.custom

boolean

Is the Sku custom. Is true when the price has been overridden.

bags.skus.custom_properties

array | null

Used to provide the merchant with custom values for the product. This functionality is currently limited to Shopify merchants.

bags.skus.external_id

string

ID of the SKU on the external commerce platform.

bags.skus.height

number | null

Height of Sku.

bags.skus.id

integer

Unique ID of the Sku in relation to the order.

bags.skus.length

number | null

Length of Sku.

bags.skus.line_price

integer

Price of the Sku multiplied by the quantity, in Cents

bags.skus.merchant_id

integer

ID of the Merchant this Sku belongs to.

bags.skus.name

string

Name of the Sku, as provided by the merchant.

bags.skus.offer_id

integer

ID of the parent Offer that this Sku is a child of.

bags.skus.price

integer

Price of the individual SKU, in cents.

bags.skus.product_id

string

deprecated

ID of the parent product the offer is a child off.

bags.skus.product_type

enum<string>

Product type that describes the Sku.

Available options:

PHYSICAL,

DIGITAL,

VIRTUAL,

BUNDLED

bags.skus.quantity

integer

Quantity of the Sku being purchased. Quantities over 1000 will default to 1000.

Required range: x < 1000

bags.skus.quantity_fulfilled

integer

The quantity of this item that has been fulfilled by the merchant.

bags.skus.rates

object[]

Rates that apply specifically to this Sku such as taxes, fees, or duties.

bags.skus.status

enum<string>

Current status of the Sku.

Available options:

IN_PROGRESS,

PROCESSING,

SHIPPED,

PARTIALLY_SHIPPED,

DELIVERED,

COULD_NOT_DELIVER,

RETURNED,

CANCELED,

REFUNDED,

ERROR,

PARTIALLY_RETURNED,

PARTIALLY_REFUNDED

bags.skus.thumbnail

string

URL of the thumbnail image. Useful for order overview displays.

bags.skus.weight

number | null

Weight of Sku.

bags.skus.width

number | null

Width of Sku.

bags.status

enum<string>

Overall status of the Bag.

Available options:

IN_PROGRESS,

SUBMITTED,

ACCEPTED,

COMPLETED,

PARTIALLY_REFUNDED,

REFUNDED,

REJECTED,

CANCELED,

BACKORDERED

bags.sub_total

integer

The price of the Bag in the base currency before discounts, shipping, duties, taxes, and tips. In Cents.

bags.tax_total

integer

The sum of all the taxes applied to the Bag in the base currency. In Cents

bags.taxes

array | null

Tax rates applied to the Bag.

bags.taxes_included

boolean

default:

false

Are taxes included in the cart subtotal. When true the taxes will not be summed separately.

bags.total

integer

The sum of all item prices, discounts, shipping, and taxes applied to the Bag in the base currency. In Cents

bags.wallet_based_checkout

boolean

default:

false

Is this Bag going to be placed through wallet-based checkout.

billing_address

object | null

The shipping or billing address of a user placing an order

currency

string

default:

USD

Base currency of cart

currency_symbol

string

Symbol representing the currency the Order operates in.

customer

object | null

Details of the customer placing the order.

customer.email

string

required

Customer's valid email address.

customer.first_name

string

required

Customer's first name.

customer.last_name

string

required

Customer's last name.

customer.billing_address

object | null

The shipping or billing address of a user placing an order

customer.external_id

string | null

ID of the Customer on the External Platform

customer.name

string

Full name of the customer.

customer.same_address

boolean

default:

false

When only one address is provided, should the one address be used for both the shipping and billing addresses.

customer.shipping_address

object | null

The shipping or billing address of a user placing an order

customer.user_id

integer | null

deprecated

Reference ID of the customer placing the order.

date_created

string

Date of order creation

date_last_modified

string

Date of last order update

developer_id

integer

ID of the Developer responsible for the creation and submission of this Order.

discount_total

integer

default:

The total discounts applied to the price of the Order in the base currency. In Cents.

errors

array | null

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.

guest

boolean

integer

ID of the Violet cart or order.

intent_based_checkout

boolean

Boolean indicating if the cart/order will be payed using a payment intent.

is_guest

boolean

default:

true

Order is Guest

order_id

integer

order_status

enum<string>

Available options:

IN_PROGRESS,

PROCESSING,

COMPLETED,

CANCELED,

PARTIALLY_REFUNDED,

REFUNDED,

REQUIRES_ACTION

payment_intent_client_secret

string

Payment intent client secret. Use for payment intent based payment capture and external captures

payment_method

object | null

Payment Method belonging to an Order

payment_transactions

object[]

Payment Transactions associated to the bags on this Cart

payment_transactions.amount

integer

required

Amount of this payment in the fractional currency unit of this transaction (e.g. cents). This is the amount charged to the shopper.

payment_transactions.currency

string

required

Currency that the amount of this payment transaction is reflected in. This is the currency that the payment provider uses to charge the shopper payment method.

payment_transactions.order_id

integer

required

Identifier of the Order entity that this payment transaction is associated with

payment_transactions.payment_provider

string

required

Payment Provider that this transaction is executed against. This is the provider that handles payment processing for this transaction.

payment_transactions.payment_provider_transaction_id

string

required

Identifier of the payment transaction in the underlying payment provider system.

payment_transactions.capture_method

enum<string>

Underlying status of the payment in the payment provider system and should be used to determine what action to take next against this payment transaction.

Available options:

AUTOMATIC,

CUSTOM,

EXTERNAL

payment_transactions.capture_status

enum<string>

Underlying status of the payment capture in the payment provider system and should be used to determine what action to take next against this payment transaction.

Available options:

PROCESSING,

CAPTURED,

CANCELLED,

FAILED,

BYPASSED,

REQUIRES_ACTION,

REQUIRES_PAYMENT_METHOD,

REQUIRES_AUTHORIZATION,

AUTHORIZED,

REFUNDED,

PARTIALLY_REFUNDED

payment_transactions.date_created

string

Time at which the object was created. In ISO-8601 format.

payment_transactions.date_last_modified

string

Time at which the object was last modified. In ISO-8601 format.

payment_transactions.errors

object[]

List of errors associated to this payment transaction during processing.. This value will only be populated if there are errors during processing

payment_transactions.id

integer

Unique identifier for the object

payment_transactions.metadata

object

Metadata from the payment provider associated to this payment transaction

payment_transactions.payment_intent_client_secret

string

Client secret for the payment intent associated to this payment transaction

payment_transactions.payment_method_id

integer

Identifier of the payment method associated with this payment transaction in Violet.

payment_transactions.payment_provider_payment_method_id

string

Identifier of the payment method associated with this payment transaction in the underlying payment provider system.

Identifiers of the Bags in Violet that are associated with this payment transaction. The amount of this payment transaction is directly computed from the total amounts on the related bags.

Identifiers of the Refunds in Violet that are associated with this payment transaction. Refund amounts are not reflected in the amount on this payment transaction.

payment_transactions.status

enum<string>

Available options:

PROCESSING,

CAPTURED,

CANCELLED,

FAILED,

BYPASSED,

REQUIRES_ACTION,

REQUIRES_PAYMENT_METHOD,

REQUIRES_AUTHORIZATION,

AUTHORIZED,

REFUNDED,

PARTIALLY_REFUNDED

payment_transactions.transfer_method

enum<string>

Underlying status of the payment in the payment provider system and should be used to determine what action to take next against this payment transaction.

Available options:

AUTOMATIC,

CUSTOM,

EXTERNAL

payment_transactions.transfer_status

enum<string>

Status of the transfer of distributions associated with this payment transaction.

Available options:

SENT,

REVERSED,

PARTIALLY_REVERSED,

PENDING,

FAILED,

BYPASSED

priced

boolean

default:

false

Is the cart priced

referral_id

string | null

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.

shipping_address

object | null

The shipping or billing address of a user placing an order

shipping_total

integer

default:

The sum of all shipping methods applied to the Order in the base currency. In Cents.

status

enum<string>

Status of the Order

Available options:

IN_PROGRESS,

PROCESSING,

COMPLETED,

CANCELED,

PARTIALLY_REFUNDED,

REFUNDED,

REQUIRES_ACTION

stripe_key

string

Stripe publishable key. Use for tokenizing payment methods.

sub_total

integer

default:

The price of the Order in the base currency before discounts, shipping, duties, taxes, and tips. In Cents.

tax_total

integer

default:

The sum of all the taxes applied to the Order in the base currency. In Cents.

token

string

deprecated

An alternative UUID that can be used as an ID to reference the cart or order.

total

integer

default:

The sum of all item prices, discounts, shipping, and taxes applied to the Order in the base currency. In Cents.

user_id

integer

deprecated

ID of the User placing the order

wallet_based_checkout

boolean

default:

false

Is this cart going to be placed through wallet-based checkout