> ## 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. # Get a payment link > Returns one payment link of your organization, with its products' current names and prices. `products` carries each product's current `name` and `price` (in centavos) from your organization's catalog — both absent for a product the catalog no longer has. Any member of the organization, or an admin of the realm, can read it. ## OpenAPI ````yaml /api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId} 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/{paymentLinkId}: get: tags: - Payment Links summary: Get a payment link description: >- Returns one payment link of your organization, with its products' current names and prices. operationId: >- getRealmsByRealmIdOrganizationsByOrganizationIdPaymentLinksByPaymentLinkId 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 link. Format: `UUID` schema: type: string format: uuid example: c4bd3f21-dfbd-44e8-8055-68ba15bed410 - name: paymentLinkId in: path required: true description: |- ID of the payment link. Format: `UUID` schema: type: string format: uuid example: 5c1e8d2a-7b4f-4e3a-9d6c-2a1b0f9e8d7c responses: '200': description: Successful response content: application/json: schema: type: object properties: id: type: string description: >- ID of the payment link. The checkout page of the link is addressed by it. example: 5c1e8d2a-7b4f-4e3a-9d6c-2a1b0f9e8d7c realmId: type: string description: ID of your realm. example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b organizationId: type: string description: ID of your organization. example: c4bd3f21-dfbd-44e8-8055-68ba15bed410 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`: payers can check out. `DEACTIVATED`: switched off; it can be activated again. `EXPIRED`: its `expirationDate` passed; final. 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 name: type: string description: >- Current name of the product in the catalog. Absent when the catalog no longer has it. example: Plano anual quantity: type: integer description: How many units of the product each checkout sells. example: 1 price: type: number description: >- Current price of one unit in the catalog, in centavos (`15000` is R$ 150,00). Absent when the catalog no longer has the product. example: 15000 required: - product - quantity description: >- A product the link sells, with its current name and price in the catalog. description: >- What the link sells, with each product's current name and price. 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`: each checkout charges once. `RECURRENT`: monthly, `numberOfInstallments` times. 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' createdBy: type: string description: >- ID of the user who created the link. Absent on links created before it was recorded. example: 60242bfd-228e-43e2-8c18-6dc40746eb69 updatedBy: type: string description: >- ID of the user who last changed the link. Absent on links never changed since it was recorded. example: 60242bfd-228e-43e2-8c18-6dc40746eb69 required: - id - realmId - organizationId - name - status - products - expirationDate - type - paymentMethod - secondaryPaymentMethod description: A payment link, with its products' current names and prices. '404': description: >- `PAYMENT_LINK_NOT_FOUND` — The organization has no payment link with this ID. 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: - PAYMENT_LINK_NOT_FOUND 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. required: - traceId - code - origin - message example: traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: PAYMENT_LINK_NOT_FOUND origin: BILLING message: Payment link not found '422': description: >- `BAD_REQUEST` — A path parameter is not a valid ID; `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: paymentLinkId message: Invalid UUID code: PAYMENTLINKID_UUID ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.