---
title: "Create a Charge - Keyed"
method: POST
path: "/v1/charges (COPY)"
---

# Create a Charge - Keyed

`POST /v1/charges (COPY)`

## Request

- Base URL: `https://testapi.payarc.net`
- URL: `https://testapi.payarc.net/v1/charges (COPY)`
- Auth: API key in header `Authorization`

This endpoint enables you to securely initiate payment transactions by submitting charge details via a POST request. You can enhance transaction data with: 

- <a href="https://docs.payarc.net/reference/create-a-charge-keyed-copy#enhancing-charges-with-level-2-and-level-3-card-data" style="color: grey;">LEVEL 2 or LEVEL 3</a> card information.
- <a href="https://docs.payarc.net/reference/create-a-charge-keyed-copy#metadata" style="color: grey;">Transaction metadata</a> for detailed insights into each charge.




<div style="text-align: right; margin-top: 20px;">
  ❔ <a href="https://docs.payarc.net/docs/faq">FAQ</a>
</div>

## Headers

- `Accept` string, required
- `Content-Type` string, required

## Request body

- object
  - `amount` integer, required: A positive integer in cents representing how much to charge. <small> <span style="color: #777777;"> <br><b>Format:</b> Numeric (in cents)<br> <b>Min Length:</b> 1 digit<br> <b>Max Length:</b> 8 digits<br> <b>Examples:</b><br> * 9 would be $0.09<br> * 99999999 would be $999,999.99<br> <b>Note:</b> The minimum amount is $0.50 USD when testing in the test environment. </span> </small>
  - `currency` string, required: Three-letter ISO currency code, in lowercase.
  - `customer_id` string: The unique number to identify a customer. A transaction is associated with a customer when a customer ID is included in the sale request.
  - `card_id` string: ID of the customer's card that should be charged.
  - `statement_description` string: An arbitrary string to be displayed on your customer’s credit card statement.
  - `token_id` string: An ID that represents a credit card or a debit card. This is obtained by using 'Create a Token' API.
  - `capture` integer: Option to capture charge immediately or pre-authorize and capture at a later date.
  - `card_level` string: Indicates extent of information to be provided for a transaction.
  - `sales_tax` integer: Sales tax amount. The sales tax amount represents a value in cents.
  - `terminal_id` string: The terminal ID from which the transaction was made.
  - `tip_amount` integer: The tip amount of the transaction.
  - `purchase_order` string: The value used by the customer to identify an order. Issued by the buyer to the seller.
  - `order_date` string: The date the order was processed.
  - `customer_ref_id` string: The reference identifier supplied by the commercial cardholder.
  - `ship_to_zip` integer: The postal code for the address to which the goods are being shipped.
  - `amex_descriptor` string: The value of the Transaction Advice Addendum field that displays descriptive information about a transactions on a customer's AMEX card statement.
  - `supplier_reference_number` string: This field contains a reference number that is used by AMEX to obtain supporting information on a transaction from a supplier. The number can be any combination of characters and numbers defined by the merchant.
  - `tax_amount` integer: The tax amount.
  - `tax_category` string: The type of tax. Formerly established through Tax Category messages.
  - `customer_vat_number` string: Government-assigned tax identification number of Merchant. Indicates the customer's government-assigned tax identification number or the identification number assigned to their purchasing company by the tax authorities.
  - `summary_commodity_code` string: The international description code of the overall goods or services being supplied.
  - `shipping_charges` integer: The dollar amount for shipping or freight charges applied to a product or transaction.
  - `duty_charges` integer: Indicates the total charges for any import or export duties included in the order.
  - `ship_from_zip` integer: The postal code for the address from which the goods were shipped.
  - `destination_country_code` string: The destination country code indicator.
  - `tax_type` string: The type of tax.
  - `vat_invoice` string: The Value Added Tax (VAT) invoice number associated with the transaction.
  - `tax_rate` integer: The type of tax rate.
  - `email` string: The cardholder's email address.
  - `cvv` integer: The three or four digit security code on the card.
  - `phone_number` integer: The cardholder's phone number.
  - `surcharge` integer: A positive number representing surcharge percentage to be added for charge.
  - `avs_parameters` integer: AVS transaction parameters that provide post authorization instructions.
  - `bin_location_parameters` integer: BIN location transaction parameters that provide post authorization instructions.
  - `bin_card_type_parameters` integer: BIN card type transaction parameters that provide post authorization instructions.
  - `metadata` string: Metadata is useful for storing additional, structured information on an object. As an example, you could store your user's full name and corresponding unique identifier from your system on a Charge object. You can specify up to 50 keys, with key names up to 20 characters long and values up to 100 characters long. Note! Keys and Values both should be strings and the json format should be like hash.
  - `do_not_send_email_to_customer` string: To prevent sending mail to customer for transaction. By default the system will sent mail
  - `do_not_send_sms_to_customer` string: Do not send sms to customer. in order to prevent sending sms the value must be yes. If not present -sms will be send
  - `card_number` integer: The 14-19 digit card number used for the transaction. The field is accepted when none of the following are present in the request. customer_id, token_id
  - `exp_month` integer: The month value displayed on the card used for the transaction. The field is accepted when none of the following are present in the request. customer_id, token_id
  - `exp_year` integer: The YYYY value mentioned on the card used for the transaction. The field is accepted when none of the following are present in the request. customer_id, token_id
  - `card_holder_name` string: Name of the cardholder as mentioned on the card used to carry out a transaction. The field is accepted when none of the following are present in the request. customer_id, token_id
  - `address_line1` string: The cardholder's billing address for line 1. The field is accepted when none of the following are present in the request. customer_id, token_id
  - `address_line2` string: The cardholder's billing address for line 2. The field is accepted when none of the following are present in the request. customer_id, token_id
  - `city` string: The cardholder's city name. Can be a City/District/Suburb/Town/Village. The field is accepted when none of the following are present in the request. customer_id, token_id
  - `state` string: The cardholder's state name. Can be State/County/Province/Region.
  - `zip` integer: The cardholder's billing ZIP code. The field is accepted when none of the following are present in the request. customer_id, token_id
  - `country` string: The cardholder's country name. The field is accepted when none of the following are present in the request. customer_id, token_id

## Response `201`

201

- union
  - object
    - `data` object
      - `object` string
      - `id` string
      - `amount` integer
      - `amount_refunded` integer
      - `amount_captured` string
      - `amount_voided` integer
      - `application_fee_amount` integer
      - `tip_amount` integer
      - `payarc_fees` integer
      - `type` string
      - `net_amount` integer
      - `captured` integer
      - `is_refunded` integer
      - `status` string
      - `auth_code` string
      - `failure_code` unknown
      - `failure_message` unknown
      - `charge_description` unknown
      - `statement_description` string
      - `invoice` unknown
      - `under_review` boolean
      - `created_at` integer
      - `updated_at` integer
      - `email` string
      - `phone_number` string
      - `card_level` string
      - `sales_tax` unknown
      - `purchase_order` unknown
      - `supplier_reference_number` unknown
      - `customer_ref_id` unknown
      - `ship_to_zip` unknown
      - `amex_descriptor` unknown
      - `customer_vat_number` unknown
      - `summary_commodity_code` unknown
      - `shipping_charges` unknown
      - `duty_charges` unknown
      - `ship_from_zip` unknown
      - `destination_country_code` unknown
      - `vat_invoice` unknown
      - `order_date` unknown
      - `tax_category` unknown
      - `tax_type` unknown
      - `tax_rate` unknown
      - `tax_amount` unknown
      - `created_by` string
      - `terminal_register` unknown
      - `tip_amount_refunded` unknown
      - `sales_tax_refunded` unknown
      - `shipping_charges_refunded` unknown
      - `duty_charges_refunded` unknown
      - `pax_reference_number` unknown
      - `refund_reason` unknown
      - `refund_description` unknown
      - `surcharge` integer
      - `toll_amount` unknown
      - `refund` object
        - `data` unknown[]
          - unknown
      - `card` object
        - `data` object
          - `object` string
          - `id` string
          - `address1` string
          - `address2` string
          - `card_source` string
          - `card_holder_name` string
          - `is_default` integer
          - `exp_month` string
          - `exp_year` string
          - `is_verified` integer
          - `fingerprint` string
          - `city` unknown
          - `state` unknown
          - `zip` string
          - `brand` string
          - `last4digit` string
          - `first6digit` integer
          - `country` unknown
          - `avs_status` unknown
          - `cvc_status` unknown
          - `address_check_passed` integer
          - `zip_check_passed` integer
          - `customer_id` string
          - `created_at` integer
          - `updated_at` integer
    - `meta` object
      - `include` string[]
      - `custom` unknown[]
        - unknown
  - object
    - `data` object
      - `object` string
      - `id` string
      - `amount` integer
      - `amount_refunded` integer
      - `amount_captured` string
      - `amount_voided` integer
      - `application_fee_amount` integer
      - `tip_amount` integer
      - `payarc_fees` integer
      - `type` string
      - `net_amount` integer
      - `captured` integer
      - `is_refunded` integer
      - `status` string
      - `auth_code` string
      - `failure_code` unknown
      - `failure_message` unknown
      - `charge_description` unknown
      - `statement_description` string
      - `invoice` unknown
      - `under_review` boolean
      - `created_at` integer
      - `updated_at` integer
      - `email` string
      - `phone_number` string
      - `card_level` string
      - `sales_tax` unknown
      - `purchase_order` unknown
      - `supplier_reference_number` unknown
      - `customer_ref_id` unknown
      - `ship_to_zip` unknown
      - `amex_descriptor` unknown
      - `customer_vat_number` unknown
      - `summary_commodity_code` unknown
      - `shipping_charges` unknown
      - `duty_charges` unknown
      - `ship_from_zip` unknown
      - `destination_country_code` unknown
      - `vat_invoice` unknown
      - `order_date` unknown
      - `tax_category` unknown
      - `tax_type` unknown
      - `tax_rate` unknown
      - `tax_amount` unknown
      - `created_by` string
      - `terminal_register` unknown
      - `tip_amount_refunded` unknown
      - `sales_tax_refunded` unknown
      - `shipping_charges_refunded` unknown
      - `duty_charges_refunded` unknown
      - `pax_reference_number` unknown
      - `refund_reason` unknown
      - `refund_description` unknown
      - `refund` object
        - `data` unknown[]
          - unknown
      - `card` object
        - `data` object
          - `object` string
          - `id` string
          - `address1` unknown
          - `address2` unknown
          - `card_source` string
          - `card_holder_name` unknown
          - `is_default` integer
          - `exp_month` string
          - `exp_year` string
          - `is_verified` integer
          - `fingerprint` string
          - `city` unknown
          - `state` unknown
          - `zip` unknown
          - `brand` string
          - `last4digit` string
          - `first6digit` integer
          - `country` unknown
          - `avs_status` unknown
          - `cvc_status` unknown
          - `address_check_passed` integer
          - `zip_check_passed` integer
          - `customer_id` unknown
          - `created_at` integer
          - `updated_at` integer
    - `meta` object
      - `include` string[]
      - `custom` unknown[]
        - unknown

## Other responses

- `422`: 422

## Changes

- **2026-11-03** `d3ee769894e4`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/payarc/apis/payarc-sandbox/changes/v1/charges%20%28COPY%29/post.md)

---

[API](https://skmtc.dev/payarc/apis/payarc-sandbox.md) - [All operations](https://skmtc.dev/payarc/apis/payarc-sandbox/llms.txt) - [OpenAPI document](https://skmtc.dev/payarc/apis/payarc-sandbox/revisions/d3ee769894e4?raw)