Skip to main content
Every request goes to:
  • HTTPS only, port 443.
  • POST the request for the action, in JSON or XML (Formats).
  • Authenticate with the register’s key in the request’s CardPointeUsername (the key id) and CardPointePassword (the secret) fields (Keys).
  • The MID in the request (MerchantId, or MerchId for voids, refunds and captures) says which merchant account to use. It must be linked to the key’s location.

Example: a sale on the terminal

The terminal asks the customer to pay; the response comes back once they have (or the sale is declined or cancelled):

What a location controls

How the terminal behaves (tips, signatures, PIN debit, CVV and ZIP prompts) is set per location in the portal, not in the request: see Terminal settings.

Next

  • Actions: everything the gateway does.
  • Errors: what each message means.