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

Request

Base URL
https://api.novabilling.one
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/novabilling/apis/novabilling-api/docs/api/portal/customers/:externalId/invoices/:invoiceId/checkout/post.ts
A function with typed inputs. Its response is checked against the schema.

externalIdstring required

Customer external ID

invoiceIdstring required

Invoice ID

Checkout URL and payment details

checkoutUrlstring required

paymentIdstring required

providerstring required

expiresAtstring required

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