SDigital2SDigital2
Bank accounts

List Bank Accounts

Retrieve a paginated list of bank accounts for the organization

GET
/v1/bank-accounts
AuthorizationBearer <token>

In: header

Query Parameters

page?number

Page number for pagination

Default1
Range1 <= value
limit?number

Max number of items per page to fetch (max 100)

Default10
Range1 <= value <= 100

Response Body

curl -X GET "https://api.sandbox.sdigital2.com/v1/bank-accounts?page=1&limit=10"
{
  "data": [
    {
      "id": "3190d115-987f-402f-b558-0316d3a22ebd",
      "customerId": "3190d115-987f-402f-b558-0316d3a22ebd",
      "name": "string",
      "type": "EXTERNAL",
      "rail": "PIX",
      "currency": "BRL",
      "beneficiary": {
        "relationship": "SELF",
        "legalName": "Shape Co.",
        "taxId": "string",
        "email": "string",
        "address": {
          "line1": "123 Avenue",
          "line2": "Apt 1",
          "city": "New York",
          "state": "NY",
          "postalCode": "10001",
          "country": "USA"
        },
        "incorporationDate": "2024-12-13"
      },
      "accountDetails": {
        "keyType": "EMAIL",
        "keyValue": "john.doe@example.com"
      },
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10
  }
}
{
  "status": 401,
  "title": "Unauthorized",
  "detail": "Authentication credentials are missing or invalid",
  "code": "UNAUTHORIZED",
  "instance": "/api/v1/transactions",
  "correlationId": "2065cb12-a9fe-42f9-8c75-d63257b3844a"
}
{
  "status": 403,
  "title": "Forbidden",
  "detail": "You do not have permission to access this resource",
  "code": "FORBIDDEN",
  "instance": "/api/v1/transactions",
  "correlationId": "2065cb12-a9fe-42f9-8c75-d63257b3844a"
}
{
  "status": 404,
  "title": "Not Found",
  "detail": "The requested resource could not be found",
  "code": "RESOURCE_NOT_FOUND",
  "instance": "/api/v1/transactions/f133bef1-226c-458a-b6d9-8312edb8d77a",
  "correlationId": "2065cb12-a9fe-42f9-8c75-d63257b3844a"
}
{
  "status": 422,
  "title": "Validation Error",
  "detail": "The request contains invalid data",
  "code": "VALIDATION_ERROR",
  "instance": "/api/v1/transactions",
  "correlationId": "2065cb12-a9fe-42f9-8c75-d63257b3844a",
  "errors": [
    {
      "detail": "sourceAmount must be a positive number",
      "pointer": "/sourceAmount"
    },
    {
      "detail": "destination.currency is required when providing sourceAmount",
      "pointer": "/destination/currency"
    }
  ]
}
{
  "status": 500,
  "title": "Internal Server Error",
  "detail": "An unexpected error occurred while processing your request",
  "code": "INTERNAL_SERVER_ERROR",
  "instance": "/api/v1/transactions",
  "correlationId": "2065cb12-a9fe-42f9-8c75-d63257b3844a"
}