Get Payment Methods

Retrieve available payment methods for checkout.

Endpoint

GET /api/shop/checkout/payment-methods

Request Headers

Header	Required	Description
Content-Type	Yes	application/json
X-STOREFRONT-KEY	Yes	Your storefront API key

Response Fields (200 OK)

Field	Type	Description
id	integer	Payment method ID
code	string	Payment method code
name	string	Display name
description	string	Method description
isActive	boolean	Method active status
instructions	string	Payment instructions or notes
icon	string	Method icon URL
additionalData	object	Additional configuration (if any)

Use Cases

• Display payment options during checkout
• Allow customer to select payment method
• Show payment instructions
• Validate payment method availability
• Implement payment gateway integration

Common Payment Methods

• Credit/Debit Card (Stripe, Square, etc.)
• PayPal
• Bank Transfer
• Cash on Delivery
• Wallet/Gift Card
• Buy Now Pay Later (Klarna, Afterpay)

Notes

• Methods availability depends on store configuration
• Some methods may have requirements or restrictions
• Instructions help guide customer through payment
• Payment processing happens after order placement

Related Resources

• Set Payment Method
• Get Shipping Methods
• Place Order