Create an applied (invoice-tied) payment link

post

https://api.benjipays.com/v2/payment-links/applied/{invoiceId}

Creates a tokenized payment link tied to an existing accounting invoice for the organization associated with the authenticated API key. After pay, the payment applies to that invoice. For security, we recommend passing allowSavedPaymentMethods: false unless you have independently authenticated the user and are certain they are authorized to use the invoice customer’s saved payment methods. Setting it to true may display existing on-file payment methods and allows the user to pay with them. Does not email the link — the caller sends url. Requires organizations:payment-links:create.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

invoiceId

string

required

length between 1 and 200

The accounting system invoice ID (e.g. the QuickBooks Id, Xero InvoiceID, or Business Central id). This is the value exposed as id on the invoice object.

Body Params

gatewayId

string

length between 1 and 100

Optional gateway store identifier override. If omitted, gateway is chosen from the invoice currency / defaults (same as unapplied).

allowSavedPaymentMethods

boolean

Security recommendation: pass false to create a guest checkout unless you have independently authenticated the user and are certain they are authorized to use the invoice customer’s saved payment methods. When true, the pay-now page may display existing on-file payment methods and allow the user to pay with them. When omitted or false (default), saved payment methods are not shown or available.

Headers

X-Request-ID

uuid

Optional client-supplied unique ID for one request. The server generates a UUID v4 if omitted and always echoes the value in the response.

X-Correlation-ID

uuid

Optional ID that flows across service boundaries for distributed tracing. The server generates a UUID v4 if omitted and always echoes the value in the response.

Idempotency-Key

string

length between 1 and 255

^[a-zA-Z0-9]+$

Optional client-supplied key that makes retries safe for POST/PATCH/PUT. Scoped per actor; cached for 24 hours. Replays return the cached response with X-Idempotency-Replayed: true. Same key with a different body returns 409. In-flight duplicates return 429 with Retry-After. See the Idempotency section in the API overview.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Payment link created

400Bad Request — invalid body/params, missing invoice customer/currency, or gateway/currency configuration

401Unauthorized — invalid or missing authentication, or API access is not active for this organization (disabled or missing).

403Forbidden — missing required OAuth scope (organizations:payment-links:create) and/or insufficient live mapping permission on the API key owner (e.g. companyAdmin). Scope and mapping are independent gates; see response detail.

404Organization not found

429Too Many Requests