BRbrale
Orders

List transfers for an account

Changed on

Returns all transfers for the specified account.

get/accounts/{account_id}/transfers

Request

  • Base URL
    https://api.brale.xyz
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.brale.xyz/oauth2/token scopes: transfers:read

Path parameters

account_idstring required

ID of the resource

Example:2VZvtmVc2j3gQ80CTlcuQXbGrwC

Account ID

Query parameters

afterstring
beforestring
sizeinteger
transaction_idstring

On-chain transaction hash

automation_idstring

Filter transfers created by a specific automation

status'pending' | 'processing' | 'complete' | 'canceled' | 'failed' | 'compliance review' | 'refunding' | 'refunded'

Filter transfers by status. Applied after paging, so a page can hold fewer than page[size] transfers; keep following pagination.next until it is absent.

address_idstring

Filter transfers by address ID

transfer_typestring

Filter transfers by blockchain chain (e.g. solana, base, ethereum). Fiat payment types (e.g. same_day_ach_credit, wire) are not supported as filter values.

value_typestring

Filter transfers by token ticker (e.g. USDC, SBC)

Response

OK

paginationobject

Example response

{
  "transfers": [
    {
      "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