Set Payment Method

Set the payment method for a cart.

Authentication

This query supports both authenticated customers and guest users:

• Authenticated customers: Provide a valid customer authentication token in the Authorization header. Obtain this token via the Customer Login API.
• Guest users: Provide the Guest Cart Token cartToken obtained from the Create Cart mutation.

Authorization: Bearer <accessToken>

Arguments

Name	Type	Required	Description
paymentMethod	String	✅ Yes	Payment method code (e.g., moneytransfer, paypal)
successUrl	String	❌ No	URL to redirect on successful payment
failureUrl	String	❌ No	URL to redirect on failed payment
cancelUrl	String	❌ No	URL to redirect on cancelled payment

Response

Field	Type	Description
success	Boolean	Success status
message	String	Success or error message
paymentGatewayUrl	String | null	Payment gateway URL for external payment processing
paymentData	String | null	Additional payment data if required

Common Payment Method Codes

Code	Description
moneytransfer	Money Transfer
paypal	PayPal
stripe	Stripe
bank_transfer	Bank Transfer
cash_on_delivery	Cash on Delivery (COD)

Prerequisites

• Billing address must be set
• Shipping method must be selected
• Payment method must be enabled in store

Validation Rules

• Payment method code must be valid and enabled
• Payment method must be available for the customer's country
• Redirect URLs must be valid if provided
• Cart must have items
• All previous checkout steps must be completed

Error Responses

{
  "errors": {
    "paymentMethod": ["Invalid or unavailable payment method."],
    "successUrl": ["The success URL must be a valid URL."],
    "billingAddress": ["Billing address must be set first."],
    "shippingMethod": ["Shipping method must be set first."]
  }
}

Related Documentation

• Get Payment Methods
• Set Billing Address
• Place Order