Clientes

---

• Recursos del cliente
• Lista de clientes
• Obtener cliente
• Crear clientes
• Editar clientes

Recursos del cliente

Campo	Tipo	Descripción
id	UUID	UUID único interno de Neopay del Cliente
name	String	Nombre del cliente
email	String	Correo electrónico del cliente (requerido)
phone	String	Número de teléfono de la cliente
city	String	Código de ciudad del cliente
state	String	Código de estado del cliente
country	String	Código de país del cliente
zip_code	String	Código postal de la cliente
street	String	Calle de la Cliente
house_number	String	Numero de casa de la cliente
currency	String	Moneda del cliente (ej: EUR)
tax_number	String	Número de impuesto
company_number	String	Numero de compañia

Ejemplo de recurso:

{
    "id": "98fa8d80-bb04-4a39-a5c0-b69ca5708664",
    "name": "John Doe",
    "email": "jhondoe@email.com",
    "phone": "+33 23 45 67 89",
    "city": "Paris",
    "state": "Île de France",
    "zip_code": "70123",
    "street": "Avenue Victor Hugo.",
    "house_number": "33",
    "currency": "EUR",
    "tax_number": "99 99 999 999 999",
    "company_number": "C9876543"
}

---

Lista de clientes

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

Obtenga la colección de recursos de Clientes disponibles para la aplicación específica.

Headers

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

Ejemplo de solicitud:

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

Ejemplo de respuesta

Respuesta de éxito:

HTTP 200

{
    "customers": {
        "data": [
            {
                "id": "98fa8d80-bb04-4a39-a5c0-b69ca5708664",
                "name": "Jhon Doe",
                "email": "jhondoe@email.com",
                "phone": "+01 23 45 67 89",
                "city": "Paris",
                "state": "Île de France",
                "zip_code": "70123",
                "street": "Avenue Victor Hugo.",
                "house_number": "33",
                "currency": "EUR",
                "tax_number": "99 99 999 999 999",
                "company_number": "C9876543"
            }
        ]
    }
}

---

Obtener cliente

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

Llevar el recurso a un cliente específico.

Query params

Param	Tipo	Descripción
id required	UUID	ID obtenido ya sea creando un nuevo cliente o extrayéndolo del List customer endpoint

Ejemplo de solicitud:

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

Ejemplo de respuesta

Respuesta de éxito:

HTTP 200

{
    "customer": {
        "id": "98fa8d80-bb04-4a39-a5c0-b69ca5708664",
        "name": "Jhon Doe",
        "email": "jhondoe@email.com",
        "phone": "+01 23 45 67 89",
        "city": "Paris",
        "state": "Île de France",
        "zip_code": "70123",
        "street": "Avenue Victor Hugo.",
        "house_number": "33",
        "currency": "EUR",
        "tax_number": "99 99 999 999 999",
        "company_number": "C9876543"
    }
}

---

Crear clientes

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

Crear un cliente para una aplicación específica

Headers

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

Ejemplo de solicitud:

curl --location 'https://neopay.io/api/customers' \
--header 'Authorization: YOUR-TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'x-app-key: YOUR-APPLICATION-TOKEN' \
--data-raw '{
"name": "Jhon Doe",
"email": "jhondoe@email.com",
"phone": "+01 23 45 67 89",
"city": "Paris",
"state": "Île de France",
"zip_code": "70123",
"street": "Avenue Victor Hugo.",
"house_number": "33",
"currency": "EUR",
"tax_number": "99 99 999 999 999",
"company_number": "C9876543"
}'

Request Body example

{
    "name": "Jhon Doe",
    "email": "jhondoe@email.com",
    "phone": "+01 23 45 67 89",
    "city": "Paris",
    "state": "Île de France",
    "zip_code": "70123",
    "street": "Avenue Victor Hugo.",
    "house_number": "33",
    "currency": "EUR",
    "tax_number": "99 99 999 999 999",
    "company_number": "C9876543"
}

Field	Type	Description
name	String	Nombre del cliente
email	String	Correo electrónico del cliente (requerido)
phone	String	Número de teléfono de la cliente
city	String	Código de ciudad del cliente
state	String	Código de estado del cliente
country	String	Código de país del cliente
zip_code	String	Código postal de la cliente
street	String	Calle de la Cliente
house_number	String	Numero de casa de la cliente
currency	String	Moneda del cliente (ej: EUR)
tax_number	String	Número de impuesto
company_number	String	Numero de compañia

Ejemplo de respuesta

Respuesta de éxito:

HTTP 200

{
    "message": "Customer saved successfully!",
    "customer": {
        "id": "98fa8d80-bb04-4a39-a5c0-b69ca5708664",
        "name": "Jhon Doe",
        "email": "jhondoe@email.com",
        "phone": "+01 23 45 67 89",
        "city": "Paris",
        "state": "Île de France",
        "zip_code": "70123",
        "street": "Avenue Victor Hugo.",
        "house_number": "33",
        "currency": "EUR",
        "tax_number": "99 99 999 999 999",
        "company_number": "C9876543"
    }
}

---

Editar cliente

.PATCH https://neopay.io/api/customers/{id}

Actualizar una cliente específica.

Query params

Param	Tipo	Description
id required	UUID	ID obtenido ya sea creando un nuevo cliente o extrayéndolo del List customer endpoint

Request Body example

{
    "name": "Jhon Doe Updated",
    "email": "jhondoeupdate@email.com",
    "phone": "+01 23 45 67 89",
    "city": "Paris",
    "state": "Île de France",
    "zip_code": "70123",
    "street": "Avenue Victor Hugo.",
    "house_number": "33",
    "currency": "EUR",
    "tax_number": "99 99 999 999 999",
    "company_number": "C9876543"
}

Campo	Tipo	Description
id	UUID	UUID del Cliente (Obligatorio si no envía el correo electrónico)
name	String	Nombre del cliente
email	String	Correo electrónico del cliente (requerido)
phone	String	Número de teléfono de la cliente
city	String	Código de ciudad del cliente
state	String	Código de estado del cliente
country	String	Código de país del cliente
zip_code	String	Código postal de la cliente
street	String	Calle de la Cliente
house_number	String	Numero de casa de la cliente
currency	String	Moneda del cliente (ej: EUR)
tax_number	String	Número de impuesto
company_number	String	Numero de compañia

Request example:

curl --location 'https://neopay.io/api/customers' \
--header 'Authorization: YOUR-TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'x-app-key: YOUR-APPLICATION-TOKEN' \
--data-raw '{
    "name": "Jhon Doe Updated",
    "email": "jhondoeupdate@email.com",
    "phone": "+01 23 45 67 89",
    "city": "Paris",
    "state": "Île de France",
    "zip_code": "70123",
    "street": "Avenue Victor Hugo.",
    "house_number": "33",
    "currency": "EUR",
    "tax_number": "99 99 999 999 999",
    "company_number": "C9876543"
}'

Ejemplo de respuesta

Respuesta de éxito:

HTTP 200

{
    "message": "Customer updated successfully!",
    "customer": {
        "id": "98fa8d80-bb04-4a39-a5c0-b69ca5708664",
        "name": "Jhon Doe Updated",
        "email": "jhondoeupdate@email.com",
        "phone": "+01 23 45 67 89",
        "city": "Paris",
        "state": "Île de France",
        "zip_code": "70123",
        "street": "Avenue Victor Hugo.",
        "house_number": "33",
        "currency": "EUR",
        "tax_number": "99 99 999 999 999",
        "company_number": "C9876543"
    }
}

---