---
updatedAt: 2026-03-24T22:29:34.000Z
agentTools:
  projectIndex: https://developers.digitalfemsa.io/llms.txt
---

# Get a list of payment links

Returns a paginated list of payment links created by the merchant. Results can be navigated using the pagination parameters.

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "contact": {
      "email": "engineering@femsa.com",
      "name": "Engineering Femsa",
      "url": "https://github.com/digitalfemsa/openapi/issues"
    },
    "description": "Femsa sdk",
    "license": {
      "name": "MIT-LICENSE",
      "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "title": "Femsa API",
    "version": "2.1.0"
  },
  "servers": [
    {
      "description": "Femsa main server",
      "url": "https://api.digitalfemsa.io"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "paths": {
    "/checkouts": {
      "get": {
        "description": "Returns a paginated list of payment links created by the merchant. Results can be navigated using the pagination parameters.",
        "operationId": "getCheckouts",
        "parameters": [
          {
            "description": "Use for knowing which language to use",
            "examples": {
              "es": {
                "summary": "for spanish request/response",
                "value": "es"
              },
              "en": {
                "summary": "for english request/response",
                "value": "en"
              }
            },
            "in": "header",
            "name": "Accept-Language",
            "required": false,
            "schema": {
              "default": "es",
              "enum": [
                "es",
                "en"
              ],
              "type": "string"
            }
          },
          {
            "description": "In the case of a holding company, the company id of the child company to which will process the request.",
            "example": "6441b6376b60c3a638da80af",
            "in": "header",
            "name": "X-Child-Company-Id",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "The numbers of items to return, the maximum value is 250",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "default": 20,
              "format": "int32",
              "maximum": 250,
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "description": "General order search, e.g. by mail, reference etc.",
            "in": "query",
            "name": "search",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "next page",
            "in": "query",
            "name": "next",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "previous page",
            "in": "query",
            "name": "previous",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/vnd.app-v2.1.0+json": {
                "schema": {
                  "$ref": "#/components/schemas/checkouts_response"
                }
              }
            },
            "description": "successful operation"
          },
          "401": {
            "content": {
              "application/vnd.app-v2.1.0+json": {
                "example": {
                  "details": [
                    {
                      "message": "Please include your access key in your request.",
                      "param": null,
                      "code": "femsa.errors.authentication.missing_key"
                    }
                  ],
                  "log_id": "507f1f77bcf86cd799439011",
                  "object": "error",
                  "type": "authentication_error"
                },
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "authentication error"
          },
          "402": {
            "content": {
              "application/vnd.app-v2.1.0+json": {
                "example": {
                  "details": [
                    {
                      "message": "The order could not be processed.",
                      "code": "femsa.errors.processing.order.used",
                      "debug_message": "The order has already been used."
                    }
                  ],
                  "log_id": "641b6d073cd9a50001515007",
                  "object": "error",
                  "type": "processing_error"
                },
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "payment required error"
          },
          "422": {
            "content": {
              "application/vnd.app-v2.1.0+json": {
                "example": {
                  "details": [
                    {
                      "message": "The name does not exist.",
                      "param": "payment_method.name",
                      "code": "femsa.errors.parameter_validation.payment_method.name.nonexistent_token",
                      "debug_message": "The name does not exist."
                    }
                  ],
                  "log_id": "641b6d813cd9a50001515017",
                  "object": "error",
                  "type": "parameter_validation_error"
                },
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "parameter validation error"
          },
          "500": {
            "content": {
              "application/vnd.app-v2.1.0+json": {
                "example": {
                  "details": [
                    {
                      "debug_message": "There was a runtime error and Femsa engineers have been notified.",
                      "message": "There was a runtime error and Femsa engineers have been notified.",
                      "param": null,
                      "code": "femsa.errors.api.system.general_failure"
                    }
                  ],
                  "object": "error",
                  "type": "api_error",
                  "log_id": "641b6f2b3cd9a50001515098"
                },
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "internal server error"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Get a list of payment links",
        "tags": [
          "Payment Link"
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "page": {
        "description": "page metadata",
        "properties": {
          "next_page_url": {
            "description": "URL of the next page.",
            "example": "https://api.femsa.io/resources?limit=10&next=chrg_1",
            "nullable": true,
            "type": "string"
          },
          "previous_page_url": {
            "description": "Url of the previous page.",
            "example": "https://api.femsa.io/resources?limit=10&previous=chrg_1",
            "nullable": true,
            "type": "string"
          }
        },
        "title": "page metadata",
        "type": "object"
      },
      "pagination": {
        "description": "pagination metadata",
        "properties": {
          "has_more": {
            "description": "Indicates if there are more pages to be requested",
            "example": false,
            "type": "boolean"
          },
          "object": {
            "description": "Object type, in this case is list",
            "example": "list",
            "type": "string"
          }
        },
        "required": [
          "has_more",
          "object"
        ],
        "title": "pagination metadata",
        "type": "object"
      },
      "error": {
        "allOf": [
          {
            "$ref": "#/components/schemas/details"
          },
          {
            "properties": {
              "log_id": {
                "description": "log id",
                "example": "507f1f77bcf86cd799439011",
                "nullable": true,
                "type": "string"
              },
              "type": {
                "example": "authentication_error",
                "type": "string"
              },
              "object": {
                "example": "error",
                "type": "string"
              }
            },
            "type": "object"
          }
        ],
        "description": "err model",
        "title": "error"
      },
      "checkout_response": {
        "description": "checkout response",
        "properties": {
          "allowed_payment_methods": {
            "example": [
              "cash"
            ],
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "can_not_expire": {
            "example": false,
            "type": "boolean"
          },
          "emails_sent": {
            "example": 0,
            "type": "integer"
          },
          "expires_at": {
            "example": 1680397724,
            "format": "int64",
            "type": "integer"
          },
          "failure_url": {
            "example": "https://pay.femsa.com/failure",
            "type": "string"
          },
          "id": {
            "example": "b0bf16c4-18b9-445e-ba24-01604f329dbf",
            "type": "string"
          },
          "livemode": {
            "example": true,
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": true,
            "example": {
              "key": "value"
            },
            "type": "object"
          },
          "name": {
            "description": "Payment link name",
            "example": "Payment Link Name 1594138857",
            "type": "string"
          },
          "needs_shipping_contact": {
            "example": false,
            "type": "boolean"
          },
          "object": {
            "example": "checkout",
            "type": "string"
          },
          "paid_payments_count": {
            "example": 0,
            "type": "integer"
          },
          "payments_limit_count": {
            "example": 5,
            "format": "int32",
            "nullable": true,
            "type": "integer"
          },
          "recurrent": {
            "example": false,
            "type": "boolean"
          },
          "slug": {
            "example": "b0bf16c418b9445eba2401604f329dbf",
            "type": "string"
          },
          "sms_sent": {
            "example": 0,
            "type": "integer"
          },
          "starts_at": {
            "example": 1677650400,
            "type": "integer"
          },
          "status": {
            "example": "Issued",
            "type": "string"
          },
          "success_url": {
            "example": "https://pay.femsa.com/success",
            "type": "string"
          },
          "type": {
            "example": "PaymentLink",
            "type": "string"
          },
          "url": {
            "example": "https://pay.femsa.com/link/b0bf16c418b9445eba2401604f329dbf",
            "format": "uri",
            "type": "string"
          }
        },
        "required": [
          "id",
          "livemode",
          "name",
          "object"
        ],
        "title": "checkout_response",
        "type": "object"
      },
      "details": {
        "properties": {
          "details": {
            "items": {
              "$ref": "#/components/schemas/details_error"
            },
            "type": "array"
          }
        },
        "type": "object"
      },
      "checkouts_response": {
        "allOf": [
          {
            "$ref": "#/components/schemas/pagination"
          },
          {
            "$ref": "#/components/schemas/page"
          },
          {
            "properties": {
              "data": {
                "items": {
                  "$ref": "#/components/schemas/checkout_response"
                },
                "type": "array"
              }
            },
            "type": "object"
          }
        ],
        "title": "checkouts_response"
      },
      "details_error": {
        "properties": {
          "code": {
            "example": "femsa.errors.authentication.missing_key",
            "type": "string"
          },
          "param": {
            "nullable": true,
            "type": "string"
          },
          "message": {
            "example": "Acceso no autorizado.",
            "type": "string"
          },
          "debug_message": {
            "example": "Please include your access key in your request.",
            "type": "string"
          }
        },
        "title": "details_error",
        "type": "object"
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  }
}
```