Skip to main content
POST
/
api
/
v1
/
ops
/
company-credit-purchases
/
{companyCreditPurchaseId}
/
cancel
Cancel Company Credit Purchase
curl --request POST \
  --url https://api.example.com/api/v1/ops/company-credit-purchases/{companyCreditPurchaseId}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>"
}
'
import requests

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

payload = { "reason": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: '<string>'})
};

fetch('https://api.example.com/api/v1/ops/company-credit-purchases/{companyCreditPurchaseId}/cancel', 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/{companyCreditPurchaseId}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

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

func main() {

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

	payload := strings.NewReader("{\n  \"reason\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/ops/company-credit-purchases/{companyCreditPurchaseId}/cancel")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "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"
  }
}
{
  "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.

Path Parameters

​
companyCreditPurchaseId
string<uuid>
required

Query Parameters

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

Body

application/json

Cancel company credit purchase payload

​
reason
string | null

Response

OK

Company credit purchase

​
companyCreditPurchaseId
string<uuid>
required
​
companyCreditAccountId
string<uuid>
required
​
organizationId
string<uuid>
required
​
companyId
string<uuid>
required
​
cooperativeId
string<uuid>
required

Cooperative identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

​
cooperative
object
required

Cooperative

​
code
string
required
​
amount
integer
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
paymentId
string<uuid> | null

Payment identifier

Example:

null

​
purchasedByUserId
string<uuid> | null
​
createdBy
string<uuid> | null
​
updatedBy
string<uuid> | null
​
canceledAt
string<date-time> | null
​
creditedAt
string<date-time> | null
​
payment
object | null