Invoicing

Start an invoice payment collection

method=manual_card creates a card PaymentIntent on the company's connected Stripe account for the mobile Stripe PaymentSheet; returns paymentIntentId, clientSecret, publishableKey, and stripeAccountId. method=checkout_link returns the public pay-online URL (same as /payment-link). method=terminal_tap is reserved and returns 501. Requires an open balance and active Stripe Connect with charges enabled.

post/invoices/{id}/collect

Request

  • Base URL: https://ledgerhq.pro/api/v1
  • URL: https://ledgerhq.pro/api/v1/invoices/{id}/collect
  • Auth: one of:
    • HTTP bearer and API key in header x-organization-id
    • HTTP bearer and API key in header x-organization-id

Path parameters

idstring uuid required

Invoice UUID

Request body

method'manual_card' | 'checkout_link' | 'terminal_tap' required

Collection method

Response

manual_card: PaymentIntent credentials for PaymentSheet. checkout_link: token + url.

Changes

No recorded changes to this operation across all 5 revisions of this API.