Skip to main content
GET
/
api
/
v1
/
ops
/
company-credit-purchases
List Company Credit Purchases
curl --request GET \
  --url https://api.example.com/api/v1/ops/company-credit-purchases \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.example.com/api/v1/ops/company-credit-purchases"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/api/v1/ops/company-credit-purchases', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/ops/company-credit-purchases",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/ops/company-credit-purchases"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/ops/company-credit-purchases")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/ops/company-credit-purchases")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "data": [
    {
      "companyCreditPurchaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "companyCreditAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cooperativeId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
      "cooperative": {
        "cooperativeId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
        "organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
        "organization": {
          "document": "45.723.174/0001-10",
          "documentType": "CNPJ",
          "name": "Cooperativa Metropolitana",
          "organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
          "type": "COOPERATIVE",
          "email": "contato@estrela.com",
          "legalName": "Cooperativa Metropolitana de Transporte Ltda.",
          "logo": "organizations/0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a/logo/0195e7b2-4a3c-7d3e-9f4a-2c6b8d0e1f3b.png",
          "tradeName": "Metropolitana"
        }
      },
      "code": "<string>",
      "amount": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "paymentId": null,
      "purchasedByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "canceledAt": "2023-11-07T05:31:56Z",
      "creditedAt": "2023-11-07T05:31:56Z",
      "payment": {
        "paymentId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
        "orderId": null,
        "organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3c",
        "organization": {
          "document": "45.723.174/0001-10",
          "documentType": "CNPJ",
          "name": "Cooperativa Metropolitana",
          "organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
          "type": "COOPERATIVE",
          "email": "contato@estrela.com",
          "legalName": "Cooperativa Metropolitana de Transporte Ltda.",
          "logo": "organizations/0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a/logo/0195e7b2-4a3c-7d3e-9f4a-2c6b8d0e1f3b.png",
          "tradeName": "Metropolitana"
        },
        "cooperativeId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3c",
        "cooperative": {
          "cooperativeId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
          "organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
          "organization": {
            "document": "45.723.174/0001-10",
            "documentType": "CNPJ",
            "name": "Cooperativa Metropolitana",
            "organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
            "type": "COOPERATIVE",
            "email": "contato@estrela.com",
            "legalName": "Cooperativa Metropolitana de Transporte Ltda.",
            "logo": "organizations/0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a/logo/0195e7b2-4a3c-7d3e-9f4a-2c6b8d0e1f3b.png",
            "tradeName": "Metropolitana"
          }
        },
        "externalProvider": "mock",
        "externalProviderId": "pay_a1b2c3d4",
        "externalOrderId": "order_a1b2c3d4",
        "method": "PIX",
        "channel": "ONLINE",
        "amount": 15000,
        "status": "PENDING",
        "createdAt": "2023-11-07T05:31:56Z",
        "issuedAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "cashSettlementId": null,
        "description": "Order payment",
        "card": {},
        "pix": {},
        "canceledBy": null,
        "createdBy": null,
        "updatedBy": null,
        "canceledAt": "2023-11-07T05:31:56Z",
        "dueDate": "2023-11-07T05:31:56Z",
        "overdueAt": "2023-11-07T05:31:56Z",
        "paidAt": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "meta": {
    "limit": 10,
    "page": 1,
    "totalItems": 100,
    "totalPages": 10
  }
}
{
  "errors": [
    {
      "message": "required",
      "path": "name"
    }
  ],
  "message": "Bad Request Error",
  "statusCode": 400
}
{
  "message": "Missing or invalid access token",
  "statusCode": 401
}
{
  "message": "Insufficient permissions",
  "statusCode": 403
}
{
  "message": "Internal Server Error",
  "statusCode": 500
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
number
default:10

Items per page

Example:

10

​
page
number
default:1

Page number

Example:

1

​
status
enum<string>

Credit purchase status

Available options:
ANTIFRAUD_APPROVED,
ANTIFRAUD_MANUAL,
ANTIFRAUD_PENDING,
ANTIFRAUD_REPROVED,
CANCELED,
CHARGEDBACK,
OVERPAID,
PAID,
PARTIAL_CANCELED,
PAYMENT_FAILED,
PENDING,
PROCESSING,
REFUNDED,
UNDERPAID
Example:

"PENDING"

​
createdAt
string

Created date range

Example:

">=2024-01-01;<=2024-12-31"

​
paidAt
string

Paid date range

Example:

">=2024-01-01;<=2024-12-31"

​
sortBy
enum<string>
default:createdAt

Field to sort by

Available options:
createdAt,
creditedAt,
amount
Example:

"createdAt"

​
sortOrder
enum<string>
default:desc

Sort order

Available options:
asc,
desc
Example:

"desc"

​
fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

List company credit purchases

​
data
object[]
required
​
meta
object
required