Get Bank

GET /banks/{idOrCode}

Try it

Get Bank

cURL

curl --request GET \
  --url https://api.monime.io/banks/{idOrCode} \
  --header 'Authorization: Bearer <token>'

200

{
  "success": true,
  "messages": [
    "<unknown>"
  ],
  "result": {
    "id": "fpr-TJh76H8hj778hftdtu66gjio",
    "code": "SLB0004",
    "name": "Guarantee Trust Bank",
    "country": "SL",
    "status": {
      "active": true
    },
    "featureSet": {
      "payout": {
        "canPayTo": true,
        "schemes": [
          "<string>"
        ],
        "metadata": {}
      },
      "payment": {
        "canPayFrom": true,
        "schemes": [
          "<string>"
        ],
        "metadata": {}
      },
      "kycVerification": {
        "canVerifyAccount": true,
        "metadata": {}
      }
    },
    "createTime": "2023-11-07T05:31:56Z",
    "updateTime": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization · string · header · required

Bearer HTTP authentication specified with the header Authorization: Bearer <access_token>

Path Parameters

idOrCode · string · required

The id or code for the bank. The id or code for the bank.

Response

200 - application/json

OK

success · boolean

Represents the status of the query operation, confirming if it was successful. This field is always true

messages · any[]

Contains a list of messages providing relevant information or feedback related to the query or operation

result · object

Show child attributes

result. id · string

The ID of the bank.

Example:

"fpr-TJh76H8hj778hftdtu66gjio"

result. code · string

The unique code assigned to a bank by Monime to identify it within Monime's ecosystem.

Example:

"SLB0004"

result. name · string

The name of the bank.

Example:

"Guarantee Trust Bank"

result. country · string

The country of the bank.

Example:

"SL"

result. status · object

The status of the bank's operations within monime'.

Show child attributes

result.status. active · boolean

Whether or not this bank is active within Monime.

result. featureSet · object

The set of Monime features that the bank supports.'

Show child attributes

result.featureSet. payout · object

The bank's payout feature information.

Show child attributes

result.featureSet.payout. canPayTo · boolean

Whether or not Monime can pay out to an account in the bank.

result.featureSet.payout. schemes · string[] | null

The supported payout schemes of the bank.

result.featureSet.payout. metadata · object

Further metadata describing this bank's payout feature.

Show child attributes

result.featureSet.payout.metadata. {key} · string

result.featureSet. payment · object

The bank's payment feature information.

Show child attributes

result.featureSet.payment. canPayFrom · boolean

Whether or not Monime can accept payment from an account in the bank.

result.featureSet.payment. schemes · string[] | null

The supported payment schemes of the bank.

result.featureSet.payment. metadata · object

Further metadata describing this bank's payment feature.

Show child attributes

result.featureSet.payment.metadata. {key} · string

result.featureSet. kycVerification · object

The bank's KYC verification feature information.

Show child attributes

result.featureSet.kycVerification. canVerifyAccount · boolean

Whether or not Monime can verify an account's KYC' in the bank.

result.featureSet.kycVerification. metadata · object

Further metadata describing this bank's KYC verification feature.

Show child attributes

result.featureSet.kycVerification.metadata. {key} · string

result. createTime · string<date-time>

The time the bank's support was added.

result. updateTime · string<date-time>

The last time the bank's support was updated.