Docs
Checking Raims account
Raims CLIAPI commands

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.

  1. Find the default

    Shell
    raims --profile production --output json withdrawal-destinations list

    Use a Production credential. Check the default entry and masked details; listing does not change the destination.

  2. Review details

    Shell
    raims --profile production --output json withdrawal-destinations get DESTINATION_ID

    Replace with the returned ID and review holder and institution details. On withdrawals create, --expected-destination-id requires that default; it does not choose another destination.

Choose a command

CommandPurpose
raims withdrawal-destinations getGet a withdrawal destination
raims withdrawal-destinations listList 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

Shell
raims withdrawal-destinations [flags]

Execution options

  • --help, -h bool default: 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

Shell
raims withdrawal-destinations get ID [flags]

OAuth environments: Production. Success responses: 200.

Example

Shell
raims --profile PROFILE --output json withdrawal-destinations get ID --dry-run

Execution options

  • --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)

See global options.

raims withdrawal-destinations list

List withdrawal destinations

Shell
raims withdrawal-destinations list [flags]

OAuth environments: Production. Success responses: 200.

Example

Shell
raims --profile PROFILE --output json withdrawal-destinations list --dry-run

Query filters

  • --after string sent only when supplied
    • Read after this opaque cursor (cannot be combined with --before)
  • --before string sent only when supplied
    • Read before this opaque cursor (cannot be combined with --after)
  • --page-size int64 sent only when supplied
    • Results per page (the API normalizes the requested size)

Execution options

  • --all bool default: false
    • Read all pages as separate results (JSON Lines with --output json)
  • --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)
  • --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)

See global options.