Institutions

Institution Resource

Field Type Description
id Integer Neopay internal unique ID of the institution
code String Code used to identify the institution on a payment request
name String Institution name
medias Object Object of media items such as logo and icons
environment Enum Field to define the institution's environment.
Options:
- LIVE
- SANDBOX
available_countries Array Array of countries where the institutions are allowed to operate
instant_payment_enabled Boolean Field to define if the institution accept INSTANT_PAYMENTS
bulk_payment_enabled Boolean Field to define if the institution accept BULK_PAYMENTS

Resource example:

{
    "id": 7,
    "code": "cic-sandbox",
    "name": "CIC Sandbox",
    "medias": {
        "logo": "https://images.yapily.com/image/fb6f1e5a-53b8-47f8-a313-9019f717bb20?size=0",
        "icon": "https://images.yapily.com/image/d77815df-ab02-44c1-8c73-24098d661d40?size=0"
    },
    "environment": "SANDBOX",
    "available_countries": [
        {
            "displayName": "France",
            "countryCode2": "FR"
        }
    ],
    "instant_payment_enabled": true,
    "bulk_payment_enabled": false
}

List institutions

.GET https://neopay.io/api/institutions

Get the resource collection of institutions available for the specific application.

Headers

{
    "x-app-key": "<my-app-key>",
    "Content-Type": "application/json/",
    "Accept": "application/json"
}

{info.fa-hint} <my-app-key> is obtained in your Application portal as the Application ID

Request example:

curl --location 'https://neopay.io/api/institutions' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'x-app-key: YOUR-APPLICATION-TOKEN' \
--header 'Authorization: YOUR-TOKEN'

Response example

Success Response:


HTTP 200 
    {
    "data": [
        {
            "id": 7,
            "code": "cic-sandbox",
            "name": "CIC Sandbox",
            "medias": {
                "logo": "https://images.yapily.com/image/fb6f1e5a-53b8-47f8-a313-9019f717bb20?size=0",
                "icon": "https://images.yapily.com/image/d77815df-ab02-44c1-8c73-24098d661d40?size=0"
            },
            "environment": "SANDBOX",
            "available_countries": [
                {
                    "displayName": "France",
                    "countryCode2": "FR"
                }
            ],
            "instant_payment_enabled": true,
            "bulk_payment_enabled": false
        },
        {
            ...
        }
    ],
    "links": {
        "first": "http://neopay-master.test/api/institutions?page=1",
        "last": "http://neopay-master.test/api/institutions?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "http://neopay-master.test/api/institutions?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "http://neopay-master.test/api/institutions",
        "per_page": 15,
        "to": 7,
        "total": 7
    }
}

Get institution

.GET https://neopay.io/api/institutions/{id}

Get the resource of a specific Institution.

Query params

Param Type Description
id
required		 ID ID obtained fetching from the List institutions endpoint

Headers

{
    "x-app-key": "<my-app-key>",
    "Content-Type": "application/json/",
    "Accept": "application/json"
}

{info.fa-hint} <my-app-key> is obtained in your Application portal as the Application ID

Request example:

curl --location 'https://neopay.io/api/institutions/{id}' \
--header 'Authorization: YOUR-TOKEN \
--header 'x-app-key:  YOUR-APPLICATION-TOKEN' \
--header 'Content-Type: application/json'
--header 'Accept: application/json'

Response example

Success Response:


HTTP 200 
{
    "id": 7,
    "code": "cic-sandbox",
    "name": "CIC Sandbox",
    "medias": {
        "logo": "https://images.yapily.com/image/fb6f1e5a-53b8-47f8-a313-9019f717bb20?size=0",
        "icon": "https://images.yapily.com/image/d77815df-ab02-44c1-8c73-24098d661d40?size=0"
    },
    "environment": "SANDBOX",
    "available_countries": [
        {
            "displayName": "France",
            "countryCode2": "FR"
        }
    ],
    "instant_payment_enabled": true,
    "bulk_payment_enabled": false
}