Commerce Cloud

Elastic Path Payments Powered by Stripe

The Elastic Path Payments Powered by Stripe integration supports the following payment methods:

  • authorize
  • capture
  • confirm
  • purchase
  • refund
note

You can contact Elastic Path sales or customer success team to get more information about Elastic Path Payments powered by Stripe and to check whether it will work for you.

Authorization or Purchase - POST Pay by token or source

https://api.moltin.com/v2/orders/:orderId/payments

Parameters

Path parameters

NameRequiredTypeDescription
orderIdRequiredstringThe Universally Unique Identifier (UUID) of the order that you want to pay for.

Headers

NameRequiredTypeDescription
AuthorizationRequiredstringThe Bearer token required to get access to the API.

Body

NameRequiredTypeDescription
options.idempotency_keyOptionalstringProvides the option to send a Stripe Idempotency Key.
options.receipt_emailOptionalstringProvides the email address to which you want to send the Stripe receipts for the transactions within the store. This feature is available only in the live mode.
paymentRequiredstringSpecifies the Stripe token or source.
options.customerOptionalstringSpecifies the Stripe customer ID. This is required if you want to send a source.
methodRequiredstringSpecifies the transaction method, such as purchase or authorize.
gatewayRequiredstringSpecifies the gateway. You must use elastic_path_payments_stripe as the required gateway.

Request examples

We recommend that you use the payment method or source with Stripe payments. For more information about generating a payment method on the client-side, see the Stripe Elements documentation.

important

When you pass source instead of a token, ensure that you include the Stripe customer ID in the request.

Curl

curl -X POST https://api.moltin.com/v2/orders/:orderId/payments \
     -H "Authorization: Bearer XXXX" \
     -d $'{
        "data": {
          "gateway": "elastic_path_payments_stripe",
          "method": "purchase",
          "payment": "pm_card_threeDSecureRequired",
          "options": {
            "receipt_email": "john@example.com"
          }
        }
      }'

JavaScript SDK

const MoltinGateway = require('@moltin/sdk').gateway
const Moltin = MoltinGateway({
  client_id: 'X'
})
const id = 'XXXX'
const payment = {
  gateway: 'elastic_path_payments_stripe',
  method: 'purchase',
  payment: 'pm_card_threeDSecureRequired'
}
Moltin.Orders.Payment(id, payment).then(() => {
  // Do something
})

Response example

201 Created

note

The x values in the "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" are replaced with the returned values.

{
    "data": {
        "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "type": "transaction",
        "reference": "pi_xxxxxxxxxxxxx",
        "gateway": "elastic_path_payments_stripe",
        "amount": 5499,
        "currency": "USD",
        "transaction-type": "purchase",
        "transaction_type": "purchase",
        "status": "pending",
        "relationships": {
            "order": {
                "data": {
                    "type": "order",
                    "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
                }
            }
        },
        "meta": {
            "display_price": {
                "amount": 5499,
                "currency": "USD",
                "formatted": "$54.99"
            },
            "created_at": "2019-08-28T10:40:21.925Z",
            "timestamps": {
                "created_at": "2019-08-28T10:40:21Z",
                "updated_at": "2019-08-28T10:40:23Z"
            }
        },
        "client_parameters": {
            "token": "pi_xxxxxxxxxxxxxxxx",
            "secret": "pi_xxxxxxxxxxxxxx_secret_xxxxxxxxxxxxxx"
        }
    }
}

Confirmation - POST Confirm the security validation succeeded

https://api.moltin.com/v2/orders/:orderId/transactions/:transactionId/confirm

Parameters

Path Parameters

NameRequiredTypeDescription
orderIdRequiredstringThe UUID of the order that you want to pay for.
transactionIdRequiredstringThe UUID of the transaction that requires client action to process validation.

Headers

NameRequiredTypeDescription
AuthorizationRequiredstringThe Bearer token required to get access to the API.

Request example - curl

If the response for the authorization or purchase request consists of client_parameters, Stripe might required client action to perform a 3D Secure validation. Use the Stripe client libraries and process the 3D Secure validation. When the validation succeeds, continue the payment processing by making a request as in the following example:

curl -X POST https://api.moltin.com/v2/orders/:orderId/transactions/:transactionId/confirm \
     -H "Authorization: Bearer XXXX" \
     -d $'{
        "data": {
        }
      }'

Response example

201 Created

note

The x values in the "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" are replaced with the returned values.

{
    "data": {
        "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "type": "transaction",
        "reference": "xxxxxx",
        "gateway": "elastic_path_payments_stripe",
        "amount": 100,
        "currency": "USD",
        "transaction_type": "purchase",
        "status": "complete",
        "relationships": {
            "order": {
                "data": {
                    "type": "order",
                    "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
                }
            }
        },
        "meta": {
            "display_price": {
                "amount": 100,
                "currency": "USD",
                "formatted": "$100.00"
            },
            "timestamps": {
              "created_at": "2020-05-25T20:58:57Z",
              "updated_at": "2020-05-25T13:59:01-07:00"
            }
        }
    }
}

Confirmation - POST Capture the payment authorization

https://api.moltin.com/v2/orders/:orderId/transactions/:transactionId/capture

Use this endpoint to capture a transaction initiated by the shopper. Usually capture does not occur at the same time as authorization. For more information, see the Capture section.

Parameters

Path parameters

NameRequiredTypeDescription
orderIdRequiredstringThe UUID of the order that you want to pay for.
transactionIdRequiredstringThe UUID of the successful transaction for this payment.

Headers

NameRequiredTypeDescription
AuthorizationRequiredstringThe Bearer token required to get access to the API.

Request example - curl

curl -X POST https://api.moltin.com/v2/orders/:orderId/transactions/:transactionId/capture \
     -H "Authorization: Bearer XXXX"

Response example

201 Created

note

The x values in the "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" are replaced with the returned values.

{
    "data": {
        "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "type": "transaction",
        "reference": "xxxxxx",
        "gateway": "elastic_path_payments_stripe",
        "amount": 100,
        "currency": "USD",
        "transaction_type": "capture",
        "status": "complete",
        "relationships": {
            "order": {
                "data": {
                    "type": "order",
                    "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
                }
            }
        },
        "meta": {
            "display_price": {
                "amount": 100,
                "currency": "USD",
                "formatted": "$100.00"
            },
            "timestamps": {
              "created_at": "2020-05-25T20:58:57Z",
              "updated_at": "2020-05-25T13:59:01-07:00"
            }
        }
    }
}

Refund - Post Refund the Payment

https://api.moltin.com/v2/orders/:orderId/transactions/:transactionId/refund

Use this endpoint to refund the amount initiated by the shopper.

Parameters

Path parameters

NameRequiredTypeDescription
orderIdRequiredstringThe UUID of the order that you want to pay for.
transactionIdRequiredstringThe UUID of the successful transaction for this payment.

Headers

NameRequiredTypeDescription
AuthorizationRequiredstringThe Bearer token required to get access to the API.

Body

NameRequiredTypeDescription
amountRequiredintegerSpecifies the amount to be refunded.
options.note_to_payerOptionalstringSpecifies the reason for the refund. It appears in both the transaction history of the payer and the emails that the payer receives.

Request example - Curl

curl -X POST https://api.moltin.com/v2/orders/:orderId/transactions/:transactionId/refund \
     -H "Authorization: Bearer XXXX"
     "data": {
     "amount": 1,
      "options": {
       "note_to_payer": "Test note to payer"
    }
  }
}

Response example

200 OK

{
    "data": {
        "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "type": "transaction",
        "reference": "pi_3Kr4EBHGgiZNYgWz1eio9cFS",
        "gateway": "elastic_path_payments_stripe",
        "amount": 80000,
        "refunded_amount": 2,
        "refund_mechanism": "automatic",
        "currency": "GBP",
        "transaction_type": "refund",
        "status": "complete",
        "relationships": {
            "order": {
                "data": {
                    "type": "order",
                    "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
                }
            }
        },
        "meta": {
            "display_price": {
                "amount": 80000,
                "currency": "GBP",
                "formatted": "£800.00"
            },
            "display_refunded_amount": {
                "total": {
                    "amount": 2,
                    "currency": "GBP",
                    "formatted": "£0.02"
                }
            },
            "timestamps": {
                "created_at": "2022-04-21T17:55:38Z",
                "updated_at": "2022-04-22T15:37:07Z"
            }
        }
    }
}
Last updated on 5/11/2022
← Stripe Payment IntentsManual Payments →