Authorize an order

post

https://api.vrio.app/orders/{order_id}/authorize

Path Params

order_id

integer

required

Body Params

offers

array of objects

Define the offers and Items to be used. Use an array if adding multiple Item and Offer combinations. This includes Upsells. Offers will be required on this method if there are not any existing offers on the order.

offers

offers_restrict

boolean

When passing offers, use this flag to mark all the existing order offers as Removed.

campaign_id

integer

Associate order with a new campaign.

force_campaign_id

boolean

If there is a campaign already on the order, pass this flag in conjunction with a campaign_id to change it to a new campaign. All campaign configurations will be used with the new campaign_id. Required when passing a campaign_id.

customers_address_billing_id

integer

A billing address is required to process an order. Either passing an an address id or creating a new address with the bill_ fields.

customers_address_shipping_id

integer

A shipping address is required to process an order that has a shippable item. Either passing an an address id or creating a new address with the ship_ fields.

bill_fname

string

Billing first name. Required when customers_address_billing_id is empty.

bill_lname

string

Billing last name. Required when customers_address_billing_id is empty.

bill_address1

string

Billing address line 1. Required when customers_address_billing_id is empty.

bill_address2

string

Billing address line 2

bill_city

string

Billing city. Required when customers_address_billing_id is empty.

bill_country

string

Billing country code, 2 letters (example : US). Required when customers_address_billing_id is empty.

bill_organization

string

Billing organization.

bill_state

string

Billing state. Required when customers_address_billing_id is empty and bill_county is US or CA.

bill_zipcode

string

Billing zipcode. Required when customers_address_billing_id is empty

same_address

boolean

Pass as true to use the same address for billing and shipping. Only one of those is required in that case.

ship_fname

string

Shipping first name. Required when customers_address_shipping_id is empty and order has shippable items.

ship_lname

string

Shipping last name. Required when customers_address_shipping_id is empty and order has shippable items.

ship_address1

string

Shipping address line 1. Required when customers_address_shipping_id is empty and order has shippable items.

ship_address2

string

Shipping address line 2

ship_city

string

Shipping city. Required when customers_address_shipping_id is empty and order has shippable items.

ship_country

string

Shipping country code, 2 letters (example : US). Required when customers_address_shipping_id is empty and order has shippable items.

ship_organization

string

Shipping organization

ship_state

string

Shipping state. Required when customers_address_shipping_id is empty and order has shippable items and ship_country is US or CA.

ship_zipcode

string

Shipping zipcode. Required when customers_address_shipping_id is empty and order has shippable items.

shipping_profile_id

integer

Shipping profile to be used to determine shipping logic. Required if shipping profiles are setup on the campaign and there are shippable items on the order.

payment_method_id

integer

enum

1 - Credit Card
2 - Check
3 - Google Pay
4 - Apple Pay
5 - Cash
6 - Paypal
7 - Alternative Payments Sofort
8 - Alternative Payments POLi
9 - Alternative Payments SEPA
10 - ACH
11 - Afterpay
12 - Klarna
13 - SEPA

merchant_id

integer

Force a specific merchant to use for this order. This will override any campaign payment configuration.

merchant_descriptor

string

Some gateways allow for Vrio to pass the merchant descriptor dynamically when processing a charge. This is configured when setting up the merchant account in Vrio. Override the value on the merchant account by passing this field.

route_id

integer

Force a specific route to use for this order. This will override any campaign payment configuration.

currency_id

integer

Force a specific currency to use for this order. This will override any campaign payment configuration.

order_tax

string

Override the tax applied on that order. This will override any campaign payment configuration.

customer_card_id

integer

A customer card is required when using the CC payment method. Either passing an existing customer card id or using the card_ fields.

card_type_id

integer | null

enum

Required when passing payment method ID = 1 and when not passing a customer card ID.

1 - Mastercard
2 - Visa
3 - Discover
4 - American Express

Allowed:

card_number

string

Required when passing payment_method_id = 1 and when not passing a customer_card_id. Must be 15 or 16 digits with no other characters.

card_cvv

string

Required when passing payment_method_id = 1 and when not passing a customer_card_id.

card_exp_month

integer

Card Expiration month (08). Required when passing payment_method_id = 1 and when not passing a customer_card_id.

card_exp_year

integer

Card Expiration year (2018). Required when passing payment_method_id = 1 and when not passing a customer_card_id.

check_present

boolean

Only used with the check payment method (if available).

check_number

string

Required when passing payment_method_id = 2.

check_amount

string

Required when passing payment_method_id = 2.

bank_account_number

string

Required when passing payment_method_id = 10.

bank_routing_number

string

Required when passing payment_method_id = 10.

iban

string

Required when passing payment_method_id = 13.

redirect_url

string

Redirect url used for 3ds three step process, PayPal, Klarna and Afterpay

payment_token

string

Used to process apple pay/google pay or paypal.

gift_cards

array of objects

If a gift card should be used towards to order total, include the gift card parameters.

gift_cards

apply_customer_balance

string

Apply a customer balance amount to that order.

date_auto_capture

date-time

Auto capture date (2025-08-17 00:00:00) in EST. For authorizations only.

order_cardholder_auth

array of strings

3D SECURE ONLY Indicates whether a transaction qualifies as an authenticated transaction or account verification. Array of values (for each transaction cycle). Example : ["Y","Y"]

order_cardholder_auth

order_eci

array of strings

3D SECURE ONLY E-commerce indicator. Array of values (for each transaction cycle). Example : ["05","05"]

order_eci

order_cavv

array of strings

3D SECURE ONLY Cardholder authentication verification value. Array of values (for each transaction cycle). Example : ["XXkBB3eIFgAAAAnDhAIJdQXXXXX=","XXkBB3eIFgAAAAnDhAIJdQXXXXX="]

order_cavv

order_3ds_version

array of strings

3D SECURE ONLY Version of the 3D Secure that was used when the transaction was already authenticated using an external MPI. For example: 1.0.2 or 2.1.0. Array of values (for each transaction cycle). Example : ["2.1.0","2.1.0"]

order_3ds_version

order_3ds_ds_transaction_id

array of strings

Version 2+ 3D SECURE ONLY Cardholder authentication transaction id. Array of values (for each transaction cycle). Example : ["XXXXXXX-37b6-4ba7-b50b-b4491515eaf4","XXXXXXX-37b6-4ba7-b50b-b4491515eaf4"]

order_3ds_ds_transaction_id

order_xid

array of strings

Version 1 3D SECURE ONLY Cardholder authentication transaction id. Array of values (for each transaction cycle)

order_xid

order_3ds_enrollment_status

array of strings

3D SECURE ONLY Indicates whether a transaction qualifies as a being enrolled for 3DS authentication. Array of values (for each transaction cycle). Example : ["E","E"]

order_3ds_enrollment_status

order_3ds_bypass_reattempt

array of booleans

3D SECURE ONLY If this flag is passed, 3ds values will not be posted to the gateway for reattempts. Array of values (for each transaction cycle). Example : [0,1]

order_3ds_bypass_reattempt

session_id

string

A custom session id to associate with the order.

ip_address

string

Customer IP Address at the time of order

tracking1

string

Custom Tracking Variable Option 1

tracking2

string

Custom Tracking Variable Option 2

tracking3

string

Custom Tracking Variable Option 3

tracking4

string

Custom Tracking Variable Option 4

tracking5

string

Custom Tracking Variable Option 5

tracking6

string

Custom Tracking Variable Option 6

tracking7

string

Custom Tracking Variable Option 7

tracking8

string

Custom Tracking Variable Option 8

tracking9

string

Custom Tracking Variable Option 9

tracking10

string

Custom Tracking Variable Option 10

tracking11

string

Custom Tracking Variable Option 11

tracking12

string

Custom Tracking Variable Option 12

tracking13

string

Custom Tracking Variable Option 13

tracking14

string

Custom Tracking Variable Option 14

tracking15

string

Custom Tracking Variable Option 15

tracking16

string

Custom Tracking Variable Option 16

tracking17

string

Custom Tracking Variable Option 17

tracking18

string

Custom Tracking Variable Option 18

tracking19

string

Custom Tracking Variable Option 19

tracking20

string

Custom Tracking Variable Option 20

Responses

200OK

400Process Error response

401Unauthorized response

403Forbidden response

500Error response