Retrieve a single automation

curl --request GET \
  --url https://api.brale.xyz/accounts/{account_id}/automations/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.brale.xyz/accounts/{account_id}/automations/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.brale.xyz/accounts/{account_id}/automations/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.brale.xyz/accounts/{account_id}/automations/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.brale.xyz/accounts/{account_id}/automations/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.brale.xyz/accounts/{account_id}/automations/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "2VcUIIsgARwVbEGlIYbhg6fGG57",
  "name": "XYZ Onramp",
  "status": "active",
  "source": {
    "value_type": "USD",
    "transfer_type": null,
    "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"
  }
}

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>'

import requests

url = "https://api.brale.xyz/accounts/{account_id}/automations/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.brale.xyz/accounts/{account_id}/automations/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.brale.xyz/accounts/{account_id}/automations/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.brale.xyz/accounts/{account_id}/automations/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.brale.xyz/accounts/{account_id}/automations/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "2VcUIIsgARwVbEGlIYbhg6fGG57",
  "name": "XYZ Onramp",
  "status": "active",
  "source": {
    "value_type": "USD",
    "transfer_type": null,
    "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]{27}$

Example:

"2VcUIIsgARwVbEGlIYbhg6fGG57"

string<ksuid>

required

The ID of the automation

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

Example:

"2VcUIIsgARwVbEGlIYbhg6fGG57"

Response

200 - */*

A single automation object

string<ksuid>

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

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. Set value_type: USD to accept fiat deposits. You do not need to select a deposit rail: a USD Automation's virtual account accepts the inbound rails enabled for your account (wire, ACH, and FedNow where enabled). When the automation becomes active, funding_instructions is populated with the virtual account details to share with the payer. This is Automation configuration. The rail of each deposit is reported on the resulting Transfer's source.transfer_type (for example, fednow_credit), not here.

Show child attributes

destination

AutomationDestination · object

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

Show child attributes

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. Selects the verified identity shown as the beneficiary on the automation's funding instructions. Pass the account_id of your own account or a managed account (business or individual). Both custodial and transactional accounts can be used, subject to applicable verification and program eligibility. The automation is still created under the account in the request path; brand.account_id only controls the identity rendered on the funding instructions. If omitted, Brale is the default beneficiary.

Show child attributes

API overview

Accounts

Addresses

Automations

Transfers

Financial institutions

Webhooks

Tokenization

Retrieve a single automation

Authorizations

Path Parameters

Response