Confirm Payment

POST/v2/orders/{orderID}/transactions/{transactionID}/confirm

Use it in a workflow

Add a step and choose the Elastic Path connector.
Pick the Confirm Payment action (under Carts).
Fill in the fields below, then reference the result from later steps as {{confirmPayment.response.data}}.

Request

Path parameters

orderIDstringrequired

The unique identifier of the order.

transactionIDstringrequired

The unique identifier of the transaction.

Response

Returns 200 with an object. Read it in later steps with {{confirmPayment.response.data.<field>}}.

dataobject

idstring (uuid)

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.

One ofadyenauthorize_netbraintreecard_connectcyber_sourceelastic_path_payments_stripemanualpaypal_express_checkoutstripestripe_payment_intentsstripe_platform_account

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`.

One ofpurchaseauthorizecapturerefund

typestring

The type of object being returned.

statusstring

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

payment_detailsobject1 fields

Payment gateway specific details.

failure_detailsobject2 fields

Non-PII payment failure information from the payment gateway. Only present on failed transactions where the gateway provided structured failure details.

payment_intentobject

Payment intent details.

capture_mechanismstring

The mechanism used for capturing the transaction.

One ofautomaticmanual

refund_mechanismstring

The mechanism used for refunding the transaction.

One ofautomaticmanual

client_parametersobject3 fields

Client-specific parameters for payment processing.

next_actionsarray<string>

Array of next actions for the transaction.

relationshipsobject1 fields

metaobject3 fields

json

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "reference": "string",
    "name": "string",
    "custom_reference": "string",
    "gateway": "adyen",
    "amount": 0,
    "refunded_amount": 0,
    "currency": "string",
    "transaction_type": "purchase",
    "type": "string",
    "status": "string",
    "payment_details": {
      "detailed_status": "string"
    }
  }
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.

Was this page helpful?