Authorize Setup

POST 
/v2/orders/:orderID/payments

Authorize setup

Request

Path Parameters

orderID stringrequired

The Universally Unique Identifier (UUID) of the order you want to pay for.

application/json

Body

data object

oneOf

Data.AdyenPayment

gateway stringrequired

Possible values: [adyen]

Specifies the gateway. You must use adyen.

method stringrequired

Possible values: [authorize, purchase, purchase_setup, authorize_setup]

Specifies the transaction method, such as purchase or authorize.

amount number

The amount to be paid for the transaction.

options object

shopper_reference string

The shopper reference token associated with the saved payment method.

recurring_processing_model string

Enter CardOnFile for a one-time purchase.

payment stringrequired

The Adyen recurringDetailReference payment method identifier.

Data.AuthorizeNetPayment

gateway stringrequired

Possible values: [authorize_net]

Specifies the gateway. You must use authorize_net.

method stringrequired

Possible values: [authorize, purchase, purchase_setup, authorize_setup]

Specifies the transaction method, such as purchase or authorize.

amount number

The amount to be paid for the transaction.

options object

customer_payment_profile_id string

The Authorize.net customer payment profile ID.

payment stringrequired

The Authorize.net customer profile ID.

Data.BraintreePayment

gateway stringrequired

Possible values: [braintree]

Specifies the gateway. You must use braintree.

method stringrequired

Possible values: [authorize, purchase, purchase_setup, authorize_setup]

Specifies the transaction method, such as purchase or authorize.

amount number

The amount to be paid for the transaction.

payment stringrequired

The Braintree Customer ID that you want to bill.

Data.CardConnectPayment

gateway stringrequired

Possible values: [card_connect]

Specifies the gateway. You must use card_connect.

method stringrequired

Possible values: [authorize, purchase, purchase_setup, authorize_setup]

Specifies the transaction method, such as purchase or authorize.

amount number

The amount to be paid for the transaction.

payment stringrequired

Enter account_id, profile_id from CardPointe API. For example, 1|16178397535388255208.

Data.CyberSourcePayment

gateway stringrequired

Possible values: [cyber_source]

Specifies the gateway. You must use cyber_source.

method stringrequired

Possible values: [authorize, purchase, purchase_setup, authorize_setup]

Specifies the transaction method, such as purchase or authorize.

amount number

The amount to be paid for the transaction.

payment stringrequired

The CyberSource token.

Elastic Path Payments Powered By Stripe

gateway stringrequired

Possible values: [elastic_path_payments_stripe]

Specifies the gateway. You must use elastic_path_payments_stripe.

method stringrequired

Possible values: [authorize, purchase, purchase_setup, authorize_setup]

Specifies the transaction method, such as purchase or authorize.

amount number

The amount to be paid for the transaction.

options object

receipt_email string

Provides the email address to which you want to send the Stripe receipts for the transactions within the store. This feature is available only in the live mode.

automatic_payment_methods object

Parent object determining whether to use Stripe's automatic_payment_methods setting.

enabled boolean

When set to true, it displays all enabled payment methods from the Stripe dashboard. When set to false, the Stripe default, which is card, is used.

payment_method_types string[]

Specifies the Stripe payment method types configured for the store. See Stripe Documentation.

payment string

Specifies the Stripe token or source.

Data.ManualPayment

gateway stringrequired

Possible values: [manual]

Specifies the type of payment gateway. You must use manual.

method stringrequired

Possible values: [authorize, purchase, purchase_setup, authorize_setup]

Specifies the transaction method, such as purchase or authorize.

amount number

The amount to be paid for the transaction.

paymentmethod_meta object

custom_reference string

A reference associated with the payment method. This might include loyalty points or gift card identifiers. We recommend not to include personal information in this field.

name string

A custom name associated with the payment method.

Data.PayPalExpressCheckoutPayment

gateway stringrequired

Possible values: [paypal_express_checkout]

Specifies the type of payment gateway. You must use paypal_express_checkout.

method stringrequired

Possible values: [authorize, purchase, purchase_setup, authorize_setup]

Specifies the transaction method, such as purchase or authorize.

amount number

The amount to be paid for the transaction.

options object

description string

The description for the payment.

soft_descriptor string

The descriptor appended to PayPal generated descriptor that is visible on the card statement of the payer.

application_context object

brand_name string

The label that overrides the business name in the PayPal account on the payPal site.

locale string

The locale pages that appear based on language and country code. PayPal supports a five-character code. For example, ja-JP.

landing_page string

The type of landing page to show on the PayPal site for customer checkout. Use values LOGIN, BILLING, or NO_PREFERENCE.

shipping_preference string

The shipping preference. Use SET_PROVIDED_ADDRESS value. This parameter does allow the user to change their address on PayPal site.

user_action string

If you set useraction=commit in the query string, the flow redirects the buyer to the PayPal payment page and displays a Pay Now button. When the shopper clicks Pay Now, call DoExpressCheckoutPayment to complete the payment without additional interaction from the shopper. Choose this flow when you know the final payment amount when you initiate the checkout flow.

return_url string

The callback URL for PayPal to redirect the user in the case of approved payment.

cancel_url string

The callback URL for PayPal to redirect user in the case a cancelled payment.

Data.StripePayment

gateway stringrequired

Possible values: [stripe]

Specifies the type of payment gateway. You must use stripe.

method stringrequired

Possible values: [authorize, purchase, purchase_setup, authorize_setup]

Specifies the transaction method, such as purchase or authorize.

amount number

The amount to be paid for the transaction.

options object

receipt_email string

The option to provide an email for Stripe receipts. Specify live mode to access this feature.

payment string

The Stripe token or source.

Data.StripeConnectPayment

gateway stringrequired

Possible values: [stripe_connect]

Specifies the type of payment gateway. You must use stripe_connect.

method stringrequired

Possible values: [authorize, purchase, purchase_setup, authorize_setup]

Specifies the transaction method, such as purchase or authorize.

amount number

The amount to be paid for the transaction.

options object

receipt_email string

Provides the email address to which you want to send the Stripe receipts for the transactions within the store. This feature is available only in the live mode.

payment string

Specifies the Stripe token or source.

Data.StripePaymentIntentsPayment

gateway stringrequired

Possible values: [stripe_payment_intents]

Specifies the type of payment gateway. You must use stripe_payment_intents.

method stringrequired

Possible values: [authorize, purchase, purchase_setup, authorize_setup]

Specifies the transaction method, such as purchase or authorize.

amount number

The amount to be paid for the transaction.

options object

receipt_email string

Provides the email address to which you want to send the Stripe receipts for the transactions within the store. This feature is available only in the live mode.

payment string

Specifies the Stripe token or source.

Responses

200

OK

application/json

Schema

Schema

data object

id uuid

The ID of the transaction.

reference string

The payment gateway reference.

name string

A custom name associated with the payment method.

custom_reference string

A reference associated with the payment method. This might include loyalty points or gift card identifiers. We recommend you not to include personal information in this field.

gateway string

Possible values: [adyen, authorize_net, braintree, card_connect, cyber_source, elastic_path_payments_stripe, manual, paypal_express_checkout, stripe, stripe_connect, stripe_payment_intents]

The name of the payment gateway used.

amount number

The amount for this transaction.

refunded_amount number

The refunded amount.

currency string

The transaction currency.

transaction-type string

The type of transaction, such as purchase, capture, authorize or refund.

status string

The status provided by the gateway for this transaction, such as complete or failed.

relationships object

order object

data object

type string

Represents the type of the object being returned. It is always order.

id uuid

The ID of the order.

meta object

display_price object

amount number

The raw total of this cart.

currency string

The currency set for this cart.

formatted string

The tax inclusive formatted total based on the currency.

display_refunded_amount object

amount number

The raw total of this cart.

currency string

The currency set for this cart.

formatted string

The tax inclusive formatted total based on the currency.

timestamps object

created_at string

The date this was created.

updated_at

The date this was last updated.

Example (from schema)

{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "reference": "string",
    "name": "string",
    "custom_reference": "string",
    "gateway": "adyen",
    "amount": 0,
    "refunded_amount": 0,
    "currency": "string",
    "transaction-type": "string",
    "status": "string",
    "relationships": {
      "order": {
        "data": {
          "type": "string",
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        }
      }
    },
    "meta": {
      "display_price": {
        "amount": 0,
        "currency": "string",
        "formatted": "string"
      },
      "display_refunded_amount": {
        "amount": 0,
        "currency": "string",
        "formatted": "string"
      },
      "timestamps": {
        "created_at": "string"
      }
    }
  }
}

401

Unauthorized

application/json

Schema

Schema

detail string
status string
title string

Example (from schema)

[
  null
]

Example

{
  "errors": {
    "status": 401,
    "title": "Unauthorized"
  }
}

Loading...