COconekta
Payment Link

Get a list of payment links

Changed on

Returns a list of links generated by the merchant

get/checkouts

Request

Query parameters

limitinteger

The numbers of items to return, the maximum value is 250

searchstring

General order search, e.g. by mail, reference etc.

nextstring

next page

previousstring

previous page

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.

Response

successful operation

has_moreboolean required

Indicates if there are more pages to be requested

objectstring required

Object type, in this case is list

next_page_urlstring nullable

URL of the next page.

previous_page_urlstring nullable

Url of the previous page.

Example response

{
  "object": "list",
  "next_page_url": "https://api.conekta.io/resources?limit=10&next=chrg_1",
  "previous_page_url": "https://api.conekta.io/resources?limit=10&previous=chrg_1",
  "data": [
    {
      "allowed_payment_methods": [
        "cash",
        "card",
        "bank_transfer",
        "bnpl",
        "pay_by_bank"
      ],
      "excluded_payment_methods": [
        "cash",
        "bank_transfer"
      ],
      "plan_ids": [
        "plan_123",
        "plan_456"
      ],
      "exclude_card_networks": [
        "visa",
        "amex"
      ],
      "expires_at": 1680397724,
      "failure_url": "https://pay.conekta.com/failure",
      "id": "b0bf16c4-18b9-445e-ba24-01604f329dbf",
      "livemode": true,
      "metadata": {
        "key": "value"
      },
      "monthly_installments_options": [
        3,
        6,
        12
      ],
      "name": "Payment Link Name 1594138857",
      "object": "checkout",
      "payments_limit_count": 5,
      "redirection_time": 30,
      "slug": "b0bf16c418b9445eba2401604f329dbf",
      "starts_at": 1677650400,
      "status": "Issued",
      "success_url": "https://pay.conekta.com/success",
      "type": "PaymentLink",
      "url": "https://pay.conekta.com/link/b0bf16c418b9445eba2401604f329dbf"
    }
  ]
}

Changes

  • 52f4c0dd8a1bRevision changes
    • warning

      removed the optional property /// from the response with the status

    • info

      added the optional property /// to the response with the status