Cancel Company Credit Purchase - Documentação DEVMOB

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>" } '

{ "companyCreditPurchaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "companyCreditAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "purchasedByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "approvedByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "code": "<string>", "amount": 123, "externalProvider": "<string>", "externalProviderId": "<string>", "paidAt": "2023-11-07T05:31:56Z", "approvedAt": "2023-11-07T05:31:56Z", "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "createdAt": "2023-11-07T05:31:56Z", "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "updatedAt": "2023-11-07T05:31:56Z" }

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

Company Credit Purchase Id

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

required

Cancellation reason

Response

Compra de créditos corporativos feita pela empresa junto à master/MOB

companyCreditPurchaseId

string<uuid>

required

Identificador único

companyCreditAccountId

string<uuid>

required

Conta corporativa impactada

organizationId

string<uuid>

required

Organização da Company

companyId

string<uuid>

required

Company compradora

purchasedByUserId

string<uuid> | null

required

Usuário da Company que solicitou a compra

approvedByUserId

string<uuid> | null

required

Usuário ou processo que incorporou a compra ao saldo

code

string

required

Código legível da compra

amount

integer

required

Valor comprado em centavos

externalProvider

string | null

required

Provedor externo de pagamento, quando aplicável

externalProviderId

string | null

required

Identificador externo da cobrança, quando aplicável

status

enum<string>

required

Status da compra

Available options:

PENDING,

PAID,

APPROVED,

REJECTED,

CANCELED

paidAt

string<date-time> | null

required

Data em que a compra foi paga

approvedAt

string<date-time> | null

required

Data de aprovação

createdBy

string<uuid> | null

required

Usuário que criou o registro, quando aplicável

createdAt

string<date-time>

required

Data de criação

updatedBy

string<uuid> | null

required

Usuário que fez a última atualização, quando aplicável

updatedAt

string<date-time>

required

Data da última atualização