Create an unapplied (no-invoice) payment link

post

https://api.benjipays.com/v2/payment-links/unapplied

Creates a no-invoice payment link for the organization associated with the authenticated API key. The payment will be added to the payment to apply table. Does not create/attach an accounting invoice and does not email the link — the caller sends url to the payer. Requires organizations:payment-links:create.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

source

string

enum

required

Who the link is for. Controls allowed returnUrl domains when returnUrl is sent.

Allowed:

amount

number

required

≤ 999999.99

Amount to charge. Must be > 0, max 999999.99, up to 2 decimal places.

currency

string

required

length between 3 and 3

^[A-Za-z]{3}$

3-letter currency code (e.g. USD). Used to pick the gateway.

gatewayId

string

length between 1 and 100

Optional gateway store identifier override. If omitted, gateway is chosen from currency / defaults.

name

string

required

length between 1 and 200

Payer / customer display name on the pay page.

reference

string

required

length between 1 and 100

Human-readable label (e.g. quote number). Shown in UI / emails.

dataId

string

length ≤ 100

Machine id from the partner (e.g. Quoter quote id). Not an accounting invoice id.

returnUrl

uri

length ≤ 2048

Optional. Where to send the customer after a successful payment. Omit for no post-pay redirect. When set: must be https. For integration partners, only the expected return URL hosts for that source are accepted; otherwise open-redirect hardening still applies.

savePaymentMethod

boolean

Optional override for the save-card checkbox. Omit = normal form. true = force save on. false = force save off.

disableSurcharging

boolean

Optional. When true, disable Benji Pays managed surcharging for this link. Does not affect surcharging managed by your payment gateway. When omitted: falls back to the integration configuration for that source, then to payment gateway settings (source=default leaves surcharge enabled / false).

customerEmail

string

length ≤ 500

Prefills receipt email(s) on the pay page. Does not send the payment link.

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 or gateway/currency/returnUrl 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