Listar intenções de pagamento

Utilize este endpoint para listar as intenções de pagamento cadastradas no banco de dados.

Filtre os resultados pelo período de tempo, status da intenção e meio de pagamento.

curl --location --request GET 'https://horizon-api-sb.app.rpe.tech/api/v1/acheron/pagamento/intencoes-pagamento?status&dataInicial&dataFinal&meioPagamento&page&size&sort' \ --header 'access_token;' \ --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \ --header 'Accept: application/json'

{ "content": [ { "idCartao": 310322, "redeOrigemOperacaoPDV": "05050505050505", "emissor": "tmockred", "nsuOrigem": "554811", "adquirente": "X", "valorTransacao": "2712", "terminalRequisitante": "mockred", "id": 2621, "dataHoraTerminal": "2023-12-20T14:58:06", "status": "PENDENTE" } ], "pageable": { "sort": { "empty": false, "unsorted": false, "sorted": true }, "offset": 0, "pageNumber": 0, "pageSize": 1, "paged": true, "unpaged": false }, "totalElements": 1, "totalPages": 1, "last": true, "size": 1, "number": 0, "sort": { "empty": false, "unsorted": false, "sorted": true }, "numberOfElements": 1, "first": true, "empty": false }

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Query

status

enum<string>

requerido

Status da intenção de pagamento.
CONFIRMADA: exclusivo processadora Cards. APROVADA: demais processadoras.

Valores permitidos:

CANCELADAPENDENTECONFIRMANDOUTILIZADAEXPIRADAPRE_APROVADAESTORNADAAPROVADANEGADACONFIRMADA

Padrão:

PENDENTE

Exemplo:

PENDENTE

dataInicial

string <date-time>

requerido

Data inicial do período que deseja consultar, no formato YYYY-MM-DD.

Padrão:

2024-10-03T06:55:24

Exemplo:

2024-10-03T06:55:24

dataFinal

string <date-time>

requerido

Data final do período que deseja consultar, no formato YYYY-MM-DD.

Padrão:

2024-10-03T06:55:24

Exemplo:

2024-10-03T06:55:24

meioPagamento

enum<string>

requerido

Meio de pagamento usado na transação.

Valores permitidos:

AUTTARCABALCLOUDWALKECOMMERCEGOOD_CARDINGENICOIPFT_WEBITAUTECPAY_GORESOMAQSKYTEFURAURA_2VEROMERCISOFTWARE_EXPRESSDIRECAOTEF_NEUSCONDUCTOR_TEFECOMMERCE_CABALECOMMERCE_VTEXECOMMERCE_APITOTEMQRCODEAPITOTEM_EXTERNOSNXPIXPAYFACEMANUAL

Padrão:

SOFTWARE_EXPRESS

Exemplo:

SOFTWARE_EXPRESS

page

string

opcional

Número da página.

Padrão:

Exemplo:

size

string

opcional

Tamanho do campo.

Padrão:

Exemplo:

sort

string

opcional

Informações sobre a ordenação da página.

Parâmetros Header

access_token

string

opcional

Token de acesso. [Obrigatório para processadora Cards.]

Authorization

string

opcional

Header HTTP utilizado para autenticação do cliente. O valor deve ser um token JWT válido precedido do prefixo Bearer.

Exemplo:

Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ

string

opcional

Tipo do conteúdo aceito.

Exemplo:

application/json

Respostas

🟢200OK

application/json

Body

content

array [object {10}]

opcional

Informações sobre a intenção de pagamento.

idCartao

integer

opcional

Identificador do cartão.

Exemplo:

301322

redeOrigemOperacaoPDV

string

opcional

Ponto de venda (PDV) originário. (CNPJ do estabelecimento, com 14 dígitos e sem pontuação).

Exemplo:

05050505050505

emissor

string

opcional

Emissor da transação.

Exemplo:

tmockred

nsuOrigem

string

opcional

Número Sequencial Único (NSU) que identifica a origem da transação. Deve conter 6 dígitos.

Exemplo:

554811

adquirente

string

opcional

Identificação do adquirente.

Exemplo:

valorTransacao

string

opcional

O valor da transação.

Exemplo:

27.12

terminalRequisitante

string

opcional

Identificação do terminal que iniciou a transação.

Exemplo:

mockred

integer

opcional

Identificador da transação.

Exemplo:

2621

dataHoraTerminal

string

opcional

Data e hora do terminal onde foi iniciada a transação.

Exemplo:

2023-12-20T14:58:06

status

enum<string>

opcional

Status da transação.

Valores permitidos:

PENDENTEAPROVADACONFIRMADA

Exemplo:

PENDENTE

pageable

object

opcional

Informações sobre a paginação.

sort

object

opcional

Informações sobre a ordenação.

offset

integer

opcional

Ponto de partida para visualização das informações.

Exemplo:

pageNumber

integer

opcional

O número da página.

Exemplo:

pageSize

integer

opcional

A quantidade de registros por página.

Exemplo:

paged

boolean

opcional

Indica se é paginado.

Padrão:

true

unpaged

boolean

opcional

Indica se não é paginado.

Padrão:

false

totalElements

integer

opcional

Número total de intenções cadastradas.

Exemplo:

totalPages

integer

opcional

Número total de páginas.

Exemplo:

last

boolean

opcional

Indica se é a última intenção cadastrada.

Padrão:

true

size

integer

opcional

O tamanho do campo.

Exemplo:

number

integer

opcional

O número da intenção cadastrada.

Exemplo:

sort

object

opcional

Informações de ordenação.

empty

boolean

opcional

Indica se está vazio.

Padrão:

false

unsorted

boolean

opcional

Indica se não é ordenado.

Padrão:

false

sorted

boolean

opcional

Indica se é ordenado.

Padrão:

true

numberOfElements

integer

opcional

Quantidade de intenções mostradas na pesquisa.

Exemplo:

first

boolean

opcional

Indica se é a primeira intenção cadastrada.

Padrão:

true

empty

boolean

opcional

Indica se está vazio.

Padrão:

false

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor