Payment links

Create several payment links at once

Splits one collectible invoice or installment into 1 to 12 payment links in ONE atomic call: every link is created or none is, so a split never stops half-way. Each payment names its amount and may name its due date; each row passes createPaymentLink's checks, counting the rows before it, and together they may not exceed what is outstanding. A refused row is named in the error details as payments[<index>].amount_minor (0-based); nothing was created, so fix it and send the whole request again. The email decision applies to each link and is carried out after the links exist; a failed email never undoes a link.

Requires an admin API key (has side effects).

post/v1/payment-links/batch

Request

  • Base URL: https://api.getfinero.com/functions/v1/api
  • URL: https://api.getfinero.com/functions/v1/api/v1/payment-links/batch
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Unique key (1–255 printable ASCII chars) scoping safe retries. Same key + same body replays the original result; same key + different body returns 409 idempotency_conflict.

Request body

invoice_idstring uuid required

Invoice to collect.

installment_idstring uuid nullable required

Real installment id in installment mode; null in invoice-only mode. Read the invoice collection_mode first.

integration_idstring uuid

Optional: a specific connected payments integration. Defaults to the tenant's connected provider.

email_delivery_mode'workflow' | 'send_now' | 'schedule' | 'suppress'

Optional email decision applied to EACH link. Omit or use workflow to preserve tenant workflow behaviour.

email_scheduled_localstring

Tenant-local YYYY-MM-DDTHH:mm wall clock, the same for every link. Required only when email_delivery_mode is schedule.

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.