Skip to main content

CreatePaymentCheckoutInput

Start an online payment checkout. Use orderId on retry to reuse an AWAITING_PAYMENT order.

input CreatePaymentCheckoutInput {
  addressId: ID
  deliveryOptionId: ID
  idempotencyKey: String!
  includePrintedInvoice: Boolean
  orderId: ID
  provider: String
  returnUrl: String!
  slotId: ID
}

Fields​

CreatePaymentCheckoutInput.addressId ● ID scalar​

Delivery address for a NEW order. Optional when orderId is supplied — a retry reuses the existing order's address (B5).

CreatePaymentCheckoutInput.deliveryOptionId ● ID scalar​

the chosen live delivery option id (mobileDeliveryOptions). Required when the store prices delivery live; ignored otherwise.

CreatePaymentCheckoutInput.idempotencyKey ● String! non-null scalar​

Idempotency key — same key returns the same live checkout (no duplicate order).

CreatePaymentCheckoutInput.includePrintedInvoice ● Boolean scalar​

Ignored. The printed-invoice fee was removed; kept so existing app builds that send it keep working.

CreatePaymentCheckoutInput.orderId ● ID scalar​

Retry: reuse this AWAITING_PAYMENT order instead of creating a new one.

CreatePaymentCheckoutInput.provider ● String scalar​

Pay with this specific gateway — a provider value from mobilePaymentOptions. Validated server-side against the gateways eligible for the order's currency: an ineligible provider is rejected, never substituted. Omitted ⇒ the first eligible gateway (back-compat for shipped app builds).

CreatePaymentCheckoutInput.returnUrl ● String! non-null scalar​

App deep link the payment browser returns to (e.g. provise://payment-return).

CreatePaymentCheckoutInput.slotId ● ID scalar​

The ID of the delivery slot the buyer picked.

Member Of​

createPaymentCheckout mutation