v2

latestOpenAPI 3.0.0raw.githubusercontent.com2026-02-16143114179.4 KB
Customer Portal

Create checkout for an invoice

Initiates a payment session with the configured payment provider. Returns a checkout URL to redirect the customer to.

post/api/portal/customers/{externalId}/invoices/{invoiceId}/checkout

Path parameters

externalIdstring required

Customer external ID

invoiceIdstring required

Invoice ID

Response

Checkout URL and payment details

checkoutUrlstring required
paymentIdstring required
providerstring required
expiresAtstring required

Example response

{
  "checkoutUrl": "https://paystack.com/pay/abc123",
  "paymentId": "clxpay123",
  "provider": "paystack"
}