raims withdrawals | Raims Documentation

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

`raims withdrawals`

Inspect and request withdrawals

Shell

raims withdrawals [flags]

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

Subcommands: raims withdrawals automatic-settings, raims withdrawals create, raims withdrawals get, raims withdrawals limits, raims withdrawals list, raims withdrawals summary.

`raims withdrawals automatic-settings`

Manage automatic withdrawal settings

Shell

raims withdrawals automatic-settings [flags]

--help, -h bool default: false
- help for automatic-settings

Subcommands: raims withdrawals automatic-settings get, raims withdrawals automatic-settings update.

`raims withdrawals automatic-settings get`

Get automatic withdrawal settings

Shell

raims withdrawals automatic-settings get [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 automatic withdrawal settings.

GET /v1/withdrawals/automatic_settings

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: Production.

Command example

Shell

raims --profile PROFILE --output json withdrawals automatic-settings get --dry-run

`raims withdrawals automatic-settings update`

Update automatic withdrawal settings

Shell

raims withdrawals automatic-settings update [flags]

--data-file string default: empty
- Read the JSON request body from a UTF-8 file, or '-' for stdin
--dry-run bool default: false
- Validate and preview the request without credentials or network access
--enabled bool default: false
- Set JSON body field enabled (boolean)
--help, -h bool default: false
- help for update
--idempotency-key string default: empty
- Reuse this optional idempotency key when retrying the same request
--minimum-amount-cents integer default: 0
- Set JSON body field minimum_amount_cents (integer)
--show-headers bool default: false
- Show public response headers without credentials or cookies
--time string default: empty
- Set JSON body field time (string)
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

Update automatic withdrawal settings.

PATCH /v1/withdrawals/automatic_settings

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: 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:
  enabled               boolean  optional
  minimum_amount_cents  integer  optional
  time                  string   optional
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):
{
  "time": "10:00"
}
Example values are illustrative. Replace resource IDs and review the request before sending it.

Command example

Shell

raims --profile PROFILE --output json withdrawals automatic-settings update --data-file request.json --dry-run
raims withdrawals automatic-settings update --time="10:00" --dry-run

`raims withdrawals create`

Request a withdrawal to the company's default Pix key

Shell

raims withdrawals 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)
--data-file string default: empty
- Read the JSON request body from a UTF-8 file, or '-' for stdin
--dry-run bool default: false
- Validate and preview the request without credentials or network access
--expected-destination-id string default: empty
- Set JSON body field expected_destination_id (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
--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 withdrawal to the company's default Pix key.

POST /v1/withdrawals

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: 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
  expected_destination_id  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": 25000
}
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 withdrawals create --data-file request.json --dry-run
raims withdrawals create --amount-cents=25000 --dry-run

`raims withdrawals get`

Get a withdrawal

Shell

raims withdrawals 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 withdrawal.

GET /v1/withdrawals/{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 withdrawals get ID --dry-run

`raims withdrawals limits`

Get withdrawal conditions and limits

Shell

raims withdrawals limits [flags]

--dry-run bool default: false
- Validate and preview the request without credentials or network access
--help, -h bool default: false
- help for limits
--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 withdrawal conditions and limits.

GET /v1/withdrawals/limits

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 withdrawals limits --dry-run

`raims withdrawals list`

List withdrawals

Shell

raims withdrawals 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)
--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)
--requested-gte int64 default: 0
- Requested at or after this Unix timestamp (seconds)
--requested-lte int64 default: 0
- Requested at or before this Unix timestamp (seconds)
--show-headers bool default: false
- Show public response headers without credentials or cookies
--sort-order string default: desc
- Sort direction: asc or desc
--status string default: empty
- Filter by comma-separated withdrawal status names
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

List withdrawals.

GET /v1/withdrawals

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 withdrawals list --dry-run

`raims withdrawals summary`

Get a summary of withdrawals in progress

Shell

raims withdrawals summary [flags]

--dry-run bool default: false
- Validate and preview the request without credentials or network access
--help, -h bool default: false
- help for summary
--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 summary of withdrawals in progress.

GET /v1/withdrawals/summary

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: Production.

Command example

Shell

raims --profile PROFILE --output json withdrawals summary --dry-run