Create Unique Payment Link

post

https://api.conekta.io/checkouts

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

requested field for checkout

It is a sub-resource of the Order model that can be stipulated in order to configure its corresponding checkout

allowed_payment_methods

array of strings

Those are the payment methods that will be available for the link. This field is mutually exclusive with excluded_payment_methods.

allowed_payment_methods

excluded_payment_methods

array of strings

Payment methods to be excluded from the checkout. This field is mutually exclusive with allowed_payment_methods.

checkout_excluded_payment_methods

Allowed:

exclude_card_networks

array of strings

List of card networks to exclude from the checkout. This field is only applicable for card payments. Accepted values: 'visa_master_card' (a single token excluding both Visa and Mastercard) and 'amex'.

checkout_exclude_card_networks

Allowed:

expires_at

int64

required

≥ 1

It is the time when the link will expire.
It is expressed in seconds since the Unix epoch. The valid range is from 5 minutes to 365 days from the creation date.

monthly_installments_enabled

boolean

This flag allows you to specify if months without interest will be active.

monthly_installments_options

array of int8s

This field allows you to specify the number of months without interest.

monthly_installments_options

three_ds_mode

string

enum

Indicates the 3DS2 mode: 'strict', 'not_strict' or 'smart'. To defer to the company-level 3DS configuration, omit the field (an explicit null is rejected on creation).

Allowed:

name

string

required

Reason for charge

needs_shipping_contact

boolean

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

on_demand_enabled

boolean | null

This flag allows you to specify if the link will be on demand.

plan_ids

array of strings

It is a list of plan IDs that will be associated with the order.

plan_ids

order_template

object

required

It maintains the attributes with which the order will be created when receiving a new payment.

payments_limit_count

int8

≥ 1

It is the number of payments that can be made through the link.

redirection_time

int8

≥ 1

It is the time in seconds that the checkout will wait before redirecting to the success_url. It must be greater than 0.

success_url

string

The URL to redirect to after a successful payment.

recurrent

boolean

required

false: single use. true: multiple payments

type

string

required

It is the type of link that will be created. It must be a valid type.

Headers

Accept-Language

string

enum

Defaults to es

Use for knowing which language to use

Allowed:

X-Child-Company-Id

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

Loading…

Response

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

application/vnd.conekta-v2.3.0+json

200successful operation

401authentication error

402payment required error

422parameter validation error

500internal server error