Create a Charge - Keyed

📘

---

To request transaction metadata, append the include query parameter to your request:

/v1/charges?include=transaction_metadata

Example Payload and Response with Metadata

Payload:

JSON

{
  "metadata": "{\"CustomerName\": \"Joanna Roscoe\", \"CustomerID\": \"123456\"}"
}

Response:

JSON

{
  "data": {
    "transaction_metadata": {
      "data": [
        {
          "object": "TransactionMeta",
          "id": "5djz0e0kv478428",
          "key": "CustomerName",
          "signature": null,
          "value": "Joanna Roscoe"
        },
        {
          "object": "TransactionMeta",
          "id": "zlwj3enkybepkaq9",
          "key": "CustomerID",
          "signature": null,
          "value": "123456"
        }
      ]
    }
  }
}

📘

When creating a new charge, you have the option to provide additional card data at LEVEL2 or LEVEL3. These enhanced data levels can provide benefits such as lower Visa and Mastercard interchange rates, particularly for commercial, corporate, purchasing, business, or government cards.

The following fields are required to process a transaction with card_level set to LEVEL2:

• address_line1
• purcharse_order
• sales_tax
• zip

To process transactions with card_level set to LEVEL3, you must include the fields required for LEVEL 2, along with the following additional fields:

• customer_vat_number
• destination_country_code
• duty_charges
• order_date
• ship_from_zip
• ship_to_zip
• shipping_charges
• summary_commodity_code
• tax_amount
• tax_category
• tax_rate
• tax_type
• vat_invoice

📘

When creating a new charge, you may encounter the following error codes. Each status is associated with a specific error message:

Status	Error Message
Activity Limit Exceeded	Activity Limit exceeded
Bad Request - Try Again	SystemError
Bad Request - Try Again	System Error (Tran)
Bad Swipe	The value of element track2Data is not valid
Bad Swipe	Invalid Encrypted Track Data or KSN
Bad Swipe	The value of element track1Data is not valid
Declined	General Card Auth Decline
Declined	Do not honor
Declined	Suspected Card
Duplicate transaction	Duplicate transaction
Expired Card	Expired Card
Host Validation Error	Contact PAYARC - Host Validation Error
Inactive terminal	Contact PAYARC - Inactive terminal (Backend)
Inactive terminal	The value '0018017679610' of element 'deviceID' is not valid
Incorrect Pin	Incorrect Pin
Insufficient Funds	Withdrawal Limit exceeded
Invalid Amount	Invalid Amount
Invalid Card Number	Invalid Card Number
Invalid Date	Invalid Date
Invalid From Account	Contact PAYARC - Invalid From Account
Invalid Service	Contact PAYARC - Invalid Service
No Such Issuer	No such issuer
Pin Attempts Exceeded	Pin attempts exceeded
Possible Duplicate Request	Possible Duplicate Request
Re-enter transaction	Re-enter transaction
Transaction Amount Invalid	The value '57679.99999999999' of element 'transactionAmount' is not valid