Charge
Process a payment charge with card details and additional transaction information
Headers
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
Tokenized payment account number. Generated from Runner.js or Run Merchant dev tools.
Merchant ID
Ticket amount (in cents)
Card expiration
Cardholder CVN (CVV2, CID, CAV2, CVC2)
Three character currency indicator (Defaults to USD)
CNP transaction origin (telephone, recurring, ecomm or mobile app). Used for ensuring that transaction is at the right interchange level
Returns cof value if included in auth request.
The user that initiated the activity.
Permission granted to save card on file for a specific profile (Y or N)
The terminal ID as identified in the auth request.
Required for transactions using stored cardholder payment information. For a merchant-initiated transaction (MIT), the cof_sched parameter specifies whether the transaction is a one-time payment or a scheduled recurring payment.
Cardholder zip code
Return BIN lookup fields in response
Customer ID
Capture upon approval (Y or N)
Account holder’s name
Account holder’s company name
Account holder’s street address
Account holder’s street address line 2
Account holder’s city
Account holder’s region, US State, Mexican State, or Canadian Province
Account holder’s country (2-character country code)
Account holder’s phone number
Account holder’s email address
Source system order number
Authorization Code
Indicates if the payment account should be saved in the vault (Y or N)
Customer purchase order number
Tax amount for the order, either decimal or in currency minor units. If taxexempt is Y, then 0.
Total order freight amount, default 0
Total order duty amount, default 0
YYYYMMDD format. For most industries this is the delivery date for the order.
If country is US, must be 5 or 9 digits. Otherwise, any alphanumeric string is accepted
Same as above
Ship to country code - Defaults to US
Level 3 Processing Line Items
The id for the vaulted card
Response
Charge processed successfully
Reference number for the transaction
The id for the vaulted card
Result of auth request
Tokenized payment account number.
Response code that represents description of the response.
Text description of response
Abbreviation that represents platform and processor for transaction
Returns cof value if included in auth request
AVS verification response code
CVV response code
Array that returns fields from BIN response
Type of BIN
POS Entry Mode
A fee amount (e.g. a credit card surcharge amount) applied to the transaction, in dollars and cents.
Duplicate of authcode field if the transaction included a fee
Fee format configured for merchant account.
MID used for processing the fee. If not applicable, returns an empty value.
Unique reference number used for processing fee. If not applicable, returns an empty value
Type of fee applied to transaction
Fee rate applied to the transaction (in basis points)
Visa decline category
Visa decline category description
Authcode from issuer
Commercial card flag - Y if corporate or purchase card
Cryptogram (ARPC) only returned when emv data is present
Receipt/EMV tag data
The user that initiated the activity
Merchant ID
Ticket amount
Card expiration
Cardholder zip
Account holder’s street address
Account holder’s city
Account holder’s region, US State, Mexican State, Canadian Province
Source system order number
Masked primary account number (PAN)
Automatically created and assigned unless otherwise specified
Indicates if the payment account was saved in the vault (Y or N)
Visa, MC, Discover, Amex, etc.
Three character currency indicator
Account holder’s company name
Account holder’s street address line 2
Account holder’s country - 2-character country code
Account holder’s phone
Account holder’s email
Authorization code from issuer