Commerce Cloud

Stripe Payment Intents

note

Stripe payment intents integration only supports the purchase payment method.

POST Pay by token or source

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

Path Parameters:

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

Headers:

NameRequiredTypeDescription
AuthorizationRequiredstringThe Bearer token to grant access to the API

Body:

NameRequiredTypeDescription
options.idempotency_keyOptionalstringSend a Stripe Idempotency Key
options.receipt_emailOptionalstringProvide an email for Stripe receipts. live mode feature
paymentRequiredstringThe Stripe token or source
options.customerOptionalstringThe Stripe customer ID (required if sending source)
methodRequiredstringpurchase
gatewayRequiredstringYou will use stripe_payment_intents in this case

201 Created

{
    "data": {
        "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "type": "transaction",
        "reference": "pi_1FCOZeCTrBHFHKc3aq7Y6QMe",
        "gateway": "stripe_payment_intents",
        "amount": 5499,
        "currency": "USD",
        "transaction-type": "purchase",
        "transaction_type": "purchase",
        "status": "pending",
        "payment_intent": {
            "client_secret": "pi_1FCOZeCTrBHFHKc3aq7Y6QMe_secret_USOWF0SwovdGuc78rLJqIfa7K",
            "status": "requires_action"
        },
        "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"
            }
        }
    }
}
note

If you are passing a source instead of a token, you must also include the Stripe customer ID in the request

curl -X POST https://api.moltin.com/v2/orders/:orderId/payments \
     -H "Authorization: Bearer XXXX" \
     -d $'{
        "data": {
          "gateway": "stripe_payment_intents",
          "method": "purchase",
          "payment": "pm_card_threeDSecureRequired",
          "options": {
            "receipt_email": "john@example.com"
          }
        }
      }'
const MoltinGateway = require('@moltin/sdk').gateway
const Moltin = MoltinGateway({
  client_id: 'X'
})
const id = 'XXXX'
const payment = {
  gateway: 'stripe_payment_intents',
  method: 'purchase',
  payment: 'pm_card_threeDSecureRequired'
}
Moltin.Orders.Payment(id, payment).then(() => {
  // Do something
})
warning

It’s recommended that you use the token/source with Stripe payments. See Stripe Elements for generating a token on the client-side.

POST Pay by Stripe Connect

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

Commerce Cloud also supports Stripe Connect. Simply pass a destination via the options object.

Path Parameters:

NameRequiredTypeDescription
orderIdRequiredstringThe UUID of the order you want to pay for

Headers:

NameRequiredTypeDescription
AuthorizationRequiredstringThe Bearer token used to grant access to the API

Body:

NameRequiredTypeDescription
options.destinationOptionalstringThe Stripe Connect Account ID
options.receipt_emailOptionalstringProvide an email for Stripe receipts. live mode only
paymentRequiredstringThe Stripe token or source
methodRequiredstringpurchase
gatewayRequiredstringYou will use stripe_payment_intents in this case

201 Created

{
    "data": {
        "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "type": "transaction",
        "reference": "pi_1FCOZeCTrBHFHKc3aq7Y6QMe",
        "gateway": "stripe_payment_intents",
        "amount": 5499,
        "currency": "USD",
        "transaction-type": "purchase",
        "transaction_type": "purchase",
        "status": "pending",
        "payment_intent": {
            "client_secret": "pi_1FCOZeCTrBHFHKc3aq7Y6QMe_secret_USOWF0SwovdGuc78rLJqIfa7K",
            "status": "requires_action"
        },
        "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"
            }
        }
    }
}
curl -X POST https://api.moltin.com/v2/orders/:orderId/payments \
     -H "Authorization: Bearer XXXX" \
     -d $'{
        "data": {
          "gateway": "stripe_payment_intents",
          "method": "purchase",
          "payment": "pm_card_threeDSecureRequired",
          "options": {
            "destination": "acct_XXX",
            "receipt_email": "john@example.com"
          }
        }
      }'
← Stripe PaymentsNext →