Payments

Handles payment transactions, allowing creation, retrieval, updates, confirmation, and cancellation of payments.

Overview

The Payment endpoints manage all operations related to payments. This includes creating a new payment, retrieving payment details, confirming a payment, partially updating the payment, and canceling a payment. These operations ensure that users can complete transactions effectively, modify payments as needed, and handle payment cancellations.

Endpoints

Method	Endpoint	Description
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.