For AI agents: the complete documentation index is at /llms.txt, and the full text of every page is at /llms-full.txt. Most pages are also available as Markdown by adding .md to the URL.

In-Store - Sale transaction

Create a card present sales transaction to charge a credit, debit, or prepaid card.

Important: For authentication, you must include the required HTTPS headers in each request. For more information about the authentication HTTPS headers, see Authenticating Your Requests.

Important

To save the customer's card details to use for future transactions, send a value of true in the create_token parameter in your request. If you send a value of true in the create_token parameter, you must also send a value in the create_token_reason parameter.

Endpoints

Environment	HTTP Method	URL
Partner Integration Test	POST	https://api.pit.paygateway.com/transactions/cardpresent/sales
Production	POST	https://api.paygateway.com/transactions/cardpresent/sales

Sample request

Content-Type: application/json
Authorization: AuthToken {AuthTokenV2}
X-GP-Request-Id: {request_id}
X-GP-Version: 2021-04-08
X-GP-Api-Key: {API Key}
X-GP-Source-App-Version: {Version of integrating application}
X-GP-Source-App-Name: {Name of integrating application}
{
  "reference_id": "XAZR863990",
  "payment": {
    "amount": "225.09",
    "currency_code": "840",
    "invoice_number": "239087",
    "gratuity_eligible_amount": "10.00",
    "healthcare_amounts": {
      "copay_amount": "23.09",
      "clinical_amount": "23.09",
      "dental_amount": "23.09",
      "prescription_amount": "23.09",
      "vision_amount": "23.09",
      "healthcare_total_amount": "23.09"
    },
    "purchase_order": {
      "destination_postal_code": "84042",
      "po_number": "2343445",
      "tax_amount": "20.01"
    }
  },
  "receipt": {
    "clerk_id": "Al090-John Doe"
  },
  "transaction": {
    "keyed_entry_mode": "allowed",
    "country_code": "840",
    "language": "en-US",
    "processing_indicators": {
      "allow_duplicate": true,
      "create_token": true,
      "partial_approval": true
    },
    "create_token_reason": "unscheduled_merchant_initiated_transaction",
    "terminal": {
      "terminal_id": "90030234"
    }
  }
}

Sample response

{
  "invoice_number": "239087",
  "amount": "23.09",
  "status": "completed",
  "currency_code": "840",
  "gratuity_amount": "10.00",
  "transactions": [
    {
      "tender_type": "credit",
      "entry_type": "contactless",
      "id": "0000012345678903266",
      "reference_id": "XAZR863990",
      "status": "approved",
      "status_code": "200",
      "processor_response": "APPROVAL ADB123",
      "transaction_datetime": "2019-12-15T13:00:00Z",
      "credit_attributes": {
        "approval_code": "ADB123",
        "avs_response": "full_match",
        "avs_response_description": "Match - Street Address",
        "cardsecurity_response": "match",
        "payment": {
          "amount": "23.09",
          "cashback_amount": "10.00",
          "type": "credit",
          "fees": {
            "customer_fee_amount": "10.03",
            "surcharge_amount": "10.03"
          }
        },
        "card": {
          "masked_card_number": "XXXXXXXXXXX5538",
          "cardholder_name": "Joe Doe",
          "expiry_month": "03",
          "expiry_year": "23",
          "token": "EnzMcSVlkP",
          "type": "visa",
          "balance": "12.09",
          "postal_code": "84042",
          "rfmiq": "ADB12",
          "card_on_file_attributes": {
            "tokenization_error_code": "ADB12",
            "tokenization_error_message": "ADB12"
          }
        },
        "emv": {
          "amount": {
            "amount_authorized": "225.09",
            "amount_other": "225.09"
          },
          "icc": {
            "dedicated_file_name": "A000000004101",
            "application_label": "Visa",
            "application_expiry_date": "string",
            "application_effective_date": "string",
            "application_interchange_profile": "5C00",
            "application_version_number": "0001",
            "application_transaction_counter": "3601",
            "application_usage_control": "stri",
            "application_preferred_name": "4D617374657243617264",
            "application_display_name": "string",
            "application_pan_sequence_number": "99",
            "application_cryptogram": "AC2E521325F52EEC",
            "application_cryptogram_type": "TC",
            "cardholder_verification_method_results": "string",
            "issuer_application_data": "0210A0800F240000000000000000000000FF",
            "terminal_verification_results": "0200008000",
            "unpredictable_number": "95637FFD",
            "pos_entry_mode": "st",
            "terminal_type": "21",
            "ifd_serial_number": "stringstringstri",
            "terminal_country_code": "840",
            "terminal_identification": "stringstringstri",
            "tac_default": "ABCFFF",
            "tac_denial": "ABCFFF",
            "tac_online": "ABCFFF",
            "transaction_type": "00",
            "transaction_currency_code": "840",
            "transaction_status_information": "E800",
            "cryptogram_information_data": "80",
            "pin_statement": "PIN Verified",
            "cvm_method": "string",
            "iac_default": "AABB32",
            "iac_denial": "AABB32",
            "iac_online": "string",
            "authorization_response_code": "st"
          }
        }
      },
      "debit_attributes": {
        "approval_code": "ADB123",
        "avs_response": "full_match",
        "avs_response_description": "Match - Street Address",
        "cardsecurity_response": "match",
        "payment": {
          "amount": "23.09",
          "cashback_amount": "10.00",
          "type": "credit",
          "fees": {
            "customer_fee_amount": "10.03",
            "surcharge_amount": "10.03"
          }
        },
        "card": {
          "masked_card_number": "XXXXXXXXXXX5538",
          "cardholder_name": "Joe Doe",
          "expiry_month": "03",
          "expiry_year": "23",
          "token": "EnzMcSVlkP",
          "type": "visa",
          "balance": "12.09",
          "postal_code": "84042",
          "debit_trace_number": "dbttrace",
          "rfmiq": "ADB12",
          "card_on_file_attributes": {
            "tokenization_error_code": "ADB12",
            "tokenization_error_message": "ADB12"
          }
        },
        "emv": {
          "amount": {
            "amount_authorized": "225.09",
            "amount_other": "225.09"
          },
          "icc": {
            "dedicated_file_name": "A000000004101",
            "application_label": "Visa",
            "application_expiry_date": "string",
            "application_effective_date": "string",
            "application_interchange_profile": "5C00",
            "application_version_number": "0001",
            "application_transaction_counter": "3601",
            "application_usage_control": "stri",
            "application_preferred_name": "4D617374657243617264",
            "application_display_name": "string",
            "application_pan_sequence_number": "99",
            "application_cryptogram": "AC2E521325F52EEC",
            "application_cryptogram_type": "TC",
            "cardholder_verification_method_results": "string",
            "issuer_application_data": "0210A0800F240000000000000000000000FF",
            "terminal_verification_results": "0200008000",
            "unpredictable_number": "95637FFD",
            "pos_entry_mode": "st",
            "terminal_type": "21",
            "ifd_serial_number": "122424",
            "terminal_country_code": "840",
            "terminal_identification": "6234534",
            "tac_default": "ABCFFF",
            "tac_denial": "ABCFFF",
            "tac_online": "ABCFFF",
            "transaction_type": "00",
            "transaction_currency_code": "840",
            "transaction_status_information": "E800",
            "cryptogram_information_data": "80",
            "pin_statement": "PIN Verified",
            "cvm_method": "string",
            "iac_default": "AABB32",
            "iac_denial": "AABB32",
            "iac_online": "string",
            "authorization_response_code": "st"
          }
        }
      }
    }
  ]
}

Policies

Connect