Sign in

v1

latestOpenAPI 3.1.0MIT-LICENSE2026-07-24113190543.3 KB
Payment Link

Create Unique Payment Link

post/checkouts

Headers

Accept-Language'es' | 'en'

Use for knowing which language to use

X-Child-Company-Idstring

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

Request body

allowed_payment_methodsstring[]

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

excluded_payment_methodsstring[]

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

exclude_card_networksstring[]

List of card networks to exclude from the checkout. This field is only applicable for card payments.

expires_atinteger required

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_enabledboolean

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

monthly_installments_optionsinteger[]

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

three_ds_modestring nullable

Indicates the 3DS2 mode for the order, either smart or strict. This property is only applicable when 3DS is enabled. When 3DS is disabled, this field should be null.

namestring required

Reason for charge

needs_shipping_contactboolean

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

on_demand_enabledboolean nullable

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

plan_idsstring[]

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

payments_limit_countinteger

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

success_urlstring

The URL to redirect to after a successful payment.

recurrentboolean required

false: single use. true: multiple payments

typestring required

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

Example request

{
  "allowed_payment_methods": [
    "cash",
    "card",
    "bank_transfer",
    "bnpl",
    "pay_by_bank"
  ],
  "excluded_payment_methods": [
    "cash",
    "bank_transfer"
  ],
  "exclude_card_networks": [
    "visa",
    "amex"
  ],
  "expires_at": 1680397724,
  "monthly_installments_enabled": true,
  "monthly_installments_options": [
    3,
    6,
    12
  ],
  "name": "Payment Link Name 1594138857",
  "on_demand_enabled": true,
  "plan_ids": [
    "plan_123",
    "plan_456"
  ],
  "order_template": {
    "currency": "MXN",
    "customer_info": {
      "name": "DevTest",
      "email": "test@conekta.com",
      "phone": "5522997233",
      "object": "customer_info"
    },
    "line_items": [
      {
        "antifraud_info": {
          "key": "value"
        },
        "brand": "Cohiba",
        "description": "Imported From Mex.",
        "metadata": {
          "key": "value"
        },
        "name": "Box of Cohiba S1s",
        "quantity": 1,
        "sku": "XYZ12345",
        "tags": [
          "food",
          "mexican food"
        ],
        "unit_price": 20000
      }
    ],
    "metadata": {
      "key": "value"
    },
    "tax_lines": [
      {
        "amount": 100,
        "description": "testing",
        "metadata": {
          "key": "value"
        }
      }
    ],
    "discount_lines": [
      {
        "amount": 500,
        "code": "123",
        "type": "loyalty"
      }
    ]
  },
  "payments_limit_count": 5,
  "success_url": "https://www.conekta.com/success",
  "type": "PaymentLink"
}

Response

successful operation