Create Credit Grant - Documentação DEVMOB

curl --request POST \ --url https://api.example.com/api/v1/ops/credit-grants \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "amount": 123, "reason": "<string>", "startsAt": "2023-11-07T05:31:56Z", "expiresAt": "2023-11-07T05:31:56Z" } '

{ "creditGrantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "grantedByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "code": "<string>", "reason": "<string>", "amount": 123, "availableAmount": 123, "reservedAmount": 123, "usedAmount": 123, "startsAt": "2023-11-07T05:31:56Z", "expiresAt": "2023-11-07T05:31:56Z", "canceledAt": "2023-11-07T05:31:56Z", "consumedAt": "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", "deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "deletedAt": "2023-11-07T05:31:56Z" }

Authorizations

Authorization

string

header

required

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

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

Create credit grant payload

customerId

string<uuid>

required

Customer que pode usar o crédito

amount

integer

required

Valor total concedido em centavos

reason

string | null

Motivo informado pela Company

startsAt

string<date-time> | null

Data inicial de validade

expiresAt

string<date-time> | null

Data final de validade

Response

Crédito concedido por uma Company a um Customer

creditGrantId

string<uuid>

required

Identificador único

organizationId

string<uuid>

required

Organização da Company que concedeu o crédito

companyId

string<uuid>

required

Company responsável pelo crédito

customerId

string<uuid>

required

Customer que pode usar o crédito

grantedByUserId

string<uuid> | null

required

Usuário que realizou a concessão do crédito

code

string

required

Código legível único do crédito

reason

string | null

required

Motivo informado pela Company

amount

integer

required

Valor total concedido em centavos

availableAmount

integer

required

Valor disponível para novas compras em centavos

reservedAmount

integer

required

Valor reservado em checkouts ainda não capturados

usedAmount

integer

required

Valor já usado em compras confirmadas

startsAt

string<date-time> | null

required

Data inicial de validade

expiresAt

string<date-time> | null

required

Data final de validade

status

enum<string>

required

Status do crédito

Available options:

ACTIVE,

SUSPENDED,

EXPIRED,

CONSUMED,

CANCELED

canceledAt

string<date-time> | null

required

Data de cancelamento, quando aplicável

consumedAt

string<date-time> | null

required

Data em que o crédito foi consumido integralmente

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

deletedBy

string<uuid> | null

required

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

deletedAt

string<date-time> | null

required

Data de remoção lógica