Payment attempts

Manages payment attempts, allowing creation, retrieval, updates, and deletion of payment attempts for transactions.

Overview

The payment-attempts endpoints handle the operations for creating, retrieving, updating, and deleting payment attempts. Payment attempts represent the initial step in processing a transaction, where the details such as amount, currency, and payment methods are specified. These endpoints allow for flexible management of the payment attempts during the transaction flow.

Endpoints

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

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.