COconekta
Payment Link

Get a payment link by ID

Changed on
get/checkouts/{id}

Request

Path parameters

idstring required
Example:6307a60c41de27127515a575

Identifier of the resource

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

allowed_payment_methodsstring[]

Are the payment methods available for this link

excluded_payment_methodsstring[]

Payment methods excluded from the checkout. This field is only returned when excluded_payment_methods is provided in the request.

plan_idsstring[]

List of plan IDs that are available for subscription

can_not_expireboolean
emails_sentinteger
exclude_card_networksstring[]
expires_atinteger
failure_urlstring
force_3ds_flowboolean
idstring required
livemodeboolean required
metadataobject
monthly_installments_enabledboolean
monthly_installments_optionsinteger[]
namestring required

Reason for charge

needs_shipping_contactboolean
objectstring required
paid_payments_countinteger
payments_limit_countinteger nullable
recurrentboolean
redirection_timeinteger nullable

It is the time in seconds that the checkout will wait before redirecting to the success_url.

slugstring
starts_atinteger
statusstring
success_urlstring

The URL to redirect to after a successful payment.

typestring
urlstring uri

Example response

{
  "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