v2

Bank Accounts
Bank Accounts Endpoints work for two different sources: investors and promoters

>>>

GET /investors/:investor_id/bank_accounts?page=&per=
Bank accounts from specific investor

GET /promoters/:promoter_id/bank_accounts?page=&per=
Bank accounts from specific promoter

Params

Param name Description
page
optional

Page index

Validations:

  • Must be a Integer
per
optional

Items per page

Validations:

  • Must be a Integer
investor_id / promoter_id
required

It could be either investor or promoter ID

Validations:

  • Must be a String

Examples

{
  "data": [
    {
      "id": "bank-account-uuid",
      "account_holder": "Account Holder Name",
      "account_holder_name": "Name",
      "account_holder_lastname": "Lastname",
      "account_holder_matriname": "Matriname",
      "account_number": "123456789012",
      "type_of": null,
      "alias": "Account Alias",
      "trust_number": null,
      "branch_name": null,
      "swift_code": null,
      "aba_code": "ABA123456789",
      "is_foreign_bank": false,
      "currency": {
        "name": "MXN",
        "value": "mxn"
      },
      "bank_name": null,
      "company": false,
      "company_name": null,
      "person_type": "Persona física",
      "extras": {
      },
      "banxico_bank": {
        "id": "banxico-bank-uuid",
        "name": "Bank Name",
        "abbreviation": "BANK",
        "code": "001"
      },
      "fiscal_address": {
        "tax_id_number": "XAXX010101000",
        "name": "Nombre",
        "lastname": "Apellido Paterno",
        "matriname": "Apellido Materno",
        "company": false,
        "company_name": null,
        "default": false,
        "id": "00000000-0000-0000-0000-000000000001",
        "street": "Calle Ejemplo",
        "street_number": "123",
        "street_number_internal": null,
        "zip_code": "00000",
        "suburb": "Colonia Ejemplo",
        "city": "Ciudad Ejemplo",
        "state": "Estado Ejemplo",
        "country": "MEX",
        "country_translated": "Mexico"
      }
    }
  ]
}

Errors

Code Description
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
>>>

GET /investors/:investor_id/bank_accounts/:id
Specific bank account from specific investor

GET /promoters/:promoter_id/bank_accounts/:id
Specific bank account from specific promoter

Params

Param name Description
page
optional

Page index

Validations:

  • Must be a Integer
per
optional

Items per page

Validations:

  • Must be a Integer
investor_id / promoter_id
required

It could be either investor or promoter ID

Validations:

  • Must be a String
id
required

Requested bank account ID

Validations:

  • Must be a String

Examples

{
  "data": {
    "id": "bank-account-uuid",
    "account_holder": "Account Holder Name",
    "account_holder_name": "Name",
    "account_holder_lastname": "Lastname",
    "account_holder_matriname": "Matriname",
    "account_number": "123456789012",
    "type_of": null,
    "alias": "Account Alias",
    "trust_number": null,
    "branch_name": null,
    "swift_code": null,
    "aba_code": "ABA123456789",
    "is_foreign_bank": false,
    "currency": {
      "name": "MXN",
      "value": "mxn"
    },
    "bank_name": null,
    "company": false,
    "company_name": null,
    "person_type": "Persona física",
    "extras": {
    },
    "banxico_bank": {
      "id": "banxico-bank-uuid",
      "name": "Bank Name",
      "abbreviation": "BANK",
      "code": "001"
    },
    "fiscal_address": {
      "tax_id_number": "XAXX010101000",
      "name": "Nombre",
      "lastname": "Apellido Paterno",
      "matriname": "Apellido Materno",
      "company": false,
      "company_name": null,
      "default": false,
      "id": "00000000-0000-0000-0000-000000000001",
      "street": "Calle Ejemplo",
      "street_number": "123",
      "street_number_internal": null,
      "zip_code": "00000",
      "suburb": "Colonia Ejemplo",
      "city": "Ciudad Ejemplo",
      "state": "Estado Ejemplo",
      "country": "MEX",
      "country_translated": "Mexico"
    }
  }
}

Errors

Code Description
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error