v1

latestOpenAPI 3.1.02026-07-24170121.2 MB

Create a Token/Card

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

post/v1/tokens

Headers

Acceptstring required

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

Content-Typestring required

Indicates the media type of the resource sent in the HTTP message body. <br /><br /><b>Possible Values:</b><br /> application/json<br />application/x-www-form-urlencoded

Request body

card_source'MANUAL' | 'PHONE' | 'MAIL' | 'INTERNET' required

This field indicates how the card data was captured at the point of sale.<br><style>td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }</style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Allowed Values</b></td><td style='text-align: center;'><b>Examples</b></td><td style='text-align: center;'><b>Notes</b></td></tr><tr><td>Alphabetic</td><td>MANUAL PHONE MAIL INTERNET</td><td>9 would be $0.09; <br>99999999 would be $999,999.99</td><td>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'.</td></tr></table>

card_numberinteger required

The 14-19 digit card number used for the transaction.<br><style>td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }</style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Min Length</b></td><td style='text-align: center;'><b>Max Length</b></td><td style='text-align: center;'><b>Allowed Values</b></td><td style='text-align: center;'><b>Examples</b></td></tr><tr><td>Numeric</td><td>14 digits</td><td>19 digits</td><td>usd</td><td>VISA: 4012000098765439<br>MASTERCARD: 5146315000000055<br>AMEX: 371449635392376<br>DISCOVER: 6011000993026909<br>DISCOVER CUP: 6282000123842342<br>DINERS: 3055155515160018<br>JCB: 3530142019945859</td></tr></table>

exp_monthstring required

The month value displayed on the card used for the transaction.<br><style>td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }</style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Min Length</b></td><td style='text-align: center;'><b>Max Length</b></td><td style='text-align: center;'><b>Examples</b></td></tr><tr><td>Numeric</td><td>1</td><td>12</td><td>01 represents the month of January.</td></tr></table>

exp_yearstring required

The YYYY value mentioned on the card used for the transaction.<br><style>td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }</style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Min Length</b></td><td style='text-align: center;'><b>Max Length</b></td><td style='text-align: center;'><b>Examples</b></td></tr><tr><td>Numeric</td><td>2 digits</td><td>4 digits</td><td>2025</td></tr></table>

cvvstring required

The three or four-digit security code on the card.<br><style>td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }</style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Min Length</b></td><td style='text-align: center;'><b>Max Length</b></td><td style='text-align: center;'><b>Notes</b></td></tr><tr><td>Numeric</td><td>3 digits</td><td>4 digits</td><td>This field can be set as 'Required' or 'Optional' at the account level by a PAYARC Admin. Email support@payarc.com 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.</td></tr></table>

card_holder_namestring

Name of the cardholder as mentioned on the card used to carry out the transaction.<br><style>td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }</style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Min Length</b></td><td style='text-align: center;'><b>Max Length</b></td><td style='text-align: center;'><b>Examples</b></td></tr><tr><td>Alphabetic and Whitespace</td><td>1 character</td><td>30 caracters</td><td>John Smith</td></tr></table>

address_line1string

The cardholder's billing address for line 1.<br><style>td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }</style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Min Length</b></td><td style='text-align: center;'><b>Max Length</b></td><td style='text-align: center;'><b>Examples</b></td><td style='text-align: center;'><b>Notes</b></td></tr><tr><td>Alphanumeric</td><td>1 character</td><td>200 characters</td><td>103 Mason Street</td><td>This field will be 'Required' if address information is requested by the merchant. Payfac Max Length: 30 characters</td></tr></table>

address_line2string

The cardholder's billing address for line 2.<br><style>td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }</style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Min Length</b></td><td style='text-align: center;'><b>Max Length</b></td><td style='text-align: center;'><b>Examples</b></td><td style='text-align: center;'><b>Notes</b></td></tr><tr><td>Alphanumeric</td><td>1 character</td><td>200 characters</td><td>2nd Floor</td><td>Note: Payfac Max Length: 30 characters</td></tr></table>

citystring

The cardholder's state name. Can be State/County/Province/Region.<br><style>td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }</style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Min Length</b></td><td style='text-align: center;'><b>Max Length</b></td><td style='text-align: center;'><b>Examples</b></td><td style='text-align: center;'><b>Notes</b></td></tr><tr><td>Alphabetic and Whitespace</td><td>1 character</td><td>50 characters</td><td>Ney York</td><td>This field will be 'Required' if address information is requested by the merchant.</td></tr></table>

statestring

The cardholder's state name. Can be State/County/Province/Region.<br><style>td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }</style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Min Length</b></td><td style='text-align: center;'><b>Max Length</b></td><td style='text-align: center;'><b>Examples</b></td><td style='text-align: center;'><b>Notes</b></td></tr><tr><td>Alphabetic and Whitespace</td><td>1 character</td><td>50 characters</td><td>NY</td><td>This field will be 'Required' if address information is requested by the merchant.</td></tr></table>

zipinteger

The cardholder's billing ZIP code.<br><style>td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }</style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Min Length</b></td><td style='text-align: center;'><b>Max Length</b></td><td style='text-align: center;'><b>Examples</b></td><td style='text-align: center;'><b>Notes</b></td></tr><tr><td>Numeric</td><td>2 digits</td><td>10 digits</td><td>10469</td><td>This field will be 'Required' if address information is requested by the merchant.</td></tr></table>

countrystring

The cardholder's country name.<br><style>td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }</style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Min Length</b></td><td style='text-align: center;'><b>Max Length</b></td><td style='text-align: center;'><b>Examples</b></td><td style='text-align: center;'><b>Notes</b></td></tr><tr><td>Alphabetic</td><td>1 character</td><td>50 characters</td><td>US</td><td>This field will be 'Required' if address information is requested by the merchant.</td></tr></table>

authorize_cardinteger

This field helps check card validity.<br><style>td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }</style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Default</b></td><td style='text-align: center;'><b>Notes</b></td></tr><tr><td>Boolean</td><td>0</td><td>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.</td></tr></table>

Response

201

Example response

{
  "data": {
    "object": "Token",
    "id": "mYL8wl00LmLmwlNE",
    "created_at": 1724461006,
    "updated_at": 1724461008,
    "card": {
      "data": {
        "object": "Card",
        "id": "mMPL0211Nmy20vyN",
        "card_source": "PHONE",
        "exp_month": "12",
        "exp_year": "2025",
        "is_verified": 1,
        "fingerprint": "1Lv0N5259NmP2105",
        "brand": "M",
        "last4digit": "0055",
        "first6digit": 514631,
        "avs_status": "0",
        "cvc_status": "M",
        "created_at": 1724461008,
        "updated_at": 1724461008
      }
    }
  }
}