Create a Token - Card

post

https://testapi.payarc.net/v1/tokens

This API creates a token that represents a credit or debit card used to carry out a transaction.

Body Params

card_source

string

enum

required

Defaults to INTERNET

This field indicates how the card data was captured at the point of sale.
td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }

Format	Allowed Values	Examples	Notes
Alphabetic	MANUAL PHONE MAIL INTERNET	9 would be $0.09; 99999999 would be $999,999.99	PAYARC processes the transaction as 'card not present' if the field value is PHONE, MAIL, or INTERNET. For any other type of transaction, PAYARC processes the transaction as 'card present'.

Allowed:

card_number

int32

required

The 14-19 digit card number used for the transaction.
td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }

Format	Min Length	Max Length	Allowed Values	Examples
Numeric	14 digits	19 digits	usd	VISA: 4012000098765439 MASTERCARD: 5146315000000055 AMEX: 371449635392376 DISCOVER: 6011000993026909 DISCOVER CUP: 6282000123842342 DINERS: 3055155515160018 JCB: 3530142019945859

exp_month

string

required

The month value displayed on the card used for the transaction.
td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }

Format	Min Length	Max Length	Examples
Numeric	1	12	01 represents the month of January.

exp_year

string

required

The YYYY value mentioned on the card used for the transaction.
td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }

Format	Min Length	Max Length	Examples
Numeric	2 digits	4 digits	2025

cvv

string

required

The three or four-digit security code on the card.
td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }

Format	Min Length	Max Length	Notes
Numeric	3 digits	4 digits	This field can be set as 'Required' or 'Optional' at the account level by a PAYARC Admin. Email [email protected] to contact the Admin. If this field is set as 'Required' and is not sent or is incorrect, the transaction may be declined based on the risk parameters set. If this field is set as 'Optional' and is not sent or is incorrect, the transaction will be processed as CVV availability not provided.

card_holder_name

string

Name of the cardholder as mentioned on the card used to carry out the transaction.
td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }

Format	Min Length	Max Length	Examples
Alphabetic and Whitespace	1 character	30 caracters	John Smith

address_line1

string

The cardholder's billing address for line 1.
td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }

Format	Min Length	Max Length	Examples	Notes
Alphanumeric	1 character	200 characters	103 Mason Street	This field will be 'Required' if address information is requested by the merchant. Payfac Max Length: 30 characters

address_line2

string

The cardholder's billing address for line 2.
td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }

Format	Min Length	Max Length	Examples	Notes
Alphanumeric	1 character	200 characters	2nd Floor	Note: Payfac Max Length: 30 characters

city

string

The cardholder's state name. Can be State/County/Province/Region.
td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }

Format	Min Length	Max Length	Examples	Notes
Alphabetic and Whitespace	1 character	50 characters	Ney York	This field will be 'Required' if address information is requested by the merchant.

state

string

The cardholder's state name. Can be State/County/Province/Region.
td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }

Format	Min Length	Max Length	Examples	Notes
Alphabetic and Whitespace	1 character	50 characters	NY	This field will be 'Required' if address information is requested by the merchant.

zip

int32

The cardholder's billing ZIP code.
td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }

Format	Min Length	Max Length	Examples	Notes
Numeric	2 digits	10 digits	10469	This field will be 'Required' if address information is requested by the merchant.

country

string

The cardholder's country name.
td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }

Format	Min Length	Max Length	Examples	Notes
Alphabetic	1 character	50 characters	US	This field will be 'Required' if address information is requested by the merchant.

authorize_card

int32

This field helps check card validity.
td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }

Format	Default	Notes
Boolean	0	0 will not authorize the card while creating a Token. 1 will authorize the customer's card for $0.00, which may result in additional fees. Failure to authorize the card may result in failed subscriptions.

Headers

string

required

Defaults to application/json

Indicates which content types, expressed as MIME types, the client is able to understand.

Content-Type

string

required

Defaults to application/json

Indicates the media type of the resource sent in the HTTP message body.

Possible Values:
application/json
application/x-www-form-urlencoded

Responses

201201

409409