Switch Card

cURL

curl --request POST \
  --url https://secure.development.knotapi.com/card \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user": {
    "name": {
      "first_name": "Ada",
      "last_name": "Lovelace"
    },
    "phone_number": "+11234567890",
    "address": {
      "street": "100 Main Street",
      "city": "New York",
      "region": "NY",
      "postal_code": "12345",
      "country": "US",
      "street2": "#100"
    }
  },
  "card": {
    "number": "4242424242424242",
    "expiration": "08/2025",
    "cvv": "123"
  },
  "task_id": "123456",
  "external_user_id": "abc123",
  "merchant_id": 46,
  "card_name": "My Credit Card",
  "customer_name": "John Doe"
}
'

{
  "message": "Success"
}

POST

card

cURL

curl --request POST \
  --url https://secure.development.knotapi.com/card \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user": {
    "name": {
      "first_name": "Ada",
      "last_name": "Lovelace"
    },
    "phone_number": "+11234567890",
    "address": {
      "street": "100 Main Street",
      "city": "New York",
      "region": "NY",
      "postal_code": "12345",
      "country": "US",
      "street2": "#100"
    }
  },
  "card": {
    "number": "4242424242424242",
    "expiration": "08/2025",
    "cvv": "123"
  },
  "task_id": "123456",
  "external_user_id": "abc123",
  "merchant_id": 46,
  "card_name": "My Credit Card",
  "customer_name": "John Doe"
}
'

{
  "message": "Success"
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

The input parameters required for switching a card.

user

object

required

Show child attributes

user.name

object

required

Show child attributes

user.name.first_name

string

required

User's first name.

Maximum string length: 255

Example:

"Ada"

user.name.last_name

string

required

User's last name.

Maximum string length: 255

Example:

"Lovelace"

user.phone_number

string

required

User's phone number in E.164 format.

Example:

"+11234567890"

user.address

object

required

Show child attributes

user.address.street

string

required

First line of the user's billing address.

Maximum string length: 46

Example:

"100 Main Street"

user.address.city

string

required

City portion of the user's billing address.

Maximum string length: 32

Example:

"New York"

user.address.region

string

required

Region portion of the user's billing address, usually a state abbreviation. Must be an ISO 3166-2 sub-division code.

Example:

"NY"

user.address.postal_code

string

required

Postal code of the user's billing address.

Required string length: 5 - 10

Example:

"12345"

user.address.country

string

required

Country portion of the user's billing address. Must be an ISO 3166-1 alpha-2 code.

Example:

"US"

user.address.street2

string

Second line of the user's billing address (e.g apt. #).

Maximum string length: 46

Example:

"#100"

card

object

required

Show child attributes

card.number

string

required

User's valid card number without spaces or hyphens.

Example:

"4242424242424242"

card.expiration

string

required

User's card expiration date. Must be MM/YYYY or MM/YY format (e.g. 08/2027).

Example:

"08/2025"

card.cvv

string

required

User's card verification value.

Maximum string length: 4

Example:

"123"

task_id

string

The task_id value provided in the AUTHENTICATED webhook. Required if you received the AUTHENTICATED webhook.

Example:

"123456"

external_user_id

string

Your unique identifier for the user. Only necessary if you are provisioning a card to an already connected merchant account all server-side

Example:

"abc123"

merchant_id

integer

Unique identifier for the merchant. Only necessary if you are provisioning a card to an already connected merchant account all server-side.

Example:

46

card_name

string

Name of the card. Recommended only if you are provisioning a card to an already connected merchant account all server-side. Learn more here.

Example:

"My Credit Card"

customer_name

string

Name of the customer. Recommended only if you are provisioning a card to an already connected merchant account all server-side. Learn more here.

Example:

"John Doe"

Response

Successful request.

message

string

Success message.

Example:

"Success"

Switch Card JWE The Transaction Object

⌘I

Overview

Development

Sessions

CardSwitcher

TransactionLink

Shopping

Merchants

Merchant Accounts

Detected Accounts

Users

Switch Card

Authorizations

Body

Response