Use the Create a charge endpoint to charge a credit cards or other payment sources.

Before you begin

The best practice is to initially create a charge in the sandbox environment so that any given payment source, such as a credit card, is not charged. Before you begin, see Ecommerce tokens, permission, and settings.

Prerequisites

Generate a card token. You need to generate a new card token for each payment.

Steps

1. Send a POST request to the v1/charges endpoint to create a charge.
2. Enter the required parameters in the request:
   1. amount
   2. currency
   3. source
3. Use the source token from the v1/charges endpoint to create and pay for orders and accept tips. For example, to process a payment with your app, use the v1/charges endpoint to autocreate an order and perform the transaction. The payment is charged to a source, which is a credit card or debit card tokenized with the hosted tokenizer.

Request example

The following table describes the request parameters to create a charge:

curl --request POST \
     --url 'https://scl-sandbox.dev.clover.com/v1/charges' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer ab86a5e8-48f3-b3bd-8c45-d415e9867833' \
     --header 'Content-Type: application/json' \
     --header 'x-forwarded-for: {client_ip}' \
     --data '{"ecomind":"ecom"}'\

Request parameters

The following table describes the request parameters to use when creating a charge:

Multi Currency Pricing (MCP)

Clover offers multi-currency pricing by allowing local currency codes in the currency field. Merchants in Canada and can accept payment, and submit refunds in regional currencies with settlement currency as USD. Once the customer completes the transaction in their submitted currency, Clover uses the current exchange rate at the time of authorization to estimate the paid amount in USD. This amount displays in the merchant's closeout report.

To use this feature, merchants need to create a charge with a currency other than USD, and the MCP allows the gateway to accept it for authentication. Clover supports MCP only for Mastercard^® and Visa^®. Hence, make sure your merchants submit charges in USD for any other network transactions.

Example: A US merchant expands their online market and starts servicing in London through e-commerce and can now accept payments in euros.

Note: The digital receipt displays transaction details in the currency selected by the customer, and the transactions detail screen displays the settlement amount in the merchant’s local currency.

Response example

{
  "id": "ABDFEFG1HIJK2", 
  "amount": 122,
  "payment_method_details": "card",
  "amount_refunded": 0,
  "currency": "usd",
  "created": 123456789123,
  "captured": true,
  "ref_num": 987654321,
  "auth_code": 123456,
  "outcome": {
    "network_status": "approved_by_network",
    "type": "authorized"
  },
  "paid": true,
  "status": "succeeded",
  "source": {
    "id": "clv_1AAAAAAbCdefJK2l3MnoPQ4r",
    "brand": "DISCOVER",
    "exp_month": 12,
    "exp_year": 2025,
    "first6": 112233,
    "last4": 1111
  },
  "ecomind": "ecom"
}

Possible responses

The following table describes the possible responses when running the create a charge endpoint: