GET/api/v1/pagamentos/transactions

Listar

Esta API retorna uma lista de transações, possivelmente paginada.

Parâmetros

AcceptObrigatório
header

application/json

Tipo:string
AuthorizationObrigatório
header

Bearer {{access_token}}

Tipo:string

Parâmetros de Query (Opcionais)

Parâmetros para paginação, filtragem ou ordenação podem ser utilizados.

CampoTipoDescrição
linksObjectObjeto contendo links de paginação.
links.firstStringURL da primeira página.
links.lastStringURL da última página.
links.prevStringURL da página anterior (pode ser null).
links.nextStringURL da próxima página (pode ser null).
metaObjectMetadados sobre a paginação.

Descrição dos Campos da Resposta

CampoTipoDescrição
dataArrayArray de objetos, onde cada objeto representa uma transação.
idStringID único da transação (UUID).
statusStringStatus da transação (pending, canceled, paid, processing, expired, liquided).
payment_methodStringMétodo de pagamento (credit, debit, pix, voucher, vale ou null).
typeStringTipo da transação (payment, cancelation).
installmentsInteiroNúmero de parcelas (>= 1).
merchant_idStringID do comerciante (<= 36 caracteres).
customer_nameStringNome do cliente (<= 200 caracteres ou null).
customer_identifierStringIdentificador do cliente (<= 50 caracteres ou null).
valueStringValor da transação (>= 0 ou null).
discount_valueStringValor do desconto (>= 0 ou null).
net_valueStringValor líquido da transação (>= 0 ou null).
external_idStringID externo da transação (<= 100 caracteres).
urlStringURL para webhooks (<= 1024 caracteres ou null).
terminal_idStringID do terminal (UUID).
payment_dateStringData do pagamento.
raw_contentStringConteúdo bruto (pode ser null).
uuid_referenceStringReferência UUID (necessário para cancelamento de transação).

Códigos de Respostas

CódigoSignificadoDescrição
200OKListagem realizada com sucesso.
401UnauthorizedToken de autenticação inválido ou ausente.
500Internal Server ErrorErro interno no servidor.
curl --location 'https://api-h.nuvende.com.br/api/v1/pagamentos/transactions' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{ access_token }}'
const axios = require("axios");

const config = {
  method: "get",
  url: "https://api-h.nuvende.com.br/api/v1/pagamentos/transactions",
  headers: {
    Accept: "application/json",
    Authorization: "Bearer {{ access_token }}",
  },
};

axios(config)
  .then((response) => {
    console.log(JSON.stringify(response.data));
  })
  .catch((error) => {
    console.log(error);
  });
import requests

url = "https://api-h.nuvende.com.br/api/v1/pagamentos/transactions"

headers = {
    'Accept': 'application/json',
    'Authorization': 'Bearer {{ access_token }}'
}

response = requests.get(url, headers=headers)

print(response.text)
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api-h.nuvende.com.br/api/v1/pagamentos/transactions',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => array(
    'Accept: application/json',
    'Authorization: Bearer {{ access_token }}'
  ),
));

$response = curl_exec($curl);
curl_close($curl);
echo $response;
?>
{
  "data": [
    {
      "id": "9dd1b42a-8da0-45f6-83a1-10bbd41a3eb0",
      "status": "pending",
      "payment_method": "credit",
      "type": "payment",
      "installments": 1,
      "merchant_code": null,
      "merchant_id": null,
      "transaction_identifier": null,
      "authorization": null,
      "customer_name": "Wendy Jones",
      "customer_identifier": "aac7778a-967a-45ed-a2d9-d4aa6de8ce6e",
      "value": "100.50",
      "discount_value": "0.00",
      "net_value": "100.50",
      "external_id": "b1ee6dbb-98ae-4ce8-8bc9-b3a54d2f27bd",
      "url": "https://webhook-test.com/d6df4d27ec979d9bb6e78fc06c4d44b5",
      "terminal_id": "32a080cb-eb8a-4a51-9e6b-d1e2d22cbdb9",
      "payment_date": "2024-12-24T14:15:22.000000Z",
      "created_at": "2024-12-26T19:06:04.000000Z",
      "updated_at": "2024-12-26T19:06:04.000000Z"
    }
  ],
  "links": {
    "first": "http://localhost:8082/api/transactions?page=1",
    "last": "http://localhost:8082/api/transactions?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "per_page": 50,
    "to": 3,
    "total": 3
  }
}