Skip to main content
POST
/
automate
Automate
curl --request POST \
  --url https://processor-prod.up.railway.app/automate \
  --header 'Content-Type: application/json' \
  --header 'x-service-key: <api-key>' \
  --data '
{
  "wallet_id": "68bc290df51feea8c53f5275",
  "transfer": false,
  "swap": false,
  "offramp": true,
  "beneficiary_id": "68bf2eba196a18d7bd166184"
}
'
{
  "success": true,
  "status": 200,
  "message": "Automation set successfully",
  "timestamp": "2025-09-10T00:52:59.708Z",
  "data": {
    "transfer": false,
    "swap": false,
    "offramp": true,
    "beneficiary_id": "68bf2eba196a18d7bd166184"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.bread.africa/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-service-key
string
header
required

Body

application/json
​
wallet_id
string
required

The wallet ID to set automation for

Example:

"68bc290df51feea8c53f5275"

​
transfer
boolean

Whether to enable automatic transfer

Example:

false

​
swap
boolean

Whether to enable automatic swap

Example:

false

​
offramp
boolean

Whether to enable automatic offramp

Example:

true

​
beneficiary_id
string

The beneficiary ID for offramp automation. Required when offramp is true.

Example:

"68bf2eba196a18d7bd166184"

Response

200 - application/json

Automation set successfully

​
success
boolean
Example:

true

​
status
integer
Example:

200

​
message
string
Example:

"Automation set successfully"

​
timestamp
string<date-time>
Example:

"2025-09-10T00:52:59.708Z"

​
data
object