Payments

Payments Resource

Field Type Description
ID UUID UUID unique interne de Neopay pour le paiement
institutionId ID ID de l'institution
application_id UUID UUID de l'application
customer.id UUID UUID du client (obligatoire si vous n'envoyez pas l'e-mail du client)
customer.email Email E-mail du client (obligatoire si vous n'envoyez pas l'ID du client)
customer.resource Resource Ressource client complète
amount Number Montant du paiement
status String Statut du paiement
currency String Devise du paiement
service String Service du paiement
enviroment String Environnement du paiement

Resource example:

{
    "id": "99639165-04a9-4742-b51b-c9dcc4fbc3cb",
    "application_id": "995d8ae8-b47f-4b3d-b411-e325d95f6ffd",
    "amount": 999.66,
    "status": "pending",
    "currency": "GBP",
    "country": "GB",
    "service": "api",
    "environment": "sandbox",
    "institution": {
        "id": 20,
        "name": "Modelo Sandbox"
    },
    "customer": {
        "id": "99639164-f36d-4836-a8b7-934ad056b16c",
        "name": "John Doe",
        "email": "johndoe@gmail.com",
        "currency": "GBP",
        "phone": "+33 7 65 31 39 61",
        "country": "GB",
        "state": "MG"
    },
    "payee": {
        "name": "John Doe",
        "country_code": "GB",
        "bank_name": "MODELO",
        "accountable": "DE89370400440532013000",
        "swift_bic": "AACSDE33"
    },
    "fee": null,
    "percentual_fee": null,
    "total_fee": null,
    "created_at": "2023-06-12T00:20:01.000000Z",
    "updated_at": "2023-06-12T00:20:01.000000Z",
    "authorisationUrl": "url of payment authorized"
}

Liste des paiements

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

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

Filtres

Nous avons quelques filtres disponibles pour répertorier les paiements : Statut, Service et Dates.

Headers

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

{info.fa-hint} <my-app-token> est le jeton généré pour votre application {info.fa-hint} <my-app-key> est obtenu dans votre portail d'application en tant queApplication ID

Exemple de demande :

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

Exemple de réponse

Réponse réussie :


HTTP 200 
{
    "data": [
        {
            "id": "99639165-04a9-4742-b51b-c9dcc4fbc3cb",
            "application_id": "995d8ae8-b47f-4b3d-b411-e325d95f6ffd",
            "amount": 999.66,
            "status": "pending",
            "currency": "GBP",
            "country": "GB",
            "service": "api",
            "environment": "sandbox",
            "institution": {
                "id": 20,
                "name": "Modelo Sandbox"
            },
            "customer": {
                "id": "99639164-f36d-4836-a8b7-934ad056b16c",
                "name": "John Doe update",
                "email": "johndoeupdated@gmail.com",
                "currency": "GBP",
                "phone": "+33 7 65 31 39 61",
                "country": "GB",
                "state": "MG"
            },
            "payee": {
                "name": "John Doe",
                "country_code": "GB",
                "bank_name": "MODELO",
                "accountable": "DE89370400440532013000",
                "swift_bic": "AACSDE33"
            },
            "fee": null,
            "percentual_fee": null,
            "total_fee": null,
            "created_at": "2023-06-12T00:20:01.000000Z",
            "updated_at": "2023-06-12T00:20:01.000000Z",
            "authorisationUrl": "url of payment authorized"
        }
    ],
    "links": {
        "first": "http://localhost/api/payments?page=1",
        "last": "http://localhost/api/payments?page=2",
        "prev": null,
        "next": "http://localhost/api/payments?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 2,
        "links": [
            {
                "url": null,
                "label": "Previous",
                "active": false
            },
            {
                "url": "api/payments?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": "api/payments?page=2",
                "label": "2",
                "active": false
            },
            {
                "url": "api/payments?page=2",
                "label": "Next",
                "active": false
            }
        ],
        "path": "api/payments",
        "per_page": 10,
        "to": 10,
        "total": 16
    }
}

Exemple de filtre:

curl --location 'https://neopay.io/api/payments?service=ap&status=pendingi&fromDate=2023-06-10&toDate=2023-06-12' \
--header 'Authorization: YOUR-TOKEN \
--header 'Content-Type: application/json' \
--header 'x-app-key: YOUR-APPLICATION-TOKEN'

Exemple de réponse

Réponse réussie:


HTTP 200 
{
    "data": [
        {
            "id": "99639165-04a9-4742-b51b-c9dcc4fbc3cb",
            "application_id": "995d8ae8-b47f-4b3d-b411-e325d95f6ffd",
            "amount": 999.66,
            "status": "pending",
            "currency": "GBP",
            "country": "GB",
            "service": "api",
            "environment": "sandbox",
            "institution": {
                "id": 20,
                "name": "Modelo Sandbox"
            },
            "customer": {
                "id": "99639164-f36d-4836-a8b7-934ad056b16c",
                "name": "John Doe update",
                "email": "johndoeupdated@gmail.com",
                "currency": "GBP",
                "phone": "+33 7 65 31 39 61",
                "country": "GB",
                "state": "MG"
            },
            "payee": {
                "name": "John Doe",
                "country_code": "GB",
                "bank_name": "MODELO",
                "accountable": "DE89370400440532013000",
                "swift_bic": "AACSDE33"
            },
            "fee": null,
            "percentual_fee": null,
            "total_fee": null,
            "created_at": "2023-06-12T00:20:01.000000Z",
            "updated_at": "2023-06-12T00:20:01.000000Z",
            "authorisationUrl": "url of payment authorized"
        }
    ],
    "links": {
        "first": "http://localhost/api/payments?page=1",
        "last": "http://localhost/api/payments?page=2",
        "prev": null,
        "next": "http://localhost/api/payments?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 2,
        "links": [
            {
                "url": null,
                "label": "Previous",
                "active": false
            },
            {
                "url": "api/payments?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": "api/payments?page=2",
                "label": "2",
                "active": false
            },
            {
                "url": "api/payments?page=2",
                "label": "Next",
                "active": false
            }
        ],
        "path": "api/payments",
        "per_page": 10,
        "to": 10,
        "total": 16
    }
}

Créer un paiement

.POST https://neopay.io/api/payments

Créer un paiement

Headers

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

{info.fa-hint} <my-app-token> est le jeton généré pour votre application {info.fa-hint} <my-app-key> est obtenu dans votre portail d'application en tant que Application ID

Exemple de corps de request

{
    "serviceId": "api",
    "institutionId": 20,
    "payment": {
        "amount": 122.44,
        "currency": "GBP"
    },
    "customer": {
        "id": "99618204-6daf-4eca-8180-c21bb8d8ee24",
        "name": "Jhon Doe",
        "email": "jhondoe@email.com",
        "country": "GB"
    },
    "reference": "reference",
    "callback_url": "https://webhook.site/2d9eefba-3ac8-4692-a0ec-d57dd3ce3abd"
}
Field Type Description
serviceId String Nom du service. (Requis)
institutionId Integer L'ID de l'institution. (Requis si le service est une API)
payment Object Les détails du paiement. (Requis)
payment.amount Number Montant du paiement (Requis)
payment.currency String La devise du paiement. (Requis)
customer Object Les détails du client (Requis)
customer.id UUID UUID du client (Requis si vous n'envoyez pas l'e-mail du client)
customer.email String E-mail du client (Requis si vous n'envoyez pas l'UUID du client)
customer.name String Nom du client (Facultatif)
customer.country String Pays du client (Requis)
customer.resource Resource Ressource client complète
reference String PRéférence du paiement (Facultatif)
callback_url String URL de rappel du paiement (Facultatif)

Exemple de demande :

curl --location 'http://localhost/api/payments' \
--header 'Authorization: YOUR-TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'x-app-key: YOUR-APPLICATION-TOKEN' \
--data-raw '{
"serviceId": "api"
"institutionId": 22,
"payment": {
"amount": 122.44,
"currency": "GBP"
},
"customer": {
"id": "99ea2084-55c9-4deb-9a74-0a698022573b",
"name": "Jhon Doe",
"email": "jhondoe@email.com",
"country": "GB"
},
"reference": "reference",
"callback_url": "https://webhook.site/b4461d69-5feb-447e-898b-75bb9ddf9023"
}'

Exemple de réponse

Réponse réussie :


HTTP 200 
{
    "message": "Payment saved successfully!",
    "payment": {
        "id": "99ea261a-d7e8-45be-af0b-5ff89b8cee2a",
        "application_id": "99e9c703-bfe1-4328-af65-12cd8457a69d",
        "authorisationUrl": "YOUR-AUTHORIZATION-URL"
    }
}

Créer un pix paiement

.POST https://neopay.io/api/payments

Créer un pix paiement

Headers

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

{info.fa-hint} <my-app-token> est le jeton généré pour votre application {info.fa-hint} <my-app-key> est obtenu dans votre portail d'application en tant que Application ID

Exemple de corps de request

{
    "serviceId": "pix",
    "payment": {
        "amount": 122.44,
        "currency": "GBP"
    },
    "customer": {
        "id": "99618204-6daf-4eca-8180-c21bb8d8ee24",
        "name": "Jhon Doe",
        "email": "jhondoe@email.com",
        "country": "GB",
        "tax_number": "06372771390"
    },
    "reference": "reference"
}

Request example:

curl --location 'http://localhost/api/payments' \
--header 'Authorization: YOUR-TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'x-app-key: YOUR-APPLICATION-TOKEN' \
--data-raw '{
"serviceId": "pix"
"payment": {
"amount": 122.44,
"currency": "GBP"
},
"customer": {
"id": "99ea2084-55c9-4deb-9a74-0a698022573b",
"name": "Jhon Doe",
"email": "jhondoe@email.com",
"country": "GB",
"tax_number": "06372771390"
},
"reference": "reference",
"callback_url": "https://webhook.site/b4461d69-5feb-447e-898b-75bb9ddf9023"
}'

Response example

Success Response:


HTTP 200 
{
    "message": "Payment saved successfully!",
    "payment": {
        "id": "99ea261a-d7e8-45be-af0b-5ff89b8cee2a",
        "application_id": "99e9c703-bfe1-4328-af65-12cd8457a69d",
        "qr_code": "YOUR-QR-CODE-PIX"
    }
}

Obtenir le paiement

.GET https://neopay.io/api/customers/{id} Obtenez la ressource à un paiement spécifique.

Query params

Param Type Description
uuid
required		 UUID UUID obtenu soit en créant un nouveau paiement, soit en récupérant depuis leList Payment endpoint

Headers

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

{info.fa-hint} <my-app-token> est le jeton généré pour votre application {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/payments/{id}' \
--header 'Authorization: YOUR-TOKEN \
--header 'Content-Type: application/json' \
--header 'x-app-key: YOUR-APPLICATION-TOKEN'

Exemple de réponse

Réponse réussie :


HTTP 200 
{
    "payment": {
        "id": "99658c35-d9ee-4b04-9bc2-4a963c0bcfc3",
        "application_id": "995d8ae8-b47f-4b3d-b411-e325d95f6ffd",
        "amount": 122.44,
        "status": "pending",
        "currency": "GBP",
        "country": "GB",
        "service": "api",
        "environment": "sandbox",
        "institution": {
            "id": 20,
            "name": "Modelo Sandbox"
        },
        "customer": {
            "id": "9965866d-03eb-46ad-a932-f517f0380a57",
            "name": "Jhon doe",
            "email": "Jhondoe@email.com",
            "currency": "GBP",
            "phone": "+33 7 65 31 39 61",
            "country": "UK",
            "state": "  Brighton"
        },
        "payee": {
            "name": "John Doe",
            "country_code": "GB",
            "bank_name": "MODELO",
            "accountable": "DE89370400440532013000",
            "swift_bic": "AACSDE33"
        },
        "fee": null,
        "percentual_fee": null,
        "total_fee": null,
        "created_at": "2023-06-12T23:57:10.000000Z",
        "updated_at": "2023-06-12T23:57:10.000000Z"
    }
}