Marketplace

Permite el registro de clientes, para posteriormente realizar la distribución según porcentaje asignado.

Ver diagrama

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

Crear cliente

POST/api/maclient

Este método permite la inserción de datos de un cliente.

Cuerpo de la solicitud

Parámetro	Tipo	Descripción
emailrequerido	string <email>	Email del cliente. máximo 50 caracteres Ejemplo: [email protected]
namerequerido	string	Nombre del cliente máximo 150 caracteres Ejemplo: John Doe
phonerequerido	string	Teléfono del cliente. máximo 12 caracteres Ejemplo: 923122312
bankrequerido	object	máximo 58 caracteres
sbifrequerido	string	Código del banco al que pertenece la cuenta bancaria. máximo 5 caracteres Ejemplo: 0001
typerequerido	string	Tipo de cuenta. 1 Corriente 2 Vista/Cuenta RUT 3 Ahorro máximo 1 caracter Ejemplo: 1
numrequerido	string	Número de cuenta del cliente. máximo 40 caracteres Ejemplo: 12312313121
rutrequerido	string	Registro Único Tributario. 12 caracteres requeridos Ejemplo: 111111111

CURL

curl -X POST \
https://BASE_URL/api/maclient \
-H 'Accept: application/json, text/plain, */*' \
-H 'Authorization: Bearer TOKEN_PUBLICO'  \
-H 'Content-Type: application/json' \
-H 'Host: BASE_URL' \
-d {
    "email": "[email protected]",
    "name": "John Doe",
    "phone": "923122312",
    "bank": {
      "sbif": "1234",
      "type": "1",
      "num": "12312313121",
      "rut": "111111111"
    }
  }'

PHP

$client = new \GuzzleHttp\Client();
  $body = $client->request('POST', 'https://BASE_URL/api/maclient', [
    'json' => [
      'email' => '[email protected]',
      'name' => 'John Doe',
      'phone' => '923122312',
      'bank' => [
        "sbif" => "0001",
        "type" => "1",
        "num" => "1231123567",
        "rut" => "111111111",
      ]
    ],
    'headers' => [
      'Authorization' => 'Bearer TOKEN_PUBLICO'
    ]
  ])->getBody();
$response = json_decode($body);

JS

const request = async (data) => {
  const response = await fetch('https://BASE_URL/api/maclient', {
    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 = {
  email: "[email protected]",
  name: "John Doe",
  phone: "923122312",
  bank: {
    sbif: "0001",
    type: "1",
    num: "12312313121",
    rut: "111111111"
  }
};

request(data);

Respuestas

200

200

{
  "id": "madb93fc00a2cf6f4449",
  "status": "register",
  "name": "John Doe",
  "phone": "923122312",
  "email": "[email protected]",
  "bank": {
    "sbif": "0001",
    "rut": "111111111",
    "type": 1,
    "num": "12312313121"
  },
  "affiliations": 0,
  "created_at": "2023-09-28 20:42:59",
  "update_at": "null"
}

Campos de la respuesta

Parámetro	Tipo	Descripción
id	string	Identificador creado por payku. Ejemplo: madb93fc00a2cf6f4449
status	string	Estatus del cliente. Ejemplo: register
name	string	Nombre del cliente. Ejemplo: John Doe
phone	string	Teléfono del cliente. Ejemplo: 923122312
email	string <email>	Email del cliente. Ejemplo: [email protected]
bank	object
sbif	string	Código banco. Ejemplo: 0001
rut	string	Registro Único Tributario. Ejemplo: 111111111
type	int	Tipo de cuenta. 1 Corriente 2 Vista/Cuenta RUT 3 Ahorro Ejemplo: 1
num	string	Número de cuenta del cliente. Ejemplo: 12312313121
affiliations	integer	Cantidad de afiliaciones. Ejemplo: 0
created_at	string <datetime>	Fecha de registro. Ejemplo: 2023-09-28 20:42:59
update_at	string <datetime>	Fecha de modificación. Ejemplo: null

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 cliente

GET/api/maclient/{identificadorCliente}

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

Parámetros de ruta

Parámetro	Tipo	Descripción
idrequerido	string	Identificador único por payku. máximo 20 caracteres

CURL

curl -X GET \
https://BASE_URL/api/maclient/id \
-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/maclient/madb93fc00a2cf6f4449', [
    'headers' => [
      'Authorization' => 'Bearer TOKEN_PUBLICO'
    ]
  ])->getBody();
$response = json_decode($body);

JS

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

request();

Respuestas

200

200

{
  "id": "madb93fc00a2cf6f4449",
  "status": "register",
  "name": "John Doe",
  "phone": "923122312",
  "email": "[email protected]",
  "bank": {
    "sbif": "0001",
    "rut": "111111111",
    "type": 1,
    "num": "12312313121"
  },
  "affiliations": 0,
  "created_at": "2023-09-28 20:42:59",
  "update_at": "null"
}

Campos de la respuesta

Parámetro	Tipo	Descripción
id	string	Identificador creado por payku. Ejemplo: madb93fc00a2cf6f4449
status	string	Estatus del cliente. Ejemplo: register
name	string	Nombre del cliente. Ejemplo: John Doe
phone	string	Teléfono del cliente. Ejemplo: 923122312
email	string <email>	Email del cliente. Ejemplo: [email protected]
bank	object
sbif	string	Código banco. Ejemplo: 0001
rut	string	Registro Único Tributario. Ejemplo: 111111111
type	int	Tipo de cuenta. 1 Corriente 2 Vista/Cuenta RUT 3 Ahorro Ejemplo: 1
num	string	Número de cuenta del cliente. Ejemplo: 12312313121
affiliations	integer	Cantidad de afiliaciones. Ejemplo: 0
created_at	string <datetime>	Fecha de registro. Ejemplo: 2023-09-28 20:42:59
update_at	string <datetime>	Fecha de modificación. Ejemplo: null

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

Actualizar cliente

PUT/api/maclient/{identificadorCliente}

Este método permite la actualización de los datos de un cliente.

Parámetros de ruta

Parámetro	Tipo	Descripción
idrequerido	string	Identificador único de marketplace. máximo 20 caracteres

Cuerpo de la solicitud

Parámetro	Tipo	Descripción
name	string	Nombre del cliente máximo 50 caracteres Ejemplo: John Doe Doe
phone	string	Teléfono del cliente máximo 12 dígitos Ejemplo: 923122312
bank	object	Datos bancarios del cliente máximo 58 caracteres
sbif	string	Código del banco al que pertenece la cuenta bancaria máximo 5 caracteres Ejemplo: 0001
type	int	Tipo de cuenta. 1 Corriente 2 Vista/Cuenta RUT 3 Ahorro máximo 1 caracter Ejemplo: 3
num	string	Número de cuenta del cliente. máximo 40 caracteres Ejemplo: 9999999
rut	string	Registro Único Tributario. 12 caracteres requeridos Ejemplo: 111111111

CURL

curl -X PUT \
https://BASE_URL/api/maclient/id \
-H 'Accept: application/json, text/plain, */*' \
-H 'Sign: SHA256-REQUEST-PATH-VALUE-TOKEN-PRIVADO'  \
-H 'Authorization: Bearer TOKEN_PUBLICO'  \
-H 'Content-Type: application/json' \
-H 'Host: BASE_URL' \
-d {
    "name":"John Doe",
    "phone":"923122312",
    "bank": {
      "sbif": "0001",
      "type": "3",
      "num": "9999999",
      "rut": "261009617"
      }
    }'

PHP

$client = new \GuzzleHttp\Client();
  $body = $client->request('PUT', 'https://BASE_URL/api/maclient/madb93fc00a2cf6f4449', [
    'json' => [
      'name' => 'John Doe',
      'phone' => '923122312',
      'bank' => [
          'num' => '9999999',
          'rut' => '261009617'
        ]
      ],
    ],
  ],
  'headers' => [
    'Sign' => 'SHA256-REQUEST-PATH-VALUE-TOKEN-PRIVADO',
    'Authorization' => 'Bearer TOKEN_PUBLICO'
  ]
])->getBody();
$response = json_decode($body);

JS

const request = async (data) => {
  const response = await fetch('https://BASE_URL/api/maclient/madb93fc00a2cf6f4449', {
    method: 'PUT',
    headers: {
      'Content-Type': 'application/json',
      'Sign': 'SHA256-REQUEST-PATH-VALUE-TOKEN-PRIVADO',
      'Authorization': 'Bearer TOKEN_PUBLICO'
    },
    body: JSON.stringify(data)
  });
  const result = await response.json();
  console.log(result)
}

let data = {
name:"John Doe",
phone:"923122312",
bank: {
  sbif: "0001",
  type: "3",
  num: "9999999",
  rut: "261009617"
  }
};

request(data);

Respuestas

200

200

{
  "id": "cl0be4c8e623c167bc8b777",
  "status": "register",
  "name": "John Doe",
  "phone": "923122312",
  "email": "923122312",
  "bank": {
    "sbif": "0001",
    "type": "3",
    "num": "9999999",
    "rut": "261009617"
  },
  "affiliations": 2,
  "affiliations_details": [
    [
      {
        "id": "s6df85b41df65b21se685",
        "status": "register",
        "token": "sgh65g1ns6fg5n1sfg2sr6j5nfg65shr6gh5s4r6h5fg6",
        "name": "market1",
        "percentage_affiliation": 1,
        "percentage_client": 99
      },
      {
        "id": "s6df85b41df65b21se685",
        "status": "register",
        "token": "sgh65g1ns6fg5n1sfg2sr6j5nfg65shr6gh5s4r6h5fg6",
        "name": "market2",
        "percentage_affiliation": 1,
        "percentage_client": 99
      }
    ]
  ]
}

Campos de la respuesta

Parámetro	Tipo	Descripción
id	string	Identificador del marketplace. Ejemplo: cl0be4c8e623c167bc8b777
status	string	Estatus del cliente. Ejemplo: register
name	string	Nombre del cliente. Ejemplo: John Doe
phone	string	Teléfono del cliente. Ejemplo: 923122312
email	string	Correo del cliente. Ejemplo: 923122312
bank	object	Datos bancarios del cliente.
sbif	string	Código del banco al que pertenece la cuenta bancaria. Ejemplo: 0001
type	string	Tipo de cuenta del cliente. Ejemplo: 3
num	string	Cuenta bancaria del cliente. Ejemplo: 9999999
rut	string	Rut del cliente. Ejemplo: 261009617
affiliations	number	Cantidad de afiliaciones. Ejemplo: 2
affiliations_details	array of objects
id	string	Identificador de la afiliación.
status	string	Estatus de la afiliación: not found pending liquidate pending for deposit paid
token	string	Token de la afiliación.
name	string	Nombre de la afiliación.
percentage_affiliation	string	Porcetnaje de la afiliación.
percentage_client	string	Porcentaje del cliente.

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

Eliminar cliente

DELETE/api/maclient/{identificadorCliente}

Este método permite la eliminación de un cliente asociado a un ID de usuario.

Parámetros de ruta

Parámetro	Tipo	Descripción
idrequerido	string	Identificador único de cliente por payku. máximo 20 caracteres

CURL

curl -X DELETE \
https://BASE_URL/api/maclient/id \
-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('DELETE', 'https://BASE_URL/api/maclient/madb93fc00a2cf6f4449', [
      'headers' => [
        'Authorization' => 'Bearer TOKEN_PUBLICO'              ]
      ])->getBody();
    $response = json_decode($body);

JS

const request = async () => {
  const response = await fetch('https://BASE_URL/api/maclient/madb93fc00a2cf6f4449', {
    method: 'DELETE',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': 'Bearer TOKEN_PUBLICO'
    },
  });
  const result = await response.json();
  console.log(result)
}

request();

Respuestas

200

200

{
  "status": "suspended",
  "id": "madb93fc00a2cf6f4449"
}

Campos de la respuesta

Parámetro	Tipo	Descripción
status	string	Estatus de cliente. Ejemplo: suspended
id	string	Identificador creado por payku. Ejemplo: madb93fc00a2cf6f4449

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

Crear afiliación

POST/api/maaffiliation

Este método permite registrar los datos para la afiliación.

Cuerpo de la solicitud

Parámetro	Tipo	Descripción
namerequerido	string	Nombre de afiliación. máximo 80 caracteres Ejemplo: name
percentagerequerido	string	Porcentaje correspondiente al usuario payku. máximo 2 caracteres Ejemplo: 20
affiliationrequerido	array of anys	Arreglo que contiene los clientes, cada cliente es un arreglo que contiene un identificador de cliente creado por payku y el porcentaje que este obtendrá. máximo 25 caracteres Ejemplo: [["madb93fc00a2cf6f4449","80"]]

CURL

curl -X POST \
https://BASE_URL/api/maaffiliation \
-H 'Accept: application/json, text/plain, */*' \
-H 'Authorization: Bearer TOKEN_PUBLICO'  \
-H 'Content-Type: application/json' \
-H 'Host: BASE_URL' \
-d {
    "name": "name",
    "percentage": "20",
    "affiliation": [
      ["ma9fd16221a9645b0036","80"]
    ]
  }'

PHP

$client = new \GuzzleHttp\Client();
  $body = $client->request('POST', 'https://BASE_URL/api/maaffiliation', [
    'json' => [
      'name' => 'name',
      'percentage' => '20',
      'affiliation' => [
        [ma9fd16221a9645b0036,80]
      ]
    ],
    'headers' => [
      'Authorization' => 'Bearer TOKEN_PUBLICO'
    ]
  ])->getBody();
$response = json_decode($body);

JS

const request = async (data) => {
  const response = await fetch('https://BASE_URL/api/maaffiliation', {
    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: "name",
  percentage: "20",
  affiliation: [
    ["ma9fd16221a9645b0036","80"]
  ]
};

request(data);

Respuestas

200

200

{
  "id": "sucaab7865dceaff49d8b3",
  "status": "register",
  "name": "name",
  "token": "eecd92fdbb8bf615e8215d6fbb30bb6ae6f82c9e1810f85b65bbeb472794c4a4",
  "percentage": "20.00",
  "affiliations": [
    {
      "id": "ma9fd16221a9645b0036",
      "name": "name",
      "percentage": "80.00"
    }
  ]
}

Campos de la respuesta

Parámetro	Tipo	Descripción
id	string	Identificador único de suscripción por payku. Ejemplo: sucaab7865dceaff49d8b3
status	string	Estatus. Ejemplo: register
name	string	Nombre de la afiliación. Ejemplo: name
token	string	Token de afiliación que se ingresa en el comercio. Ejemplo: eecd92fdbb8bf615e8215d6fbb30bb6ae6f82c9e1810f85b65bbeb472794c4a4
percentage	string	Porcentaje de afiliación usuario payku. Ejemplo: 20.00
affiliations	array of objects
id	string	Identificar. Ejemplo: ma9fd16221a9645b0036
name	string	Nombre del afiliado. Ejemplo: name
percentage	string	Porcentaje correspondiente a cada afiliado. Ejemplo: 80.00

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 afiliación

GET/api/maaffiliation/{identificadorCliente}

Este método permite obtener el detalle de una afiliación.

Parámetros de ruta

Parámetro	Tipo	Descripción
idrequerido	string	Identificador único de afiliación por payku. máximo 20 caracteres

CURL

curl -X GET \
https://BASE_URL/api/maaffiliation/id \
-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/maaffiliation/sucaab7865dceaff49d8b3', [
    'headers' => [
      'Authorization' => 'Bearer TOKEN_PUBLICO'
    ]
  ])->getBody();
$response = json_decode($body);

JS

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

request();

Respuestas

200

200

{
  "id": "sucaab7865dceaff49d8b3",
  "status": "register",
  "name": "name",
  "token": "eecd92fdbb8bf615e8215d6fbb30bb6ae6f82c9e1810f85b65bbeb472794c4a4",
  "percentage": "20.00",
  "affiliations": [
    {
      "id": "ma9fd16221a9645b0036",
      "name": "name",
      "percentage": "80.00"
    }
  ]
}

Campos de la respuesta

Parámetro	Tipo	Descripción
id	string	Identificador único de suscripción por payku. Ejemplo: sucaab7865dceaff49d8b3
status	string	Estatus. Ejemplo: register
name	string	Nombre de la afiliación. Ejemplo: name
token	string	Token de afiliación que se ingresa en el comercio. Ejemplo: eecd92fdbb8bf615e8215d6fbb30bb6ae6f82c9e1810f85b65bbeb472794c4a4
percentage	string	Porcentaje de afiliación usuario payku. Ejemplo: 20.00
affiliations	array of objects
id	string	Identificar. Ejemplo: ma9fd16221a9645b0036
name	string	Nombre del afiliado. Ejemplo: name
percentage	string	Porcentaje correspondiente a cada afiliado. Ejemplo: 80.00

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

Eliminar afiliación

DELETE/api/maaffiliation/{identificadorCliente}

Este método permite la eliminación de una afiliación asociada a un ID.

Parámetros de ruta

Parámetro	Tipo	Descripción
idrequerido	string	Identificador único de cliente por payku. máximo 20 caracteres

CURL

curl -X DELETE \
https://BASE_URL/api/maaffiliation/id \
-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('DELETE', 'https://BASE_URL/api/maaffiliation/madb93fc00a2cf6f4449', [
      'headers' => [
        'Authorization' => 'Bearer TOKEN_PUBLICO'              ]
      ])->getBody();
    $response = json_decode($body);

JS

const request = async () => {
  const response = await fetch('https://BASE_URL/api/maaffiliation/sucaab7865dceaff49d8b3', {
    method: 'DELETE',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': 'Bearer TOKEN_PUBLICO'
    },
  });
  const result = await response.json();
  console.log(result)
}

request();

Respuestas

200

200

{
  "status": "suspended",
  "id": "maab4462d6133e05e518"
}

Campos de la respuesta

Parámetro	Tipo	Descripción
status	string	Estatus de afiliación. Ejemplo: suspended
id	string	Identificador creado por payku. Ejemplo: maab4462d6133e05e518

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

Crear transacción marketplace

POST/api/transaction/

Este método permite crear una orden de pago a payku y recibe como respuesta la URL para redirigir el browser del pagador y el token que identifica la transacción. Una vez que el pagador efectúe el pago exitoso, payku notificará el resultado a la página del comercio que se envió en el parámetro urlnotify.

Cuerpo de la solicitud

Parámetro	Tipo	Descripción
emailrequerido	string <email>	Email del usuario máximo 50 caracteres Ejemplo: [email protected]
orderrequerido	string	Orden del comercio, este debe ser único. máximo 40 caracteres Ejemplo: 98745
subjectrequerido	string	Descripción de la orden. máximo 2000 caracteres Ejemplo: payment description
amountrequerido	integer	Monto de la orden. máximo 14 dígitos Ejemplo: 25000
payment	integer	Identificador del medio de pago. Si se envía el identificador, el pagador será redireccionado directamente al medio de pago que se indique. 1 Webpay 4 Etpay (Transferencia) 6 Pago46 9 Mach 19 Fintoc (Transferencia) 23 Tenpo 26 Floid (Transferencia) 99 Todos máximo 2 caracteres Ejemplo: 1
urlreturn	string <url>	url de retorno del comercio donde payku redirigirá al pagador. máximo 200 caracteres Ejemplo: https://youwebsite.com/urlreturn?orderClient=98745
urlnotify	string <url>	url callback del comercio donde payku notificara el pago. máximo 600 caracteres Ejemplo: https://www.youwebsite.com/urlnotify?orderClient=98745
marketplace	string	atributo obligatorio para realizar transacciones a afiliación de Marketplace, este consiste en el token de la afiliación de marketplace a la que se le desea realizar la transacción. máximo 70 caracteres Ejemplo: c1c879f4862d393ea6b326a313022dd98f0baa2869d3e9095c124199c9941030

cURL

curl -X POST \
https://BASE-URL/api/transaction \
-H 'Accept: application/json, text/plain, */*' \
-H 'Authorization: Bearer TOKEN-PUBLICO' \
-H 'Content-Type: application/json' \
-H 'Host: BASE-URL' \
-d '{
  "email": "[email protected]",
  "order": "5696",
  "subject": "Cliente Test",
  "amount": 25000,
  "payment": 1,
  "urlreturn": "https://youwebsite.com/urlreturn?orderClient=5696",
  "urlnotify": "https://youwebsite.com/urlnotify?orderClient=5696",
  "marketplace": "c1c879f4862d393ea6b326a313022dd98f0baa2869d3e9095c124199c9941030"
}'

PHP

$client = new \GuzzleHttp\Client();
  $body = $client->request('POST', 'https://BASE_URL/api/transaction', [
    'json' => [
      'email' => '[email protected]',
      'order' => "98745",
      'subject' => 'Client Test',
      'amount' => 25000,
      'payment' => 1,
      'urlreturn' => 'https://youwebsite.com/urlreturn?orderClient=98745',
      'urlnotify' => 'https://www.youwebsite.com/urlnotify?orderClient=98745'
      'marketplace' => 'c1c879f4862d393ea6b326a313022dd98f0baa2869d3e9095c124199c9941030'
      ],
    'headers' => [
      'Authorization' => 'Bearer TOKEN_PUBLICO'
    ]
  ])->getBody();
$response = json_decode($body);

JS

const request = async (data) => {
  const response = await fetch('https://BASE_URL/api/transaction', {
    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 = {
  email: "[email protected]",
  order: "98745",
  subject: "payment description",
  amount: 25000,
  payment: 1,
  urlreturn: "https://youwebsite.com/urlreturn?orderClient=98745",
  urlnotify: "https://www.youwebsite.com/urlnotify?orderClient=98745",
  marketplace: "c1c879f4862d393ea6b326a313022dd98f0baa2869d3e9095c124199c9941030"
};

request(data);

Respuestas

200

200

{
  "status": "pending",
  "id": "trx3b4d77b43acd9a720",
  "url": "https://BASE_URL/url_de_pago"
}

Campos de la respuesta

Parámetro	Tipo	Descripción
status	string	Estatus de transacción.Los posibles estados que puede obtener son los siguientes: pending success rejected Ejemplo: pending
id	string	Identificador de la transacción creado por payku. Ejemplo: trx3b4d77b43acd9a720
url	string	URL a redireccionar al usuario. Ejemplo: https://BASE_URL/url_de_pago

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