{ "opencollection": "1.0.0", "info": { "name": "Addresses Introduction Account Addresses Payments API", "version": "25.1126.6886238" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Payments", "type": "folder" }, "items": [ { "info": { "name": "Create Stripe Payment Intent for a Cart", "type": "http" }, "http": { "method": "POST", "url": "https://useast.api.elasticpath.com/v2/carts/:cartID/payments", "params": [ { "name": "cartID", "value": "", "type": "path", "description": "The universally unique identifier of the cart for which you want to create a payment intent." } ], "body": { "type": "json", "data": "{}" } }, "docs": "The Cart Payment Intent feature enables the creation of a Stripe Payment Intent specifically tied to a shopping cart and its subsequent order. This allows Payment Intent users to track payment details from the cart stage and seamlessly maintain consistency in payment information throughout the order stage. Using these features, you can create Payment Intents for their carts, update Payment Intents with final cart details, and synchronize Payment Intents from Stripe to Commerce.\n\n:::note\n\n- Typic" }, { "info": { "name": "Payments", "type": "http" }, "http": { "method": "POST", "url": "https://useast.api.elasticpath.com/v2/orders/:orderID/payments", "params": [ { "name": "orderID", "value": "", "type": "path", "description": "The Universally Unique Identifier (UUID) of the order you want to pay for." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Depending on the payment gateway, you may have access to different transaction types such as capturing funds immediately or authorizing them for later. For more information, see [Payments](/docs/api/carts/payments).\n\nThe following types of payment methods are available depending on the payment gateway:\n\n- `purchase`: This is the simplest method. The gateway attempts to charge the customer immediately.\n- `authorize`: This method authorizes a payment so that funds can be captured later, for exampl" }, { "info": { "name": "Confirm Payment", "type": "http" }, "http": { "method": "POST", "url": "https://useast.api.elasticpath.com/v2/orders/:orderID/transactions/:transactionID/confirm", "params": [ { "name": "orderID", "value": "", "type": "path", "description": "The unique identifier of the order." }, { "name": "transactionID", "value": "", "type": "path", "description": "The unique identifier of the transaction." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Confirm Payment serves as a mechanism to synchronize transaction information from the third-party payment provider back to our system. This ensures that Composable Commerce accurately reflects the values from the payment provider.\n\n### Handling 3D Secure Validations for Stripe Payments\n\nFor Stripe Payments requiring 3D Secure validation, the transaction response will include the `client_parameters` object, which provides credentials to support validation of these payment requests on the payment " }, { "info": { "name": "Capture a Transaction", "type": "http" }, "http": { "method": "POST", "url": "https://useast.api.elasticpath.com/v2/orders/:orderID/transactions/:transactionID/capture", "params": [ { "name": "orderID", "value": "", "type": "path", "description": "The UUID of the order." }, { "name": "transactionID", "value": "", "type": "path", "description": "The UUID of the transaction to capture." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to capture a previously authorized payment. In this step, you can also pass in a custom reference, such as the payment reference from your chosen gateway." }, { "info": { "name": "Refund a Transaction", "type": "http" }, "http": { "method": "POST", "url": "https://useast.api.elasticpath.com/v2/orders/:orderID/transactions/:transactionID/refund", "params": [ { "name": "orderID", "value": "", "type": "path", "description": "The UUID of the order." }, { "name": "transactionID", "value": "", "type": "path", "description": "The UUID of the transaction you want to refund." } ], "body": { "type": "json", "data": "{}" } }, "docs": "There are two ways to refund; through your payment gateway and mark it refunded in Commerce Manager, or directly through Commerce Manager or API.\n\n* Mark as Refunded: You can manually mark a transaction as refunded. Before you can mark the order as refunded, you need to handle the actual refund on your side with your payment provider. Mark as Refunded is a full refund made to the transaction.\n* Refund through Composable Commerce: You can process a full or partial refund to a supported payment pr" }, { "info": { "name": "Get Order Transactions", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/v2/orders/:orderID/transactions", "params": [ { "name": "orderID", "value": "", "type": "path", "description": "The unique identifier of the order." } ] }, "docs": "Get order transactions" }, { "info": { "name": "Get a Transaction", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/v2/orders/:orderID/transactions/:transactionID", "params": [ { "name": "orderID", "value": "", "type": "path", "description": "The unique identifier of the order that you require transactions for." }, { "name": "transactionID", "value": "", "type": "path", "description": "The unique identifier of the transaction." } ] }, "docs": "Retrieves a transaction" }, { "info": { "name": "Cancel a Transaction", "type": "http" }, "http": { "method": "POST", "url": "https://useast.api.elasticpath.com/v2/orders/:orderID/transactions/:transactionID/cancel", "params": [ { "name": "orderID", "value": "", "type": "path", "description": "The unique identifier of the order." }, { "name": "transactionID", "value": "", "type": "path", "description": "The unique identifier of the transaction to be canceled or voided." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to cancel or void a pending or authorized transaction. The transaction can be canceled or voided when it is in `pending` and `completed` statuses.\n\n:::caution\n\nThis endpoint works only for Stripe and PayPal and does not work for manual gateway.\n\n:::\n" } ] } ], "bundled": true }