BRbrale
Automations

Create an Automation

Creates a new automation.

post/accounts/{account_id}/automations

Request

  • Base URL
    https://api.brale.xyz
  • Auth
    HTTP bearer

Path parameters

account_idstring ksuid required
Example:2VcUIIsgARwVbEGlIYbhg6fGG57

The ID of the account

Headers

Idempotency-Keystring required

A unique string used to prevent duplicate operations. Each POST request must use a new idempotency key. Use a UUIDv4 string. Example: idemp-123e4567-e89b-12d3-a456-426614174000

Request body

namestring required

Example request

{
  "name": "XYZ Onramp",
  "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"
  },
  "brand": {
    "account_id": "2VcUIIsgARwVbEGlIYbhg6fGG57"
  }
}

Response

Automation successfully created

idstring ksuid
namestring
status'pending' | 'active' | 'disabled' | 'archived'

The current lifecycle state of the automation.

created_atstring date-time
updated_atstring date-time

Example response

{
  "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"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.