Payments

Use our Payments endpoints to take payments from a card in card-present environments, e‑Commerce environments, or MOTO environments.

Integrate with our Create Payment method to run a sale or a pre-authorization. When you send a successful request, our gateway returns a paymentId for the transaction, which you can use to:

Retrieve the details of the transaction

Integrate with our Retrieve Payment method to view transaction details for a specific transaction, such as the order information, the payment card details, and the transaction result.

Integrate with our List Payments method to return a paginated list of transactions that meet specific query parameters.

Adjust the details of the transaction

Integrate with our Adjust Payment method to change the following details of a transaction:

• Order amount and tip amount
• Status of the transaction
• Cardholder’s shipping address and contact information
• Cardholder’s signature

Capture the transaction

Integrate with our Capture Payment method to capture a pre-authorization.

Reverse the transaction

We have three methods to reverse a transaction:

• If the transaction is in an open batch, the merchant must cancel the transaction. To cancel a transaction, integrate with our Reverse Payment method.
• If the transaction is in a closed batch and the merchant has the paymentId of the transaction, the merchant must refund the transaction. To refund a transaction, integrate with our Refund Payment method.
• If the transaction is in a closed batch and the merchant doesn’t have the paymentId of the transaction, the merchant must run an unreferenced refund. To run an unreferenced refund, integrate with our Create Refund method.