Skip to main content
GET
/
v1
/
loans
/
banks
/
list
List MBS Banks
curl --request GET \
  --url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans/banks/list \
  --header 'apikey: <api-key>' \
  --header 'x-carbon-key: <x-carbon-key>'
{
  "status": "success",
  "data": [
    {
      "bankCode": "565",
      "bankName": "Carbon"
    },
    {
      "bankCode": "058",
      "bankName": "GTBank"
    },
    {
      "bankCode": "011",
      "bankName": "First Bank"
    },
    {
      "bankCode": "033",
      "bankName": "UBA"
    }
  ]
}

​
Overview

Returns all banks supported by the Mobile Banking Statement (MBS) service. Use the bankCode from this list as sort_code when calling POST /v1/loans/:applicationId/bank-statement.

​
Request

Method: GET
URL: /v1/loans/banks/list

​
Parameters

NameInTypeRequiredDescription
x-carbon-keyHeaderstringYesAPI key for authentication.

​
Response

​
200 OK

{
  "status": "success",
  "data": [
    { "bankCode": "565", "bankName": "Carbon" },
    { "bankCode": "058", "bankName": "GTBank" },
    { "bankCode": "011", "bankName": "First Bank" },
    { "bankCode": "033", "bankName": "UBA" }
  ]
}

Authorizations

​
apikey
string
header
required

Provide your API key in the 'apikey' header.

Headers

​
x-carbon-key
string
required

Response

200 - application/json

Successful response

The response is of type object.