raims charges | Raims Documentation

Look up syntax, arguments, and options for each command. Use raims COMMAND --help to read the help in your terminal.

`raims charges`

Manage charges and their payment details

Shell

raims charges [flags]

--help, -h bool default: false
- help for charges

Subcommands: raims charges boleto, raims charges create, raims charges get, raims charges list, raims charges payment, raims charges receipt, raims charges refund-eligibility, raims charges refunds, raims charges revoke, raims charges statistics, raims charges update.

`raims charges boleto`

Get the boleto download information

Shell

raims charges boleto ID [flags]

--dry-run bool default: false
- Validate and preview the request without credentials or network access
--help, -h bool default: false
- help for boleto
--save string default: empty
- Save the PDF to PATH (up to 32 MiB); the parent directory must exist and the file must not exist
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

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.

Command example

Shell

raims --profile PROFILE --output json charges boleto ID --dry-run

`raims charges create`

Create a charge

Shell

raims charges create [flags]

--amount-cents integer default: 0
- Set JSON body field amount_cents (integer, required in the body)
--body-null stringArray default: []
- Set a nullable JSON body field to null by its JSON name (repeat for each field; cannot be combined with --data-file)
--cancel-redirect-url string default: empty
- Set JSON body field cancel_redirect_url (string, nullable)
--create-checkout bool default: false
- Set JSON body field create_checkout (boolean)
--customer-id string default: empty
- Set JSON body field customer_id (string, required in the body)
--data-file string default: empty
- Read the JSON request body from a UTF-8 file, or '-' for stdin
--description string default: empty
- Set JSON body field description (string, nullable)
--dry-run bool default: false
- Validate and preview the request without credentials or network access
--due-date integer default: 0
- Set JSON body field due_date (integer, required in the body)
--external-reference string default: empty
- Set JSON body field external_reference (string, nullable)
--help, -h bool default: false
- help for create
--idempotency-key string default: empty
- Reuse this optional idempotency key when retrying the same request
--metadata stringArray default: empty
- Set a metadata text value as KEY=VALUE (repeat for each key; dots in keys are literal)
--metadata-empty bool default: false
- Send an empty metadata object; an update preserves existing keys
--metadata-null stringArray default: []
- Send null for a metadata key (repeat for each key; removes it when updating)
--payment-method integer default: 0
- Set JSON body field payment_method (integer)
--payment-method-types integerArray default: empty
- Set JSON body field payment_method_types (array<integer>, repeat the option for each item, nullable)
--send-email bool default: false
- Set JSON body field send_email (boolean)
--show-headers bool default: false
- Show public response headers without credentials or cookies
--success-redirect-url string default: empty
- Set JSON body field success_redirect_url (string, nullable)
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)
--title string default: empty
- Set JSON body field title (string, nullable)

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.

Command example

Shell

raims --profile PROFILE --output json charges create --data-file request.json --dry-run
raims charges create --amount-cents=10000 --customer-id="cus_1Q2W3E4R5T6Y7U8I9O0P" --due-date=1893456000 --dry-run

`raims charges get`

Get a charge

Shell

raims charges get ID [flags]

--dry-run bool default: false
- Validate and preview the request without credentials or network access
--help, -h bool default: false
- help for get
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

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.

Command example

Shell

raims --profile PROFILE --output json charges get ID --dry-run

`raims charges list`

List charges

Shell

raims charges list [flags]

--after string default: empty
- Read after this opaque cursor (cannot be combined with --before)
--all bool default: false
- Read all pages as separate results (JSON Lines with --output json)
--before string default: empty
- Read before this opaque cursor (cannot be combined with --after)
--created-gte int64 default: 0
- Created at or after this Unix timestamp (seconds)
--created-lte int64 default: 0
- Created at or before this Unix timestamp (seconds)
--customer-id string default: empty
- Filter by customer ID
--dry-run bool default: false
- Validate and preview the request without credentials or network access
--due-gte int64 default: 0
- Due at or after this Unix timestamp (seconds)
--due-lte int64 default: 0
- Due at or before this Unix timestamp (seconds)
--email string default: empty
- Filter by email address
--external-reference string default: empty
- Filter by external reference
--help, -h bool default: false
- help for list
--identifier string default: empty
- Filter by public resource identifier
--max-pages int default: 100
- Maximum pages to read with --all (1-10000)
--page-size int64 default: 10
- Results per page (the API normalizes the requested size)
--paid-gte int64 default: 0
- Paid at or after this Unix timestamp (seconds)
--paid-lte int64 default: 0
- Paid at or before this Unix timestamp (seconds)
--payment-method string default: empty
- Filter by comma-separated payment method codes
--show-headers bool default: false
- Show public response headers without credentials or cookies
--sort-key string default: empty
- Sort results by this API field
--sort-order string default: desc
- Sort direction: asc or desc
--status string default: empty
- Filter by comma-separated charge status codes
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

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.

Command example

Shell

raims --profile PROFILE --output json charges list --dry-run

`raims charges payment`

Get payment details for a charge

Shell

raims charges payment ID [flags]

--dry-run bool default: false
- Validate and preview the request without credentials or network access
--help, -h bool default: false
- help for payment
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

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.

Command example

Shell

raims --profile PROFILE --output json charges payment ID --dry-run

`raims charges receipt`

Get the payment receipt download information

Shell

raims charges receipt ID [flags]

--dry-run bool default: false
- Validate and preview the request without credentials or network access
--help, -h bool default: false
- help for receipt
--save string default: empty
- Save the PDF to PATH (up to 32 MiB); the parent directory must exist and the file must not exist
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

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.

Command example

Shell

raims --profile PROFILE --output json charges receipt ID --dry-run

`raims charges refund-eligibility`

Check whether a charge can be refunded

Shell

raims charges refund-eligibility ID [flags]

--dry-run bool default: false
- Validate and preview the request without credentials or network access
--help, -h bool default: false
- help for refund-eligibility
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

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.

Command example

Shell

raims --profile PROFILE --output json charges refund-eligibility ID --dry-run

`raims charges refunds`

Inspect and request refunds for a charge

Shell

raims charges refunds [flags]

--help, -h bool default: false
- help for refunds

Subcommands: raims charges refunds create, raims charges refunds list.

`raims charges refunds create`

Request a refund for a charge

Shell

raims charges refunds create ID [flags]

--amount-cents integer default: 0
- Set JSON body field amount_cents (integer, required in the body)
--body-null stringArray default: []
- Set a nullable JSON body field to null by its JSON name (repeat for each field; cannot be combined with --data-file)
--data-file string default: empty
- Read the JSON request body from a UTF-8 file, or '-' for stdin
--description string default: empty
- Set JSON body field description (string, nullable)
--dry-run bool default: false
- Validate and preview the request without credentials or network access
--help, -h bool default: false
- help for create
--idempotency-key string default: empty
- Reuse this optional idempotency key when retrying the same request
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

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.

Command example

Shell

raims --profile PROFILE --output json charges refunds create ID --data-file request.json --dry-run
raims charges refunds create ID --amount-cents=2500 --dry-run

`raims charges refunds list`

List refunds for a charge

Shell

raims charges refunds list ID [flags]

--after string default: empty
- Read after this opaque cursor (cannot be combined with --before)
--all bool default: false
- Read all pages as separate results (JSON Lines with --output json)
--before string default: empty
- Read before this opaque cursor (cannot be combined with --after)
--created-gte int64 default: 0
- Created at or after this Unix timestamp (seconds)
--created-lte int64 default: 0
- Created at or before this Unix timestamp (seconds)
--dry-run bool default: false
- Validate and preview the request without credentials or network access
--help, -h bool default: false
- help for list
--max-pages int default: 100
- Maximum pages to read with --all (1-10000)
--page-size int64 default: 10
- Results per page (the API normalizes the requested size)
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

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.

Command example

Shell

raims --profile PROFILE --output json charges refunds list ID --dry-run

`raims charges revoke`

Revoke a charge

Shell

raims charges revoke ID [flags]

--dry-run bool default: false
- Validate and preview the request without credentials or network access
--help, -h bool default: false
- help for revoke
--idempotency-key string default: empty
- Reuse this optional idempotency key when retrying the same request
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

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.

Command example

Shell

raims --profile PROFILE --output json charges revoke ID --dry-run

`raims charges statistics`

Get charge statistics for a period

Shell

raims charges statistics [flags]

--dry-run bool default: false
- Validate and preview the request without credentials or network access
--help, -h bool default: false
- help for statistics
--period string default: today
- Reporting period: today, last_7_days, last_15_days or last_30_days
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

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.

Command example

Shell

raims --profile PROFILE --output json charges statistics --dry-run

`raims charges update`

Update a charge

Shell

raims charges update ID [flags]

--body-null stringArray default: []
- Set a nullable JSON body field to null by its JSON name (repeat for each field; cannot be combined with --data-file)
--data-file string default: empty
- Read the JSON request body from a UTF-8 file, or '-' for stdin
--description string default: empty
- Set JSON body field description (string, nullable)
--dry-run bool default: false
- Validate and preview the request without credentials or network access
--external-reference string default: empty
- Set JSON body field external_reference (string, nullable)
--help, -h bool default: false
- help for update
--idempotency-key string default: empty
- Reuse this optional idempotency key when retrying the same request
--metadata stringArray default: empty
- Set a metadata text value as KEY=VALUE (repeat for each key; dots in keys are literal)
--metadata-empty bool default: false
- Send an empty metadata object; an update preserves existing keys
--metadata-null stringArray default: []
- Send null for a metadata key (repeat for each key; removes it when updating)
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)
--title string default: empty
- Set JSON body field title (string, nullable)

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.

Command example

Shell

raims --profile PROFILE --output json charges update ID --data-file request.json --dry-run
raims charges update ID --description="Descrição atualizada da cobrança" --dry-run