> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Get the tenant's Pix receiver configuration > Returns the Pix key and the receiver address of the tenant of the credentials you authenticate with. They are the Pix receiver of the tenant's hybrid boletos (`type: HYBRID` on POST /v1/boletos), which carry a Pix QR code. A hybrid boleto issued while the key or a member of the address is missing is refused with 422 PBP-0120, naming what is missing. `complete` is true when the key and the four members of the address are present. A partial configuration, such as a key with no address, is answered 200 with `complete: false`, and the members it lacks are omitted. `complete` does not guarantee that an issuance is accepted: the receiver's name and document are not part of this configuration, they come from the record of the collection account when a boleto is issued. A CPF or CNPJ key is checked against the document of that account's holder; the other key types are not verified. Only a tenant with no Pix key configured, or with no provider credential, is answered 404 PBP-0005. ## OpenAPI ````yaml /pt/openapi/v3-current/payments.yaml get /v1/admin/pix-config openapi: 3.1.0 info: description: >- API for the Lerian Payments interface via BTG. It covers boleto issuance, cancellation, and queries; bill payments (bankslip, utilities, and DARF) and queries; aggregated boleto and payment dashboards; provider connection and outbound webhook configuration; and the provider webhook receiver for settlement events. ERROR BODIES. A failed request arrives as an RFC 9457 problem document on application/problem+json. Branch on the code member. A license refusal carries an LCS code, listed in the License Manager error list. title: Payments — via BTG API version: 1.0.0 servers: - url: https://api.example.com description: >- Replace the example host with the URL provided during environment onboarding. security: [] tags: - description: >- Tenant-level setup: connecting the banking provider and configuring where status notifications are delivered. name: Admin - description: Issuing, querying and cancelling boletos, and retrieving the rendered PDF. name: Boletos - description: >- Aggregated counts, amounts and breakdowns over a period, for boletos and for payments. name: Dashboards - description: >- Paying bankslips, utility bills and DARF tax slips, and querying those payments. name: Payments - description: >- The webhook the payment provider posts settlement events to. Authenticated with a credential agreed with the provider, not with the platform identity used by the rest of this API. name: Settlement paths: /v1/admin/pix-config: get: tags: - Admin summary: Get the tenant's Pix receiver configuration description: >- Returns the Pix key and the receiver address of the tenant of the credentials you authenticate with. They are the Pix receiver of the tenant's hybrid boletos (`type: HYBRID` on POST /v1/boletos), which carry a Pix QR code. A hybrid boleto issued while the key or a member of the address is missing is refused with 422 PBP-0120, naming what is missing. `complete` is true when the key and the four members of the address are present. A partial configuration, such as a key with no address, is answered 200 with `complete: false`, and the members it lacks are omitted. `complete` does not guarantee that an issuance is accepted: the receiver's name and document are not part of this configuration, they come from the record of the collection account when a boleto is issued. A CPF or CNPJ key is checked against the document of that account's holder; the other key types are not verified. Only a tenant with no Pix key configured, or with no provider credential, is answered 404 PBP-0005. operationId: getAdminPixConfig parameters: - description: >- Tenant organization ID. Optional. The organization context is determined by the credentials you authenticate with; this header does not select or change it. in: header name: X-Organization-Id schema: description: >- Tenant organization ID. Optional. The organization context is determined by the credentials you authenticate with; this header does not select or change it. type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/PixConfigResponse' description: OK '400': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Bad Request '401': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: >- Authentication failed: the request carries no valid credential, or the credential does not identify a tenant. The error body is an RFC 9457 problem document (`application/problem+json`) with error code `PBP-0003`. Obtain a valid bearer token and send the request again. '403': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: >- The authenticated principal is not allowed to perform this request. The error body is an RFC 9457 problem document (`application/problem+json`) with error code `PBP-0004`: the principal lacks permission for this operation, and the permission has to be granted before the request can succeed. '404': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Not Found '422': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Unprocessable Entity '500': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Internal Server Error '503': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: >- Service Unavailable. PBP-0008 means a dependency the request needs, authentication or the tenant's storage, is temporarily unavailable. The request was not processed; wait and send it again. security: - BearerAuth: [] components: schemas: PixConfigResponse: additionalProperties: false properties: complete: description: >- True when the key and the four members of the address are present, which is what a boleto that carries a Pix QR code needs from this configuration. It does not guarantee that an issuance is accepted: the receiver's name and document are not part of this configuration, they come from the record of the collection account when a boleto is issued. A CPF or CNPJ key is checked against the document of that account's holder; the other key types are not verified. type: boolean pixKey: description: >- The configured Pix key. It is not masked: it is public data, carried in the Pix QR code of every boleto that pays it. examples: - f34f8ec2-a4b7-41b4-8200-b53a07e00bac type: string receiverAddress: $ref: '#/components/schemas/PixReceiverAddressResponse' description: >- The receiver's address. Omitted when none is configured; a member that is not configured is omitted too. updatedAt: description: >- When the configuration was last written with POST /v1/admin/pix-config, in UTC. Omitted for a configuration never written with it. examples: - '2026-10-13T15:04:05Z' format: date-time type: string updatedBy: description: >- Identifier of the authenticated principal that made that write: the subject of its access token. Omitted like updatedAt. type: string required: - pixKey - complete type: object Detail: additionalProperties: true properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string upstream: $ref: '#/components/schemas/Upstream' description: >- RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one. type: object PixReceiverAddressResponse: additionalProperties: false properties: city: description: City. examples: - SAO PAULO type: string state: description: State code (UF). examples: - SP type: string street: description: Street and number. examples: - Avenida Paulista 1000 type: string zipCode: description: CEP with 8 digits. examples: - '01310100' type: string type: object ErrorDetail: additionalProperties: false properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object Upstream: additionalProperties: false properties: code: description: The upstream provider's own error code, verbatim. examples: - E4001 type: string message: description: >- The upstream provider's own error message, verbatim (bounded, never its raw response body). examples: - account not found at provider type: string type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.