Skip to main content

Confirm Payment

POST 

https://useast.api.elasticpath.com/v2/orders/:orderID/transactions/:transactionID/confirm

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.

Handling 3D Secure Validations for Stripe Payments

For 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 provider's side. We recommend using the Stripe's client libraries to manage these 3D Secure validations. Once the validation succeeds, proceed with a confirmation request to sync the validated transaction into Composable Commerce and continue with the payment process.

Request

Path Parameters

    orderID stringrequired

    The unique identifier of the order.

    transactionID stringrequired

    The unique identifier of the transaction.

Body

    dataobject

Responses

Response Headers
    Schema
      data object
      iduuid

      The ID of the transaction.

      referencestring

      The payment gateway reference.

      namestring

      A custom name associated with the payment method.

      custom_referencestring

      A reference associated with the payment method. This might include loyalty points or gift card identifiers. We recommend you not to include personal information in this field.

      gatewaystring

      The name of the payment gateway used.

      Possible values: [adyen, authorize_net, braintree, card_connect, cyber_source, elastic_path_payments_stripe, manual, paypal_express_checkout, stripe, stripe_connect, stripe_payment_intents]

      amountnumber

      The amount for this transaction.

      refunded_amountnumber

      The refunded amount.

      currencystring

      The transaction currency.

      transaction-typestring

      The type of transaction, such as purchase, capture, authorize or refund.

      statusstring

      The status provided by the gateway for this transaction, such as complete or failed.

      relationships object
      order object
      data object
      typestring

      Represents the type of the object being returned. It is always order.

      iduuid

      The ID of the order.

      meta object
      display_price object
      amountnumber

      The raw total.

      currencystring

      The currency set for this amount.

      formattedstring

      The formatted total based on the amount and currency.

      display_refunded_amount object
      amountnumber

      The raw total.

      currencystring

      The currency set for this amount.

      formattedstring

      The formatted total based on the amount and currency.

      timestamps object
      created_atstring

      The date this was created.

      updated_at

      The date this was last updated.

    Authorization: http

    name: bearerAuthtype: httpscheme: bearer
    var client = new HttpClient();
    var request = new HttpRequestMessage(HttpMethod.Post, "https://useast.api.elasticpath.com/v2/orders/:orderID/transactions/:transactionID/confirm");
    request.Headers.Add("Accept", "application/json");
    request.Headers.Add("Authorization", "Bearer <token>");
    var content = new StringContent("{\n \"data\": {}\n}", null, "application/json");
    request.Content = content;
    var response = await client.SendAsync(request);
    response.EnsureSuccessStatusCode();
    Console.WriteLine(await response.Content.ReadAsStringAsync());
    Request Collapse all
    Base URL
    https://useast.api.elasticpath.com
    Auth
    Parameters
    — pathrequired
    — pathrequired
    Body
    {
      "data": {}
    }
    
    ResponseClear

    Click the Send API Request button above and see the response here!

    We use cookies to enhance your experience. By continuing to visit this site you agree to our use of cookies.