BRbrale
Automations

Simulate Automation Deposit

Changed on

Simulate an inbound ACH, wire or FedNow deposit into a testnet Automation

post/accounts/{account_id}/automations/{automation_id}/simulations/deposits

Request

  • Base URL
    https://api.brale.xyz
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.brale.xyz/oauth2/token scopes: automations:write, network:testnet

Path parameters

account_idstring required

ID of the resource

Example:2VZvtmVc2j3gQ80CTlcuQXbGrwC

Account ID

automation_idstring required

ID of the resource

Example:2VZvtmVc2j3gQ80CTlcuQXbGrwC

Automation ID

Request body

transfer_type'ach' | 'wire' | 'fednow' required

Example request

{
  "amount": {
    "currency": "USD",
    "value": "11234.88"
  }
}

Response

Accepted

OR
OR

Example response

{
  "amount": {
    "currency": "USD",
    "value": "11234.88"
  },
  "created_at": "2020-01-01T12:00:00Z",
  "failure": {
    "ach_return": {
      "code": "R01",
      "reason": "Insufficient Funds"
    },
    "fednow_return": {
      "code": "AC01",
      "reason": "Incorrect account number"
    },
    "occurred_at": "2020-01-01T12:00:00Z",
    "type": "ach_return",
    "wire_return": {
      "code": "AC04",
      "reason": "Account closed"
    }
  },
  "id": "2VZvtmVc2j3gQ80CTlcuQXbGrwC",
  "updated_at": "2020-01-01T12:00:00Z"
}

Changes

  • 3fea88224150Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • f2328489c945Revision changes
    • info

      added to the / response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      removed from the / response property allOf list for the response status

    • info

      removed from the // response property allOf list for the response status

    • info

      removed from the // response property allOf list for the response status