List Payments

get

https://api.datanomik.com/v1/payments

List payments. Role: ROLE_PAYMENTS_READ.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

linkId

string

Link identifier

accountId

string

Account identifier

ownerId

string

Owner identifier

generalOwnerId

string

General owner identifier

institutionId

string

Institution identifier

dateFrom

string

Start date (YYYY-MM-DD)

dateTo

string

End date (YYYY-MM-DD)

type

string

Payment type

status

string

Payment status

amountFrom

string

Minimum amount

amountTo

string

Maximum amount

currency

string

Currency (BRL, USD, etc.)

country

string

Country (BR, AR, etc.)

beneficiaryName

string

Beneficiary name

beneficiaryDocument

string

Beneficiary document

description

string

Description

transactionId

string

Transaction identifier

reference

string

Reference

barcode

string

Barcode or digitable line (linha digitável) of the payment: 44-digit barcode, 47-digit line of a bank slip (boleto) or 48-digit line of a utility/tax collection slip (tributos e concessionárias). Non-digit characters are ignored, and any of these formats matches the payment regardless of the format the bank provided. When informed, the default date range is not applied, so dateFrom and dateTo are not required. If no payment matches, the response is an empty page.

categoryId

string

Category identifier

Responses

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200

400Bad Request. Invalid or missing parameters/body, or a business rule that rejects the request.

401Unauthorized. Missing or invalid Basic Auth credentials.

403Forbidden. Source IP not whitelisted, credentials without the required scope, or trial period expired.

500Internal Server Error. Unexpected error; report the traceId to support.