List Payments

get https://api-kosmos.ultrapayments.com.br/payments/api/sales

Use this feature to retrieve all payments linked to the store. You have the option to filter the results by selecting the desired payment status.

❗️
Note:

The period between dateStart and dateEnd must not exceed 30 days.

Query Params

page

int32

Defaults to 1

Page number to query. Must be a value equal to or greater than one, representing the desired page offset.

perPage

int32

Defaults to 10

Desired page size. This value determines the number of results to be returned in a single query. Maximum size of up to 2000.

string

Payment identifier to query.

orderNumber

string

Purchase identification code used by the store to query.

onlineId

string

Your additional purchase identification number/Order number to query.

authorizationCode

string

Authorization code to query.

nsu

string

NSU of the payment to query.

type

string

Payment type to query. Allowed values:
- CREDIT
- DEBIT
- PIX

status

string

Payment status to query. Allowed values:
- PRE_AUTHORIZED
- CANCELLED
- AUTHORIZED
- REFUNDED_WAITING
- IN_PROCESSING
- REFUNDED
- NOT_AUTHORIZED
- REVERSED

amount

int32

Payment amount to query. Only positive integer numbers.
Example: $ 39.90 = 3990

brand

string

Card brand to query. Allowed values:
- MASTERCARD
- VISA
- ELO
- HIPERCARD
- AMEX

installments

int32

Number of installments to query. Allowed values: 1x até 12x.

dateStart

date

Start date of the search interval. Example: 2000-12-20

dateEnd

date

End date of the search interval. Example: 2000-12-20

Headers

Authorization

string

required

Unique integration key generated by Payment Authentication (PayAuth) for the establishment.

Format
Bearer <access_token>

Responses

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api-kosmos.ultrapayments.com.br/payments/api/sales \
3
     --header 'accept: application/json'

Choose an example:

application/json

❗️Note:

200200

400400

401401

422422

500500

❗️
Note: