raims charges

Get the boleto download information.

GET /v1/charges/{id}/boleto

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox, Production.

Create a charge.

POST /v1/charges

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox, Production.

Read the JSON request body with --data-file PATH, or --data-file - for standard input. You can also provide the body options listed below. Repeat array options for each item. Do not combine file input with body options. Only supplied fields are sent. When listed, --body-null FIELD sends an explicit null for a nullable field. Array size and uniqueness follow the endpoint contract. Objects without dedicated body options and arrays of objects use file input.

JSON body fields:
  amount_cents          integer         required
  cancel_redirect_url   string          optional, nullable
  create_checkout       boolean         optional
  customer_id           string          required
  description           string          optional, nullable
  due_date              integer         required
  external_reference    string          optional, nullable
  metadata              object          optional, nullable
  payment_method        integer         optional; allowed: 0, 1, 2
  payment_method_types  array<integer>  optional, nullable; allowed: 1, 2
  send_email            boolean         optional
  success_redirect_url  string          optional, nullable
  title                 string          optional, nullable
Nested requirements apply when the parent object is present, or for each supplied array item. Omit an optional field to leave it unspecified; null is accepted only for nullable fields.

JSON body example (save as request.json):
{
  "customer_id": "cus_1Q2W3E4R5T6Y7U8I9O0P",
  "amount_cents": 10000,
  "payment_method": 0,
  "due_date": 1893456000,
  "title": "Serviço contratado",
  "description": "Cobrança do serviço",
  "send_email": false,
  "external_reference": "pedido_12345"
}
Example values are illustrative. Replace resource IDs and review the request before sending it.

HTTP 202 means the request is pending. Inspect the returned resource before repeating an operation; this command does not wait for completion.

Metadata options send a text map: repeat --metadata KEY=VALUE for values, use --metadata-null KEY for a null value, or --metadata-empty for an empty object. Empty text, numeric-looking values and the text null remain strings. Omitted metadata and an empty object preserve existing keys when updating; null values remove individual keys, and --body-null metadata clears the entire map. Do not combine these options with --data-file, or use multiple values for the same key.

Get a charge.

GET /v1/charges/{id}

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox, Production.

List charges.

GET /v1/charges

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox, Production.

Get payment details for a charge.

GET /v1/charges/{id}/payment

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox, Production.

Get the payment receipt download information.

GET /v1/charges/{id}/receipt

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox, Production.

Check whether a charge can be refunded.

GET /v1/charges/{id}/refund_eligibility

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox, Production.

Request a refund for a charge.

POST /v1/charges/{id}/refunds

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox, Production.

Read the JSON request body with --data-file PATH, or --data-file - for standard input. You can also provide the body options listed below. Repeat array options for each item. Do not combine file input with body options. Only supplied fields are sent. When listed, --body-null FIELD sends an explicit null for a nullable field. Array size and uniqueness follow the endpoint contract. Objects without dedicated body options and arrays of objects use file input.

JSON body fields:
  amount_cents  integer  required
  description   string   optional, nullable
Nested requirements apply when the parent object is present, or for each supplied array item. Omit an optional field to leave it unspecified; null is accepted only for nullable fields.

JSON body example (save as request.json):
{
  "amount_cents": 2500,
  "description": "Devolução parcial do serviço"
}
Example values are illustrative. Replace resource IDs and review the request before sending it.

HTTP 202 means the request is pending. Inspect the returned resource before repeating an operation; this command does not wait for completion.

List refunds for a charge.

GET /v1/charges/{id}/refunds

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox, Production.

Revoke a charge.

DELETE /v1/charges/{id}

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox, Production.

HTTP 202 means the request is pending. Inspect the returned resource before repeating an operation; this command does not wait for completion.

Get charge statistics for a period.

GET /v1/charges/statistics

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox, Production.

Update a charge.

PATCH /v1/charges/{id}

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox, Production.

Read the JSON request body with --data-file PATH, or --data-file - for standard input. You can also provide the body options listed below. Repeat array options for each item. Do not combine file input with body options. Only supplied fields are sent. When listed, --body-null FIELD sends an explicit null for a nullable field. Array size and uniqueness follow the endpoint contract. Objects without dedicated body options and arrays of objects use file input.

JSON body fields:
  description         string  optional, nullable
  external_reference  string  optional, nullable
  metadata            object  optional, nullable
  title               string  optional, nullable
Nested requirements apply when the parent object is present, or for each supplied array item. Omit an optional field to leave it unspecified; null is accepted only for nullable fields.

JSON body example (save as request.json):
{
  "title": "Serviço atualizado",
  "description": "Descrição atualizada da cobrança",
  "external_reference": "pedido_12345_atualizado"
}
Example values are illustrative. Replace resource IDs and review the request before sending it.

Metadata options send a text map: repeat --metadata KEY=VALUE for values, use --metadata-null KEY for a null value, or --metadata-empty for an empty object. Empty text, numeric-looking values and the text null remain strings. Omitted metadata and an empty object preserve existing keys when updating; null values remove individual keys, and --body-null metadata clears the entire map. Do not combine these options with --data-file, or use multiple values for the same key.