Overview
The Payment API enables you to securely and efficiently process Mail Order Telephone Order transactions. The payment is initiated by the merchant entering the customer’s card information. The API is designed for you to build your own virtual terminal system to enter remote order details. The transaction will not need to go through 3DS.
Features
Transaction information
To ensure each transaction is unique and trackable, the API provides multiple ways to monitor the transaction's status before and after processing.
Payment Intent: Each transaction must be associated with a payment intent. This allows you to track the entire payment journey, from initiation to completion.
Transaction Unique: Transactions require a unique reference called
transaction_unique
. This reference is useful for reconciliation or tracking, and you can either generate it yourself or use thetransaction_unique
provided by the Intents API.Transaction ID: Once a transaction is processed, a
transaction ID
will be generated. This ID can be used to track the transaction through various states.
Customer Information
It is mandatory to include the customer’s name and email with each transaction. This information helps you identify the transaction, whether it's linked to an invoice or order, or if a refund is needed. If email receipts are enabled, the customer will receive a receipt at the provided email address. Additionally, you can send the billing address and postcode. While these fields are optional, they may be required for additional AVS (Address Verification Service) security checks.
Additional information
You can include extra data in a JSON-encoded string called merchant_data
. This feature is useful when integrating with third-party systems that require additional fields, such as order details, inventory, or multiple invoice references.
Repeat Payments
As well as single payments, it is possible to create subscription payment cycles from a MOTO transaction. Click here for more details.
Endpoints Overview
POST creditcards: This endpoint is to charge customers via card either by MOTO or ECOM transactions.