Payment links

Get a payment link

Returns one payment link, including its hosted checkout URL and settlement state.

Available to admin and readonly API keys (no side effects).

get/v1/payment-links/{paymentLinkId}

Request

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

Path parameters

paymentLinkIdstring uuid required

Payment link id.

Response

Success

idstring uuid required

Payment link id.

invoice_idstring uuid required

Invoice the link collects.

installment_idstring uuid nullable required

Installment the link collects. An installment may carry SEVERAL live links (0280) — their amounts together may not exceed the installment's collection_outstanding, which the database enforces under a row lock. What Finero already collected is ALREADY netted off that figure; subtracting it a second time under-states the room.

status'active' | 'processing' | 'paid' | 'inactive' | 'needs_replacement' | 'action_required' required

Lifecycle status. active = payable now; processing = a payment is being confirmed; paid = settled; inactive = deactivated or superseded; needs_replacement = the provider-side link stopped being usable (expired or removed at the provider), so a new link must be created; action_required = frozen pending a human decision — Finero will not act on it automatically. A payment whose provider report does not match the request is frozen in processing, not here.

provider'stripe' | 'wix' required

Payment provider hosting the checkout.

mode'test' | 'live' required

Provider environment. test means a TEST processor handled this money: it is not revenue and must never be reported as cash collected, however real the amount looks. live is real money.

amount_minorinteger required

Amount the link collects. Integer amount in the currency's MINOR unit (e.g. cents), as defined by the PAYMENT PROVIDER's own table, which is not always ISO 4217 — the two disagree on ISK and MGA among others, so converting with an ISO exponent misprices those. Invoice and installment amounts are exact decimal strings and are the safe basis for arithmetic and display.

currencystring required

Link currency. ISO 4217 alphabetic code, e.g. "USD".

payment_due_datestring date nullable required

Business due date owned by this payment link (YYYY-MM-DD). It is snapshotted at creation and does not change when the source installment changes. Null only for legacy links whose source had no date.

urlstring nullable required

Hosted customer-facing pay-page URL; null once the link is withdrawn (inactive). Treat as a capability: anyone with the URL can open the checkout.

paid_atstring date-time nullable required

When the link was paid (ISO 8601 UTC).

paid_amount_minorinteger nullable required

Settled amount. Integer amount in the currency's MINOR unit (e.g. cents), as defined by the PAYMENT PROVIDER's own table, which is not always ISO 4217 — the two disagree on ISK and MGA among others, so converting with an ISO exponent misprices those. Invoice and installment amounts are exact decimal strings and are the safe basis for arithmetic and display.

paid_currencystring nullable required

Settled currency. ISO 4217 alphabetic code, e.g. "USD".

deactivated_atstring date-time nullable required

When the link was deactivated (ISO 8601 UTC).

created_atstring date-time required

Creation time (ISO 8601 UTC).

updated_atstring date-time required

Last update time (ISO 8601 UTC).

Changes

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