--- updatedAt: 2026-06-30T23:26:37.000Z agentTools: projectIndex: https://docs.datanomik.com/llms.txt --- # List Payment Slips List payment slips. Role: ROLE_PAYMENTS_READ. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "openbanking-api", "version": "1.0" }, "servers": [ { "url": "https://api.datanomik.com" } ], "components": { "securitySchemes": { "sec0": { "type": "http", "scheme": "basic" } } }, "security": [ { "sec0": [] } ], "paths": { "/v1/payment-slips": { "get": { "responses": { "200": { "description": "", "content": { "application/json": { "examples": { "OK": { "summary": "OK", "value": { "content": [ { "id": "11111111-1111-1111-1111-111111111111", "bank_number": "00000000000", "client_number": "0000000", "amount": 14860.34, "charged_amount": 14860.34, "fee": 0, "date": "2026-05-29", "due_date": "2026-06-05", "metadata": { "display_name": "EXAMPLE BENEFICIARY LTDA", "fluctuation": 0, "occurrence": 1, "modality": "BOLETO", "payer_document": "12.345.678/0001-99", "tx_id": "00000000000000000000", "movement_description": "Boleto outros bancos", "status": "SETTLED", "settlement_date": "2026-05-29", "settled_amount": 14860.34, "discount": 0, "rebate": 0, "penalty": 0, "interest": 0, "tariff": 0, "costs": 0 }, "link": { "id": "22222222-2222-2222-2222-222222222222", "country": "BR", "institution": "ITAU_WEB", "institution_description": "Itau", "institution_logo": "https://resources.datanomik.com/institutions/br/Itau.svg" }, "account": { "id": "33333333-3333-3333-3333-333333333333", "account_number": "00000-0", "branch": "0000", "currency": "BRL", "type": "Conta Corrente", "owner": { "id": "44444444-4444-4444-4444-444444444444", "document": "98.765.432/0001-10", "document_type": "CNPJ", "display_name": "EXAMPLE OWNER LTDA" }, "description": "Conta Corrente", "category": "CHECKING" } } ], "first": true, "last": false, "page_number": 0, "page_size": 1, "total_elements": 12, "total_pages": 12 } } } } } }, "400": { "description": "Bad Request. Invalid or missing parameters/body, or a business rule that rejects the request.", "content": { "application/json": { "examples": { "BEAN_VALIDATION_ERROR": { "value": "{\n \"code\": 402,\n \"type\": \"BEAN_VALIDATION_ERROR\",\n \"message\": \"Invalid arguments for specific request. Please check details to satisfy validations\",\n \"traceId\": \"0af7651916cd43dd8448eb211c80319c\",\n \"details\": [\n \"linkId: must not be blank\"\n ]\n}" }, "TYPE_MISMATCH": { "value": "{\n \"code\": 454,\n \"type\": \"TYPE_MISMATCH\",\n \"message\": \"Type mismatch for parameter\",\n \"traceId\": \"0af7651916cd43dd8448eb211c80319c\"\n}" } }, "schema": { "type": "object", "properties": { "code": { "type": "integer", "example": 402 }, "type": { "type": "string", "example": "BEAN_VALIDATION_ERROR" }, "message": { "type": "string", "example": "Invalid arguments for specific request. Please check details to satisfy validations" }, "traceId": { "type": "string", "example": "0af7651916cd43dd8448eb211c80319c" }, "details": { "type": "array", "items": { "type": "string" }, "example": [ "linkId: must not be blank" ] } } } } } }, "401": { "description": "Unauthorized. Missing or invalid Basic Auth credentials.", "content": { "application/json": { "examples": { "UNAUTHORIZED": { "value": "{\n \"code\": 401,\n \"type\": \"UNAUTHORIZED\",\n \"message\": \"Invalid credentials.\",\n \"traceId\": \"0af7651916cd43dd8448eb211c80319c\"\n}" } }, "schema": { "type": "object", "properties": { "code": { "type": "integer", "example": 401 }, "type": { "type": "string", "example": "UNAUTHORIZED" }, "message": { "type": "string", "example": "Invalid credentials." }, "traceId": { "type": "string", "example": "0af7651916cd43dd8448eb211c80319c" } } } } } }, "403": { "description": "Forbidden. Source IP not whitelisted, credentials without the required scope, or trial period expired.", "content": { "application/json": { "examples": { "IP_NOT_ALLOWED": { "value": "{\n \"code\": 632,\n \"type\": \"IP_NOT_ALLOWED\",\n \"message\": \"Source ip address not allowed.\",\n \"traceId\": \"0af7651916cd43dd8448eb211c80319c\"\n}" }, "FORBIDDEN": { "value": "{\n \"code\": 403,\n \"type\": \"FORBIDDEN\",\n \"message\": \"Forbidden\",\n \"traceId\": \"0af7651916cd43dd8448eb211c80319c\"\n}" } }, "schema": { "type": "object", "properties": { "code": { "type": "integer", "example": 632 }, "type": { "type": "string", "example": "IP_NOT_ALLOWED" }, "message": { "type": "string", "example": "Source ip address not allowed." }, "traceId": { "type": "string", "example": "0af7651916cd43dd8448eb211c80319c" } } } } } }, "500": { "description": "Internal Server Error. Unexpected error; report the `traceId` to support.", "content": { "application/json": { "examples": { "INTERNAL_ERROR": { "value": "{\n \"code\": 500,\n \"type\": \"INTERNAL_ERROR\",\n \"message\": \"Unexpected error. Please contact support with the traceId.\",\n \"traceId\": \"0af7651916cd43dd8448eb211c80319c\"\n}" } }, "schema": { "type": "object", "properties": { "code": { "type": "integer", "example": 500 }, "type": { "type": "string", "example": "INTERNAL_ERROR" }, "message": { "type": "string", "example": "Unexpected error. Please contact support with the traceId." }, "traceId": { "type": "string", "example": "0af7651916cd43dd8448eb211c80319c" } } } } } } }, "parameters": [ { "in": "query", "name": "linkId", "schema": { "type": "string" }, "description": "Link identifier" }, { "in": "query", "name": "accountId", "schema": { "type": "string" }, "description": "Account identifier" }, { "in": "query", "name": "ownerId", "schema": { "type": "string" }, "description": "Owner identifier" }, { "in": "query", "name": "generalOwnerId", "schema": { "type": "string" }, "description": "General owner identifier" }, { "in": "query", "name": "institutionId", "schema": { "type": "string" }, "description": "Institution identifier" }, { "in": "query", "name": "dateFrom", "schema": { "type": "string" }, "description": "Start date (YYYY-MM-DD)" }, { "in": "query", "name": "dateTo", "schema": { "type": "string" }, "description": "End date (YYYY-MM-DD)" }, { "in": "query", "name": "currency", "schema": { "type": "string" }, "description": "Currency (BRL, USD, etc.)" }, { "in": "query", "name": "country", "schema": { "type": "string" }, "description": "Country (BR, AR, etc.)" } ], "summary": "List Payment Slips", "operationId": "get_v1-payments-2", "description": "List payment slips. Role: ROLE_PAYMENTS_READ." } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```