API Reference
  1. PAGAMENTOS

Listar Pagamentos

get
https://api-kosmos.ultrapayments.com.br/payments/api/sales
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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
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.

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.

string

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

string

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

string

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

string

NSU do pagamento que deseja consultar.

string
enum

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

Allowed:
string
enum

Status do pagamento que deseja consultar. Valores permitidos:
- PRE_AUTHORIZED
- CANCELLED
- AUTHORIZED
- REFUNDED_WAITING
- IN_PROCESSING
- REFUNDED
- NOT_AUTHORIZED
- REVERSED

int32

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

string
enum

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

Allowed:
int32

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

date

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

date

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

Headers
string
required

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

Formato
Bearer <access_token>

Responses

Updated almost 2 years ago

Language
LoadingLoading…
Response
Choose an example:
application/json

Updated almost 2 years ago