Listar Pagamentos

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

Utilize esse recurso para recuperar todos os pagamentos vinculados a loja. Você tem a opção de filtrar os resultados selecionando o estado do pagamento desejado.

❗️
Observação:

O período entre dateStart e dateEnd não deve exceder 30 dias.

Query Params

page

int32

Defaults to 1

Número da página que deseja consultar. Deve ser um valor igual ou maior que um, representando o deslocamento da página desejada.

perPage

int32

Defaults to 10

Tamanho da página desejada. Este valor determina a quantidade de resultados a serem retornados em uma única consulta. Tamanho máximo de até 2000.

string

Identificador do pagamento que deseja consultar.

orderNumber

string

Código de identificação da compra utilizado pela loja que deseja consultar.

onlineId

string

Seu número de identificação adicional da compra/Número do pedido que deseja consultar.

authorizationCode

string

Código de autorização que deseja consultar.

nsu

string

NSU do pagamento que deseja consultar.

type

string

Tipo de pagamento que deseja consultar. Valores permitidos:
- CREDIT
- DEBIT
- PIX

status

string

Status do pagamento que deseja consultar. Valores permitidos:
- 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

Bandeira do cartão que deseja consultar. Valores permitidos:
- MASTERCARD
- VISA
- ELO
- HIPERCARD
- AMEX

installments

int32

Número de parcelas que deseja consultar. Valores permitidos: 1x to 12x.

dateStart

date

Data de início do intervalo de busca. Exemplo: 2000-12-20

dateEnd

date

Data final do intervalo de busca. Exemplo: 2000-12-20

Headers

Authorization

string

required

Chave de integração única gerado pela Autenticação de Pagamento (PayAuth) para o estabelecimento.

Formato
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

❗️Observação:

200200

400400

401401

422422

500500

❗️
Observação: