Neopay

Enlaces de Pagos

Recurso de enlace de pago

Field	Type	Description
`ID`	ID	Identificador interno único de Neopay del enlace de pago
`application_id`	UUID	UUID de la aplicación (obligatorio)
`product`	String	Nombre del producto del enlace de pago (obligatorio)
`description`	String	Enlace de pago Descripción del producto
`amount`	Number	Importe del enlace de pago (requerido)
`status`	String	Estado del enlace de pago
`currency`	String	Moneda de enlace de pago
`reference`	String	Referencia de enlace de pago
`slug`	String	Slug de enlace de pago
`expired_at`	Date	Fecha de caducidad del enlace de pago
`request_customer_data`	Bool	Solicite los datos del cliente al pagar desde el enlace de pago
`show_payee_data`	Bool	Mostrar datos del beneficiario en la página o Enlace de pago
`settings.expirationDate`	Bool	Show payee data in page o Payment Link
`settings.requestCustomerData`	Bool	Definir si se requieren datos del cliente
`settings.showPayeeData`	Bool	Show payee data in page o Payment Link
`settings.theme.selected`	Bool	Establecer si se selecciona un tema de enlace de pago
`settings.theme.logo`	Bool	Establecer si se selecciona un logotipo de tema de enlace de pago
`settings.theme.logoType`	Bool	Establecer si se selecciona un tipo de logotipo de tema de enlace de pago

Lister les liens de paiement

GET

https://neopay.io/api/links

Obtenir la ressource liee à 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> es el token generado para su aplicación {info.fa-hint} <my-app-key> se obtiene en su portal de aplicaciones comoApplication ID

Solicitud de muestra:

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

Ejemplo de respuesta

Respuesta exitosa:

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

Obtener enlace de pago

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

Obtenga el recurso vinculado a un ID de enlace de pago específico

Headers

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

{info.fa-hint} <my-app-token> es el token generado para su aplicación {info.fa-hint} <my-app-key> se obtiene en su portal de aplicaciones comoApplication ID

Query params

Param	Tipo	Descripción
`id` required	UUID	Id. de enlace obtenido ya sea creando un nuevo enlace o recuperándolo del `List payment links` endpoints

Solicitud de muestra:

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

Ejemplo de respuesta

Respuesta exitosa::

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

Crear un enlace de pago

POST

https://neopay.io/api/links

Obtenga el recurso vinculado a un ID de enlace de pago específico

Headers

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

{info.fa-hint} <my-app-token> es el token generado para su aplicación {info.fa-hint} <my-app-key> se obtiene en su portal de aplicaciones comoApplication ID

Solicitud de muestra:

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

Descripción de los parámetros del cuerpo

Param	Tipo	Descripción
`product` required	String(50)	Campo para describir el producto a vender.
`amount` required	Double(10.2)	Cantidad de producto vendido. Solicitar 2 decimales
`description`	String(150)	Una breve descripción de la página de su producto.
`communication`	String(18)	La referencia de pago para ver en el extracto bancario
`expired_at`	DateTime	Campo para establecer la fecha de caducidad de la página. Leer solo cuando settings.expirationDate
est réglé sur`true`
`request_customer_data`	Enum List	Defina qué datos se solicitarán al cliente en el momento del pago. Solo se lee cuando settings.requestCustomerData se establece en `true` Customer's email will always be requested Lista: - `name` : Solicitará el nombre completo del cliente - `name_phone`:Se solicitará el nombre completo y teléfono del cliente - `full_customer` : Solicitará el correo electrónico del Cliente, nombre completo, teléfono y dirección
`settings.expirationDate`	Boolean	Define si la página debe caducar en una fecha y hora programada.
`settings.showPayeeData`	Boolean	Mostrar los detalles del comerciante en la página del enlace de pago
`settings.requestCustomerData`	Boolean	Define si la página debe solicitar datos personales del cliente

Ejemplo de respuesta

Respuesta exitosa:

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

Obtenga el recurso vinculado a un ID de enlace de pago específico

Headers

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

{info.fa-hint} <my-app-token> es el token generado para su aplicación {info.fa-hint} <my-app-key> se obtiene en su portal de aplicaciones comoApplication ID

Solicitud de muestra:

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	Tipo	Descripción
`id` required	UUID	Id. de enlace obtenido ya sea creando un nuevo enlace o recuperándolo del `List payment links` endpoints

Ejemplo de respuesta

Respuesta exitosa:

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

Obtenga el recurso vinculado a un ID de enlace de pago específico

Headers

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

{info.fa-hint} <my-app-token> es el token generado para su aplicación {info.fa-hint} <my-app-key> se obtiene en su portal de aplicaciones comoApplication ID

Solicitud de muestra:

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	Tipo	Descripción
`id` required	UUID	Id. de enlace obtenido ya sea creando un nuevo enlace o recuperándolo del `List payment links` endpoints

Ejemplo de respuesta

Respuesta exitosa:

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

Cerrar enlace

PATCH

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

Obtenga el recurso vinculado a un ID de enlace de pago específico

Headers

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

{info.fa-hint} <my-app-token> es el token generado para su aplicación {info.fa-hint} <my-app-key> se obtiene en su portal de aplicaciones comoApplication ID

Query params

Param	Tipo	Descripción
`id` required	UUID	Id. de enlace obtenido ya sea creando un nuevo enlace o recuperándolo del `List payment links` endpoints

Solicitud de muestra:

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'

Ejemplo de respuesta

Respuesta exitosa:

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

Empezar

¿Cómo funciona?

Referencias de la API

Enlaces de Pagos

Recurso de enlace de pago

Lister les liens de paiement

Headers

Solicitud de muestra:

Ejemplo de respuesta

Respuesta exitosa:

Obtener enlace de pago

Headers

Query params

Solicitud de muestra:

Ejemplo de respuesta

Respuesta exitosa::

Crear un enlace de pago

Headers

Solicitud de muestra:

Body params

Descripción de los parámetros del cuerpo

Ejemplo de respuesta

Respuesta exitosa:

Publish Link

Headers

Solicitud de muestra:

Query params

Ejemplo de respuesta

Respuesta exitosa:

Unpublish Link

Headers

Solicitud de muestra:

Query params

Ejemplo de respuesta

Respuesta exitosa:

Cerrar enlace

Headers

Query params

Solicitud de muestra:

Ejemplo de respuesta

Respuesta exitosa: