raims withdrawal-destinations
Inspect withdrawal destinations
From command to result
Read the default Production withdrawal destination before preparing a request. Its ID lets you require the same default to remain current when sending.
Configure the profile and credential before running real reads. With an API
key, the key determines the company and environment. --environment selects
an environment only for OAuth.
Find the default
Shellraims --profile production --output json withdrawal-destinations listUse a Production credential. Check the default entry and masked details; listing does not change the destination.
Review details
Shellraims --profile production --output json withdrawal-destinations get DESTINATION_IDReplace with the returned ID and review holder and institution details. On
withdrawals create,--expected-destination-idrequires that default; it does not choose another destination.
Choose a command
| Command | Purpose |
|---|---|
raims withdrawal-destinations get | Get a withdrawal destination |
raims withdrawal-destinations list | List withdrawal destinations |
The previews below use --dry-run and do not send the request. Replace placeholders and review the result before sending a write.
Body fields, filters, and headers are sent only when supplied. Execution option defaults do not fill API fields.
raims withdrawal-destinations
Inspect withdrawal destinations
raims withdrawal-destinations [flags]Execution options
--help,-hbooldefault: false- help for withdrawal-destinations
See global options.
Subcommands: raims withdrawal-destinations get, raims withdrawal-destinations list.
raims withdrawal-destinations get
Get a withdrawal destination
raims withdrawal-destinations get ID [flags]OAuth environments: Production. Success responses: 200.
Example
raims --profile PROFILE --output json withdrawal-destinations get ID --dry-runThe excerpt below shows the CLI contents of data. The envelope also reports status_code and the received request_id.
Company's default destination
{
"id": "wdst_3AbHiWSrsZBoaTg47OcMzC",
"key_type": "CNPJ",
"key_masked": "***0195",
"holder_name": "Empresa Exemplo Ltda.",
"bank_ispb": "12345678",
"is_default": true
}Execution options
--dry-runbooldefault: false- Validate and preview the request without credentials or network access
--help,-hbooldefault: false- help for get
--show-headersbooldefault: false- Show public response headers without credentials or cookies
--timeoutdurationdefault: 1m0s- Total request timeout, including retries (for example 30s or 2m)
See global options.
Get a withdrawal destination.
GET /v1/withdrawal_destinations/{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: Production.raims withdrawal-destinations list
List withdrawal destinations
raims withdrawal-destinations list [flags]OAuth environments: Production. Success responses: 200.
Example
raims --profile PROFILE --output json withdrawal-destinations list --dry-runThe excerpt below shows the CLI contents of data. The envelope also reports status_code and the received request_id.
Company's default destination
{
"list": [
{
"id": "wdst_3AbHiWSrsZBoaTg47OcMzC",
"key_type": "CNPJ",
"key_masked": "***0195",
"holder_name": "Empresa Exemplo Ltda.",
"bank_ispb": "12345678",
"is_default": true,
"verified_at": 1792047600
}
],
"page": {
"page_size": 10,
"has_next": false,
"has_previous": false,
"next_after": null,
"previous_before": null
}
}Query filters
--afterstringsent only when supplied- Read after this opaque cursor (cannot be combined with --before)
--beforestringsent only when supplied- Read before this opaque cursor (cannot be combined with --after)
--page-sizeint64sent only when supplied- Results per page (the API normalizes the requested size)
Execution options
--allbooldefault: false- Read all pages as separate results (JSON Lines with --output json)
--dry-runbooldefault: false- Validate and preview the request without credentials or network access
--help,-hbooldefault: false- help for list
--max-pagesintdefault: 100- Maximum pages to read with --all (1-10000)
--show-headersbooldefault: false- Show public response headers without credentials or cookies
--timeoutdurationdefault: 1m0s- Total request timeout, including retries (for example 30s or 2m)
See global options.
List withdrawal destinations.
GET /v1/withdrawal_destinations
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.