Skip to main content
GET
/
accounts
/
{account_id}
/
automations
/
{id}
Retrieve a single automation
curl --request GET \
  --url https://api.brale.xyz/accounts/{account_id}/automations/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "2VcUIIsgARwVbEGlIYbhg6fGG57",
  "name": "XYZ Onramp",
  "status": "active",
  "source": {
    "value_type": "USD",
    "transfer_type": "wire",
    "funding_instructions": {
      "beneficiary_name": "Jane Business",
      "bank_name": "Example Bank",
      "bank_address": "456 Commerce St., Des Moines, IA 50309",
      "beneficiary_address": "612 Commerce St., Des Moines, IA 50309",
      "account_number": "123456789",
      "routing_number": "063108680"
    }
  },
  "destination": {
    "address_id": "2VcUIIsgARwVbEGlIYbhg6fGG57",
    "value_type": "SBC",
    "transfer_type": "solana"
  },
  "created_at": "2024-01-15T12:34:56Z",
  "updated_at": "2024-01-15T12:34:56Z",
  "brand": {
    "account_id": "2VcUIIsgARwVbEGlIYbhg6fGG57"
  }
}
Use the playground below to try this endpoint directly, or review the OpenAPI details in the right panel.

Authorizations

​
Authorization
string
header
required

Use the Bearer token returned from the Auth endpoint via OAuth2 client_credentials flow. Include the token in the "Authorization: Bearer " header.

Path Parameters

​
account_id
string<ksuid>
required

The ID of the account

Pattern: ^[a-zA-Z0-9]{26}$
Example:

"2VcUIIsgARwVbEGlIYbhg6fGG57"

​
id
string<ksuid>
required

The ID of the automation

Pattern: ^[a-zA-Z0-9]{26}$
Example:

"2VcUIIsgARwVbEGlIYbhg6fGG57"

Response

200 - */*

A single automation object

​
id
string<ksuid>
Pattern: ^[a-zA-Z0-9]{26}$
Example:

"2VcUIIsgARwVbEGlIYbhg6fGG57"

​
name
string
Example:

"XYZ Onramp"

​
status
enum<string>

The current lifecycle state of the automation.

Available options:
pending,
active,
disabled,
archived
Example:

"active"

​
source
AutomationSource · object

The funding source for the automation. Defines the fiat rail and value type that the automation accepts. When the automation becomes active, funding_instructions is populated with the virtual account details to share with the payer.

​
destination
AutomationDestination · object

The destination wallet that receives minted stablecoins when the automation is funded.

​
created_at
string<date-time>
Example:

"2024-01-15T12:34:56Z"

​
updated_at
string<date-time>
Example:

"2024-01-15T12:34:56Z"

​
brand
AutomationBrand · object

Optional. Controls the beneficiary name on funding instructions. Pass the account_id of your own account or a managed account whose business name should appear as the beneficiary. If omitted, Brale is the default beneficiary.