Appearance
Payment API
Use the Payment API to initialize payments, verify transactions, check available payment gateways, retrieve payment records, and generate split payment links.
Endpoints
| Endpoint | Method | Path | Description |
|---|---|---|---|
| Initialize Payment | POST | /v1/payments/initialize | Initialize payment for authenticated customer order |
| Initialize Guest Payment | POST | /v1/payments/guest/initialize | Initialize payment for guest customer order |
| Verify Payment | POST | /v1/payments/confirm | Confirm and verify transaction with payment gateway |
| Get All Payments | GET | /v1/payments | Paginated list of payment transactions |
| Get Payment by ID | GET | /v1/payments/{paymentId} | Transaction detail for a specific payment |
| Generate Payment Link | POST | /v1/payment-links | Generate hosted split payment link |
| Get Latest Order Payment Link | GET | /v1/payment-links/orders/{orderId}/latest | Retrieve latest payment link for an order |
| Update Payment Status | PATCH | /v1/payments/{paymentId}/status | Update status of a payment record |
| Storefront Payment Gateways | GET | /v1/storefront/payment-gateways | Public list of payment gateways offered by the store |
