POST add payment method to checkout intent

JavaScript

import CheckoutIntents from 'checkout-intents';

const client = new CheckoutIntents({
  apiKey: 'My API Key',
});

const checkoutIntent = await client.checkoutIntents.addPayment('id', {
  paymentMethod: { stripeToken: 'tok_1RkrWWHGDlstla3f1Fc7ZrhH', type: 'stripe_token' },
});

console.log(checkoutIntent);

{
  "buyer": {
    "postalCode": "10001",
    "country": "United States",
    "province": "NY",
    "city": "New York",
    "address1": "123 Main St",
    "phone": "+1234567890",
    "email": "[email protected]",
    "lastName": "Doe",
    "firstName": "John",
    "address2": "Apt 1"
  },
  "quantity": 123,
  "productUrl": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "state": "retrieving_offer",
  "variantSelections": [
    {
      "value": "Small, Red, XS, L, etc.",
      "label": "Size, Color, etc."
    }
  ]
}

POST

api

checkout-intents

{id}

payment

JavaScript

import CheckoutIntents from 'checkout-intents';

const client = new CheckoutIntents({
  apiKey: 'My API Key',
});

const checkoutIntent = await client.checkoutIntents.addPayment('id', {
  paymentMethod: { stripeToken: 'tok_1RkrWWHGDlstla3f1Fc7ZrhH', type: 'stripe_token' },
});

console.log(checkoutIntent);

{
  "buyer": {
    "postalCode": "10001",
    "country": "United States",
    "province": "NY",
    "city": "New York",
    "address1": "123 Main St",
    "phone": "+1234567890",
    "email": "[email protected]",
    "lastName": "Doe",
    "firstName": "John",
    "address2": "Apt 1"
  },
  "quantity": 123,
  "productUrl": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "state": "retrieving_offer",
  "variantSelections": [
    {
      "value": "Small, Red, XS, L, etc.",
      "label": "Size, Color, etc."
    }
  ]
}

Authorizations

Authorization

string

header

required

Rye API key

Path Parameters

string

required

The id of the checkout intent to add payment details to

Body

application/json

The request body containing the payment details

paymentMethod

object

required

Option 1
Option 2
Option 3

Show child attributes

paymentMethod.stripeToken

string

required

Example:

"tok_1RkrWWHGDlstla3f1Fc7ZrhH"

paymentMethod.type

enum<string>

required

Available options:

stripe_token

Example:

"stripe_token"

Response

Payment response

Option 1
Option 2
Option 3
Option 4
Option 5

buyer

object

required

Show child attributes

buyer.postalCode

string

required

Maximum string length: 255

Example:

"10001"

buyer.country

string

required

Example:

"United States"

buyer.province

string

required

Maximum string length: 255

Example:

"NY"

buyer.city

string

required

Maximum string length: 255

Example:

"New York"

buyer.address1

string

required

Maximum string length: 255

Example:

"123 Main St"

buyer.phone

string

required

Example:

"+1234567890"

buyer.email

string

required

Example:

"[email protected]"

buyer.lastName

string

required

Maximum string length: 255

Example:

"Doe"

buyer.firstName

string

required

Maximum string length: 255

Example:

"John"

buyer.address2

string

Maximum string length: 255

Example:

"Apt 1"

quantity

number<double>

required

productUrl

string

required

createdAt

string<date-time>

required

string

required

state

enum<string>

required

Available options:

retrieving_offer

variantSelections

object[]

Show child attributes

variantSelections.value

string

required

Maximum string length: 30

Example:

"Small, Red, XS, L, etc."

variantSelections.label

string

required

Maximum string length: 30

Example:

"Size, Color, etc."

POST confirm checkout intent

⌘I

Universal Checkout API

API Reference

POST add payment method to checkout intent

Authorizations

Path Parameters

Body

Response