Payments API (4.3.0)

Download OpenAPI specification:Download

Welcome to the documentation for the Truevo Payments API. These APIs provide a unified interface to securely accept and process payment transactions. Using this API, you can perform various payment operations through a uniform, secure and reliable interface. All new integrations are supported with modern REST APIs using the JSON standard for data payloads. Each operation is implemented through a multistep process that supports reliable rapid communication. All operations are performed using a two-step approach. The first step involves requesting a transaction to be performed. The second step is to ask for the outcome of that request. For example, you may request an authorisation to be performed, providing the card details and transaction amount. The system will acknowledge this request. Following this, you will request the information required to determine whether the transaction was successfully authorised. By using a two-step approach, no long-running connection is required. Truevo will immediately respond with an acknowledgement allowing both parties to continue their operations. This limits failures due to poor network conditions; allows for retry and recoverability, and facilitates better resource usage.

Payments

Payment Services. This section contains the direct Truevo payment endpoints.

Authorise a Payment

Create a new payment and request an authorization hold. This amount can be captured in a later request. If not captured, delayed cancellation will occur.

Authorizations:
TokenAuthorizer
header Parameters
idempotencyKey
required
string

Idempotency allows a request to be retried multiple times without the operation being performed more than once. A unique identifier must be provided in this parameter to identify the request and prevent duplicate processing. It is recommended that you utilize a GUID or similar mechanism.

authorization
required
string

Bearer token used to authenticate the request.

Request Body schema: application/json
required
object (transaction)

Details specific to the transaction being processed.

required
object (merchant)

Details specific to the merchant processing the transaction.

required
object

Details related to the card.

object (initiateSecureEcommerce)

Details required to initiate a secure ecommerce payment

object (secureEcommerce)

Details required for a secure ecommerce payment

object (recurringData)

Details related to Recurring transactions.

object (terminal)

Details specific to the card terminal

object (customer)

Details specific to the customer

Array of objects (additionalData)

Additional data can be provided in this field. This may be required by Truevo to support certain types of transactions or operations.