> ## Documentation Index > Fetch the complete documentation index at: https://developers.portao3.com.br/llms.txt > Use this file to discover all available pages before exploring further. # List payment links > Lists the payment links of your organization, newest first by default. Each link comes with `totalProductsPrice`: the current catalog price of its products times their quantities. Filter by a text in the name, by status and by the creation date (`startAt`/`endAt`, each on its own or both). Sort with `order` and `orderBy`, and page with `limit` + `next`: pass the `next` of one page to get the following one — the last page has no `next`. Any member of the organization, or an admin of the realm, can list them. ## OpenAPI ````yaml /api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/payment-links openapi: 3.0.3 info: title: Billing version: 1.0.0 description: >- Portão 3 billing API. Every endpoint requires a bearer token in the Authorization header (Authorization: Bearer ) unless its page states otherwise; see the Authentication guide. That requirement is not repeated per endpoint. Generated by tools/openapi from code (routes + security) and the hand-written spec (request/response bodies). Full billing surface — contracts, deals, invoices, statements, payment links, checkout and NFSe orchestration. (The product/supplier catalog moved to registry.) Confidence tiers: generated:typed=74 copied:manual=0 unknown=5. servers: - url: https://api.billing.v2.portao3.com.br/ description: production - url: https://api.billing.dev.3pers.com.br/ description: development security: [] tags: - name: Contracts - name: Deals - name: Invoices - name: Invoice Entries - name: Invoice Statements - name: NFSe Configuration - name: Payment Links paths: /realms/{realmId}/organizations/{organizationId}/payment-links: get: tags: - Payment Links summary: List payment links description: Lists the payment links of your organization, newest first by default. operationId: getRealmsByRealmIdOrganizationsByOrganizationIdPaymentLinks parameters: - name: realmId in: path required: true description: |- ID of your realm. Format: `UUID` schema: type: string format: uuid example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b - name: organizationId in: path required: true description: |- ID of your organization: the one that sells through the links. Format: `UUID` schema: type: string format: uuid example: c4bd3f21-dfbd-44e8-8055-68ba15bed410 - name: name in: query required: false description: Only links whose name contains this text, ignoring case. schema: type: string minLength: 1 maxLength: 56 example: anual - name: status in: query required: false description: |- Only links in these statuses. Omit it for every status. --- Example (comma-separated list): `?status=ACTIVE,DEACTIVATED` schema: type: array items: type: string enum: - ACTIVE - DEACTIVATED - EXPIRED style: form explode: false - name: limit in: query required: false description: Page size. schema: default: 15 type: integer minimum: 1 maximum: 100 example: 15 - name: next in: query required: false description: >- Cursor returned as `next` by the previous page; it must be valid base64. Omit it for the first page. Use it with the same filters and order: a cursor that no longer matches a link returns the first page. schema: type: string maxLength: 128 pattern: ^[A-Za-z0-9+/]+={0,2}$ example: NjcxMWI0YzBkOGUxYTMwMDEyYjdjOWYy - name: order in: query required: false description: Sort direction. schema: default: DESC type: string enum: - ASC - DESC example: DESC - name: orderBy in: query required: false description: Field to sort by. schema: default: createdAt type: string enum: - name - createdAt example: createdAt - name: startAt in: query required: false description: >- Only links created on or after this moment: an ISO 8601 date (read as midnight UTC) or a date-time with an offset. schema: anyOf: - type: string format: date - type: string format: date-time example: '2026-01-01' - name: endAt in: query required: false description: >- Only links created on or before this moment: an ISO 8601 date (read as midnight UTC) or a date-time with an offset. schema: anyOf: - type: string format: date - type: string format: date-time example: '2026-12-31T23:59:59.999Z' responses: '200': description: Successful response content: application/json: schema: type: object properties: next: type: string description: >- Cursor of the next page: pass it as `next` to get it. Absent on the last page. example: NjcxMWI0YzBkOGUxYTMwMDEyYjdjOWYy items: type: array items: type: object properties: id: type: string description: ID of the payment link. example: 5c1e8d2a-7b4f-4e3a-9d6c-2a1b0f9e8d7c name: type: string description: Name of the link. example: Plano anual description: type: string description: What the link sells. Absent when it has none. example: Acesso completo por 12 meses. status: type: string enum: - ACTIVE - DEACTIVATED - EXPIRED description: '`ACTIVE`, `DEACTIVATED` or `EXPIRED`.' example: ACTIVE products: type: array items: type: object properties: product: type: string description: >- ID of the product in your organization's catalog. example: 8c7d6e5f-4a3b-4c2d-9e1f-0a9b8c7d6e5f quantity: type: integer description: >- How many units of the product each checkout sells. example: 1 required: - product - quantity description: A product the link sells. description: What the link sells. totalProductsPrice: type: number description: >- The current catalog price of every product times its quantity, in centavos. A product the catalog no longer has counts as zero. example: 15000 expirationDate: description: >- Last day the link can be paid (midnight UTC of that day), or `null` when it never expires. example: '2026-12-31T00:00:00.000Z' type: string format: date-time nullable: true type: type: string enum: - RECURRENT - ONE_TIME description: '`ONE_TIME` or `RECURRENT`.' example: ONE_TIME paymentMethod: type: array items: type: string enum: - BANK_SLIP - PIX_INITIATION - PIX - PIX_AUTOMATIC example: PIX description: |- The ways the payer can choose from at checkout. --- Example: `["PIX","BANK_SLIP"]` secondaryPaymentMethod: type: array items: type: string enum: - BANK_SLIP - PIX_INITIATION - PIX - PIX_AUTOMATIC example: PIX description: >- Other ways each invoice can also be paid. Empty when there are none. --- Example: `["PIX"]` firstPaymentDate: type: object properties: pix: type: string enum: - SAME_DAY - EXPIRATION_DATE - ONE_DAY - FIVE_DAYS - TEN_DAYS - THIRTY_DAYS - SIXTY_DAYS description: When the first payment is due, for `PIX`. example: SAME_DAY bankSlip: type: string enum: - SAME_DAY - EXPIRATION_DATE - ONE_DAY - FIVE_DAYS - TEN_DAYS - THIRTY_DAYS - SIXTY_DAYS description: When the first payment is due, for `BANK_SLIP`. example: FIVE_DAYS pixAutomatic: type: string enum: - SAME_DAY - EXPIRATION_DATE - ONE_DAY - FIVE_DAYS - TEN_DAYS - THIRTY_DAYS - SIXTY_DAYS description: >- When the first payment is due, for `PIX_AUTOMATIC`. example: TEN_DAYS description: >- When the first payment of a checkout is due, per payment method. numberOfInstallments: type: integer description: >- How many monthly payments a checkout of a `RECURRENT` link creates, or `null` (1). example: null createdAt: type: string format: date-time description: When the link was created. example: '2026-10-26T14:30:00.000Z' updatedAt: type: string format: date-time description: When the link was last changed. example: '2026-10-26T14:30:00.000Z' required: - id - name - status - products - totalProductsPrice - expirationDate - type - paymentMethod - secondaryPaymentMethod description: >- A payment link in a list, with the price of what it sells. description: The links of this page. required: - items description: One page of payment links. '422': description: >- `BAD_REQUEST` — A path or query parameter is invalid, such as an unknown `status`, a `limit` out of range or a `startAt` after `endAt`; `fields` lists each one. content: application/json: schema: type: object properties: traceId: type: string description: >- Identifier of the request that failed. Quote it when contacting support. example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: type: string enum: - BAD_REQUEST description: >- Stable, machine-readable error code. Branch on this, never on `message`. origin: type: string enum: - BILLING description: Service that produced the error. message: type: string description: >- Human-readable explanation. Its wording may change without notice. fields: type: array description: >- One entry per invalid request field (validation errors only). items: type: object properties: field: type: string description: >- Path of the invalid field, e.g. `label` or `values[0].value`. example: label message: type: string description: Why the field was rejected. example: label is required code: type: string description: >- `_` — e.g. `LABEL_REQUIRED`, `TYPE_ONE_OF`, `VALUES_VALUE_TYPE_ERROR`. example: LABEL_REQUIRED values: type: array items: type: string description: >- The accepted values, when the field is an enumeration. required: - field - message - code required: - traceId - code - origin - message example: traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: BAD_REQUEST origin: BILLING message: >- Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields. fields: - field: name message: 'Too big: expected string to have <=56 characters' code: NAME_MAX ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.