Payments Links

Payment Link Resource

Field	Type	Description
`ID`	ID	Neopay internal unique ID of the Payment Link
`application_id`	UUID	UUID of Application (Required)
`product`	String	Product name of Payment Link (Required)
`description`	String	Product description of Payment Link
`amount`	Number	Amount of Payment Link (Required)
`status`	String	Status of Payment Link
`currency`	String	Currency of Payment Link
`reference`	String	Reference of Payment Link
`slug`	String	Slug of Payment Link
`expired_at`	Date	Date the Payment Link expires
`request_customer_data`	Bool	Request customer details when pay the Payment Link
`show_payee_data`	Bool	Show payee data in page o Payment Link
`settings.expirationDate`	Bool	Set expiration date of payment link
`settings.requestCustomerData`	Bool	Define if customer data is required
`settings.showPayeeData`	Bool	Set of payee data will shown
`settings.theme.selected`	Bool	Définir si un thème de lien de paiement est sélectionné
`settings.theme.logo`	Bool	Set if a payment link theme logo is selected
`settings.theme.logoType`	Bool	Set if a payment link theme logoType is selected

List payment Links

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

Get the resource linked to a specific Payment link ID

Headers

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

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

Request example:

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

Response example

Success Response:

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é",
        "reference": null,
        "currency": "EUR",
        "expired_at": null,
        "request_customer_data": false,
        "show_payee_data": false,
        "enabled": true,
        "settings": {
            "expirationDate": false,
            "showPayeeData": false,
            "requestCustomerData": true,
            "theme": {
                "selected": "blue",
                "logo": "logo-url",
                "logoTYpe": "blue"
            }
        },
        "created_at": "2023-04-11T19:44:43.000000Z",
        "updated_at": "2023-04-11T19:44:43.000000Z",
        "deleted_at": null
    }
}

Get A Payment Link

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

Get the resource linked to a specific Payment link ID

Headers

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

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

Query params

Param	Type	Description
`id` required	ID	Link ID obtained either by creating a new link or fetching from the `List payment links` endpoints

Request example:

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

Response example

Success Response:

HTTP 200

{
    "id": 1,
    "application_id": "995d8ae8-b47f-4b3d-b411-e325d95f6ffd",
    "status": "draft",
    "slug": "67vSVdqelH",
    "product": "Iphone 14 PRO",
    "amount": 23.23,
    "description": "Iphone 14 PRO reconditionné",
    "reference": null,
    "currency": "EUR",
    "expired_at": null,
    "request_customer_data": false,
    "show_payee_data": false,
    "enabled": true,
    "settings": {
        "expirationDate": false,
        "showPayeeData": true,
        "requestCustomerData": false,
        "theme": {
            "selected": "purple",
            "logo": "logo-url",
            "logoType": "icon"
        }
    },
    "created_at": "2023-06-17T18:46:24.000000Z",
    "updated_at": "2023-06-17T18:46:24.000000Z"
}

Create Payment Link

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

Get the resource linked to a specific Payment link ID

Headers

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

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

Request example:

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é",
    "reference": "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:

Parameter	Type	Description
`product` required	String(50)	Field to describe the product to be selled.
`amount` required	Double(10.2)	Amount of the produt selled. Requests 2 decimal case
`description`	String(150)	A small description about your product page.
`communication`	String(18)	The payment reference to seen in the Bank statement
`expired_at`	DateTime	Field to set the expiration date of the page. Only readed when settings.expirationDate is set to `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
`settings.theme.selected`	String	Defines the color theme on Payment Link page
`settings.theme.logo`	String	Defines the logo on top left side in Payment Link page
`settings.theme.logoType`	Enum List	Defines the style of the logoon the moment of the checkout. List: - `icon` : Logo in icon format - `icon_name`:Logo in icon format with merchant name at side - `logo` : Logo in normal size

Response example

Success Response:

HTTP 200

{
    "id": 1,
    "application_id": "995d8ae8-b47f-4b3d-b411-e325d95f6ffd",
    "status": "draft",
    "slug": "67vSVdqelH",
    "product": "Iphone 14 PRO",
    "amount": 23.23,
    "description": "Iphone 14 PRO reconditionné",
    "reference": null,
    "currency": "EUR",
    "expired_at": null,
    "request_customer_data": false,
    "show_payee_data": false,
    "enabled": true,
    "settings": {
        "expirationDate": false,
        "showPayeeData": true,
        "requestCustomerData": false,
        "theme": {
            "selected": "purple",
            "logo": null,
            "logoType": "icon"
        }
    },
    "created_at": "2023-06-17T18:46:24.000000Z",
    "updated_at": "2023-06-17T18:46:24.000000Z"
}

Publish Link

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

Get the resource linked to a specific Payment link ID

Headers

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

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

Request example:

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	ID	Link ID obtained either by creating a new link or fetching from the `List payment links` endpoints

Response example

Success Response:

HTTP 200

{
    "id": 1,
    "application_id": "995d8ae8-b47f-4b3d-b411-e325d95f6ffd",
    "status": "published",
    "slug": "67vSVdqelH",
    "product": "Iphone 14 PRO",
    "amount": 23.23,
    "description": "Iphone 14 PRO reconditionné",
    "reference": null,
    "currency": "EUR",
    "expired_at": null,
    "request_customer_data": false,
    "show_payee_data": false,
    "enabled": true,
    "settings": {
        "expirationDate": false,
        "showPayeeData": true,
        "requestCustomerData": false,
        "theme": {
            "selected": "purple",
            "logo": "logo-url",
            "logoType": "icon"
        }
    },
    "created_at": "2023-06-17T18:46:24.000000Z",
    "updated_at": "2023-06-17T18:46:24.000000Z"
}

Unpublish Link

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

Get the resource linked to a specific Payment link ID

Headers

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

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

Request example:

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	ID	Link ID obtained either by creating a new link or fetching from the `List payment links` endpoints

Response example

Success Response:

HTTP 200

{
    "id": 1,
    "application_id": "995d8ae8-b47f-4b3d-b411-e325d95f6ffd",
    "status": "unpublised",
    "slug": "67vSVdqelH",
    "product": "Iphone 14 PRO",
    "amount": 23.23,
    "description": "Iphone 14 PRO reconditionné",
    "reference": null,
    "currency": "EUR",
    "expired_at": null,
    "request_customer_data": false,
    "show_payee_data": false,
    "enabled": true,
    "settings": {
        "expirationDate": false,
        "showPayeeData": true,
        "requestCustomerData": false,
        "theme": {
            "selected": "purple",
            "logo": "logo-url",
            "logoType": "icon"
        }
    },
    "created_at": "2023-06-17T18:46:24.000000Z",
    "updated_at": "2023-06-17T18:46:24.000000Z"
}

Close Link

.PATCH https://neopay.io/api/links/{id}/close

Get the resource linked to a specific Payment link ID

Headers

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

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

Request example:

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'

Query params

Param	Type	Description
`id` required	ID	Link ID obtained either by creating a new link or fetching from the `List payment links` endpoints

Response example

Success Response:

HTTP 200

{
    "id": 1,
    "application_id": "995d8ae8-b47f-4b3d-b411-e325d95f6ffd",
    "status": "closed",
    "slug": "67vSVdqelH",
    "product": "Iphone 14 PRO",
    "amount": 23.23,
    "description": "Iphone 14 PRO reconditionné",
    "reference": null,
    "currency": "EUR",
    "expired_at": null,
    "request_customer_data": false,
    "show_payee_data": false,
    "enabled": true,
    "settings": {
        "expirationDate": false,
        "showPayeeData": true,
        "requestCustomerData": false,
        "theme": {
            "selected": "purple",
            "logo": "logo-url",
            "logoType": "icon"
        }
    },
    "created_at": "2023-06-17T18:46:24.000000Z",
    "updated_at": "2023-06-17T18:46:24.000000Z"
}

Get Started

How it works

API References

Payments Links

Payment Link Resource

List payment Links

Headers

Request example:

Response example

Success Response:

Get A Payment Link

Headers

Query params

Request example:

Response example

Success Response:

Create Payment Link

Headers

Request example:

Body params

body params description:

Response example

Success Response:

Publish Link

Headers

Request example:

Query params

Response example

Success Response:

Unpublish Link

Headers

Request example:

Query params

Response example

Success Response:

Close Link

Headers

Request example:

Query params

Response example

Success Response: