Payments Links

Payment Link Resource

Field	Type	Description
`ID`	ID	Identifiant interne unique Neopay du Lien de Paiement
`application_id`	UUID	UUID de l'application (obligatoire)
`product`	String	Nom du produit du lien de paiement (obligatoire)
`description`	String	Description du produit du lien de paiement
`amount`	Number	Montant du lien de paiement (obligatoire)
`status`	String	Statut du lien de paiement
`currency`	String	Devise du lien de paiement
`reference`	String	Référence du lien de paiement
`slug`	String	Slug de lien de paiement
`expired_at`	Date	Date d'expiration du lien de paiement
`request_customer_data`	Bool	Demander les détails du client lors du paiement du lien de paiement
`show_payee_data`	Bool	Show payee data in page o Payment Link
`settings.expirationDate`	Bool	Show payee data in page o Payment Link
`settings.requestCustomerData`	Bool	Définir si les données client sont requises
`settings.showPayeeData`	Bool	Show payee data in page o Payment Link
`settings.theme.selected`	Bool	Définir si un thème de lien de paiement est sélectionné
`settings.theme.logo`	Bool	Définir si un logo de thème de lien de paiement est sélectionné
`settings.theme.logoType`	Bool	Définir si un logoType de thème de lien de paiement est sélectionné

Lister les liens de paiement

GET

https://neopay.io/api/links

Obtenir la ressource liée à un ID de lien de paiement spécifique

Headers

{
    "x-app-key": "<my-app-key>",
    "Authorization": "<my-app-token>",
    "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/links' \
--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": "98e878e8-2486-458a-b1f4-878d37398b52",
        "application_id": "98e2fe88-3a95-4c7c-a98f-dfa5192b85f6",
        "status": "draft",
        "slug": "5EczjXZRsZ",
        "product": "Iphone 14 Pro",
        "amount": 350.41,
        "description": "Iphone 14 Pro reconditionné",
        "communication": null,
        "expired_at": null,
        "request_customer_data": false,
        "show_payee_data": false,
        "enabled": true,
        "settings": {
            "expirationDate": false,
            "showPayeeData": false,
            "requestCustomerData": true,
            "theme": {
                "selected": "blue"
            }
        },
        "created_at": "2023-04-11T19:44:43.000000Z",
        "updated_at": "2023-04-11T19:44:43.000000Z",
        "deleted_at": null
    }
}

Obtenir un lien de paiement

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

Obtenir la ressource liée à un ID de lien de paiement spécifique

Headers

{
    "x-app-key": "<my-app-key>",
    "Authorization": "<my-app-token>",
    "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

Query params

Param	Taper	Description
`id` required	UUID	ID de lien obtenu soit en créant un nouveau lien, soit en récupérant à partir du `List payment links` endpoints

Exemple de demande :

curl --location 'https://neopay.io/api/links/{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

{
    "data": {
        "id": "98e878e8-2486-458a-b1f4-878d37398b52",
        "application_id": "98e2fe88-3a95-4c7c-a98f-dfa5192b85f6",
        "status": "draft",
        "slug": "5EczjXZRsZ",
        "product": "Iphone 14 Pro",
        "amount": 350.41,
        "description": "Iphone 14 Pro reconditionné",
        "communication": null,
        "expired_at": null,
        "request_customer_data": false,
        "show_payee_data": false,
        "enabled": true,
        "settings": {
            "expirationDate": false,
            "showPayeeData": false,
            "requestCustomerData": true,
            "theme": {
                "selected": "blue"
            }
        },
        "created_at": "2023-04-11T19:44:43.000000Z",
        "updated_at": "2023-04-11T19:44:43.000000Z",
        "deleted_at": null
    }
}

Créer un lien de paiement

POST

https://neopay.io/api/links

Obtenir la ressource liée à un ID de lien de paiement spécifique

Headers

{
    "x-app-key": "<my-app-key>",
    "Authorization": "<my-app-token>",
    "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/links' \
--header 'Authorization: YOUR-TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'x-app-key: YOUR-APPLICATION-TOKEN '\
--data '{
"product": "Iphone 14 Pro",
"amount": 350.41,
"description": "Iphone 14 Pro reconditionné",
"reference": "NEOPAY-IPHONE",
"expired_at": "2023-10-31 18:00:00",
"request_customer_data": "full_customer",
"settings": {
"expirationDate": false,
"showPayeeData": false,
"requestCustomerData": true,
"theme": {
"selected": "blue"
}
}
}'

Body params

{
    "product": "Iphone 14 Pro",
    "amount": 350.41,
    "description": "Iphone 14 Pro reconditionné",
    "communication": "NEOPAY-IPHONE",
    "expired_at": "2023-01-31 18:00:00",
    "request_customer_data": "full_customer",
    "settings": {
        "expirationDate": false,
        "showPayeeData": false,
        "requestCustomerData": true,
        "theme": {
            "selected": "blue"
        }
    }
}

body params description:

Param	Taper	Description
`product` required	Chaîne(50)
Champ pour décrire le produit à vendre.
`amount` required	Double(10.2)	Montant du produit vendu. Demande 2 décimales
`description`	Chaîne(150)	Une petite description de votre page produit.
`communication`	Chaîne(18)	La référence de paiement à voir dans le relevé bancaire
`expired_at`	DateTime	Champ pour définir la date d'expiration de la page. Lu uniquement lorsque settings.expirationDate
est réglé sur`true`
`request_customer_data`	Enum List	Define what data will be requested to customer on the moment of the checkout. Only readed when settings.requestCustomerData is set to `true` Customer's email will always be requested List: - `name` : Will request the customer Full name - `name_phone`: Will request the customer full name and phone - `full_customer` : Will request Customer's email, full name, phone and address
`settings.expirationDate`	Boolean	Defines if the page must expires at a schedule datetime.
`settings.showPayeeData`	Boolean	Show merchant's details into the payment link page
`settings.requestCustomerData`	Boolean	Defines if the page must request customer's personal data

Exemple de réponse

Réponse réussie :

HTTP 200

{
    "data": {
        "id": "98e878e8-2486-458a-b1f4-878d37398b52",
        "application_id": "98e2fe88-3a95-4c7c-a98f-dfa5192b85f6",
        "status": "draft",
        "slug": "5EczjXZRsZ",
        "product": "Iphone 14 Pro",
        "amount": 350.41,
        "description": "Iphone 14 Pro reconditionné",
        "communication": null,
        "expired_at": null,
        "request_customer_data": false,
        "show_payee_data": false,
        "enabled": true,
        "settings": {
            "expirationDate": false,
            "showPayeeData": false,
            "requestCustomerData": true,
            "theme": {
                "selected": "blue"
            }
        },
        "created_at": "2023-04-11T19:44:43.000000Z",
        "updated_at": "2023-04-11T19:44:43.000000Z",
        "deleted_at": null
    }
}

Publish Link

PATCH

https://neopay.io/api/links/{id}/publish

Obtenir la ressource liée à un ID de lien de paiement spécifique

Headers

{
    "x-app-key": "<my-app-key>",
    "Authorization": "<my-app-token>",
    "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 --request PATCH 'https://neopay.io/api/links/{id}/publish' \
--header 'Authorization: YOUR-TOKEN' \
--header 'x-app-key: YOUR-APPLICATION-TOKEN' \
--header 'Content-Type: application/json'

Query params

Param	Type	Description
`id` required	UUID	ID de lien obtenu soit en créant un nouveau lien, soit en récupérant à partir du `List payment links` endpoints

Exemple de réponse

Réponse réussie :

HTTP 200

{
    "data": {
        "id": "98e878e8-2486-458a-b1f4-878d37398b52",
        "application_id": "98e2fe88-3a95-4c7c-a98f-dfa5192b85f6",
        "status": "draft",
        "slug": "5EczjXZRsZ",
        "product": "Iphone 14 Pro",
        "amount": 350.41,
        "description": "Iphone 14 Pro reconditionné",
        "communication": null,
        "expired_at": null,
        "request_customer_data": false,
        "show_payee_data": false,
        "enabled": true,
        "settings": {
            "expirationDate": false,
            "showPayeeData": false,
            "requestCustomerData": true,
            "theme": {
                "selected": "blue"
            }
        },
        "created_at": "2023-04-11T19:44:43.000000Z",
        "updated_at": "2023-04-11T19:44:43.000000Z",
        "deleted_at": null
    }
}

Unpublish Link

PATCH

https://neopay.io/api/links/{id}/unpublish

Obtenir la ressource liée à un ID de lien de paiement spécifique

Headers

{
    "x-app-key": "<my-app-key>",
    "Authorization": "<my-app-token>",
    "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 --request PATCH 'https://neopay.io/api/links/{id}/unpublish' \
--header 'Authorization: YOUR-TOKEN' \
--header 'x-app-key: YOUR-APPLICATION-TOKEN' \
--header 'Content-Type: application/json'

Query params

Param	Type	Description
`id` required	UUID	ID de lien obtenu soit en créant un nouveau lien, soit en récupérant à partir du `List payment links` endpoints

Exemple de réponse

Réponse réussie :

HTTP 200

{
    "data": {
        "id": "98e878e8-2486-458a-b1f4-878d37398b52",
        "application_id": "98e2fe88-3a95-4c7c-a98f-dfa5192b85f6",
        "status": "draft",
        "slug": "5EczjXZRsZ",
        "product": "Iphone 14 Pro",
        "amount": 350.41,
        "description": "Iphone 14 Pro reconditionné",
        "communication": null,
        "expired_at": null,
        "request_customer_data": false,
        "show_payee_data": false,
        "enabled": true,
        "settings": {
            "expirationDate": false,
            "showPayeeData": false,
            "requestCustomerData": true,
            "theme": {
                "selected": "blue"
            }
        },
        "created_at": "2023-04-11T19:44:43.000000Z",
        "updated_at": "2023-04-11T19:44:43.000000Z",
        "deleted_at": null
    }
}

Close Link

PATCH

https://neopay.io/api/links/{id}/publish

Obtenir la ressource liée à un ID de lien de paiement spécifique

Headers

{
    "x-app-key": "<my-app-key>",
    "Authorization": "<my-app-token>",
    "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

Query params

Param	Type	Description
`id` required	UUID	ID de lien obtenu soit en créant un nouveau lien, soit en récupérant à partir du `List payment links` endpoints

Exemple de demande :

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

Exemple de réponse

Réponse réussie :

HTTP 200

{
    "data": {
        "id": "98e878e8-2486-458a-b1f4-878d37398b52",
        "application_id": "98e2fe88-3a95-4c7c-a98f-dfa5192b85f6",
        "status": "draft",
        "slug": "5EczjXZRsZ",
        "product": "Iphone 14 Pro",
        "amount": 350.41,
        "description": "Iphone 14 Pro reconditionné",
        "communication": null,
        "expired_at": null,
        "request_customer_data": false,
        "show_payee_data": false,
        "enabled": true,
        "settings": {
            "expirationDate": false,
            "showPayeeData": false,
            "requestCustomerData": true,
            "theme": {
                "selected": "blue"
            }
        },
        "created_at": "2023-04-11T19:44:43.000000Z",
        "updated_at": "2023-04-11T19:44:43.000000Z",
        "deleted_at": null
    }
}

Commencer

Comment ça fonctionne

Les références API

Payments Links

Payment Link Resource

Lister les liens de paiement

Headers

Exemple de demande :

Exemple de réponse

Réponse réussie :

Obtenir un lien de paiement

Headers

Query params

Exemple de demande :

Exemple de réponse

Réponse réussie :

Créer un lien de paiement

Headers

Exemple de demande :

Body params

body params description:

Exemple de réponse

Réponse réussie :

Publish Link

Headers

Exemple de demande :

Query params

Exemple de réponse

Réponse réussie :

Unpublish Link

Headers

Exemple de demande :

Query params

Exemple de réponse

Réponse réussie :

Close Link

Headers

Query params

Exemple de demande :

Exemple de réponse

Réponse réussie :