Sign in
Payments

Create payment

Use this method to run a sale or a pre-authorization with a customer's payment card.

In the response, our gateway returns information about the card payment and a paymentId, which you need for the following methods:

Payment methods

  • Cards - Credit, debit, and EBT
  • Digital wallets - Apple Pay® and Google Pay®
  • Tokens - Secure tokens and single-use tokens

Features

Our Create Payment method also supports the following features:

  • Repeat payments - Run multiple payments as part of a payment schedule that you manage with your own software.
  • Offline sales - Run a sale or a pre-authorization if the terminal loses its connection to our gateway.
  • Tokenization - Save card details to use in future transactions.
  • 3-D Secure - Verify the identity of the cardholder.
  • Custom fields - Add your own data to a payment.
  • Tips - Add tips to the card payment.
  • Taxes - Add local taxes to the card payment.
  • Surcharging - Add a surcharge to the card payment.
  • Dual pricing - Offer different prices based on payment method, for example, if you use our RewardPay Choice pricing program.
  • Healthcare - Accept payments from Health Savings Accounts (HSA) and Flexible Spending Accounts (FSA).
post/payments

Headers

Authorizationstring required

Bearer authentication

Idempotency-Keystring uuid required

Unique identifier that you generate for each request. You must use the UUID v4 format for the identifier. For more information about the idempotency key, go to Idempotency.

Request body

channel'pos' | 'web' | 'moto' required

Channel that the merchant used to receive the payment details.

processingTerminalIdstring required

Unique identifier that we assigned to the terminal.

operatorstring

Operator who ran the transaction.

autoCaptureboolean

Indicates if we should automatically capture the payment amount.

  • true - Run a sale and automatically capture the transaction.
  • false- Run a pre-authorization and capture the transaction later.

Note: If you send false and the terminal doesn't support pre-authorization, we set the transaction's status to pending. The merchant must capture the transaction to take payment from the customer.

processAsSaleboolean

Indicates if we should immediately settle the sale transaction. The merchant cannot adjust the transaction if we immediately settle it.

Note: If the value for processAsSale is true, the gateway ignores the value in autoCapture.

Response

Successful request. We processed the transaction.

paymentIdstring required

Unique identifier that our gateway assigned to the transaction.

processingTerminalIdstring required

Unique identifier of the terminal that initiated the transaction.

operatorstring

Operator who initiated the request.

supportedOperationsSupportedOperationsItems[]

Array of operations that you can perform on the transaction. Our gateway can return any of the following values:

Changes

No recorded changes to this endpoint across all 1 revision of this API.