Create Unique Payment Link

Creates a Payment Link: a shareable URL that lets your customer pay without you building a custom checkout. Configure the link type, allowed payment methods, and expiration. The request also includes an order_template (currency and line items) used to generate an Order when the customer completes a payment. Use recurrent=false for a single-use link, or recurrent=true to allow multiple payments (limited by payments_limit_count).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

requested field for checkout

Creates a Payment Link. This is a sub-resource related to an Order template: each time a customer pays using the link, the API will create an Order using order_template.

string
required

Payment link name.

string
required

Checkout type.

boolean
required

false: single use. true: multiple payments

int32

Required when recurrent is true. Maximum number of payments allowed through the link.

allowed_payment_methods
array of strings
required

Payment methods available in the payment link.

allowed_payment_methods*
boolean
required

This flag allows you to fill in the shipping information at checkout.

int64

Start time for the link. Unix timestamp in seconds.

int64
required

Expiration time for the link (Unix timestamp in seconds). Valid range is between 2 and 365 days (calculated from the next day of creation at 00:01).

boolean

If true, the link does not expire.

order_template
object
required

Attributes used to create the order when a new payment is received.

Headers
string
enum
Defaults to es

Use for knowing which language to use

Allowed:
string

In the case of a holding company, the company id of the child company to which will process the request.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.app-v2.1.0+json