Orders > Orders > ordersPay
Commerce APIOrdersOrdersordersPay
ordersPay
POST:orders/pay.json

Description

Perform payment on an existing order.

Permission bit: "orders.payment"

Topic: Orders

Arguments

data: OrderPayment!

Main argument for mutations.


order_id: String!

Unique order identifier. See also: Unique Identifiers

Example: "or_EQzGqWoY"


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


uuid: String


Data Argument Fields

confirm: Boolean

Confirm pending payment intent


credit_card: OrderPaymentCreditCard

Use it to perform gateway payment


manual: OrderPaymentManual

Use it to perform manual payment


payment_method: String

Use it to perform gateway payment (when gateway type is "stripe")


paypal: OrderPaymentPaypal

Use it to perform gateway payment (when gateway type is "paypal")


Result

Order

Preview (typescript)

Loading module