> ## Documentation Index > Fetch the complete documentation index at: https://docs.devmob.app.br/llms.txt > Use this file to discover all available pages before exploring further. # List Payments > Lists payments. ## OpenAPI ````yaml /api-reference/bko/openapi.json get /api/v1/bko/payments openapi: 3.0.0 info: title: DEVMOB BKO API version: '1.0' servers: [] security: [] tags: - name: Auth description: Authentication endpoints. - name: Benefit Category description: Global fare benefit category endpoints. - name: Benefit Program description: Platform fare benefit program endpoints. - name: Invite description: Invitation endpoints. - name: Member description: BKO internal member endpoints. - name: Order description: Order query endpoints. - name: Organization description: Organization management endpoints. - name: Organization Address description: Organization address endpoints. - name: Payment description: Payment query endpoints. - name: Permission description: Permission catalog endpoints. - name: Place description: Place lookup endpoints. - name: Point description: Global point catalog endpoints. - name: Profile description: Authenticated BKO profile endpoints. - name: Receivable description: Receivable query endpoints. - name: Report description: Platform report endpoints. - name: Role description: Internal and reusable role endpoints. - name: Storage description: Storage upload signing endpoints. - name: Transfer description: Transfer query endpoints. - name: User description: Platform user administration endpoints. paths: /api/v1/bko/payments: get: tags: - Payment summary: List Payments description: Lists payments. operationId: listPayments parameters: - name: limit required: false in: query schema: default: 10 description: Items per page example: 10 type: number - name: page required: false in: query schema: default: 1 description: Page number example: 1 type: number - name: status required: false in: query schema: type: string enum: - ANTIFRAUD_APPROVED - ANTIFRAUD_MANUAL - ANTIFRAUD_PENDING - ANTIFRAUD_REPROVED - CANCELED - CHARGEDBACK - OVERPAID - PAID - PARTIAL_CANCELED - PAYMENT_FAILED - PENDING - PROCESSING - REFUNDED - UNDERPAID description: Payment status example: PENDING - name: method required: false in: query schema: type: string enum: - CASH - PIX - CREDIT_CARD - DEBIT_CARD description: Payment method example: PIX - name: organizationId required: false in: query schema: description: Organization identifier example: 01900000-0000-7000-8000-000000000020 type: string format: uuid - name: sortBy required: false in: query schema: default: createdAt description: Field to sort by example: createdAt type: string enum: - createdAt - paidAt - amount - name: sortOrder required: false in: query schema: default: desc description: Sort order example: desc type: string enum: - asc - desc - name: fields required: false in: query description: >- Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. `id,name,user.email,trips.route.id`). Unknown fields are silently dropped. schema: type: string responses: '200': content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/Payment' meta: $ref: '#/components/schemas/PageMeta' required: - data - meta description: OK '400': content: application/json: example: errors: - message: required path: name message: Bad Request Error statusCode: 400 schema: properties: message: type: string statusCode: enum: - 400 type: number errors: items: properties: message: type: string path: type: string required: - message - path type: object type: array required: - message - statusCode type: object description: Bad Request Error '401': content: application/json: example: message: Missing or invalid access token statusCode: 401 schema: properties: message: type: string statusCode: enum: - 401 type: number required: - message - statusCode type: object description: Unauthorized '403': content: application/json: example: message: Insufficient permissions statusCode: 403 schema: properties: message: type: string statusCode: enum: - 403 type: number required: - message - statusCode type: object description: Forbidden '500': content: application/json: example: message: Internal Server Error statusCode: 500 schema: properties: message: type: string statusCode: enum: - 500 type: number required: - message - statusCode type: object description: Internal Server Error security: - bearer: [] - bearer: [] components: schemas: Payment: type: object properties: paymentId: type: string format: uuid description: Identificador único orderId: type: string format: uuid description: Referência ao pedido (relação 1:1) organizationId: type: string format: uuid description: Referência à organização da empresa beneficiária companyId: type: string format: uuid description: Referência à empresa beneficiária externalProvider: type: string description: Nome do provedor externo de pagamento externalProviderId: type: string description: ID da transação no provedor externo description: type: string nullable: true description: Descrição do pagamento method: type: string enum: - CASH - PIX - CREDIT_CARD - DEBIT_CARD description: Método de pagamento channel: type: string enum: - ONLINE - POS description: Canal em que o pagamento foi criado card: type: object additionalProperties: true nullable: true description: Metadados do cartão (quando aplicável) pix: type: object additionalProperties: true nullable: true description: Metadados do PIX (quando aplicável) amount: type: integer description: Valor do pagamento em centavos dueDate: type: string format: date-time nullable: true description: Data de vencimento status: type: string enum: - PENDING - PROCESSING - ANTIFRAUD_PENDING - ANTIFRAUD_MANUAL - ANTIFRAUD_APPROVED - ANTIFRAUD_REPROVED - PAID - UNDERPAID - OVERPAID - PARTIAL_CANCELED - CANCELED - PAYMENT_FAILED - REFUNDED - CHARGEDBACK description: Status do pagamento issuedAt: type: string format: date-time description: Data de emissão paidAt: type: string format: date-time nullable: true description: Data em que o pagamento foi confirmado overdueAt: type: string format: date-time nullable: true description: Data em que o pagamento ficou vencido canceledBy: type: string format: uuid nullable: true description: Usuário que cancelou o pagamento, quando aplicável canceledAt: type: string format: date-time nullable: true description: Data de cancelamento createdBy: type: string format: uuid nullable: true description: Usuário que criou o registro, quando aplicável createdAt: type: string format: date-time description: Data de criação updatedBy: type: string format: uuid nullable: true description: Usuário que fez a última atualização, quando aplicável updatedAt: type: string format: date-time description: Data da última atualização required: - paymentId - orderId - organizationId - companyId - externalProvider - externalProviderId - description - method - channel - card - pix - amount - dueDate - status - issuedAt - paidAt - overdueAt - canceledBy - canceledAt - createdBy - createdAt - updatedBy - updatedAt description: Pagamento único associado a um pedido PageMeta: type: object properties: page: type: integer description: Current page number example: 1 limit: type: integer description: Items per page example: 20 total: type: integer description: Total number of items example: 125 totalPages: type: integer description: Total number of pages example: 7 required: - page - limit - total - totalPages description: Pagination metadata securitySchemes: bearer: scheme: bearer bearerFormat: JWT type: http ````