raims withdrawals | Documentação da Raims

Consulte a sintaxe, os argumentos e as opções de cada comando. Use raims COMANDO --help para ler a ajuda no terminal.

`raims withdrawals`

Consulte e solicite saques.

Shell

raims withdrawals [flags]

--help, -h bool padrão: false
- Exibe a ajuda de withdrawals.

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

`raims withdrawals automatic-settings`

Gerencie as configurações de saque automático.

Shell

raims withdrawals automatic-settings [flags]

--help, -h bool padrão: false
- Exibe a ajuda de automatic-settings.

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

`raims withdrawals automatic-settings get`

Consulte as configurações de saque automático.

Shell

raims withdrawals automatic-settings get [flags]

--dry-run bool padrão: false
- Valide e apresente a requisição sem credenciais ou acesso à rede.
--help, -h bool padrão: false
- Exibe a ajuda de get.
--show-headers bool padrão: false
- Mostre os headers públicos da resposta, sem credenciais ou cookies.
--timeout duration padrão: 1m0s
- Prazo total da requisição, incluindo novas tentativas. Exemplos: 30s ou 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.

Exemplo do comando

Shell

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

`raims withdrawals automatic-settings update`

Atualize as configurações de saque automático.

Shell

raims withdrawals automatic-settings update [flags]

--data-file string padrão: vazio
- Leia o corpo JSON de um arquivo UTF-8 ou use '-' para stdin.
--dry-run bool padrão: false
- Valide e apresente a requisição sem credenciais ou acesso à rede.
--enabled bool padrão: false
- Defina enabled no corpo JSON: booleano.
--help, -h bool padrão: false
- Exibe a ajuda de update.
--idempotency-key string padrão: vazio
- Reutilize esta chave de idempotência opcional ao repetir a mesma requisição.
--minimum-amount-cents integer padrão: 0
- Defina minimum_amount_cents no corpo JSON: inteiro.
--show-headers bool padrão: false
- Mostre os headers públicos da resposta, sem credenciais ou cookies.
--time string padrão: vazio
- Defina time no corpo JSON: texto.
--timeout duration padrão: 1m0s
- Prazo total da requisição, incluindo novas tentativas. Exemplos: 30s ou 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.

Exemplo do comando

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`

Solicite um saque para a chave Pix padrão da empresa.

Shell

raims withdrawals create [flags]

--amount-cents integer padrão: 0
- Defina amount_cents no corpo JSON: inteiro obrigatório.
--body-null stringArray padrão: []
- Envie null em um campo do corpo que aceite esse valor, usando o nome JSON; repita para outros campos e não combine com --data-file.
--data-file string padrão: vazio
- Leia o corpo JSON de um arquivo UTF-8 ou use '-' para stdin.
--dry-run bool padrão: false
- Valide e apresente a requisição sem credenciais ou acesso à rede.
--expected-destination-id string padrão: vazio
- Defina expected_destination_id no corpo JSON (string, aceita null).
--help, -h bool padrão: false
- Exibe a ajuda de create.
--idempotency-key string padrão: vazio
- Reutilize esta chave de idempotência opcional ao repetir a mesma requisição.
--show-headers bool padrão: false
- Mostre os headers públicos da resposta, sem credenciais ou cookies.
--timeout duration padrão: 1m0s
- Prazo total da requisição, incluindo novas tentativas. Exemplos: 30s ou 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.

Exemplo do comando

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`

Consulte um saque.

Shell

raims withdrawals get ID [flags]

--dry-run bool padrão: false
- Valide e apresente a requisição sem credenciais ou acesso à rede.
--help, -h bool padrão: false
- Exibe a ajuda de get.
--show-headers bool padrão: false
- Mostre os headers públicos da resposta, sem credenciais ou cookies.
--timeout duration padrão: 1m0s
- Prazo total da requisição, incluindo novas tentativas. Exemplos: 30s ou 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.

Exemplo do comando

Shell

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

`raims withdrawals limits`

Consulte as condições e os limites de saque.

Shell

raims withdrawals limits [flags]

--dry-run bool padrão: false
- Valide e apresente a requisição sem credenciais ou acesso à rede.
--help, -h bool padrão: false
- Exibe a ajuda de limits.
--show-headers bool padrão: false
- Mostre os headers públicos da resposta, sem credenciais ou cookies.
--timeout duration padrão: 1m0s
- Prazo total da requisição, incluindo novas tentativas. Exemplos: 30s ou 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.

Exemplo do comando

Shell

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

`raims withdrawals list`

Liste os saques.

Shell

raims withdrawals list [flags]

--after string padrão: vazio
- Consulte após este cursor opaco. Não combine com --before.
--all bool padrão: false
- Leia todas as páginas como resultados separados. Com --output json, a saída usa JSON Lines.
--before string padrão: vazio
- Consulte antes deste cursor opaco. Não combine com --after.
--dry-run bool padrão: false
- Valide e apresente a requisição sem credenciais ou acesso à rede.
--help, -h bool padrão: false
- Exibe a ajuda de list.
--max-pages int padrão: 100
- Limite de páginas com --all, entre 1 e 10000.
--page-size int64 padrão: 10
- Quantidade de resultados por página. A API ajusta o tamanho solicitado.
--requested-gte int64 padrão: 0
- Solicitado a partir desta data Unix, em segundos.
--requested-lte int64 padrão: 0
- Solicitado até esta data Unix, em segundos.
--show-headers bool padrão: false
- Mostre os headers públicos da resposta, sem credenciais ou cookies.
--sort-order string padrão: desc
- Direção da ordenação: asc ou desc.
--status string padrão: vazio
- Filtre pelos nomes dos status dos saques, separados por vírgula.
--timeout duration padrão: 1m0s
- Prazo total da requisição, incluindo novas tentativas. Exemplos: 30s ou 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.

Exemplo do comando

Shell

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

`raims withdrawals summary`

Consulte o resumo dos saques em andamento.

Shell

raims withdrawals summary [flags]

--dry-run bool padrão: false
- Valide e apresente a requisição sem credenciais ou acesso à rede.
--help, -h bool padrão: false
- Exibe a ajuda de summary.
--show-headers bool padrão: false
- Mostre os headers públicos da resposta, sem credenciais ou cookies.
--timeout duration padrão: 1m0s
- Prazo total da requisição, incluindo novas tentativas. Exemplos: 30s ou 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.

Exemplo do comando

Shell

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