API Reference
  1. UrbanPay
  2. Payment Initiation
  3. Bulk Payment Links

Commit Bulk Paylinks

post
https://example.com/api/v1/checkout/paylink/bulk

Create payment links in bulk

Re-validates the rows, then queues a background batch that creates one
payment link per row. Requires X-Idempotency-Key; replaying the same key
returns the existing batch with 200.

Errors:

  • 400: empty X-Idempotency-Key
  • 409: warnings_not_acknowledged (send acknowledge_warnings: true),
    batch_already_running (one active batch per account)
  • 422: row_errors with the offending rows; nothing is created
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
rows
array of objects
required
length between 1 and 500
Rows*
≥ 1

Row number in the uploaded file, for display

length ≤ 1024

Payer email

length ≤ 1024

Payer name, used only when a new user is created

string

Amount in EUR; a number or a string such as 1234.56 or 1.234,56

length ≤ 4096

Payment description; falls back to default_description

length ≤ 64

Project id; takes precedence over project

length ≤ 1024

Project name as written in the template

string

Email the payer the link: true/false or yes/no; falls back to default_send_email

string
required
length ≥ 1

Project used by rows without one

length ≤ 500

Description used by rows without one

boolean
Defaults to true

Whether rows without send_email email the payer

boolean
Defaults to true

Create a user for emails that do not exist yet

boolean
Defaults to false

Required when the preview reported warnings

Optional hard expiry applied to every link

length ≤ 255

Uploaded file name, for the batch list

Headers
string
required
Responses

Updated about 1 hour ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 hour ago

Did this page help you?