Skip to content

Payment API ​

Use the Payment API to initialize payments, verify transactions, check available payment gateways, retrieve payment records, and generate split payment links.

Endpoints ​

EndpointMethodPathDescription
Initialize PaymentPOST/v1/payments/initializeInitialize payment for authenticated customer order
Initialize Guest PaymentPOST/v1/payments/guest/initializeInitialize payment for guest customer order
Verify PaymentPOST/v1/payments/confirmConfirm and verify transaction with payment gateway
Get All PaymentsGET/v1/paymentsPaginated list of payment transactions
Get Payment by IDGET/v1/payments/{paymentId}Transaction detail for a specific payment
Generate Payment LinkPOST/v1/payment-linksGenerate hosted split payment link
Get Latest Order Payment LinkGET/v1/payment-links/orders/{orderId}/latestRetrieve latest payment link for an order
Update Payment StatusPATCH/v1/payments/{paymentId}/statusUpdate status of a payment record
Storefront Payment GatewaysGET/v1/storefront/payment-gatewaysPublic list of payment gateways offered by the store

Build with joy