Preview Bulk Paylinks

post

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

Preview payment links from JSON rows

Same validation as the file preview, for rows edited in the dashboard or
supplied directly by an API integration. Creates nothing.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

rows

array of objects

required

length between 1 and 500

Rows*

source_row

≥ 1

Row number in the uploaded file, for display

length ≤ 1024

Payer email

full_name

length ≤ 1024

Payer name, used only when a new user is created

amount

string

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

description

length ≤ 4096

Payment description; falls back to default_description

project_id

length ≤ 64

Project id; takes precedence over project

project

length ≤ 1024

Project name as written in the template

send_email

string

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

default_project_id

Project used by rows without one

default_description

length ≤ 500

Description used by rows without one

default_send_email

boolean

Defaults to true

Whether rows without send_email email the payer

auto_create_users

boolean

Defaults to true

Create a user for emails that do not exist yet

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response

422Validation Error