Evento

Permite la creación de eventos y posteriormente consultar su estado.

URL base: https://app.payku.cl/ (Default server) · https://des.payku.cl/ (Sandbox server)

Crear un evento

POST/api/event

Este método permite crear un evento y recibir como respuesta el detalle del evento.

Cuerpo de la solicitud

Parámetro	Tipo	Descripción
eventrequerido	string	Indicador del evento. máximo 40 caracteres Ejemplo: 98374
namerequerido	string	Nombre del evento. máximo 400 caracteres Ejemplo: Event
date_eventrequerido	datetime	Fecha en la cual se realizara el evento. Ejemplo: 2023-12-20
date_closing_salesrequerido	datetime	Fecha de cierre de las ventas, debe ser menor o igual a date_event. Ejemplo: 2023-12-19 23:59:00
date_paymentrequerido	datetime	Fecha de pago del evento, debe ser mayor a la fecha date_event. Ejemplo: 2023-12-20
url_event	string <url>	url en donde se encuentra publicado el evento. máximo 240 caracteres Ejemplo: https://www.example.com/event1
url_logo	string <url>	url del logo que identifica al evento. máximo 240 caracteres Ejemplo: https://www.example.com/logo_event1.png
service_sale	integer	Monto del servicio de ventas, pertenece al monto que recibirá el dueño de la cuenta por transacción. máximo 7 caracteres Ejemplo: 10
affiliation	array of objects	Distribución de los beneficiarios.
email	string	Email del beneficiario. máximo 50 caracteres Ejemplo: [email protected]
percent	number	Porcentaje la cual le corresponde al beneficiario. máximo 6 caracteres Ejemplo: 50

CURL

curl -X POST \
  https://BASE_URL/api/event \
  -H 'Accept: application/json, text/plain, */*' \
  -H 'Authorization: Bearer TOKEN_PUBLICO'  \
  -H 'Content-Type: application/json' \
  -H 'Host: BASE_URL' \
  -d {
    "name": "Event",
    "event": "98374",
    "date_event": "2023-12-20",
    "date_payment": "2023-12-22",
    "date_closing_sales": "2023-12-19 23:59:00",
    "url_logo": "https://www.example.com/logo_event1.png",
    "url_event": "https://www.example.com/event1",
    "service_sale": 10,
    "affiliation": [
      ["[email protected]",  50],
      ["[email protected]",  50]
    ]
  }'

PHP

$client = new \GuzzleHttp\Client();
  $body = $client->request('POST', 'https://BASE_URL/api/event', [
    'json' => [
        'name' => 'Event',
        'event' => '98374',
        'date_event' => '2023-12-20',
        'date_payment' => '2023-12-22',
        'date_closing_sales' => '2023-12-19 23:59:00',
        'url_logo' => 'https://www.example.com/logo_event1.png',
        'url_event' => 'https://www.example.com/event1',
        'service_sale' => 10,
        'affiliation' => [
          ['[email protected]',  50],
          ['[email protected]',  50]
        ]
      ],
    'headers' => [
      'Authorization' => 'Bearer TOKEN_PUBLICO'
    ]
  ])->getBody();
$response = json_decode($body);

JS

const request = async (data) => {
  const response = await fetch('https://BASE_URL/api/event', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': 'Bearer TOKEN-PUBLICO'
    },
    body: JSON.stringify(data)
  });
  const result = await response.json();
  console.log(result)
}

let data = {
  name: "Event",
  event: "98374",
  date_event: "2023-12-20",
  date_payment: "2023-12-22",
  date_closing_sales: "2023-12-19 23:59:00",
  url_logo: "https://www.example.com/logo_event1.png",
  url_event: "https://www.example.com/event1",
  service_sale: 10,
  affiliation: [
    ["[email protected]",  50],
    ["[email protected]",  50]
  ]
};

request(data);

Respuestas

200

200

{
  "status": "success",
  "id": "98374",
  "event": "Event",
  "date_event": "2023-12-20",
  "date_payment": "2023-12-22",
  "date_closing_sales": "2023-12-19 23:59:00",
  "url_logo": "https://www.example.com/logo_event1.png",
  "url_event": "https://www.example.com/event1",
  "distribution": {
    "affiliate": "100.00",
    "service_sale": "10.00"
  },
  "affiliation": [
    {
      "id": "b99dfd8193ebfd37d4b9",
      "email": "[email protected]",
      "percent": "100.00",
      "status": "pending"
    }
  ]
}

Campos de la respuesta

Parámetro	Tipo	Descripción
status	string	Estatus de la solicitud. Ejemplo: success
id	string	Identificador del evento. Ejemplo: 98374
event	string	Nombre del evento. Ejemplo: Event
date_event	datetime	Fecha en la cual se realizara el evento. Ejemplo: 2023-12-20
date_payment	datetime	Fecha de pago del evento, debe ser mayor a la fecha date_event . Ejemplo: 2023-12-22
date_closing_sales	datetime	Fecha de cierre de las ventas, debe ser menor o igual a date_event. Ejemplo: 2023-12-19 23:59:00
url_logo	string <url>	url del logo que pertenece al evento . Ejemplo: https://www.example.com/logo_event1.png
url_event	string <url>	url en donde se encuentra publicado el evento. Ejemplo: https://www.example.com/event1
distribution	object	Distribución de las transacciones.
affiliate	string	Monto a distribuir a los beneficiarios. Ejemplo: 100.00
service_sale	string	Monto a distribuir en el servicio de venta . Ejemplo: 10.00
affiliation	array of objects
id	string	Identificador del beneficiario. Ejemplo: b99dfd8193ebfd37d4b9
email	string	Correo del beneficiario. Ejemplo: [email protected]
percent	string	Porcentaje la cual le corresponde al beneficiario. Ejemplo: 100.00
status	string	Estatus del beneficiario. Ejemplo: pending

400

400

Error en la solicitud.

{
  "status": "failed",
  "type": "Unprocessable Entity",
  "message_error": "subject:invalid,amount:is empty,email:is empty,order:invalid"
}

Campos de la respuesta

Parámetro	Tipo	Descripción
status	string	Estatus de la solicitud. Ejemplo: failed
type	string	Tipo de error ocurrido. Ejemplo: Unprocessable Entity
message_error	string	Mensaje de error Ejemplo: subject:invalid,amount:is empty,email:is empty,order:invalid

401

401

Token Público incorrecto.

{
  "type": "Unauthorized",
  "message_error": {
    "error": "waiting token public"
  }
}

Campos de la respuesta

Parámetro	Tipo	Descripción
type	string	Tipo de error ocurrido. Ejemplo: Unauthorized
message_error	object
error	string	Mensaje de error Ejemplo: waiting token public

Obtener evento

GET/api/event/{identificadorEvento}

Este método permite obtener el detalle de un evento.

Parámetros de ruta

Parámetro	Tipo	Descripción
idrequerido	string	id del evento a solicitar máximo 40 caracteres

CURL

curl -X GET \
  https://BASE_URL/api/event \
  -H 'Accept: application/json, text/plain, */*' \
  -H 'Authorization: Bearer TOKEN_PUBLICO'  \
  -H 'Content-Type: application/json' \
  -H 'Host: BASE_URL' \

PHP

$client = new \GuzzleHttp\Client();
  $body = $client->request('GET', 'https://BASE_URL/api/event/98374', [
    'headers' => [
      'Authorization' => 'Bearer TOKEN_PUBLICO'
    ]
  ])->getBody();
$response = json_decode($body);

JS

const request = async (data) => {
  const response = await fetch('https://BASE_URL/api/event/98374', {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': 'Bearer TOKEN-PUBLICO'
    },
  });
  const result = await response.json();
  console.log(result)
}

request(data);

Respuestas

200

200

{
  "id": "98374",
  "event": "Event",
  "date_event": "2023-12-20",
  "date_payment": "2023-12-22",
  "date_closing_sales": "2023-12-19 23:59:00",
  "url_logo": "https://www.example.com/logo_event1.png",
  "url_event": "https://www.example.com/event1",
  "distribution": {
    "affiliate": "100.00",
    "service_sale": "10.00"
  },
  "affiliations": [
    {
      "id": "b99dfd8193ebfd37d4b9",
      "email": "[email protected]",
      "percent": "100.00",
      "status": "pending"
    }
  ]
}

Campos de la respuesta

Parámetro	Tipo	Descripción
id	string	Identificador del evento. Ejemplo: 98374
event	string	Nombre del evento. Ejemplo: Event
date_event	datetime	Fecha en la cual se realizara el evento. Ejemplo: 2023-12-20
date_payment	datetime	Fecha de pago del evento, debe ser mayor a la fecha date_event . Ejemplo: 2023-12-22
date_closing_sales	datetime	Fecha de cierre de las ventas, debe ser menor o igual a date_event. Ejemplo: 2023-12-19 23:59:00
url_logo	string <url>	url del logo que pertenece al evento . Ejemplo: https://www.example.com/logo_event1.png
url_event	string <url>	url en donde se encuentra publicado el evento. Ejemplo: https://www.example.com/event1
distribution	object	Distribución de las transacciones.
affiliate	string	Monto a distribuir a los beneficiarios. Ejemplo: 100.00
service_sale	string	Monto a distribuir en el servicio de venta . Ejemplo: 10.00
affiliations	array of objects
id	string	Identificador del beneficiario. Ejemplo: b99dfd8193ebfd37d4b9
email	string	Correo del beneficiario. Ejemplo: [email protected]
percent	string	Porcentaje la cual le corresponde al beneficiario. Ejemplo: 100.00
status	string	Estatus del beneficiario. Ejemplo: pending

400

400

Error en la solicitud.

{
  "status": "failed",
  "type": "Unprocessable Entity",
  "message_error": "subject:invalid,amount:is empty,email:is empty,order:invalid"
}

Campos de la respuesta

Parámetro	Tipo	Descripción
status	string	Estatus de la solicitud. Ejemplo: failed
type	string	Tipo de error ocurrido. Ejemplo: Unprocessable Entity
message_error	string	Mensaje de error Ejemplo: subject:invalid,amount:is empty,email:is empty,order:invalid

401

401

Token Público incorrecto.

{
  "type": "Unauthorized",
  "message_error": {
    "error": "waiting token public"
  }
}

Campos de la respuesta

Parámetro	Tipo	Descripción
type	string	Tipo de error ocurrido. Ejemplo: Unauthorized
message_error	object
error	string	Mensaje de error Ejemplo: waiting token public