Get Payment Methods
Retrieve available payment methods for checkout.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
token | String | No | Deprecated - Keep empty. Use Authorization header instead |
Authentication
This query supports both authenticated customers and guest users:
- Authenticated customers: Provide a valid customer authentication token in the
Authorizationheader. Obtain this token via the Customer Login API. - Guest users: Provide the Guest Cart Token
cartTokenobtained from the Create Cart mutation.
Authorization: Bearer <accessToken>Response Fields
| Field | Type | Description |
|---|---|---|
id | String | API resource identifier |
_id | String | Payment method identifier |
method | String | Payment method code (for setting) |
title | String | Display name |
description | String | Method description |
icon | String | Payment method icon URL |
isAllowed | Boolean | null | Whether method is allowed for current cart |
Common Methods
| Method | Title | Description |
|---|---|---|
moneytransfer | Money Transfer | Direct money transfer payment |
paypal | PayPal | PayPal online payment |
stripe | Stripe | Credit/debit card via Stripe |
cash_on_delivery | Cash on Delivery | Pay when item is delivered |
bank_transfer | Bank Transfer | Manual bank transfer |
Method Availability
Available payment methods depend on:
- Store configuration
- Customer country
- Cart total
- Order fulfillment location
Use Cases
- Display payment options during checkout
- Show available methods based on customer
- Check if method is active
- Build payment selection UI
Error Responses
json
{
"errors": {
"general": ["No payment methods available."]
}
}