Meta

List institutions

Request

GET https://api-dev.spay.ng/api/v1/meta/institutions
Authorization: Bearer <access-token>
Accept: application/json

curl

curl 'https://api-dev.spay.ng/api/v1/meta/institutions' \
  -H "Authorization: Bearer $SPAY_ACCESS_TOKEN" \
  -H "Accept: application/json"

No request body.

Response: 200 OK

[
  {
    "institutionCode": "999488",
    "name": "Indulge MFB"
  },
  {
    "institutionCode": "000013",
    "name": "Example Bank"
  }
]

Response fields

Field	Type	Description
[].institutionCode	string	The institution’s code, sent as destinationBankCode.
[].name	string	The institution’s name.

• Spay’s own institution is listed first.

Errors

HTTP status	Body
401	{"error":{"code":"63","message":"Missing, invalid or expired access token"}}
403	{"error":{"code":"63","message":"Operation not permitted"}}
503	{"error":{"code":"91","message":"Service unavailable"}}

List account types

Request

GET https://api-dev.spay.ng/api/v1/meta/account-types
Authorization: Bearer <access-token>
Accept: application/json

curl

curl 'https://api-dev.spay.ng/api/v1/meta/account-types' \
  -H "Authorization: Bearer $SPAY_ACCESS_TOKEN" \
  -H "Accept: application/json"

No request body.

Response: 200 OK

[
  {
    "id": "33333333-3333-4333-8333-333333333333",
    "name": "POS_BUSINESS",
    "description": "POS Business Account",
    "customerType": "BUSINESS",
    "currency": "NGN"
  }
]

Response fields

Field	Type	Description
[].id	string, UUID	The account type’s id. Pass it as accountTypeId when opening an account.
[].name	string	A short code for the account type.
[].description	string	The label to show.
[].customerType	enum: RETAIL, BUSINESS	The kind of customer the type is for.
[].currency	string, NGN	The account currency.

Errors

HTTP status	Body
401	{"error":{"code":"63","message":"Missing, invalid or expired access token"}}
403	{"error":{"code":"63","message":"Operation not permitted"}}
503	{"error":{"code":"91","message":"Service unavailable"}}