Instituciones

Recurso de la institución

Campo Tipo Descripción
id Integer identificador único interno de Neopay del establecimiento
code String Código utilizado para identificar la institución en una solicitud de pago
name String Nombre de la institución
medias Object Objeto de elementos multimedia como logotipos e iconos.
environment Enum Campo utilizado para definir el entorno de la institución.
Opcion:
- LIVE
- SANDBOX
available_countries Array Tabla de países donde las instituciones están autorizadas para operar
instant_payment_enabled Bool Campo para definir si el establecimiento acepta INSTANT_PAYMENTS
bulk_payment_enabled Bool Campo para definir si el establecimiento aceptaBULK_PAYMENTS

Ejemplo de recurso:

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

Lista de establecimientos

GET

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

Obtener la recaudación de recursos de las instituciones disponibles para la aplicación específica.

Headers

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

{info.fa-hint} <my-app-key> se obtiene en su portal de aplicaciones como Application ID

Solicitud de muestra:

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'

Ejemplo de respuesta

Respuesta de éxito:


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

Obtener establecimiento

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

Obtener el recurso de una institución específica.

Query params

Param Tipo Descripción
id
required		 ID ID
obtuvo la recuperación 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> se obtiene en su portal de aplicaciones comoApplication ID

Solicitud de muestra:

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'

Ejemplo de respuesta

Respuesta de éxito:


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
}