Institutions

Ressource de l'établissement

Champ Taper Description
id Entier Identifiant unique interne Neopay de l'établissement
code Chaîne Code utilisé pour identifier l'établissement sur une demande de paiement
name Chaîne
Nom de l'institution
medias Objet Objet des éléments multimédias tels que le logo et les icônes
environment Énumération
Champ permettant de définir l'environnement de l'établissement.
Choix:
- LIVE
- SANDBOX
available_countries l' ordre Tableau des pays où les institutions sont autorisées à opérer
instant_payment_enabled Booléen Champ à définir si l'établissement accepte INSTANT_PAYMENTS
bulk_payment_enabled Booléen Champ à définir si l'établissement accepteBULK_PAYMENTS

Exemple de ressource :

{
    "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
}

Liste des établissements

GET

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

Obtenez la collection de ressources des institutions disponibles pour l'application spécifique.

Headers

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

{info.fa-hint} <my-app-key> est obtenu dans votre portail d'application en tant que Application ID

Exemple de demande:

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'

Exemple de réponse

Succès 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
    }
}

Obtenir l'établissement

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

Obtenez la ressource d'une institution spécifique.

Query params

Param Type Description
id
required		 ID ID
obtenu la récupération de la List institutions endpoint

Headers

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

{info.fa-hint} <my-app-key> est obtenu dans votre portail d'application en tant que Application ID

Exemple de demande:

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'

Exemple de réponse

Succès 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
}