v1

latestOpenAPI 3.0.1Apache 2.02026-07-2647148658.0 KB
Checkout

Create a checkout

post/v2/checkout

Request body

OR

Example request

{
  "entity_id": "a6b45428-0296-4394-8ddd-0b50b5b20aa9",
  "currency_code": "USD",
  "amount": 1000,
  "merchant_reference": "ORDER-12345",
  "return_url": "https://merchant.example.com/order/success",
  "interaction_type": "HPP",
  "receipt_type": "FULL_RECEIPT",
  "configurations": {
    "card": {
      "mode": "PAYMENT",
      "payment_contract_id": "e3d4f5a6-b7c8-9d0e-1f2a-3b4c5d6e7f8a",
      "capture_now": true,
      "threed_secure": {
        "enabled": true,
        "threeds_contract_id": "c1d2e3f4-a5b6-7c8d-9e0f-1a2b3c4d5e6f"
      }
    }
  },
  "customer_details": {
    "entity_id": "a6b45428-0296-4394-8ddd-0b50b5b20aa9",
    "email_address": "shopper@example.com",
    "billing": {
      "first_name": "Jane",
      "last_name": "Doe",
      "address_1": "123 Main Street",
      "city": "New York",
      "state": "NY",
      "postal_code": "10001",
      "country_code": "US"
    }
  },
  "line_items": [
    {
      "name": "Widget Pro",
      "quantity": 2,
      "unit_price": 499,
      "total_amount": 998,
      "sku": "WGT-PRO-001"
    }
  ]
}

Response

Successful

idstring required

Checkout ID

urlstring

URL of the Checkout

Example response

{
  "id": "f8e7d6c5-b4a3-2f1e-0d9c-8b7a6e5f4d3c",
  "url": "https://emea.gsc.verifone.cloud/pay/f8e7d6c5-b4a3-2f1e-0d9c-8b7a6e5f4d3c"
}