Transactions

Manages transactions through various operations, including simulating transactions, handling payment attempts, and processing payments.

Overview

The Transaction page covers all the key operations related to transactions. It includes simulating transactions, managing payment attempts (creating, retrieving, updating, and deleting), and handling payments (creating, confirming, canceling). It also supports adding and removing payment methods for payment attempts, ensuring a smooth transaction flow from initiation to completion.

Endpoints

Method	Endpoint	Description
POST	/simulates	Simulates a transaction for testing purposes.
POST	/payment-attempts	Creates a new payment attempt for a transaction.
GET	/payment-attempts/{transactionId}	Retrieves details of a specific payment attempt.
PATCH	/payment-attempts/{transactionId}	Partially updates a payment attempt.
PUT	/payment-attempts/{transactionId}	Fully replaces an existing payment attempt.
DELETE	/payment-attempts/{transactionId}	Deletes a payment attempt.
POST	/payment-attempts/{transactionId}/origins	Adds payment methods (origins) to a payment attempt.
POST	/payment-attempts/{transactionId}/destinations	Adds payment methods (destinations) to a payment attempt.
DELETE	/payment-attempts/{transactionId}/origins/{name}	Removes a payment origin from a payment attempt.
DELETE	/payment-attempts/{transactionId}/destinations/{name}	Removes a payment destination from a payment attempt.
POST	/payments	Creates a new payment.
GET	/payments/{transactionId}	Retrieves details of a payment.
PATCH	/payments/{transactionId}	Partially updates a payment.
POST	/payments/{transactionId}/confirm	Confirms a payment and completes the transaction.
DELETE	/payments/{transactionId}	Cancels a payment before it is confirmed.

Security

This API is secured using API key and Bearer token authentication.

• API Key: Include the x-api-key in the header.

• Bearer Token: Authenticate with a JWT bearer token.

Models

For more detailed information about the models and related fields, please refer to the model page

Model	Description
Transaction	Represents the details of the transaction, including amounts, type, and status.
Payment	Represents the methods (origins/destinations) added to the payment attempt.
Quote	Represents a currency exchange quote, including details like exchange rate, provider, and fees related to the exchange.