Introducción
La API de Openpay está diseña sobre REST, por lo tanto encontrarás que las URL están orientadas a recursos y se usa códigos de respuesta HTTP para indicar los errores en la API.
Todas las respuestas de la API están en formato JSON, incluyendo errores.
En el caso de usar los clientes existentes del API de Openpay (Java, Php ) las respuestas son específicamente del tipo definido en dichos clientes en sus respectivos lenguajes.
API Endpoints
Recurso disponibles
a) Por Comercio
/v1/{MERCHANT_ID}/...
/charges
/charges/{TRANSACTION_ID}
/cards
/cards/{CARD_ID}
/customers
/customers/{CUSTOMER_ID}
/plans
/plans/{PLAN_ID}
/tokens
/tokens/{TOKEN_ID}
b) Por Cliente
/v1/{MERCHANT_ID}/customers/{CUSTOMER_ID}/...
/cards
/cards/{CARD_ID}
/charges
/charges/{TRANSACTION_ID}
/subscriptions
/subscriptions/{SUBSCRIPTION_ID}
La API REST de Openpay tiene un ambiente de pruebas (sandbox) y un ambiente de producción. Usa las credenciales que se generaron al momento de tu registro para realizar la integración de tu sistema con Openpay. Una vez que estes listo para pasar a producción y tu solicitud sea aprobada, se generarán nuevas credenciales para acceder al ambiente de producción.
La siguientes URIs forman la base de los endpoints para los ambientes soportados:
- Pruebas, URI base:
https://sandbox-api.openpay.pe
- Producción, URI base:
https://api.openpay.pe
Un endpoint completo esta formado por la URI base del ambiente, el identificador del comercio y el recurso.
Por ejemplo, si queremos crear un nuevo cliente, el endpoint sería:
POST https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/customers
Para crear una petición completa es necesaria envíar las cabeceras HTTP correctas y la información en formato JSON.
Autenticación
Ejemplo de autenticación
curl https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/charges \
-u sk_e568c42a6c384b7ab02cd47d2e407cab:
El parámetro -u se ocupa para realizar la autenticación HTTP Basic (al agregar dos puntos después de la llave privada se previene el uso de contraseña)
<?
//Por default se usa el ambiente de sandbox
$openpay = Openpay::getInstance('moiep6umtcnanql3jrxp'
, 'sk_3433941e467c4875b178ce26348b0fac');
?>
//Sandbox
final OpenpayAPI api = new OpenpayAPI("https://sandbox-api.openpay.pe",
"moiep6umtcnanql3jrxp", "sk_3433941e467c4875b178ce26348b0fac", "127.0.0.1");
//Produccion
final OpenpayAPI api = new OpenpayAPI("https://api.openpay.pe"
, "moiep6umtcnanql3jrxp", "sk_3433941e467c4875b178ce26348b0fac", "127.0.0.1");
var Openpay = require('openpay');
var openpay = new Openpay('moiep6umtcnanql3jrxp','sk_3433941e467c4875b178ce26348b0fac');
//Sandbox
OpenpayAPI openpayAPI = new OpenpayAPI("sk_3433941e467c4875b178ce26348b0fac", "moiep6umtcnanql3jrxp");
openpayAPI.Production = false; // Default value = false
//Produccion
OpenpayAPI openpayAPI = new OpenpayAPI("sk_3433941e467c4875b178ce26348b0fac", "moiep6umtcnanql3jrxp");
openpayAPI.Production = true;
#Sandbox
openpay=OpenpayApi.new("moiep6umtcnanql3jrxp","sk_3433941e467c4875b178ce26348b0fac")
#Produccion
openpay=OpenpayApi.new("moiep6umtcnanql3jrxp","sk_3433941e467c4875b178ce26348b0fac", true)
#Definir timeout para los request's
#Este cliente maneja un timeout por defecto de 90 seg., para configurar el timeout usado para crear los request a los servicios de Openpay, es necesario definir explícitamente el tipo de ambiente, seguido del nuevo valor del timeout para el request:
#Sintaxis:
# openpay_prod=OpenpayApi.new(merchant_id,private_key,isProduction,timeout)
#Example:
# openpay_prod=OpenpayApi.new(merchant_id,private_key,false,30)
Producción
Solo es necesario usar la URI base https://api.openpay.pe
<?
Openpay::setProductionMode(true);
?>
//Solo es necesario usar la URI base https://api.openpay.pe
openpayAPI.Production = true;
openpay.setProductionReady(true);
#Solo es necesario pasar como tercer argumento un "true" cuando se crea el objeto OpenpayApi
Para realizar peticiones a la API de Openpay, es necesario enviar la llave de API (API Key) en todas tus llamadas a nuestros servidores. La llave la puedes obtener desde el dashboard.
Existen 2 tipos de llaves de API:
- Privada.- Para llamadas entre servidores y con acceso total a todas las operaciones de la API (nunca debe ser compartida).
- Pública.- Sólo se debe utilizar en llamadas desde JavaScript. Esta llave sólo tiene permitido realizar crear tarjetas o crear tokens
Para la autenticación al API debes usar autenticación de acceso básica, donde la llave de API es el nombre de usuario. La contraseña no es requerida y debe dejarse en blanco por fines de simplicidad.
Errores
Openpay regresa objetos de JSON en las respuestas del servicio, incluso en caso de errores por lo que cuando exista un error.
Objeto Error
Ejemplo de objeto
{
"category" : "request",
"description" : "The customer with id 'm4hqp35pswl02mmc567' does not exist",
"http_code" : 404,
"error_code" : 1005,
"request_id" : "1981cdb8-19cb-4bad-8256-e95d58bc035c",
"fraud_rules": [
"Billing <> BIN Country for VISA/MC"
]
}
//Para el caso de java, toda operación regresara una instancia de la clase "OpenpayServiceException" la cual contendrá esta información del error.
//Para el caso de C Sharp, toda operación regresará una instancia de la clase "OpenpayException" la cual contendrá esta información del error.
#Para el caso de Ruby, toda operación puede regresar cualquiera de las siguientes excepciones:
# => OpenpayException: Para errores genericos, como acceso a recursos invalidos, etc.
# => OpenpayConnectionException: Para errores relacionados con problemas en la conexión al servidor.
# => OpenpayTransactionException: Para errores relacionados durante la ejecución de las operaciones.
Propiedad | Descripción |
---|---|
category | string request: Indica un error causado por datos enviados por el cliente. Por ejemplo, una petición inválida, un intento de una transacción sin fondos, o una transferencia a una cuenta que no existe. internal: Indica un error del lado de Openpay, y ocurrira muy raramente. gateway: Indica un error durante la transacción de los fondos de una tarjeta a la cuenta de Openpay o de la cuenta hacia un banco o tarjeta. |
error_code | numeric El código del error de Openpay indicando el problema que ocurrió. |
description | string Descripción del error. |
http_code | string Código de error HTTP de la respuesta. |
request_id | string Identificador de la petición. |
fraud_rules | array Arreglo con la lista de coincidencia de reglas definidas para deteccion de fraudes. |
Códigos de error
Generales
Código | Error HTTP | Causa |
---|---|---|
1000 | 500 Internal Server Error | Ocurrió un error interno en el servidor de Openpay |
1001 | 400 Bad Request | El formato de la petición no es JSON, los campos no tienen el formato correcto, o la petición no tiene campos que son requeridos. |
1002 | 401 Unauthorized | La llamada no esta autenticada o la autenticación es incorrecta. |
1003 | 422 Unprocessable Entity | La operación no se pudo completar por que el valor de uno o más de los parametros no es correcto. |
1004 | 503 Service Unavailable | Un servicio necesario para el procesamiento de la transacción no se encuentra disponible. |
1005 | 404 Not Found | Uno de los recursos requeridos no existe. |
1006 | 409 Conflict | Ya existe una transacción con el mismo ID de orden. |
1007 | 402 Payment Required | La transferencia de fondos entre una cuenta de banco o tarjeta y la cuenta de Openpay no fue aceptada. |
1008 | 423 Locked | Una de las cuentas requeridas en la petición se encuentra desactivada. |
1009 | 413 Request Entity too large | El cuerpo de la petición es demasiado grande. |
1010 | 403 Forbidden | Se esta utilizando la llave pública para hacer una llamada que requiere la llave privada, o bien, se esta usando la llave privada desde JavaScript. |
Almacenamiento
Código | Error HTTP | Causa |
---|---|---|
2001 | 409 Conflict | La cuenta de banco con esta CLABE ya se encuentra registrada en el cliente. |
2002 | 409 Conflict | La tarjeta con este número ya se encuentra registrada en el cliente. |
2003 | 409 Conflict | El cliente con este identificador externo (External ID) ya existe. |
2004 | 422 Unprocessable Entity | El dígito verificador del número de tarjeta es inválido de acuerdo al algoritmo Luhn. |
2005 | 400 Bad Request | La fecha de expiración de la tarjeta es anterior a la fecha actual. |
2006 | 400 Bad Request | El código de seguridad de la tarjeta (CVV2) no fue proporcionado. |
2007 | 412 Precondition Failed | El número de tarjeta es de prueba, solamente puede usarse en Sandbox. |
2008 | 412 Precondition Failed | La tarjeta consultada no es valida para puntos. |
2009 | 412 Precondition Failed | El código de seguridad de la tarjeta (CVV2) no no es valido. |
Tarjetas
Código | Error HTTP | Causa |
---|---|---|
3001 | 402 Payment Required | La tarjeta fue declinada. |
3002 | 402 Payment Required | La tarjeta ha expirado. |
3003 | 402 Payment Required | La tarjeta no tiene fondos suficientes. |
3004 | 402 Payment Required | La tarjeta ha sido identificada como una tarjeta robada. |
3005 | 402 Payment Required | La tarjeta ha sido identificada como una tarjeta fraudulenta. |
3006 | 412 Precondition Failed | La operación no esta permitida para este cliente o esta transacción. |
3008 | 412 Precondition Failed | La tarjeta no es soportada en transacciones en linea. |
3009 | 402 Payment Required | La tarjeta fue reportada como perdida. |
3010 | 402 Payment Required | El banco ha restringido la tarjeta. |
3011 | 402 Payment Required | El banco ha solicitado que la tarjeta sea retenida. Contacte al banco. |
3012 | 412 Precondition Failed | Se requiere solicitar al banco autorización para realizar este pago. |
Cuentas
Código | Error HTTP | Causa |
---|---|---|
4001 | 412 Preconditon Failed | La cuenta de Openpay no tiene fondos suficientes. |
Cargos
Los cargos se pueden realizar a tarjetas, tiendas y bancos. A cada cargo se le asigna un identificador único en el sistema.
Los cargos a tarjeta puedes hacerlos a una tarjeta guardada usando el id de la tarjeta, usando un token o puedes enviar la información de la tarjeta al momento de la invocación.
Cambios por disposiciones oficiales para la prevención de fraude E-commerce
Toda integración que se realice mediante SDK o peticiones directas al API de Openpay, es de carácter obligatorio enviar el header X-Forwarded-For donde se deberá indicar la IP del dispositivo del cliente. En las pestañas de las diferentes tecnologías ubicadas del lado derecho se encuentra la definición de cómo debe ser enviado.
Con id de tarjeta o token
Definición
Comercio
POST https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/charges
Cliente
POST https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/customers/{CUSTOMER_ID}/charges
<?
Comercio
$openpay->charges->create(chargeRequest);
Cliente
$customer = $openpay->customers->get($customerId);
$customer->charges->create(chargeRequest);
?>
//Cliente
openpayAPI.charges().create(String customerId, CreateCardChargeParams request);
//Comercio
openpayAPI.charges().create(CreateCardChargeParams request);
// Comercio
openpay.charges.create(chargeRequest, callback);
// Cliente
openpay.customers.charges.create(customerId, chargeRequest, callback);
//Cliente
openpayAPI.ChargeService.Create(string customer_id, ChargeRequest request);
//Comercio
openpayAPI.ChargeService.Create(ChargeRequest request);
#Cliente
@charges=@openpay.create(:charges)
@charges.create(request_hash, customer_id)
#Comercio
@charges=@openpay.create(:charges)
@charges.create(request_hash)
Ejemplo de petición con comercio
curl https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/charges \
-u sk_e568c42a6c384b7ab02cd47d2e407cab: \
-H "Content-type: application/json" \
-H "X-Forwarded-For: 129.18.168.184" \
-X POST -d '{
"source_id" : "kqgykn96i7bcs1wwhvgw",
"method" : "card",
"amount" : 100,
"currency" : "PEN",
"description" : "Cargo inicial a mi cuenta",
"order_id" : "oid-00051",
"device_session_id" : "kR1MiQhz2otdIuUlQkbEyitIqVMiI16f",
"customer" : {
"name" : "Juan",
"last_name" : "Vazquez Juarez",
"phone_number" : "4423456723",
"email" : "juan.vazquez@empresa.com.pe"
}
}'
<?
$openpay = Openpay::getInstance('mzdtln0bmtms6o3kck8f'
, 'sk_e568c42a6c384b7ab02cd47d2e407cab','PE', '127.0.0.1');
$customer = array(
'name' => 'Juan',
'last_name' => 'Vazquez Juarez',
'phone_number' => '4423456723',
'email' => 'juan.vazquez@empresa.com.pe');
$chargeRequest = array(
'method' => 'card',
'source_id' => 'kqgykn96i7bcs1wwhvgw',
'amount' => 100,
'currency' => 'PEN'
'description' => 'Cargo inicial a mi merchant',
'order_id' => 'oid-00051',
'device_session_id' => 'kR1MiQhz2otdIuUlQkbEyitIqVMiI16f',
'customer' => $customer);
$charge = $openpay->charges->create($chargeRequest);
?>
OpenpayAPI api = new OpenpayAPI("https://sandbox-api.openpay.pe"
, "sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
CreateCardChargeParams request = new CreateCardChargeParams();
Customer customer = new Customer();
customer.setName("Juan");
customer.setLastName("Vazquez Juarez");
customer.setPhoneNumber("4423456723");
customer.setEmail("juan.vazquez@empresa.com.pe");
request.cardId("kqgykn96i7bcs1wwhvgw"); // =source_id
request.amount(new BigDecimal("100.00"));
request.currency("PEN");
request.description("Cargo inicial a mi merchant");
request.orderId("oid-00051");
request.deviceSessionId("kR1MiQhz2otdIuUlQkbEyitIqVMiI16f");
request.setCustomer(customer);
Charge charge = api.charges().create(request);
OpenpayAPI api = new OpenpayAPI("sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
ChargeRequest request = new ChargeRequest();
Customer customer = new Customer();
customer.Name = "Juan";
customer.LastName = "Vazquez Juarez";
customer.PhoneNumber = "4423456723";
customer.Email = "juan.vazquez@empresa.com.pe";
request.Method = "card";
request.SourceId = "kwkoqpg6fcvfse8k8mg2";
request.Amount = new Decimal(100.00);
request.Currency = "PEN";
request.Description = "Cargo inicial a mi merchant";
request.OrderId = "oid-00051";
request.DeviceSessionId = "kR1MiQhz2otdIuUlQkbEyitIqVMiI16f";
request.Customer = customer;
Charge charge = api.ChargeService.Create(request);
var chargeRequest = {
'source_id' : 'kqgykn96i7bcs1wwhvgw',
'method' : 'card',
'amount' : 100,
'currency' : 'PEN',
'description' : 'Cargo inicial a mi cuenta',
'order_id' : 'oid-00051',
'device_session_id' : 'kR1MiQhz2otdIuUlQkbEyitIqVMiI16f',
'customer' : {
'name' : 'Juan',
'last_name' : 'Vazquez Juarez',
'phone_number' : '4423456723',
'email' : 'juan.vazquez@empresa.com.pe'
}
}
openpay.charges.create(chargeRequest, function(error, charge) {
// ...
});
@openpay=OpenpayApi.new("moiep6umtcnanql3jrxp","sk_3433941e467c4875b178ce26348b0fac")
@charges=@openpay.create(:charges)
customer_hash={
"name" => "Juan",
"last_name" => "Vazquez Juarez",
"phone_number" => "4423456723",
"email" => "juan.vazquez@empresa.com.pe"
}
request_hash={
"method" => "card",
"source_id" => "kqgykn96i7bcs1wwhvgw",
"amount" => 100.00,
"currency" => "PEN",
"description" => "Cargo inicial a mi merchant",
"order_id" => "oid-00051",
"device_session_id" => "kR1MiQhz2otdIuUlQkbEyitIqVMiI16f",
"customer" => customer_hash
}
response_hash=@charges.create(request_hash.to_hash)
Ejemplo de respuesta
{
"id":"trzjaozcik8msyqshka4",
"amount":100.00,
"authorization":"801585",
"method":"card",
"operation_type":"in",
"transaction_type":"charge",
"card":{
"id":"kqgykn96i7bcs1wwhvgw",
"type":"debit",
"brand":"visa",
"address":null,
"card_number":"411111XXXXXX1111",
"holder_name":"Juan Perez Ramirez",
"expiration_year":"20",
"expiration_month":"12",
"allows_charges":true,
"allows_payouts":true,
"creation_date":"2014-05-26T11:02:16-05:00",
"bank_name":"Banamex",
"bank_code":"002"
},
"status":"completed",
"currency":"USD",
"exchange_rate" : {
"from" : "USD",
"date" : "2014-11-21",
"value" : 13.61,
"to" : "PEN"
},
"creation_date":"2014-05-26T11:02:45-05:00",
"operation_date":"2014-05-26T11:02:45-05:00",
"description":"Cargo inicial a mi cuenta",
"error_message":null,
"order_id":"oid-00051"
}
Este tipo de cargo requiere una tarjeta guardada o que hayas generado un token. Para guardar tarjetas consulta como crear una tarjeta y para usar tokens consulta la sección creación de tokens.
Una vez que tengas una tarjeta guardada o un token usa la propiedad source_id
para enviar el identificador.
La propiedad device_session_id
deberá ser generada desde el API JavaScript, véase Fraud detection using device data.
Sistema antifraude personalizado Es posible enviar información adicional a la plataforma Openpay para incrementar su base de conocimientos, esto le permitirá aplicar reglas personalizadas de acuerdo al giro del comercio y de manera oportuna, con el propósito de detectar con la mayor efectividad posible los intentos de fraude.
Petición
Propiedad | Descripción |
---|---|
method | string (requerido) Debe contener el valor card para indicat que el cargo se hará de una tarjeta. |
source_id | string (requerido, longitud = 45) ID de la tarjeta guardada o el id del token creado de donde se retirarán los fondos. |
amount | numeric (requerido) Cantidad del cargo. Debe ser una cantidad mayor a cero, con hasta dos dígitos decimales. |
currency | string (opcional) Tipo de moneda del cargo. Por el momento solo se soportan 2 tipos de monedas: Pesos Mexicanos(PEN) y Dólares Americanos(USD). |
description | string (requerido, longitud = 250) Una descripción asociada al cargo. |
order_id | string (opcional, longitud = 100) Identificador único del cargo. Debe ser único entre todas las transacciones. |
device_session_id | string (requerido, longitud = 32) Identificador del dispositivo generado con la herramienta antifraudes |
capture | boolean (opcional, default = true) Indica si el cargo se hace o no inmediatamente, cuando el valor es false el cargo se maneja como una autorización (o preautorización) y solo se reserva el monto para ser confirmado o cancelado en una segunda llamada. |
customer | objeto (requerido) Información del cliente al que se le realiza el cargo. Se puede ocupar los mismos parámetros usados en la creación de un cliente pero no se creará una cuenta al cliente. Nota: Este parámetro solo se puede utilizar creando el cargo a nivel comercio Si desea crear un cliente y llevar un historial de sus cargos consulte como crear un cliente y realice el cargo a nivel cliente. |
payment_plan | objeto (opcional) Datos del plan de meses sin intereses que se desea utilizar en el cargo. Ver Objeto PaymentPlan. |
metadata | list(key, value) (opcional) Listado de campos personalizados de antifraude, estos campos deben de apegarse a las reglas para creación de campos personalizados de antifraude |
send_email | boolean (opcional) Usado para cargos de tipo redirect. Indica si se desea enviar un email que direccione al formulario de pago de Openpay. |
redirect_url | string (requerido) Usado para cargos de tipo redirect. Indica la url a la que redireccionar despues de una transaccion exitosa en el fomulario de pago de openpay. Nota: Este parámetro solo se puede utilizar si se especifica el manejo de 3D Secure. |
use_3d_secure | string (opcional) Se debe especificar este parámetro en true para manejar 3D Secure. |
Respuesta
Regresa un objeto de transacción con la información del cargo o una respuesta de error.
Con redireccionamiento
Definición
Comercio
POST https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/charges
Cliente
POST https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/customers/{CUSTOMER_ID}/charges
<?
Comercio
$openpay->charges->create(chargeRequest);
Cliente
$customer = $openpay->customers->get($customerId);
$customer->charges->create(chargeRequest);
?>
//Cliente
openpayAPI.charges().create(String customerId, CreateCardChargeParams request);
//Comercio
openpayAPI.charges().create(CreateCardChargeParams request);
// Comercio
openpay.charges.create(chargeRequest, callback);
// Cliente
openpay.customers.charges.create(customerId, chargeRequest, callback);
//Cliente
openpayAPI.ChargeService.Create(string customer_id, ChargeRequest request);
//Comercio
openpayAPI.ChargeService.Create(ChargeRequest request);
#Cliente
@charges=@openpay.create(:charges)
@charges.create(request_hash, customer_id)
#Comercio
@charges=@openpay.create(:charges)
@charges.create(request_hash)
Ejemplo de petición con comercio
curl https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/charges \
-u sk_e568c42a6c384b7ab02cd47d2e407cab: \
-H "Content-type: application/json" \
-X POST -d '{
"method" : "card",
"amount" : 100,
"description" : "Cargo inicial a mi cuenta",
"order_id" : "oid-00051",
"customer" : {
"name" : "Juan",
"last_name" : "Vazquez Juarez",
"phone_number" : "4423456723",
"email" : "juan.vazquez@empresa.com.pe"
},
"confirm" : "false",
"send_email":"false",
"redirect_url":"http://www.openpay.pe/index.html"
}'
<?
$openpay = Openpay::getInstance('mzdtln0bmtms6o3kck8f', 'sk_e568c42a6c384b7ab02cd47d2e407cab');
$customer = array(
'name' => 'Juan',
'last_name' => 'Vazquez Juarez',
'phone_number' => '4423456723',
'email' => 'juan.vazquez@empresa.com.pe');
$chargeRequest = array(
"method" : "card",
'amount' => 100,
'description' => 'Cargo terminal virtual a mi merchant',
'customer' => $customer,
'send_email' => false,
'confirm' => false,
'redirect_url' => 'http://www.openpay.pe/index.html')
;
$charge = $openpay->charges->create($chargeRequest);
?>
OpenpayAPI api = new OpenpayAPI("https://sandbox-api.openpay.pe", "sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
CreateCardChargeParams request = new CreateCardChargeParams();
Customer customer = new Customer();
customer.setName("Juan");
customer.setLastName("Vazquez Juarez");
customer.setPhoneNumber("4423456723");
customer.setEmail("juan.vazquez@empresa.com.pe");
request.amount(new BigDecimal("100.00"));
request.description("Cargo inicial a mi merchant");
request.orderId("oid-00051");
request.setCustomer(customer);
request.setSendEmail(false);
request.setConfirm(false);
request.setRedirectUrl("http://www.openpay.pe/index.html");
Charge charge = api.charges().create(request);
OpenpayAPI api = new OpenpayAPI("sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
ChargeRequest request = new ChargeRequest();
Customer customer = new Customer();
customer.Name = "Juan";
customer.LastName = "Vazquez Juarez";
customer.PhoneNumber = "4423456723";
customer.Email = "juan.vazquez@empresa.com.pe";
request.Method = "card";
request.Amount = new Decimal(100.00);
request.Description = "Cargo inicial a mi merchant";
request.OrderId = "oid-00051";
request.Confirm = false;
request.SendEmail = false;
request.RedirectUrl = "http://www.openpay.pe/index.html";
request.Customer = customer;
Charge charge = api.ChargeService.Create(request);
var chargeRequest = {
'method' : 'card',
'amount' : 100,
'description' : 'Cargo inicial a mi cuenta',
'order_id' : 'oid-00051',
'customer' : {
'name' : 'Juan',
'last_name' : 'Vazquez Juarez',
'phone_number' : '4423456723',
'email' : 'juan.vazquez@empresa.com.pe'
},
'send_email' : false,
'confirm' : false,
'redirect_url' : 'http://www.openpay.pe/index.html')
}
openpay.charges.create(chargeRequest, function(error, charge) {
// ...
});
@openpay=OpenpayApi.new("moiep6umtcnanql3jrxp","sk_3433941e467c4875b178ce26348b0fac")
@charges=@openpay.create(:charges)
customer_hash={
"name" => "Juan",
"last_name" => "Vazquez Juarez",
"phone_number" => "4423456723",
"email" => "juan.vazquez@empresa.com.pe"
}
request_hash={
"method" => "card",
"amount" => 100.00,
"description" => "Cargo inicial a mi merchant",
"order_id" => "oid-00051",
"customer" => customer_hash,
"send_email" => false,
"confirm" => false,
"redirect_url" => "http://www.openpay.pe/index.html"
}
response_hash=@charges.create(request_hash.to_hash)
Ejemplo de respuesta
{
"id": "trq7yrthx5vc4gtjdkwg",
"authorization": null,
"method": "card",
"operation_type": "in",
"transaction_type": "charge",
"status": "charge_pending",
"conciliated": false,
"creation_date": "2016-09-09T18:52:02-05:00",
"operation_date": "2016-09-09T18:52:02-05:00",
"description": "Cargo desde terminal virtual de 111",
"error_message": null,
"amount": 100,
"currency": "PEN",
"payment_method": {
"type": "redirect",
"url": "https://sandbox-api.openpay.pe/v1/mexzhpxok3houd5lbvz1/charges/trq7yrthx5vc4gtjdkwg/card_capture"
},
"customer": {
"name": "Juan",
"last_name": "Vazquez Juarez",
"email": "juan.vazquez@empresa.com.pe",
"phone_number": "4423456723",
"creation_date": "2016-09-09T18:52:02-05:00",
"clabe": null,
"external_id": null
}
}
Este tipo de cargo no requiere una tarjeta guardada o que hayas generado un token.
Petición
Propiedad | Descripción |
---|---|
method | string (requerido en card) Debe contener el valor card para indicat que el cargo se hará de una tarjeta. |
amount | numeric (requerido) Cantidad del cargo. Debe ser una cantidad mayor a cero, con hasta dos dígitos decimales. |
description | string (requerido, longitud = 250) Una descripción asociada al cargo. |
order_id | string (opcional, longitud = 100) Identificador único del cargo. Debe ser único entre todas las transacciones. |
customer | objeto (requerido) Información del cliente al que se le realiza el cargo. Se puede ocupar los mismos parámetros usados en la creación de un cliente pero no se creará una cuenta al cliente. Nota: Este parámetro solo se puede utilizar creando el cargo a nivel comercio Si desea crear un cliente y llevar un historial de sus cargos consulte como crear un cliente y realice el cargo a nivel cliente. |
confirm | boolean (requerido en false) El valor false indica que se trata de un cargo con terminal virtual. |
send_email | boolean (opcional) Indica si se desea enviar un email que direccione al formulario de pago de openpay. |
redirect_url | string (requerido) Indica la url a la que redireccionar despues de una transaccion exitosa en el fomulario de pago de openpay. |
Respuesta
Regresa un objeto de transacción con la información del cargo o una respuesta de error.
Cargo en tienda
Definición
Comercio
POST https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/charges
Cliente
POST https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/customers/{CUSTOMER_ID}/charges
<?
Comercio
$openpay->charges->create(chargeRequest);
Cliente
$customer = $openpay->customers->get(customerId);
$customer->charges->create(chargeRequest;
?>
//Cliente
openpayAPI.charges().create(String customerId, CreateStoreChargeParams request);
//Comercio
openpayAPI.charges().create(CreateStoreChargeParams request);
//Cliente
openpayAPI.ChargeService.Create(string customer_id, ChargeRequest request);
//Comercio
openpayAPI.ChargeService.Create(ChargeRequest request);
//Comercio
openpay.charges.create(chargeRequest, callback);
//Cliente
openpay.customers.charges.create(customerId, chargeRequest, callback);
#Cliente
@charges=@openpay.create(:charges)
@charges.create(request_hash, customer_id)
#Comercio
@charges=@openpay.create(:charges)
@charges.create(request_hash)
Ejemplo de petición con cliente
curl https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/customers/ag4nktpdzebjiye1tlze/charges \
-u sk_e568c42a6c384b7ab02cd47d2e407cab: \
-H "Content-type: application/json" \
-X POST -d '{
"method" : "store",
"amount" : 100,
"description" : "Cargo con tienda",
"order_id" : "oid-00053",
"due_date" : "2014-05-20T13:45:00"
} '
<?
$openpay = Openpay::getInstance('mzdtln0bmtms6o3kck8f', 'sk_e568c42a6c384b7ab02cd47d2e407cab');
$chargeRequest = array(
'method' => 'store',
'amount' => 100,
'description' => 'Cargo con tienda',
'order_id' => 'oid-00053',
'due_date' => '2014-05-28T13:45:00');
$customer = $openpay->customers->get('ag4nktpdzebjiye1tlze');
$charge = $customer->charges->create($chargeRequest);
?>
OpenpayAPI api = new OpenpayAPI("https://sandbox-api.openpay.pe", "sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Calendar dueDate = Calendar.getInstance();
dueDate.set(2014, 5, 28, 13, 45, 0);
CreateStoreChargeParams request = new CreateStoreChargeParams();
request.amount(new BigDecimal("100.00"));
request.description("Cargo con tienda");
request.orderId("oid-00053");
request.dueDate(dueDate.getTime());
Charge charge = api.charges().create("ag4nktpdzebjiye1tlze", request);
OpenpayAPI api = new OpenpayAPI("sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
ChargeRequest request = new ChargeRequest();
request.Method = "store";
request.Amount = new Decimal(100.00);
request.Description = "Cargo con tienda";
request.OrderId = "oid-00053";
request.DueDate = new DateTime(2014, 5, 28, 13, 45, 0);
Charge charge = api.ChargeService.Create("ag4nktpdzebjiye1tlze", request);
var storeChargeRequest = {
'method' : 'store',
'amount' : 100,
'description' : 'Cargo con tienda',
'order_id' : 'oid-00053',
'due_date' : '2014-05-28T13:45:00'
};
openpay.customers.charges.create('ag4nktpdzebjiye1tlze', storeChargeRequest, function(error, charge) {
// ...
});
@openpay=OpenpayApi.new("moiep6umtcnanql3jrxp","sk_3433941e467c4875b178ce26348b0fac")
@charges=@openpay.create(:charges)
request_hash={
"method" => "store",
"amount" => 100.00,
"description" => "Cargo con tienda",
"order_id" => "oid-00053"
"due_date" => "2014-05-28T13:45:00"
}
response_hash=@charges.create(request_hash.to_hash, "ag4nktpdzebjiye1tlze")
Ejemplo de respuesta
{
"id":"trnirkiyobo5qfex55ef",
"amount":100.00,
"authorization":null,
"method":"store",
"operation_type":"in",
"transaction_type":"charge",
"status":"in_progress",
"currency":"PEN",
"creation_date":"2014-05-26T13:48:25-05:00",
"operation_date":"2014-05-26T13:48:25-05:00",
"due_date":"2014-05-28T13:45:00-05:00",
"description":"Cargo con tienda",
"error_message":null,
"order_id":"oid-00053",
"customer_id":"ag4nktpdzebjiye1tlze",
"payment_method":{
"type":"store",
"reference":"000020TRNIRKIYOBO5QFEX55EF0100009",
"paybin_reference":"0101990000001065",
"barcode_url":"https://sandbox-api.openpay.pe/barcode/000020TRNIRKIYOBO5QFEX55EF0100009?width=1&height=45&text=false",
"barcode_paybin_url":"https://sandbox-api.openpay.pe/barcode/0101990000001065?width=1&height=45&text=false"
}
}
Para un pago en una tienda de conveniencia se debe crear un petición de tipo cargo indicando como método store. Esto generará una respuesta con un número de referencia y una URL a un código de barras, los cuales debes de utilizar para crear un recibo a tu cliente y que con él pueda realizar el pago en una de las tienda de conveniencia aceptadas. El código de barras es de tipo Code 128.
Petición
Propiedad | Descripción |
---|---|
method | string (requerido) Debe contener el valor store para indicar que el pago se hará en tienda. |
amount | numeric (requerido) Cantidad del cargo. Debe ser una cantidad mayor a cero, con hasta dos dígitos decimales. |
description | string (requerido, longitud = 250) Una descripción asociada al cargo. |
order_id | string (opcional, longitud = 100) Identificador único del cargo. Debe ser único entre todas las transacciones. |
due_date | datetime (opcional) Fecha de vigencia para hacer el pago en la tienda en formato ISO 8601. Ejemplo (UTC): 2014-08-01T00:50:00Z Nota: Del lado del servidor se cambiara a hora central Ejemplo (Central Time): 2014-08-01T11:51:23-05:00 |
customer | objeto (requerido) Información del cliente al que se le realiza el cargo. Se puede ocupar los mismos parámetros usados en la creación de un cliente pero no se creará una cuenta al cliente. Nota: Este parámetro solo se puede utilizar creando el cargo a nivel comercio Si desea crear un cliente y llevar un historial de sus cargos consulte como crear un cliente y realize el cargo a nivel cliente. |
Respuesta
Regresa un objeto de transacción con la información del cargo o una respuesta de error.
Confirmar un cargo
Definición
Comercio
POST https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/charges/{TRANSACTION_ID}/capture
Cliente
POST https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/customers/{CUSTOMER_ID}/charges/{TRANSACTION_ID}/capture
<?
Comercio
$charge = $openpay->charges->get(transactionId);
$charge->capture(captureData);
Cliente
$customer = $openpay->customers->get(customerId);
$charge = $customer->charges->get(transactionId);
$charge->capture(captureData);
?>
//Cliente
openpayAPI.charges().confirmCapture(String customerId, ConfirmCaptureParams request);
//Comercio
openpayAPI.charges().confirmCapture(ConfirmCaptureParams request);
//Cliente
openpayAPI.ChargeService.Capture(string customer_id, string transaction_id, Decimal? amount);
//Comercio
openpayAPI.ChargeService.Capture(string transaction_id, Decimal? amount);
// Comercio
openpay.charges.capture(transactionId, captureRequest, callback);
// Cliente
openpay.customers.charges.capture(customerId, transactionId, captureRequest, callback);
#Cliente
@charges=@openpay.create(:charges)
@charges.capture(transaction_id, customer_id)
#Comercio
@charges=@openpay.create(:charges)
@charges.capture(transaction_id)
Ejemplo de petición con cliente
curl https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/customers/ag4nktpdzebjiye1tlze/charges/tryqihxac3msedn4yxed/capture \
-u sk_e568c42a6c384b7ab02cd47d2e407cab: \
-H "Content-type: application/json" \
-X POST -d '{
"amount" : 100.00
} '
<?
$openpay = Openpay::getInstance('mzdtln0bmtms6o3kck8f', 'sk_e568c42a6c384b7ab02cd47d2e407cab');
$captureData = array('amount' => 100.00);
$customer = $openpay->customers->get('ag4nktpdzebjiye1tlze');
$charge = $customer->charges->get('tryqihxac3msedn4yxed');
$charge->capture($captureData);
?>
OpenpayAPI api = new OpenpayAPI("https://sandbox-api.openpay.pe", "sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
ConfirmCaptureParams request = new ConfirmCaptureParams();
request.chargeId("tryqihxac3msedn4yxed");
request.amount(new BigDecimal("100.00"));
Charge charge = api.charges().confirmCapture("ag4nktpdzebjiye1tlze", request);
OpenpayAPI api = new OpenpayAPI("sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Charge charge = api.ChargeService.Capture("ag4nktpdzebjiye1tlze", "tryqihxac3msedn4yxed", new Decimal(100.00));
var captureRequest = {
'amount' : 100.00
};
openpay.customers.charges.capture('ag4nktpdzebjiye1tlze', 'tryqihxac3msedn4yxed', captureRequest,
function(error, charge){
// ...
});
@openpay=OpenpayApi.new("moiep6umtcnanql3jrxp","sk_3433941e467c4875b178ce26348b0fac")
@charges=@openpay.create(:charges)
response_hash=@charges.capture("tryqihxac3msedn4yxed", "ag4nktpdzebjiye1tlze")
Ejemplo de respuesta
{
"id":"tryqihxac3msedn4yxed",
"amount":100.00,
"authorization":"801585",
"method":"card",
"operation_type":"in",
"transaction_type":"charge",
"card":{
"type":"debit",
"brand":"visa",
"address":null,
"card_number":"411111XXXXXX1111",
"holder_name":"Juan Perez Ramirez",
"expiration_year":"20",
"expiration_month":"12",
"allows_charges":true,
"allows_payouts":true,
"bank_name":"Banamex",
"bank_code":"002"
},
"status":"completed",
"currency":"PEN",
"creation_date":"2014-05-26T14:00:17-05:00",
"operation_date":"2014-05-26T14:00:17-05:00",
"description":"Cargo inicial a mi cuenta",
"error_message":null,
"order_id":null,
"customer_id":"ag4nktpdzebjiye1tlze"
}
Confirmar un cargo creado con la propieda de capture = "false"
, este método es la segunda parte de la creación de un cargo con tarjeta (id o token) y puede confirmar el monto capturado en la primera llamada o un monto menor.
Petición
Propiedad | Descripción |
---|---|
amount | numeric (opcional) Cantidad a confirmar. Puede ser menor o igual al monto capturado hasta dos dígitos decimales. |
Respuesta
Regresa un objeto de transacción con la información del cargo o una respuesta de error.
Devolver un cargo
Definición
Comercio
POST https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/charges/{TRANSACTION_ID}/refund
Cliente
POST https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/customers/{CUSTOMER_ID}/charges/{TRANSACTION_ID}/refund
<?
Comercio
$charge = $openpay->charges->get(transactionId);
$charge->refund(refundData);
Cliente
$customer = $openpay->customers->get(customerId);
$charge = $customer->charges->get(transactionId);
$charge->refund(refundData);
?>
//Cliente
openpayAPI.charges().refund(String customerId, RefundParams request);
//Comercio
openpayAPI.charges().refund(RefundParams request);
//Cliente
openpayAPI.ChargeService.Refund(string customer_id, string transaction_id, string description);
//Comercio
openpayAPI.ChargeService.Refund(string transaction_id, string description);
// Comercio
openpay.charges.refund(transactionId, refundRequest, callback);
// Cliente
openpay.customers.charges.refund(customerId, transactionId, refundRequest, callback);
#Cliente
@charges=@openpay.create(:charges)
@charges.refund(transaction_id, request_hash, customer_id)
#Comercio
@charges=@openpay.create(:charges)
@charges.refund(transaction_id, request_hash)
Ejemplo de petición con cliente
curl https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/customers/ag4nktpdzebjiye1tlze/charges/tr6cxbcefzatd10guvvw/refund \
-u sk_e568c42a6c384b7ab02cd47d2e407cab: \
-H "Content-type: application/json" \
-X POST -d '{
"description" : "devolución",
"amount" : 100.00
} '
<?
$openpay = Openpay::getInstance('mzdtln0bmtms6o3kck8f', 'sk_e568c42a6c384b7ab02cd47d2e407cab');
$refundData = array(
'description' => 'devolución',
'amount' => 100);
$customer = $openpay->customers->get('ag4nktpdzebjiye1tlze');
$charge = $customer->charges->get('tr6cxbcefzatd10guvvw');
$charge->refund($refundData);
?>
OpenpayAPI api = new OpenpayAPI("https://sandbox-api.openpay.pe", "sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
RefundParams request = new RefundParams();
request.chargeId("tryqihxac3msedn4yxed");
request.description("Monto de cargo devuelto");
request.amount(new BigDecimal("100.00"));
Charge charge = api.charges().refund("ag4nktpdzebjiye1tlze", request);
OpenpayAPI api = new OpenpayAPI("sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Charge charge = api.ChargeService.Refund("ag4nktpdzebjiye1tlze", "tryqihxac3msedn4yxed", "Monto de cargo devuelto", , new Decimal(100.00));
var refundRequest = {
'description' : 'devolución',
'amount' : 100.00
};
openpay.customers.charges.refund('ag4nktpdzebjiye1tlze', 'tryqihxac3msedn4yxed', refundRequest,
function(error, charge) {
// ...
});
@openpay=OpenpayApi.new("moiep6umtcnanql3jrxp","sk_3433941e467c4875b178ce26348b0fac")
@charges=@openpay.create(:charges)
request_hash={
"description" => "Monto de cargo devuelto",
"amount" => 100.00
}
response_hash=@charges.refund("tryqihxac3msedn4yxed", request_hash.to_hash, "ag4nktpdzebjiye1tlze")
Ejemplo de respuesta
{
"id":"tr6cxbcefzatd10guvvw",
"amount":100.00,
"authorization":"801585",
"method":"card",
"operation_type":"in",
"transaction_type":"charge",
"card":{
"type":"debit",
"brand":"visa",
"address":null,
"card_number":"411111XXXXXX1111",
"holder_name":"Juan Perez Ramirez",
"expiration_year":"20",
"expiration_month":"12",
"allows_charges":true,
"allows_payouts":true,
"bank_name":"Banamex",
"bank_code":"002"
},
"status":"completed",
"refund":{
"id":"trcbsmjkroqmjobxqhpb",
"amount":100.00,
"authorization":"801585",
"method":"card",
"operation_type":"out",
"transaction_type":"refund",
"status":"completed",
"currency":"PEN",
"creation_date":"2014-05-26T13:56:21-05:00",
"operation_date":"2014-05-26T13:56:21-05:00",
"description":"devolucion",
"error_message":null,
"order_id":null,
"customer_id":"ag4nktpdzebjiye1tlze"
},
"currency":"PEN",
"creation_date":"2014-05-26T11:56:25-05:00",
"operation_date":"2014-05-26T11:56:25-05:00",
"description":"Cargo inicial a mi cuenta",
"error_message":null,
"order_id":"oid-00052",
"customer_id":"ag4nktpdzebjiye1tlze"
}
Si deseas realizar una devolución de un cargo hecho a tarjeta puedes ocupar este método. El monto a devolver será por el total del cargo o un monto menor. Ten en cuenta que la devolución puede tardar en aparecer en el estado de cuenta de tu cliente de 1 a 3 días hábiles.
Petición
Propiedad | Descripción |
---|---|
description | string (opcional, longitud = 250) Texto libre para describir motivo de la devolución. |
amount | numeric (opcional) Cantidad a reembolsar. Debe ser una cantidad mayor a cero y menor o igual al cargo original, con hasta dos dígitos decimales. |
Respuesta
Regresa un objeto de transacción con la información del cargo o una respuesta de error.
Obtener un cargo
Definición
Comercio
GET https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/charges/{TRANSACTION_ID}
Comercio
GET https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/customers/{CUSTOMER_ID}/charges/{TRANSACTION_ID}
<?
Comercio
$charge = $openpay->charges->get(transactionId);
Cliente
$customer = $openpay->customers->get(customerId);
$charge = $customer->charges->get(transactionId);
?>
//Cliente
openpayAPI.charges().get(String customerId, String transactionId);
//Comercio
openpayAPI.charges().get(String transactionId);
//Cliente
openpayAPI.ChargeService.Get(string customer_id, string transaction_id);
//Comercio
openpayAPI.ChargeService.Get(string transaction_id);
// Comercio
openpay.charges.get(transactionId, callback);
// Cliente
openpay.customers.charges.get(customerId, transactionId, callback);
#Cliente
@charges=@openpay.create(:charges)
@charges.get(transaction_id, customerId)
#Comercio
@charges=@openpay.create(:charges)
@charges.get(transaction_id)
Ejemplo de petición con cliente
curl https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/customers/ag4nktpdzebjiye1tlze/charges/tr6cxbcefzatd10guvvw \
-u sk_e568c42a6c384b7ab02cd47d2e407cab:
<?
$openpay = Openpay::getInstance('mzdtln0bmtms6o3kck8f', 'sk_e568c42a6c384b7ab02cd47d2e407cab');
$customer = $openpay->customers->get('ag4nktpdzebjiye1tlze');
$charge = $customer->charges->get('tr6cxbcefzatd10guvvw');
?>
OpenpayAPI api = new OpenpayAPI("https://sandbox-api.openpay.pe", "sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Charge charge = api.charges().get("ag4nktpdzebjiye1tlze", "tr6cxbcefzatd10guvvw");
OpenpayAPI api = new OpenpayAPI("sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Charge charge = api.ChargeService.Get("ag4nktpdzebjiye1tlze", "tryqihxac3msedn4yxed");
openpay.customers.charges.get('ag4nktpdzebjiye1tlze', 'tr6cxbcefzatd10guvvw', function(error, charge){
// ...
});
@openpay=OpenpayApi.new("moiep6umtcnanql3jrxp","sk_3433941e467c4875b178ce26348b0fac")
@charges=@openpay.create(:charges)
response_hash=@charges.get("tr6cxbcefzatd10guvvw", "ag4nktpdzebjiye1tlze")
Ejemplo de respuesta
{
"id":"tr6cxbcefzatd10guvvw",
"amount":100.00,
"authorization":"801585",
"method":"card",
"operation_type":"in",
"transaction_type":"charge",
"card":{
"type":"debit",
"brand":"visa",
"address":null,
"card_number":"411111XXXXXX1111",
"holder_name":"Juan Perez Ramirez",
"expiration_year":"20",
"expiration_month":"12",
"allows_charges":true,
"allows_payouts":true,
"bank_name":"Banamex",
"bank_code":"002"
},
"status":"completed",
"refund":{
"id":"trcbsmjkroqmjobxqhpb",
"amount":100.00,
"authorization":"801585",
"method":"card",
"operation_type":"out",
"transaction_type":"refund",
"status":"completed",
"currency":"PEN",
"creation_date":"2014-05-26T13:56:21-05:00",
"operation_date":"2014-05-26T13:56:21-05:00",
"description":"devolucion",
"error_message":null,
"order_id":null,
"customer_id":"ag4nktpdzebjiye1tlze"
},
"currency":"PEN",
"creation_date":"2014-05-26T11:56:25-05:00",
"operation_date":"2014-05-26T11:56:25-05:00",
"description":"Cargo inicial a mi cuenta",
"error_message":null,
"order_id":"oid-00052",
"customer_id":"ag4nktpdzebjiye1tlze"
}
Regresa la información de un cargo generado en cualquier momento solo con conocer el id de cargo.
Petición
Propiedad | Descripción |
---|---|
transaction_id | string (requerido, longitud = 45) Identificador del cargo a consultar. |
Respuesta
Regresa un objeto de transacción con la información del cargo o una respuesta de error.
Listado de cargos
Definición
Comercio
GET https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/charges
Comercio
GET https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/customers/{CUSTOMER_ID}/charges
<?
Comercio
$chargeList = $openpay->charges->getList(searchParams);
Cliente
$customer = $openpay->customers->get(customerId);
$chargeList = $customer->charges->getList(searchParams);
?>
//Cliente
openpayAPI.charges().list(String customerId, SearchParams request);
//Comercio
openpayAPI.charges().list(SearchParams request);
//Cliente
openpayAPI.ChargeService.List(string customer_id, SearchParams request = null);
//Comercio
openpayAPI.ChargeService.List(SearchParams request = null);
// Comercio
openpay.charges.list(callback);
openpay.charges.list(searchParams, callback);
// Cliente
openpay.customers.charges.list(customerId, callback);
openpay.customers.charges.list(customerId, searchParams, callback);
#Cliente
@charges=@openpay.create(:charges)
@charges.all(customer_id)
#Comercio
@charges=@openpay.create(:charges)
@charges.all
Ejemplo de petición con cliente
curl -g "https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/customers/ag4nktpdzebjiye1tlze/charges?creation[gte]=2013-11-01&limit=2" \
-u sk_e568c42a6c384b7ab02cd47d2e407cab:
<?
$openpay = Openpay::getInstance('mzdtln0bmtms6o3kck8f', 'sk_e568c42a6c384b7ab02cd47d2e407cab');
$searchParams = array(
'creation[gte]' => '2013-11-01',
'creation[lte]' => '2014-11-01',
'offset' => 0,
'limit' => 2);
$customer = $openpay->customers->get('ag4nktpdzebjiye1tlze');
$chargeList = $customer->charges->getList($searchParams);
?>
final Calendar dateGte = Calendar.getInstance();
final Calendar dateLte = Calendar.getInstance();
dateGte.set(2014, 5, 1, 0, 0, 0);
dateLte.set(2014, 5, 15, 0, 0, 0);
OpenpayAPI api = new OpenpayAPI("https://sandbox-api.openpay.pe", "sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
SearchParams request = new SearchParams();
request.creationGte(dateGte.getTime());
request.creationLte(dateLte.getTime());
request.offset(0);
request.limit(100);
request.amount(new BigDecimal("100.00"));
List<Charge> charges = api.charges().list("ag4nktpdzebjiye1tlze", request);
OpenpayAPI api = new OpenpayAPI("sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
SearchParams request = new SearchParams();
request.CreationGte = new Datetime(2014, 5, 1);
request.CreationLte = new DateTime(2014, 5, 15);
request.Offset = 0;
request.Limit = 100;
request.Amount = new Decimal(100.00);
List<Charge> charges= openpayAPI.ChargeService.List("ag4nktpdzebjiye1tlze", request);
var searchParams = {
'creation[gte]' : '2013-11-01',
'limit' : 2
};
openpay.customers.charges.list('ag4nktpdzebjiye1tlze',searchParams, function(error, chargeList) {
// ...
});
@openpay=OpenpayApi.new("moiep6umtcnanql3jrxp","sk_3433941e467c4875b178ce26348b0fac")
@charges=@openpay.create(:charges)
response_hash=@charges.all("ag4nktpdzebjiye1tlze")
Ejemplo de respuesta
[
{
"id":"tryqihxac3msedn4yxed",
"amount":100.00,
"authorization":"801585",
"method":"card",
"operation_type":"in",
"transaction_type":"charge",
"card":{
"type":"debit",
"brand":"visa",
"address":null,
"card_number":"411111XXXXXX1111",
"holder_name":"Juan Perez Ramirez",
"expiration_year":"20",
"expiration_month":"12",
"allows_charges":true,
"allows_payouts":true,
"bank_name":"Banamex",
"bank_code":"002"
},
"status":"completed",
"currency":"PEN",
"creation_date":"2014-05-26T14:00:17-05:00",
"operation_date":"2014-05-26T14:00:17-05:00",
"description":"Cargo inicial a mi cuenta",
"error_message":null,
"order_id":null,
"customer_id":"ag4nktpdzebjiye1tlze"
},
{
"id":"trnzf2xjwpupjfryyj23",
"amount":100.00,
"authorization":null,
"method":"bank_account",
"operation_type":"in",
"transaction_type":"charge",
"status":"in_progress",
"currency":"PEN",
"creation_date":"2014-05-26T13:51:25-05:00",
"operation_date":"2014-05-26T13:51:25-05:00",
"description":"Cargo con banco",
"error_message":null,
"order_id":"oid-00055",
"customer_id":"ag4nktpdzebjiye1tlze",
"payment_method":{
"type":"bank_transfer",
"agreement" : "1411217",
"bank":"BBVA Bancomer",
"clabe":"012914002014112176",
"name":"11030021342311520255"
}
}
]
Obtiene un listado de los cargos realizados por comercio o cliente.
Petición
Puede realizar una búsqueda utilizando los siguiente parámetros como filtros.
Propiedad | Descripción |
---|---|
order_id | string Identificador único de la orden generado por el comercio y asociado a la transaccion mediante el campo order_id de la petición del cargo. |
creation | date Igual a la fecha de creación. Formato yyyy-mm-dd |
creation[gte] | date Mayor a la fecha de creación. Formato yyyy-mm-dd |
creation[lte] | date Menor a la fecha de creación. Formato yyyy-mm-dd |
offset | numeric Número de registros a omitir al inicio, por defecto 0. |
limit | numeric Número de registros que se requieren, por defecto 10. |
amount | numeric Igual al monto. |
amount[gte] | numeric Mayor o igual al monto. |
amount[lte] | numeric Menor o igual al monto. |
status | TransactionStatus Estado de la transacción (IN_PROGRESS,COMPLETED,REFUNDED,CHARGEBACK_PENDING,CHARGEBACK_ACCEPTED,CHARGEBACK_ADJUSTMENT,CHARGE_PENDING,CANCELLED,FAILED). |
Respuesta
Regresa un arreglo de objetos de transacción de los cargos en orden descendente por fecha de creación.
Cobro con Link
Enviar a los clientes un link de cobro y comenzar a recibir pagos por las ventas.Permite realizar cobros a través de la generación de un link el cual puede ser compartido por medio de un email, redes sociales o bien por un mensaje de texto, de esta manera se logra que los comercios puedan recibir pagos con tarjetas de crédito, débito, puntos bancarios, transferencias interbancarias y/o efectivo en tiendas, todo esto sin la necesidad de que el comercio cuenta con un sitio web o app para realizar estos cobros.Con esto, Openpay busca que un gran número de comercios con o sin presencia digital, ofrezcan la posibilidad a sus clientes de hacer pagos rápidos con distintos medios de pago.
Crear Cobro con Link
Petición:
Propiedad | Descripción |
---|---|
amount | numeric (requerido)Cantidad del cargo. Debe ser una cantidad mayor a cero. |
description | string (requerido longitud = 250) descripción asociada al cargo. |
order_id | string (opcional, longitud = 100)Identificador único del cargo. Debe ser único entre todas las transacciones. |
currency | string (requerido)Tipo de moneda del cargo. Soporta Soles (PEN) y Dólares (USD) |
redirect_url | string (requerido)URL de redirección para una transaccion exitosa en el fomulario de pago de Openpay. |
expiration_date | datetime (opcional)Fecha de vigencia para hacer el pago formato ISO 8601. |
send_email | boolean (opcional)Indica si se desea enviar un email que direccione al formulario de pago de Openpay. |
customer | objeto (requerido)Información del cliente que realiza el cargo. |
Nota: Si desea crear un cliente y llevar un historial de sus cargos consulte como crear un cliente y realice el cobro con link a nivel cliente.cURLJAVA
Nivel Comercio
Ejemplo
curl https://sandbox-api.openpay.pe/v1/mzdtln3bqtms6o3kck2f/checkouts \
-u sk_e562c42a6q384b2ab02cd47d2n301uwk:-H
"Content-type: application/json"-X POST -d ‘{
"amount" : 250,
"currency" : "PEN",
"description" : "Cargo cobro con link",
”redirect_url" : ”https://misitioempresa.pe",
"order_id" : "oid-12324",
"expiration_date" : "2021-08-31 12:50",
"send_email" : ”true",
"customer" : {
"name" : "Cliente Perú",
"last_name" : "Vazquez Juarez",
"phone_number" : "4448936475",
"email" : "juan.vazquez@empresa.pe"
}
}'
Nivel cliente
Ejemplo
curl https://sandbox-api.openpay.pe/v1/mzdtln3bqtms6o3kck2f/customers/a7eeayo7jv1v4nayhyyg/checkouts \
-u sk_e562c42a6q384b2ab02cd47d2n301uwk:-H
"Content-type: application/json"-X POST -d ‘{
"amount" : 250,
"currency" : "PEN",
"description" : "Cargo cobro con link cliente",
”redirect_url" : ”https://misitioempresa.pe",
"order_id" : "oid-12324",
"send_email" : ”true"
}'
Nivel Comercio
Ejemplo
OpenpayAPI api = new OpenpayAPI(apiUrl, apiKey, merchantId);
Customer customer = new Customer();
customer.name("Juan");
customer.lastName("Valdez");
customer.email("juan_v@miempresa.pe");
customer.phoneNumber("579473947561");
customer.requiresAccount(false);
Address customerAddress = new Address();
customerAddress.countryCode("PE");
customerAddress.city("Canta");
customerAddress.state("Lima");
customer.address(customerAddress);
CreateCheckoutParams checkoutParamsClient = new CreateCheckoutParams()
.amount(new BigDecimal("10.00")).description("cargo cobro con link Perú").orderId("ascfdyusygaij").currency(Currency.USD)
.redirectUrl("https://misitioempresa.pe").expirationDate("2021-08-31").sendEmail(true).customer(customer);api.checkouts()
.createCheckout(checkoutParamsClient);
Nivel cliente
Ejemplo
OpenpayAPI api = new OpenpayAPI(apiUrl, apiKey, merchantId);
Customer existentCustomer = api.customers().get("a7eeayo7jv1v4nayhyyg");
CreateCheckoutParams checkoutParams = new CreateCheckoutParams().amount(new BigDecimal("10.00"))
.description("cargo cobro con link Perú").orderId("ascfdyusygaij").currency(Currency.USD)
.redirectUrl("https://misitioempresa.pe").expirationDate("2021-08-31").sendEmail(true);
api.checkouts().createCheckout(existentCustomer.getId(), checkoutParams);
Response:
{
"id": "ckp4210mayo0pmfndmuc",
"amount": 10.00,
"description": "cargo cobro con link Perú",
"order_id": "ascfdyusygaij",
"currency": "PEN",
"status": "available",
"checkout_link": "https://sandbox-api.openpay.pe/ck/488GT4TOcqwT",
"creation_date": "2021-08-12T14:32:47.806-0500",
"expiration_date": null,
"customer": {
"name": "Juan",
"email": "juan_v@miempresa.pe",
"last_name": ”Valdez",
"phone_number": "579473947561"
}
}
Consultar Cobro con Link
Actualizar Cobro con Link
Clientes
Los clientes son recursos en Openpay que se manejan dentro de su cuenta de comercio y puede representar usuarios, clientes o socios segun el tipo de negocio.
A los clientes les puedes agregar tarjetas y cuentas de banco para despues realizar transacciones de Cargo, Transferencia o Pago.
Objeto Cliente
Ejemplo de objeto
{
"id":"cz4nkhrlcu9k7qd4lwqx",
"creation_date":"2013-11-08T12:04:46-06:00",
"name":"Rodrigo",
"last_name":"Velazco Perez",
"email":"rodrigo.velazco@payments.com",
"phone_number":"4425667045",
"external_id":"cliente1",
"status":"active",
"balance":103,
"address":{
"line1":"Av. 5 de febrero No. 1080 int Roble 207",
"line2":"Carrillo puerto",
"line3":"Zona industrial carrillo puerto",
"postal_code":"06500",
"state":"Querétaro",
"city":"Querétaro",
"country_code":"PE"
},
"store": {
"reference": "OPENPAY02DQ35YOY7",
"barcode_url": "https://sandbox-api.openpay.pe/barcode/OPENPAY02DQ35YOY7?width=1&height=45&text=false"
},
"clabe": "646180109400423323"
}
Propiedad | Descripción |
---|---|
id | string Identificador único del cliente. |
creation_date | datetime Fecha y hora en que se creó el cliente en formato ISO 8601 |
name | string Nombre del cliente. |
last_name | string Apellidos del cliente. |
string Cuenta de correo electrónico del cliente. |
|
phone_number | numeric Número telefónico del Cliente. |
status | string Estatus de la cuenta del cliente puede ser active o deleted. Si la cuenta se encuentra en estatus deleted no se permite realizar ninguna transacción. |
balance | numeric Saldo en la cuenta con dos decimales. |
address | object Dirección del Cliente. Usada comúnmente como dirección de envío. |
Crear un nuevo cliente
Definición
POST https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/customers
<?
$customer = $openpay->customers->add(customerData);
?>
openpayAPI.customers().create(Customer customer);
openpayAPI.CustomerService.Create(Customer customer);
openpay.customers.create(customerRequest, callback);
@customers=@openpay.create(:customers)
@customers.create(request_hash)
Ejemplo de petición
curl https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/customers \
-u sk_e568c42a6c384b7ab02cd47d2e407cab: \
-H "Content-type: application/json" \
-X POST -d '{
"name": "customer name",
"email": "customer_email@me.com",
"requires_account": false
}'
<?
$openpay = Openpay::getInstance('mzdtln0bmtms6o3kck8f', 'sk_e568c42a6c384b7ab02cd47d2e407cab');
$customerData = array(
'external_id' => '',
'name' => 'customer name',
'last_name' => '',
'email' => 'customer_email@me.com',
'requires_account' => false,
'phone_number' => '44209087654',
'address' => array(
'line1' => 'Calle 10',
'line2' => 'col. san pablo',
'line3' => 'entre la calle 1 y la 2',
'state' => 'Queretaro',
'city' => 'Queretaro',
'postal_code' => '76000',
'country_code' => 'PE'
)
);
$customer = $openpay->customers->add($customerData);
?>
OpenpayAPI api = new OpenpayAPI("https://sandbox-api.openpay.pe", "sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Customer request = new Customer();
request.externalId("idExterno0101");
request.name("Julian Gerardo");
request.lastName("López Martínez");
request.email("julian.martinez@gmail.com");
request.phoneNumber("4421432915");
request.requiresAccount(false);
Address address = new Address();
address.city("Queretaro");
address.countryCode("PE");
address.state("Queretaro");
address.postalCode("79125");
address.line1("Av. Pie de la cuesta #12");
address.line2("Desarrollo San Pablo");
address.line3("Qro. Qro.");
request.address(address);
request = api.customers().create(request);
OpenpayAPI api = new OpenpayAPI("sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Customer request = new Customer();
request.ExternalId = "idExterno0101";
request.Name = "Julian Gerardo";
request.LastName = "López Martínez";
request.Email = "julian.martinez@gmail.com";
request.PhoneNumber = "4421432915";
request.RequiresAccount = false;
Address address = new Address();
address.City = "Queretaro";
address.CountryCode = "PE";
address.State = "Queretaro";
address.PostalCode = "79125";
address.Line1 = "Av. Pie de la cuesta #12";
address.Line2 = "Desarrollo San Pablo";
address.Line3 = "Qro. Qro.";
request.Address = address;
request = api.CustomerService.Create(request);
var customerRequest = {
'name': 'customer name',
'email': 'customer_email@me.com',
'requires_account': false
};
openpay.customers.create(customerRequest, function(error, customer) {
// ...
});
@openpay=OpenpayApi.new("mzdtln0bmtms6o3kck8f","sk_e568c42a6c384b7ab02cd47d2e407cab")
@customers=@openpay.create(:customers)
address_hash={
"line1" => "Calle 10",
"line2" => "col. san pablo",
"line3" => "entre la calle 1 y la 2",
"state" => "Queretaro",
"city" => "Queretaro",
"postal_code" => "76000",
"country_code" => "PE"
}
request_hash={
"external_id" => nil,
"name" => "customer name",
"last_name" => nil,
"email" => "customer_email@me.com",
"requires_account" => false,
"phone_number" => "44209087654",
"address" => address_hash
}
response_hash=@customers.create(request_hash.to_hash)
Ejemplo de respuesta
{
"id":"anbnldwgni1way3yp2dw",
"name":"customer name",
"last_name":null,
"email":"customer_email@me.com",
"phone_number":null,
"address":null,
"creation_date":"2014-05-20T16:47:47-05:00",
"external_id":null,
"store": {
"reference": "OPENPAY02DQ35YOY7",
"barcode_url": "https://sandbox-api.openpay.pe/barcode/OPENPAY02DQ35YOY7?width=1&height=45&text=false"
},
"clabe": "646180109400423323"
}
Crea un objeto cliente.
Petición
Propiedad | Descripción |
---|---|
external_id | string (opcional, longitud = 100) Identificador externo único para el cliente asignado por el comercio. |
name | string (requerido, longitud = 100) Nombre(s) del cliente. |
last_name | string (opcional, longitud = 100) Apellidos del cliente. |
string (requerido, longitud = 100) Cuenta de correo electrónico del Cliente. |
|
requires_account | boolean (opcional, default = false) Enviar con valor true si requiere que el cliente se cree con cuenta para manejo del saldo. |
phone_number | string (opcional, longitud = 100) Número telefónico del Cliente. |
address | object (opcional) Dirección del Cliente. Usada comúnmente como dirección de envío. |
Respuesta
Un objeto cliente en caso de que se hayan enviado todos los datos correctamente, o una respuesta de error si ocurrió algún problema en la creación.
Actualizar un cliente
Definición
PUT https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/customers/{CUSTOMER_ID}
<?
$customer = $openpay->customers->get(customerId);
$customer->save();
?>
openpayAPI.customers().update(Customer customer);
openpayAPI.CustomerService.Update(Customer customer);
openpay.customers.update(customerId, customerRequest, callback);
@customers=@openpay.create(:customers)
@customers.update(request_hash)
Ejemplo de petición
curl https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/customers/anbnldwgni1way3yp2dw \
-u sk_e568c42a6c384b7ab02cd47d2e407cab: \
-H "Content-type: application/json" \
-X PUT -d '{
"name": "customer name",
"email": "customer_email@me.com",
"address":{
"city":"Queretaro",
"state":"Queretaro",
"line1":"Calle 10",
"postal_code":"76000",
"line2":"col. san pablo",
"line3":"entre la calle 1 y la 2",
"country_code":"PE"
},
"phone_number":"44209087654"
}'
<?
$openpay = Openpay::getInstance('moiep6umtcnanql3jrxp', 'sk_3433941e467c1055b178ce26348b0fac');
$customer = $openpay->customers->get('a9ualumwnrcxkl42l6mh');
$customer->name = 'Juan';
$customer->last_name = 'Godinez';
$customer->save();
?>
OpenpayAPI api = new OpenpayAPI("https://sandbox-api.openpay.pe", "sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Customer request = new Customer();
request.name("Julian Gerardo");
request.lastName("López Martínez");
request.email("julian.martinez@gmail.com");
request.phoneNumber("4421432915");
Address address = new Address();
address.city("Queretaro");
address.countryCode("10");
address.state("Queretaro");
address.postalCode("79125");
address.line1("Av. Pie de la cuesta #12");
address.line2("Desarrollo San Pablo");
address.line3("Qro. Qro.");
request.address(address);
request = api.customers().update(request);
OpenpayAPI api = new OpenpayAPI("sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Customer request = new Customer();
request.Name = "Julian Gerardo";
request.LastName = "López Martínez";
request.Email = "julian.martinez@gmail.com";
request.PhoneNumber = "4421432915";
Address address = new Address();
address.City = "Queretaro";
address.CountryCode = "PE";
address.State = "Queretaro";
address.PostalCode = "79125";
address.Line1 = "Av. Pie de la cuesta #12";
address.Line2 = "Desarrollo San Pablo";
address.Line3 = "Qro. Qro.";
request.Address = address;
request = api.CustomerService.Update(request);
var customerRequest = {
'name': 'customer name',
'email': 'customer_email@me.com',
'address':{
'city':'Queretaro',
'state':'Queretaro',
'line1':'Calle 10',
'postal_code':'76000',
'line2':'col. san pablo',
'line3':'entre la calle 1 y la 2',
'country_code':'PE'
}
};
openpay.customers.update('anbnldwgni1way3yp2dw', customerRequest, function(error, customer) {
// ...
});
@openpay=OpenpayApi.new("mzdtln0bmtms6o3kck8f","sk_e568c42a6c384b7ab02cd47d2e407cab")
@customers=@openpay.create(:customers)
address_hash={
"line1" => "Calle 10",
"line2" => "col. san pablo",
"line3" => "entre la calle 1 y la 2",
"state" => "Queretaro",
"city" => "Queretaro",
"postal_code" => "76000",
"country_code" => "PE"
}
request_hash={
"external_id" => nil,
"name" => "customer name",
"last_name" => nil,
"email" => "customer_email@me.com",
"requires_account" => true,
"phone_number" => "44209087654",
"address" => address_hash
}
response_hash=@customers.update(request_hash.to_hash)
Ejemplo de respuesta
{
"id":"anbnldwgni1way3yp2dw",
"name":"customer name",
"last_name":null,
"email":"customer_email@me.com",
"phone_number":"44209087654",
"address":{
"line1":"Calle 10",
"line2":"col. san pablo",
"line3":"entre la calle 1 y la 2",
"state":"Queretaro",
"city":"Queretaro",
"postal_code":"76000",
"country_code":"PE"
},
"store": {
"reference": "OPENPAY02DQ35YOY7",
"barcode_url": "https://sandbox-api.openpay.pe/barcode/OPENPAY02DQ35YOY7?width=1&height=45&text=false"
},
"clabe": "646180109400423323",
"creation_date":"2014-05-20T16:47:47-05:00",
"external_id":null
}
Actualiza uno o más datos del cliente.
Petición
Propiedad | Descripción |
---|---|
name | string (requerido, longitud = 100) Nombre(s) del cliente. |
last_name | string (opcional, longitud = 100) Apellidos del cliente. |
string (requerido, longitud = 100) Cuenta de correo electrónico del Cliente. |
|
phone_number | string (opcional, longitud = 100) Número telefónico del Cliente. |
address | object Dirección del Cliente. Usada comúnmente como dirección de envío. |
Respuesta
Regresa un objeto cliente con la información actualizada, o una respuesta de error si ocurrió algún problema en la actualización.
Obtener un cliente existente
Definición
GET https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/customers/{CUSTOMER_ID}
<?
$customer = $openpay->customers->get(customerId);
?>
openpayAPI.customers().get(String customerId);
openpayAPI.CustomerService.Update(string customer_id);
openpay.customers.get(customerId, callback);
@customers=@openpay.create(:customers)
@customers.get(customer_id)
Ejemplo de petición
curl https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/customers/anbnldwgni1way3yp2dw \
-u sk_e568c42a6c384b7ab02cd47d2e407cab: \
-H "Content-type: application/json"
<?
$openpay = Openpay::getInstance('moiep6umtcnanql3jrxp', 'sk_3433941e467c1055b178ce26348b0fac');
$customer = $openpay->customers->get('a9ualumwnrcxkl42l6mh');
?>
OpenpayAPI api = new OpenpayAPI("https://sandbox-api.openpay.pe", "sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Customer customer = api.customers().get("a9pvykxz4g5rg0fplze0");
OpenpayAPI api = new OpenpayAPI("sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Customer customer = api.CustomerService.Update("a9pvykxz4g5rg0fplze0");
openpay.customers.get('a9pvykxz4g5rg0fplze0', function(error, customer) {
// ...
});
@openpay=OpenpayApi.new("mzdtln0bmtms6o3kck8f","sk_e568c42a6c384b7ab02cd47d2e407cab")
@customers=@openpay.create(:customers)
response_hash=@customers.get("asynwirguzkgq2bizogo")
Ejemplo de respuesta
{
"id":"anbnldwgni1way3yp2dw",
"name":"customer name",
"last_name":null,
"email":"customer_email@me.com",
"phone_number":"44209087654",
"address":{
"line1":"Calle 10",
"line2":"col. san pablo",
"line3":"entre la calle 1 y la 2",
"state":"Queretaro",
"city":"Queretaro",
"postal_code":"76000",
"country_code":"PE"
},
"store": {
"reference": "OPENPAY02DQ35YOY7",
"barcode_url": "https://sandbox-api.openpay.pe/barcode/OPENPAY02DQ35YOY7?width=1&height=45&text=false"
},
"clabe": "646180109400423323",
"creation_date":"2014-05-20T16:47:47-05:00",
"external_id":null
}
Obtiene la información actual de un cliente existente. Solo es necesario especificar el identificador que fue regresado al momento de crear el cliente.
Petición
Propiedad | Descripción |
---|---|
id | string (requerido, longitud = 45) Identificador único del cliente que se desea obtener. |
Respuesta
Si el identificador existe regresa un objeto cliente con la información del cliente.
Eliminar un cliente
Definición
DELETE https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/customers/{CUSTOMER_ID}
<?
$customer = $openpay->customers->get(customerId);
$customer->delete();
?>
openpayAPI.customers().delete(String customerId);
openpayAPI.CustomerService.Delete(string customer_id);
openpay.customers.delete(customerId, callback);
@customers=@openpay.create(:customers)
@customers.delete(customer_id)
Ejemplo de petición
curl https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/customers/anbnldwgni1way3yp2dw \
-u sk_e568c42a6c384b7ab02cd47d2e407cab: \
-H "Content-type: application/json" \
-X DELETE
<?
$openpay = Openpay::getInstance('moiep6umtcnanql3jrxp', 'sk_3433941e467c1055b178ce26348b0fac');
$customer = $openpay->customers->get('a9ualumwnrcxkl42l6mh');
$customer->delete();
?>
OpenpayAPI api = new OpenpayAPI("https://sandbox-api.openpay.pe", "sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
api.customers().delete("a9pvykxz4g5rg0fplze0");
OpenpayAPI api = new OpenpayAPI("sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
api.CustomerService.Delete("a9pvykxz4g5rg0fplze0");
openpay.customers.delete('a9pvykxz4g5rg0fplze0', function(error) {
// ...
});
@openpay=OpenpayApi.new("mzdtln0bmtms6o3kck8f","sk_e568c42a6c384b7ab02cd47d2e407cab")
@customers=@openpay.create(:customers)
response_hash=@customers.delete("asynwirguzkgq2bizogo")
Elimina un cliente permanentemente. Openpay mantiene los registros de las operaciones. El cliente no se podrá borrar si su saldo es mayor a 0 (para cliente con manejo de saldo)
Petición
Propiedad | Descripción |
---|---|
id | string (requerido, longitud = 45) Identificador único del cliente a borrar. |
Respuesta
Si el cliente se borra correctamente la respuesta es vacía, si no se puede borrar se regresa un objeto error indicando el motivo.
Listado de clientes
Definición
GET https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/customers
<?
$customerList = $openpay->customers->getList(findDataRequest);
?>
openpayAPI.customers().list(SearchParams request);
openpayAPI.CustomerService.List(SearchParams request = null);
openpay.customers.list(callback);
openpay.customers.list(searchParams, callback);
@customers=@openpay.create(:customers)
@customers.all
Ejemplo de petición
curl -g "https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/customers?creation[gte]=2013-11-01&limit=2" \
-u sk_e568c42a6c384b7ab02cd47d2e407cab: \
-H "Content-type: application/json"
<?
$openpay = Openpay::getInstance('moiep6umtcnanql3jrxp', 'sk_3433941e467c1055b178ce26348b0fac');
$findDataRequest = array(
'creation[gte]' => '2013-01-01',
'creation[lte]' => '2013-12-31',
'offset' => 0,
'limit' => 5);
$customerList = $openpay->customers->getList($findDataRequest);
?>
final Calendar dateGte = Calendar.getInstance();
final Calendar dateLte = Calendar.getInstance();
dateGte.set(2014, 5, 1, 0, 0, 0);
dateLte.set(2014, 5, 15, 0, 0, 0);
OpenpayAPI api = new OpenpayAPI("https://sandbox-api.openpay.pe", "sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
SearchParams request = new SearchParams();
request.creationGte(dateGte.getTime());
request.creationLte(dateLte.getTime());
request.offset(0);
request.limit(100);
List<Customer> customers = api.customers().list(request);
OpenpayAPI api = new OpenpayAPI("sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
SearchParams request = new SearchParams();
request.CreationGte = new Datetime(2014, 5, 1);
request.CreationLte = new DateTime(2014, 5, 15);
request.Offset = 0;
request.Limit = 100;
List<Customer> customers = api.CustomerService.List(request);
var searchParams = {
'creation[gte]' : '2013-11-01',
'limit' : 2
};
openpay.customers.list(searchParams, function(error, list) {
// ...
});
@openpay=OpenpayApi.new("mzdtln0bmtms6o3kck8f","sk_e568c42a6c384b7ab02cd47d2e407cab")
@customers=@openpay.create(:customers)
response_hash=@customers.all
Ejemplo de respuesta
[{
"id":"cpjdhf754ythr65yu9k7q",
"creation_date":"2013-11-08T12:04:46-06:00",
"name":"Rodrigo",
"last_name":"Velazco Perez",
"email":"rodrigo.velazco@payments.com",
"phone_number":"4425667045",
"status":"active",
"balance":142.5,
"store": {
"reference": "OPENPAY02DQ35YOY7",
"barcode_url": "https://sandbox-api.openpay.pe/barcode/OPENPAY02DQ35YOY7?width=1&height=45&text=false"
},
"clabe": "646180109400423323"
}, {
"id":"cz4nkhrlcu9k7qd4lwqx",
"creation_date":"2013-11-07T14:54:46-06:00",
"name":"Eriberto",
"last_name":"Rodriguez Lopez",
"email":"eriberto.rodriguez@payments.com",
"phone_number":"442",
"status":"active",
"balance":103,
"store": {
"reference": "OPENPAY02DQWERWJ3",
"barcode_url": "https://sandbox-api.openpay.pe/barcode/OPENPAY02DQWERWJ3?width=1&height=45&text=false"
},
"clabe": "646180109400423323"
}]
Regresa una lista de los cliente registrados, si desea delimitar el resultado se pueden utilizar los filtros.
Petición
Puede realizar una búsqueda utilizando los siguiente parámetros como filtros.
Propiedad | Descripción |
---|---|
external_id | string Identificador único del cliente asignado por el comercio que se desea obtener. |
creation | date Igual a la fecha de creación del cliente. Formato yyyy-mm-dd |
creation[gte] | date Mayor a la fecha de creación del cliente .Formato yyyy-mm-dd |
creation[lte] | date Menor a la fecha de creación del cliente .Formato yyyy-mm-dd |
offset | numeric Número de registros a omitir al inicio, por defecto 0. |
limit | numeric Número de registros que se requieren, por defecto 10. |
Respuesta
Regresa un arreglo de objetos cliente.
Tarjetas
Dentro de la plataforma Openpay podrás agregar tarjetas a la cuenta del cliente, eliminarlas, recuperar alguna en específico y listarlas.
Se pueden almacenar múltiples tarjetas de débito y/o crédito a nivel cliente o a nivel comercio para realizar cargos posteriormente sin la necesidad de introducir nuevamente la información.
Objeto Tarjeta
Ejemplo de objeto
{
"type":"debit",
"brand":"mastercard",
"address":{
"line1":"Av 5 de Febrero",
"line2":"Roble 207",
"line3":"col carrillo",
"state":"Queretaro",
"city":"Querétaro",
"postal_code":"76900",
"country_code":"PE"
},
"id":"kgipbqixvjg3gbzowl7l",
"card_number":"1111",
"holder_name":"Juan Perez Ramirez",
"expiration_year":"20",
"expiration_month":"12",
"allows_charges":true,
"allows_payouts":false,
"creation_date":"2013-12-12T17:50:00-06:00",
"bank_name":"DESCONOCIDO",
"bank_code":"000",
"customer_id":"a2b79p8xmzeyvmolqfja",
"points_card":true
}
Propiedad | Descripción |
---|---|
id | string Identificador único de la tarjeta. |
creation_date | datetime Fecha y hora en que se creó la tarjeta en formato ISO 8601 |
holder_name | string Nombre del tarjeta habiente. |
card_number | numeric Número de tarjeta, puede ser de 16 o 19 dígitos. |
cvv2 | string Código de seguridad como aparece en la parte de atrás de la tarjeta. Generalmente 3 dígitos. |
expiration_month | numeric Mes de expiración tal como aparece en la tarjeta. |
expiration_year | numeric Año de expiración tal como aparece en la tarjeta. |
address | object Dirección de facturación del tarjeta habiente. |
allows_charges | boolean Permite conocer si se pueden realizar cargos a la tarjeta. |
allows_payouts | boolean Permite conocer si se pueden realizar envíos de pagos a la tarjeta. |
brand | string Marca de la tarjeta: visa, mastercard, carnet o american express. |
type | string Tipo de la tarjeta: debit, credit, cash, etc. |
bank_name | string Nombre del banco emisor. |
bank_code | string Código del banco emisor. |
customer_id | string Identificador del cliente al que pertenece la tarjeta. Si la tarjeta es a nivel comercio este valor será null. |
points_card | boolean Indica si la tarjeta soporta el pago con puntos. |
Crear una tarjeta
Definición
Comercio
POST https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/cards
Cliente
POST https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/customers/{CUSTOMER_ID}/cards
<?
//Cliente
$customer = $openpay->customers->get(customerId);
$card = $customer->cards->add(cardDataRequest);
//Comercio
$card = $openpay->cards->add(cardDataRequest);
?>
//Cliente
openpayAPI.cards().create(String customerId, Card request);
//Comercio
openpayAPI.cards().create(Card request);
//Cliente
openpayAPI.CardService.Create(string customer_id, Card card);
//Comercio
openpayAPI.CardService.Create(Card card);
// Comercio
openpay.cards.create(cardRequest, callback);
// Cliente
openpay.customers.cards.create(customerId, cardRequest, callback);
#Cliente
@cards=@openpay.create(:cards)
@cards.create(request_hash, customer_id)
#Comercio
@cards=@openpay.create(:cards)
@cards.create(request_hash)
Ejemplo de petición con cliente
curl https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/customers/ag4nktpdzebjiye1tlze/cards \
-u sk_e568c42a6c384b7ab02cd47d2e407cab: \
-H "Content-type: application/json" \
-X POST -d '{
"card_number":"4111111111111111",
"holder_name":"Juan Perez Ramirez",
"expiration_year":"20",
"expiration_month":"12",
"cvv2":"110",
"device_session_id" : "kR1MiQhz2otdIuUlQkbEyitIqVMiI16f"
}'
<?
$openpay = Openpay::getInstance('moiep6umtcnanql3jrxp', 'sk_3433941e467c1055b178ce26348b0fac');
$cardDataRequest = array(
'holder_name' => 'Teofilo Velazco',
'card_number' => '4916394462033681',
'cvv2' => '123',
'expiration_month' => '12',
'expiration_year' => '15',
'device_session_id' => 'kR1MiQhz2otdIuUlQkbEyitIqVMiI16f',
'address' => array(
'line1' => 'Privada Rio No. 12',
'line2' => 'Co. El Tintero',
'line3' => '',
'postal_code' => '76920',
'state' => 'Querétaro',
'city' => 'Querétaro.',
'country_code' => 'PE'));
$customer = $openpay->customers->get('a9ualumwnrcxkl42l6mh');
$card = $customer->cards->add($cardDataRequest);
?>
OpenpayAPI api = new OpenpayAPI("https://sandbox-api.openpay.pe", "sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Card request = new Card();
request.holderName("Juan Perez Ramirez");
request.cardNumber("4111111111111111");
request.cvv2("110");
request.expirationMonth(12);
request.expirationYear(20);
request.deviceSessionId("kR1MiQhz2otdIuUlQkbEyitIqVMiI16f");
Address address = new Address();
address.city("Queretaro");
address.countryCode("10");
address.state("Queretaro");
address.postalCode("79125");
address.line1("Av. Pie de la cuesta #12");
address.line2("Desarrollo San Pablo");
address.line3("Qro. Qro.");
request.address(address);
request = api.cards().create("a9pvykxz4g5rg0fplze0", request);
OpenpayAPI api = new OpenpayAPI("sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Card request = new Card();
request.HolderName = "Juan Perez Ramirez";
request.CardNumber = "4111111111111111";
request.Cvv2 = "110";
request.ExpirationMonth = "12";
request.ExpirationYear = "20";
request.DeviceSessionId = "kR1MiQhz2otdIuUlQkbEyitIqVMiI16f";
Address address = new Address();
address.City = "Queretaro";
address.CountryCode = "PE";
address.State = "Queretaro";
address.PostalCode = "79125";
address.Line1 = "Av. Pie de la cuesta #12";
address.Line2 = "Desarrollo San Pablo";
address.Line3 = "Qro. Qro.";
request.Address = address;
request = api.CardService.Create("a9pvykxz4g5rg0fplze0", request);
var cardRequest = {
'card_number':'4111111111111111',
'holder_name':'Juan Perez Ramirez',
'expiration_year':'20',
'expiration_month':'12',
'cvv2':'110',
'device_session_id':'kR1MiQhz2otdIuUlQkbEyitIqVMiI16f'
};
openpay.customers.cards.create('a9pvykxz4g5rg0fplze0', cardRequest, function(error, card) {
// ...
});
@openpay=OpenpayApi.new("mzdtln0bmtms6o3kck8f","sk_e568c42a6c384b7ab02cd47d2e407cab")
@cards=@openpay.create(:cards)
address_hash={
"line1" => "Calle 10",
"line2" => "col. san pablo",
"line3" => "entre la calle 1 y la 2",
"state" => "Queretaro",
"city" => "Queretaro",
"postal_code" => "76000",
"country_code" => "PE"
}
request_hash={
"holder_name" => "Juan Perez Ramirez",
"card_number" => "411111XXXXXX1111",
"cvv2" => "110",
"expiration_month" => "12",
"expiration_year" => "20",
"device_session_id" => "kR1MiQhz2otdIuUlQkbEyitIqVMiI16f",
"address" => address_hash
}
response_hash=@cards.create(request_hash.to_hash, "asynwirguzkgq2bizogo")
Ejemplo de respuesta
{
"id":"ktrpvymgatocelsciak7",
"type":"debit",
"brand":"visa",
"card_number":"411111XXXXXX1111",
"holder_name":"Juan Perez Ramirez",
"expiration_year":"20",
"expiration_month":"12",
"allows_charges":true,
"allows_payouts":true,
"creation_date":"2014-05-21T17:31:01-05:00",
"bank_name":"Banamex",
"customer_id":"ag4nktpdzebjiye1tlze",
"bank_code":"002"
}
Cuando se crea una tarjeta debe especificarse cliente, si no se especifica el cliente la tarjeta quedará registrada para la cuenta del comercio. Una vez guardada la tarjeta no se puede obtener el número y código de seguridad.
Al momento de guardar la tarjeta se generará un id que podrá ser usado para hacer cargos a la tarjeta, envíos a una tarjeta o simplemente obtener la información no sensible de la tarjeta.
Cuando se crea una tarjeta puede usarse o no la implementación del sistema antifraude. La propiedad device_session_id
deberá ser generada desde el API JavaScript, véase Fraud detection using device data.
Petición
Propiedad | Descripción |
---|---|
holder_name | string (requerido, longitud = 80) Nombre del tarjeta habiente. |
card_number | numeric (requerido) Número de tarjeta puede ser de 16 o 19 dígitos. |
cvv2 | string (requerido) Código de seguridad como aparece en la parte de atrás de la tarjeta. Generalmente 3 dígitos. |
expiration_month | numeric (requerido) Mes de expiración tal como aparece en la tarjeta. |
expiration_year | numeric (requerido) Año de expiración tal como aparece en la tarjeta. |
device_session_id | string (opcional, longitud = 255) Identificador del dispositivo generado con la herramienta antifraudes. |
address | object Dirección de facturación del tarjeta habiente. |
Respuesta
Regresa un objeto tarjeta cuando se creó correctamente o una respuesta de error si ocurrió algún problema en la creación.
Crear una tarjeta con token
Definición
Comercio
POST https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/cards
Cliente
POST https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/customers/{CUSTOMER_ID}/cards
<?
//Cliente
$customer = $openpay->customers->get(customerId);
$card = $customer->cards->add(cardDataRequest);
//Comercio
$card = $openpay->cards->add(cardDataRequest);
?>
//Cliente
openpayAPI.cards().create(String customerId, Card card);
//Comercio
openpayAPI.cards().create(Card card);
//Cliente
openpayAPI.CardService.Create(string customer_id, Card request);
//Comercio
openpayAPI.CardService.Create(Card request);
// Comercio
openpay.cards.create(cardRequest, callback);
// Cliente
openpay.customers.cards.create(customerId, cardRequest, callback);
#Cliente
@cards=@openpay.create(:cards)
@cards.create(request_hash, customer_id)
#Comercio
@cards=@openpay.create(:cards)
@cards.create(request_hash)
Ejemplo de petición con cliente
curl https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/customers/ag4nktpdzebjiye1tlze/cards \
-u sk_e568c42a6c384b7ab02cd47d2e407cab: \
-H "Content-type: application/json" \
-X POST -d '{
"token_id":"tokgslwpdcrkhlgxqi9a",
"device_session_id":"8VIoXj0hN5dswYHQ9X1mVCiB72M7FY9o"
}'
<?
$openpay = Openpay::getInstance('moiep6umtcnanql3jrxp', 'sk_3433941e467c1055b178ce26348b0fac');
$cardDataRequest = array(
'token_id' => 'tokgslwpdcrkhlgxqi9a',
'device_session_id' => '8VIoXj0hN5dswYHQ9X1mVCiB72M7FY9o'
);
$customer = $openpay->customers->get('a9ualumwnrcxkl42l6mh');
$card = $customer->cards->add($cardDataRequest);
?>
OpenpayAPI api = new OpenpayAPI("https://sandbox-api.openpay.pe", "sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Card request = new Card();
request.tokenId("tokgslwpdcrkhlgxqi9a");
request.deviceSessionId("8VIoXj0hN5dswYHQ9X1mVCiB72M7FY9o");
request = api.cards().create("a9pvykxz4g5rg0fplze0", request);
OpenpayAPI api = new OpenpayAPI("sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Card request = new Card();
request.TokenId = "tokgslwpdcrkhlgxqi9a";
request.DeviceSessionId = "8VIoXj0hN5dswYHQ9X1mVCiB72M7FY9o";
request = api.CardService.Create("a9pvykxz4g5rg0fplze0", request);
var cardRequest = {
'token_id' : 'tokgslwpdcrkhlgxqi9a',
'device_session_id' : '8VIoXj0hN5dswYHQ9X1mVCiB72M7FY9o'
}
openpay.customers.cards.create('a9pvykxz4g5rg0fplze0', cardRequest, function(error, card) {
// ...
});
@openpay=OpenpayApi.new("mzdtln0bmtms6o3kck8f","sk_e568c42a6c384b7ab02cd47d2e407cab")
@cards=@openpay.create(:cards)
request_hash={
"token_id" => "tokgslwpdcrkhlgxqi9a",
"device_session_id" => "8VIoXj0hN5dswYHQ9X1mVCiB72M7FY9o"
}
response_hash=@cards.create(request_hash.to_hash, "asynwirguzkgq2bizogo")
Ejemplo de respuesta
{
"type":"credit",
"brand":"visa",
"id":"kso4st83wxaibffyt6su",
"card_number":"4242",
"holder_name":"Juan Perez Ramirez",
"expiration_year":"15",
"expiration_month":"12",
"allows_charges":true,
"allows_payouts":false,
"creation_date":"2014-02-12T10:57:09-06:00",
"bank_name":"BANCOMER",
"bank_code":"012",
"customer_id":"a2b79p8xmzeyvmolqfja"
}
Crea una tarjeta a partir de un token obtenido desde el navegador o dispositivo del cliente. Esta forma evita que la información sensible de la tarjeta pase por tus servidores.
Petición
Propiedad | Descripción |
---|---|
token_id | string (requerido, longitud = 45) Identificador del token generado en el navegador o dispositivo del cliente. |
device_session_id | string (requerido, longitud = 255) Identificador del dispositivo generado con la herramienta antifraudes |
Respuesta
Regresa un objeto tarjeta
Obtener una tarjeta
Definición
Comercio
GET https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/cards/{CARD_ID}
Cliente
GET https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/customers/{CUSTOMER_ID}/cards/{CARD_ID}
<?
//Cliente
$customer = $openpay->customers->get(customerId);
$card = $customer->cards->get(cardId);
//Comercio
$card = $openpay->cards->get(cardId);
?>
//Cliente
openpayAPI.cards().get(String customerId, String cardId);
//Comercio
openpayAPI.cards().get(String cardId);
//Cliente
openpayAPI.CardService.Get(string customer_id, string card_id);
//Comercio
openpayAPI.CardService.Get(string card_id);
// Comercio
openpay.cards.get(cardId, callback);
// Cliente
openpay.customers.cards.get(customerId, cardId, callback);
#Cliente
@cards=@openpay.create(:cards)
@cards.get(card_id, customer_id)
#Comercio
@cards=@openpay.create(:cards)
@cards.get(card_id)
Ejemplo de petición con cliente
curl https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/customers/ag4nktpdzebjiye1tlze/cards/ktrpvymgatocelsciak7 \
-u sk_e568c42a6c384b7ab02cd47d2e407cab: \
-H "Content-type: application/json"
<?
$openpay = Openpay::getInstance('moiep6umtcnanql3jrxp', 'sk_3433941e467c1055b178ce26348b0fac');
$customer = $openpay->customers->get('a9ualumwnrcxkl42l6mh');
$card = $customer->cards->get('k9pn8qtsvr7k7gxoq1r5');
?>
OpenpayAPI api = new OpenpayAPI("https://sandbox-api.openpay.pe", "sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Card card = api.cards().get("a9pvykxz4g5rg0fplze0", "ktrpvymgatocelsciak7");
OpenpayAPI api = new OpenpayAPI("sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Card card = api.CardService.Get("a9pvykxz4g5rg0fplze0", "ktrpvymgatocelsciak7");
openpay.customers.cards.get('a9pvykxz4g5rg0fplze0', 'ktrpvymgatocelsciak7', function(error, card){
// ...
});
@openpay=OpenpayApi.new("mzdtln0bmtms6o3kck8f","sk_e568c42a6c384b7ab02cd47d2e407cab")
@cards=@openpay.create(:cards)
response_hash=@cards.get("ktrpvymgatocelsciak7", "asynwirguzkgq2bizogo")
Ejemplo de respuesta
{
"id":"ktrpvymgatocelsciak7",
"type":"debit",
"brand":"visa",
"card_number":"411111XXXXXX1111",
"holder_name":"Juan Perez Ramirez",
"expiration_year":"20",
"expiration_month":"12",
"allows_charges":true,
"allows_payouts":true,
"creation_date":"2014-05-21T17:31:01-05:00",
"bank_name":"Banamex",
"customer_id":"ag4nktpdzebjiye1tlze",
"bank_code":"002"
}
Obtiene los detalles de una tarjeta solicitándola con su id.
Petición
Propiedad | Descripción |
---|---|
id | string (requerido, longitud = 45) Identificador único de la tarjeta |
Respuesta
Regresa un objeto tarjeta
Eliminar una tarjeta
Definición
Comercio
DELETE https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/cards/{CARD_ID}
Cliente
DELETE https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/customers/{CUSTOMER_ID}/cards/{CARD_ID}
<?
//Cliente
$customer = $openpay->customers->get(customerId);
$card = $customer->cards->get(cardId);
$card->delete();
//Comercio
$card = $openpay->cards->get(cardId);
$card->delete();
?>
//Cliente
openpayAPI.cards().delete(String customerId, String cardId);
//Comercio
openpayAPI.cards().delete(String cardId);
//Cliente
openpayAPI.CardService.Delete(string customer_id, string card_id);
//Comercio
openpayAPI.CardService.Delete(string card_id);
// Comercio
openpay.cards.delete(cardId, callback);
// Cliente
openpay.customers.cards.delete(customerId, cardId, callback);
#Cliente
@cards=@openpay.create(:cards)
@cards.delete(card_id, customer_id)
#Comercio
@cards=@openpay.create(:cards)
@cards.delete(card_id)
Ejemplo de petición con cliente
curl https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/customers/ag4nktpdzebjiye1tlze/cards/ktrpvymgatocelsciak7 \
-u sk_e568c42a6c384b7ab02cd47d2e407cab: \
-X DELETE
<?
$openpay = Openpay::getInstance('moiep6umtcnanql3jrxp', 'sk_3433941e467c1055b178ce26348b0fac');
$customer = $openpay->customers->get('a9ualumwnrcxkl42l6mh');
$card = $customer->cards->get('k9pn8qtsvr7k7gxoq1r5');
$card->delete();
?>
OpenpayAPI api = new OpenpayAPI("https://sandbox-api.openpay.pe", "sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
api.cards().delete("a9pvykxz4g5rg0fplze0", "ktrpvymgatocelsciak7");
OpenpayAPI api = new OpenpayAPI("sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
api.CardService.Delete("a9pvykxz4g5rg0fplze0", "ktrpvymgatocelsciak7");
openpay.customers.cards.delete('a9pvykxz4g5rg0fplze0', 'ktrpvymgatocelsciak7', function(error) {
// ...
});
@openpay=OpenpayApi.new("mzdtln0bmtms6o3kck8f","sk_e568c42a6c384b7ab02cd47d2e407cab")
@cards=@openpay.create(:cards)
response_hash=@cards.delete("ktrpvymgatocelsciak7", "asynwirguzkgq2bizogo")
Elimina una tarjeta del cliente o comercio. Una vez eliminada no se permitirá hacer movimientos, sin embargo, se mantendrán todos los registros de operaciones que haya realizado y se podrán consultar en el dashboard.
Para eliminarla sólo es necesario proporcionar el identificador de la tarjeta.
Petición
Propiedad | Descripción |
---|---|
id | string (requerido, longitud = 45) Identificador único de la tarjeta |
Respuesta
Si la tarjeta se borra correctamente la respuesta es vacía, si no se puede borrar se regresa un objeto error indicando el motivo.
Listado de tarjetas
Definición
Comercio
GET https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/customers
Cliente
GET https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/customers/{CUSTOMER_ID}/cards
<?
//Clientes
$customer = $openpay->customers->get(customerId);
$cardList = $customer->cards->getList(findDataRequest);
//Comercio
$cardList = $openpay->cards->getList(findDataRequest);
?>
//Cliente
openpayAPI.cards().list(String customerId, SearchParams request);
//Comercio
openpayAPI.cards().list(SearchParams request);
//Cliente
openpayAPI.CardService.List(string customer_id, SearchParams request = null);
//Comercio
openpayAPI.CardService.List(SearchParams request = null);
// Comercio
openpay.cards.list(callback);
openpay.cards.list(searchParams, callback);
// Cliente
openpay.cards.list(customerId, callback);
openpay.cards.list(customerId, searchParams, callback);
#Cliente
@cards=@openpay.create(:cards)
@cards.all(customer_id)
#Comercio
@cards=@openpay.create(:cards)
@cards.all
Ejemplo de petición con cliente
curl -g "https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/customers/ag4nktpdzebjiye1tlze/cards?limit=2" \
-u sk_e568c42a6c384b7ab02cd47d2e407cab:
<?
$openpay = Openpay::getInstance('moiep6umtcnanql3jrxp', 'sk_3433941e467c1055b178ce26348b0fac');
$findDataRequest = array(
'creation[gte]' => '2013-01-01',
'creation[lte]' => '2013-12-31',
'offset' => 0,
'limit' => 5);
$customer = $openpay->customers->get('a9ualumwnrcxkl42l6mh');
$cardList = $customer->cards->getList($findDataRequest);
?>
final Calendar dateGte = Calendar.getInstance();
final Calendar dateLte = Calendar.getInstance();
dateGte.set(2014, 5, 1, 0, 0, 0);
dateLte.set(2014, 5, 15, 0, 0, 0);
OpenpayAPI api = new OpenpayAPI("https://sandbox-api.openpay.pe", "sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
SearchParams request = new SearchParams();
request.creationGte(dateGte.getTime());
request.creationLte(dateLte.getTime());
request.offset(0);
request.limit(100);
List<Card> cards = api.cards().list("a9pvykxz4g5rg0fplze0", request);
OpenpayAPI api = new OpenpayAPI("sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
SearchParams request = new SearchParams();
request.CreationGte = new Datetime(2014, 5, 1);
request.CreationLte = new DateTime(2014, 5, 15);
request.Offset = 0;
request.Limit = 100;
List<Card> cards = api.CardService.List("a9pvykxz4g5rg0fplze0", request);
var searchParams = {
'limit' : 2
};
openpay.customers.cards.list('ag4nktpdzebjiye1tlze', searchParams, function(error, list){
// ...
});
@openpay=OpenpayApi.new("mzdtln0bmtms6o3kck8f","sk_e568c42a6c384b7ab02cd47d2e407cab")
@cards=@openpay.create(:cards)
response_hash=@cards.all("asynwirguzkgq2bizogo")
Ejemplo de respuesta
[
{
"id":"kxq1rpdymlcpxekvjsxm",
"card_number":"1118",
"holder_name":"Pedro Paramo",
"expiration_year":"15",
"expiration_month":"12",
"allows_charges":true,
"allows_payouts":true,
"creation_date":"2013-11-20T09:22:25-06:00",
"bank_name":"BBVA BANCOMER",
"bank_code":"012",
"type":"debit",
"brand":"mastercard"
},
{
"id":"kgjy0jiami01kkpdoywr",
"card_number":"1111",
"holder_name":"Pedro Paramo",
"expiration_year":"15",
"expiration_month":"12",
"allows_charges":true,
"allows_payouts":true,
"creation_date":"2013-11-19T13:26:12-06:00",
"bank_name":"BBVA BANCOMER",
"bank_code":"012",
"type":"debit",
"brand":"mastercard"
}
]
Regresa una lista de las tarjetas registrados por comercio o cliente, si desea delimitar el resultado se pueden utilizar los filtros.
Petición
Puede realizar una búsqueda utilizando los siguiente parámetros como filtros.
Propiedad | Descripción |
---|---|
creation | date Igual a la fecha de creación. Formato yyyy-mm-dd |
creation[gte] | date Mayor a la fecha de creación. Formato yyyy-mm-dd |
creation[lte] | date Menor a la fecha de creación. Formato yyyy-mm-dd |
offset | numeric Número de registros a omitir al inicio, por defecto 0. |
limit | numeric Número de registros que se requieren, por defecto 10. |
Respuesta
Listado de objetos tarjeta registrados de acuerdo a los parámetros proporcionados, ordenadas por fecha de creación en orden descendente.
Actualizar tarjeta
Definición
Comercio
PUT https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/cards/{CARD_ID}
Cliente
PUT https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/customers/{CUSTOMER_ID}/cards/{CARD_ID}
Ejemplo de petición con cliente
curl https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/customers/ag4nktpdzebjiye1tlze/cards/kysc8pycq8hnlzivk1x4 \
-u sk_e568c42a6c384b7ab02cd47d2e407cab: \
-H "Content-type: application/json" \
-X PUT -d '{
"cvv2":"000"
}'
Ejemplo de respuesta
{
}
Actualiza los datos de una tarjeta desde el navegador o dispositivo del cliente. También permite enviar un cvv2 que se usará en el próximo cargo que se realice a esta tarjeta. De esta forma evita que la información sensible de la tarjeta pase por tus servidores.
Petición
Propiedad | Descripción |
---|---|
holder_name | string (opcional) Nombre del tarjeta habiente. |
cvv2 | string (opcional) Código de seguridad como aparece en la parte de atrás de la tarjeta. Generalmente 3 dígitos. |
expiration_month | numeric (opcional) Mes de expiración tal como aparece en la tarjeta. |
expiration_year | numeric (opcional) Año de expiración tal como aparece en la tarjeta. |
merchant_id | string (condicional) ID del comercio. Usado solamente cuando se usa un grupo de comercio. |
Respuesta
Actualmente regresa un JSON sin datos. Considerar que se podría extender la respuesta en el futuro.
Planes
Los planes son recursos en Openpay que permiten crear plantillas para las suscripciones. Con ellos podrás definir la cantidad y frecuencia con la que se realizarán los cargos recurrentes.
Objeto Plan
Ejemplo de objeto
{
"name": "Curso de ingles",
"status": "active",
"amount": 150,
"currency": "PEN",
"id": "patpflacwilazguj6bem",
"creation_date": "2013-12-13T09:43:52-06:00",
"repeat_every": 1,
"repeat_unit": "month",
"retry_times": 2,
"status_after_retry": "cancelled",
"trial_days": 30
}
Propiedad | Descripción |
---|---|
id | string Identificador único del Plan. |
creation_date | datetime Fecha y hora en que se creó el Plan en formato ISO 8601 |
name | string Nombre del Plan. |
amount | numeric Monto que se aplicará cada vez que se cobre la suscripción. Debe ser una cantidad mayor a cero, con hasta 2 dígitos decimales. |
currency | string Moneda usada en la operación, por default es PEN |
repeat_every | numeric Número de unidades tiempo entre los que se cobrará la suscripción. Por ejemplo, repeat_unit=month y repeat_every=2 indica que se cobrará cada 2 meses. |
repeat_unit | string Especifica la frecuencia de cobro. Puede ser semanal(week), mensual(month) o anual(year). |
retry_times | numeric Número de reintentos de cobro de la suscripción. Cuando se agotan los intentos se pone en el estatus determinado por el campo status_after_retry. |
status | string Estatus del Plan puede ser active o deleted. Si el plan se encuentra en estado deleted no se permite registrar nuevas suscripciones, pero las que ya están registradas, se siguen cobrando. |
status_after_retry | string Este campo especifica el status en el que se pondrá la suscripción una vez que se agotaron los intentos. Puede ser: unpaid o cancelled |
trial_days | numeric Número de días de prueba por defecto que tendrá la suscripción. |
Crear un nuevo plan
Definición
POST https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/plans
<?
$plan = $openpay->plans->add(planDataRequest);
?>
openpayAPI.plans().create(Plan request);
openpayAPI.PlanService.Create(Plan plan);
openpay.plans.create(planRequest, callback);
#Cliente
@plans=@openpay.create(:plans)
@plans.create(request_hash)
Ejemplo de petición
curl https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/plans \
-u sk_e568c42a6c384b7ab02cd47d2e407cab: \
-H "Content-type: application/json" \
-X POST -d '{
"amount": 150.00,
"status_after_retry": "cancelled",
"retry_times": 2,
"name": "Curso de ingles",
"repeat_unit": "month",
"trial_days": "30",
"repeat_every": "1"
}'
<?
$openpay = Openpay::getInstance('moiep6umtcnanql3jrxp', 'sk_3433941e467c1055b178ce26348b0fac');
$planDataRequest = array(
'amount' => 150.00,
'status_after_retry' => 'cancelled',
'retry_times' => 2,
'name' => 'Plan Curso Verano',
'repeat_unit' => 'month',
'trial_days' => '30',
'repeat_every' => '1',
'currency' => 'PEN');
$plan = $openpay->plans->add($planDataRequest);
?>
OpenpayAPI api = new OpenpayAPI("https://sandbox-api.openpay.pe", "sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Plan request = new Plan();
request.name("Curso de ingles");
request.amount(new BigDecimal("100.00"));
request.repeatEvery(1, PlanRepeatUnit.WEEK);
request.retryTimes(3);
request.statusAfterRetry(PlanStatusAfterRetry.UNPAID);
request.trialDays(30);
request = api.plans().create(request);
OpenpayAPI api = new OpenpayAPI("sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Plan request = new Plan();
request.Name = "Curso de ingles";
request.Amount = new Decimal(100.00);
request.RepeatEvery = 1;
request.RepeatUnit = "week";
request.RetryTimes = 2;
request.StatusAfterRetry = "unpaid";
request.TrialDays = 30;
request = api.PlanService.Create(request);
var planRequest = {
'amount': 150.00,
'status_after_retry': 'cancelled',
'retry_times': 2,
'name': 'Curso de ingles',
'repeat_unit': 'month',
'trial_days': '30',
'repeat_every': '1'
};
openpay.plans.create(planRequest, function(error, plan){
// ...
});
@openpay=OpenpayApi.new("mzdtln0bmtms6o3kck8f","sk_e568c42a6c384b7ab02cd47d2e407cab")
@plans=@openpay.create(:plans)
request_hash={
"name" => "Curso de ingles",
"amount" => 150.00,
"repeat_every" => "1",
"repeat_unit" => "month",
"retry_times" => 2,
"status_after_retry" => "cancelled",
"trial_days" => "30"
}
response_hash=@plans.create(request_hash.to_hash)
Ejemplo de respuesta
{
"id":"p8e6x3hafqqsbmnoevrt",
"name":"Curso de ingles",
"status":"active",
"amount":150.00,
"currency":"PEN",
"creation_date":"2014-05-22T12:29:31-05:00",
"repeat_every":1,
"repeat_unit":"month",
"retry_times":2,
"status_after_retry":"cancelled",
"trial_days":30
}
Crea un nuevo plan al se podrán suscribir uno o varios clientes.
Petición
Propiedad | Descripción |
---|---|
name | string (requerido, longitud = 255) Nombre del Plan. |
amount | numeric (requerido) Monto que se aplicará cada vez que se cobre la suscripción. Debe ser una cantidad mayor a cero, con hasta 2 dígitos decimales. |
repeat_every | numeric (requerido) Número de unidades tiempo entre los que se cobrara la suscripción. Por ejemplo, repeat_unit=month y repeat_every=2 indica que se cobrara cada 2 meses. |
repeat_unit | numeric (requerido) Especifica la frecuencia de cobro. Puede ser semanal(week), mensual(month) o anual(year). |
retry_times | numeric (opcional) Número de reintentos de cobro de la suscripción. Cuando se agotan los intentos se pone en el estado determinado por el campo status_after_retry. |
status_after_retry | string (requerido, valores = “UNPAID/CANCELLED”) Este campo especifica el status en el que se pondrá la suscripción una vez que se agotaron los intentos. Puede ser: unpaid o cancelled |
trial_days | numeric (requerido) Número de días de prueba por defecto que tendrán las suscripciones que se creen a partir del plan creado. |
Respuesta
Regresa un objeto plan creado o un error en caso de ocurrir algún problema.
Actualizar un plan existente
Definición
PUT https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/plans/{PLAN_ID}
<?
$plan = $openpay->plans->get(planId);
$plan->save();
?>
openpayAPI.plans().update(Plan request);
openpayAPI.PlanService.Update(Plan plan);
openpay.plans.update(planId, planRequest, callback);
#Cliente
@plans=@openpay.create(:plans)
@plans.update(request_hash, plan_id)
Ejemplo de petición
curl https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/plans/p8e6x3hafqqsbmnoevrt \
-u sk_e568c42a6c384b7ab02cd47d2e407cab: \
-H "Content-type: application/json" \
-X PUT -d '{
"name": "Curso de aleman",
"trial_days": "60"
}'
<?
$openpay = Openpay::getInstance('moiep6umtcnanql3jrxp', 'sk_3433941e467c1055b178ce26348b0fac');
$plan = $openpay->plans->get('pduar9iitv4enjftuwyl');
$plan->name = 'Plan Curso de Verano 2014';
$plan->save();
?>
OpenpayAPI api = new OpenpayAPI("https://sandbox-api.openpay.pe", "sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Plan request = new Plan();
request.setId("p8e6x3hafqqsbmnoevrt");
request.name("Curso de ingles");
request.trialDays(30);
request = api.plans().update(request);
OpenpayAPI api = new OpenpayAPI("sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Plan request = new Plan();
request.Id = "p8e6x3hafqqsbmnoevrt";
request.Name = "Curso de ingles";
request.TrialDays = 30;
request = api.PlanService.Update(request);
var planRequest = {
'name': 'Curso de aleman',
'trial_days': 60
};
openpay.plans.update(planId, planRequest, function(error, plan){
// ...
});
@openpay=OpenpayApi.new("mzdtln0bmtms6o3kck8f","sk_e568c42a6c384b7ab02cd47d2e407cab")
@plans=@openpay.create(:plans)
request_hash={
"name" => "Curso de ingles",
"trial_days" => "30"
}
response_hash=@plans.update(request_hash.to_hash, "p8e6x3hafqqsbmnoevrt")
Ejemplo de respuesta
{
"id":"p8e6x3hafqqsbmnoevrt",
"name":"Curso de aleman",
"status":"active",
"amount":150.00,
"currency":"PEN",
"creation_date":"2014-05-22T12:29:31-05:00",
"repeat_every":1,
"repeat_unit":"month",
"retry_times":2,
"status_after_retry":"cancelled",
"trial_days":60
}
Actualiza la información de un plan. Se requiere tener el id del plan y solo se puede actualizar cierta información.
Petición
Propiedad | Descripción |
---|---|
name | string (opcional, longitud = 80) Nombre del Plan. |
trial_days | numeric (opcional) Número de días de prueba por defecto que tendrán las suscripciones que se creen a partir del plan creado. |
Respuesta
Regresa un objeto plan con la información actualizada o una respuesta de error si ocurrió algún problema en la actualización.
Obtener un plan
Definición
GET https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/plans/{PLAN_ID}
<?
$plan = $openpay->plans->get(planId);
?>
openpayAPI.plans().get(String planId);
openpayAPI.PlanService.Get(string plan_id);
openpay.plans.get(planId, callback);
#Cliente
@plans=@openpay.create(:plans)
@plans.get(plan_id)
Ejemplo de petición
curl https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/plans/p8e6x3hafqqsbmnoevrt \
-u sk_e568c42a6c384b7ab02cd47d2e407cab:
<?
$openpay = Openpay::getInstance('moiep6umtcnanql3jrxp', 'sk_3433941e467c1055b178ce26348b0fac');
$plan = $openpay->plans->get('pduar9iitv4enjftuwyl');
?>
OpenpayAPI api = new OpenpayAPI("https://sandbox-api.openpay.pe", "sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Plan plan = api.plans().get("p8e6x3hafqqsbmnoevrt");
OpenpayAPI api = new OpenpayAPI("sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Plan plan = api.PlanService.Get("p8e6x3hafqqsbmnoevrt");
openpay.plans.get('p8e6x3hafqqsbmnoevrt', function(error, plan){
// ...
});
@openpay=OpenpayApi.new("mzdtln0bmtms6o3kck8f","sk_e568c42a6c384b7ab02cd47d2e407cab")
@plans=@openpay.create(:plans)
response_hash=@plans.get("p8e6x3hafqqsbmnoevrt")
Ejemplo de respuesta
{
"id":"p8e6x3hafqqsbmnoevrt",
"name":"Curso de aleman",
"status":"active",
"amount":150.00,
"currency":"PEN",
"creation_date":"2014-05-22T12:29:31-05:00",
"repeat_every":1,
"repeat_unit":"month",
"retry_times":2,
"status_after_retry":"cancelled",
"trial_days":60
}
Obtiene los detalles de un plan.
Petición
Propiedad | Descripción |
---|---|
id | string (requerido, longitud = 45) Identificador del plan. |
Respuesta
Regresa un objeto plan
Eliminar un plan
Definición
DELETE https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/plans/{PLAN_ID}
<?
$customer = $openpay->customers->get(customerId);
$plan = $openpay->plans->get(planId);
$plan->delete();
?>
openpayAPI.plans().delete(String planId);
openpayAPI.PlanService.Delete(string plan_id);
openpay.plans.delete(planId, callback);
#Cliente
@plans=@openpay.create(:plans)
@plans.delete(plan_id)
Ejemplo de petición
curl https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/plans/p8e6x3hafqqsbmnoevrt \
-u sk_e568c42a6c384b7ab02cd47d2e407cab: \
-X DELETE
<?
$openpay = Openpay::getInstance('moiep6umtcnanql3jrxp', 'sk_3433941e467c1055b178ce26348b0fac');
$customer = $openpay->customers->get('a9ualumwnrcxkl42l6mh');
$plan = $openpay->plans->get('pduar9iitv4enjftuwyl');
$plan->delete();
?>
OpenpayAPI api = new OpenpayAPI("https://sandbox-api.openpay.pe", "sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
api.plans().delete("p8e6x3hafqqsbmnoevrt");
OpenpayAPI api = new OpenpayAPI("sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
api.PlanService.Delete("p8e6x3hafqqsbmnoevrt");
openpay.plans.delete('p8e6x3hafqqsbmnoevrt', function(error){
// ...
});
@openpay=OpenpayApi.new("mzdtln0bmtms6o3kck8f","sk_e568c42a6c384b7ab02cd47d2e407cab")
@plans=@openpay.create(:plans)
response_hash=@plans.delete("p8e6x3hafqqsbmnoevrt")
Al eliminar un plan no se permitirán crear mas suscripciones asociadas a él, sin embargo las suscripciones ya asociadas se mantienen y se continuan cobrando.
Petición
Propiedad | Descripción |
---|---|
id | string (requerido, longitud = 45) Identificador del plan a eliminar |
Respuesta
Si el plan se borra correctamente la respuesta es vacía, si no se puede borrar se regresa un objeto error indicando el motivo.
Listado de planes
Definición
GET https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/plans
<?
$planList = $openpay->plans->getList(findDataRequest);
?>
openpayAPI.plans().list(SearchParams request);
openpayAPI.PlanService.List(SearchParams request = null);
openpay.plans.list(callback);
openpay.plans.list(searchParams, callback);
#Cliente
@plans=@openpay.create(:plans)
@plans.all
Ejemplo de petición
curl -g "https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/plans?limit=10" \
-u sk_e568c42a6c384b7ab02cd47d2e407cab:
<?
$openpay = Openpay::getInstance('moiep6umtcnanql3jrxp', 'sk_3433941e467c1055b178ce26348b0fac');
$findDataRequest = array(
'creation[gte]' => '2013-01-01',
'creation[lte]' => '2013-12-31',
'offset' => 0,
'limit' => 5);
$planList = $openpay->plans->getList($findDataRequest);
?>
final Calendar dateGte = Calendar.getInstance();
final Calendar dateLte = Calendar.getInstance();
dateGte.set(2014, 5, 1, 0, 0, 0);
dateLte.set(2014, 5, 15, 0, 0, 0);
OpenpayAPI api = new OpenpayAPI("https://sandbox-api.openpay.pe", "sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
SearchParams request = new SearchParams();
request.creationGte(dateGte.getTime());
request.creationLte(dateLte.getTime());
request.offset(0);
request.limit(100);
List<Plan> plans = api.plans().list(request);
OpenpayAPI api = new OpenpayAPI("sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
SearchParams request = new SearchParams();
request.CreationGte = new Datetime(2014, 5, 1);
request.CreationLte = new DateTime(2014, 5, 15);
request.Offset = 0;
request.Limit = 100;
List<Plan> plans = api.PlanService.List(request);
var searchParams = {
'limit' : 10
};
openpay.plans.list(searchParams, function(error, list){
// ...
});
@openpay=OpenpayApi.new("mzdtln0bmtms6o3kck8f","sk_e568c42a6c384b7ab02cd47d2e407cab")
@plans=@openpay.create(:plans)
response_hash=@plans.all
Ejemplo de respuesta
[
{
"name": "Curso de aleman",
"status": "active",
"amount": 150,
"currency": "PEN",
"id": "patpflacwilazguj6bem",
"creation_date": "2013-12-13T09:43:52-06:00",
"repeat_every": 1,
"repeat_unit": "month",
"retry_times": 2,
"status_after_retry": "cancelled",
"trial_days": 60
},
{
"name": "Curso de ingles",
"status": "active",
"amount": 150,
"currency": "PEN",
"id": "pjl7wfryrrd1tznr0fnl",
"creation_date": "2013-12-13T11:36:40-06:00",
"repeat_every": 1,
"repeat_unit": "month",
"retry_times": 2,
"status_after_retry": "cancelled",
"trial_days": 30
}
]
Regresa los detalles de todos los planes que están activos.
Petición
Se pueden realizar búsquedas utilizando los siguiente parámetros.
Propiedad | Descripción |
---|---|
creation | date Igual a la fecha de creación. Formato yyyy-mm-dd |
creation[gte] | date Mayor a la fecha de creación. Formato yyyy-mm-dd |
creation[lte] | date Menor a la fecha de creación. Formato yyyy-mm-dd |
offset | numeric Número de registros a omitir al inicio, por defecto 0. |
limit | numeric Número de registros que se requieren, por defecto 10. |
Respuesta
Listado de objetos plan registrados de acuerdo a los parámetros proporcionados, ordenadas por fecha de creación en orden descendente.
Suscripciones
Las suscripciones permiten asociar un cliente y una tarjeta para que se puedan realizar cargos recurrentes.
Para poder suscribir algún cliente es necesario primero crear un plan.
Objeto Suscripción
Ejemplo de objeto
{
"status": "trial",
"card": {
"type": "debit",
"brand": "mastercard",
"card_number": "1111",
"holder_name": "Juan Perez Ramirez",
"expiration_year": "20",
"expiration_month": "12",
"allows_charges": true,
"allows_payouts": false,
"creation_date": "2013-12-13T12:39:46-06:00",
"bank_name": "DESCONOCIDO",
"customer_id": null,
"bank_code": "000"
},
"id": "svxdm1suclzipbi4pavm",
"cancel_at_period_end": false,
"charge_date": "2014-01-12",
"creation_date": "2013-12-13T12:39:46-06:00",
"current_period_number": 0,
"period_end_date": "2014-01-11",
"trial_end_date": "2014-01-11",
"plan_id": "pjl7wfryrrd1tznr0fnl",
"customer_id": "a2b79p8xmzeyvmolqfja"
}
Propiedad | Descripción |
---|---|
id | string Identificador único del Plan. |
creation_date | datetime Fecha y hora en que se creó la suscripción en formato ISO 8601 |
cancel_at_period_end | string Indica si se cancela la suscripción al terminar el periodo. |
charge_date | numeric Fecha en la que se cobrar la suscripción. |
current_period_number | string Indica el periodo actual a cobrar. |
period_end_date | numeric Fecha en la que se termina el periodo actual, un día antes del siguiente cobro. |
trial_end_date | string Fecha en la que termina el periodo de prueba. Un día después de esta fecha, se realiza el primer cargo. |
plan_id | numeric Identificador del plan sobre el que se crea la suscripción. |
status | string Estado de la suscripción puede ser “active”, “trial”, “past_due”, “unpaid”, o “cancelled”. Si la suscripción tiene periodo de prueba, se pone en status “trial”, si no tiene periodo de prueba, o cuando termino el periodo de prueba y se logro efectuar el primer pago, se pone en “active”, cuando el cobro no logro efectuarse, se coloca en “past_due”, y cuando se agotan los intentos de cobro, se coloca de acuerdo a la configuración del plan, en “unpaid” o en “cancelled”. Cuando se coloca en “unpaid”, y se quiere reactivar la suscripción, es necesario actualizar el medio de pago (tarjeta) de la suscripción. En cualquier otro caso, el status se establece como “cancelled”. |
customer_id | string Identificador del customer al que pertenece la suscripción. |
card | object Medio de pago con el cual se cobrará la suscripción. Ver objeto tarjeta |
Crear una nueva suscripción
Definición
POST https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/customers/{CUSTOMER_ID}/subscriptions
<?
$customer = $openpay->customers->get(customerId);
$subscription = $customer->subscriptions->add(subscriptionDataRequest);
?>
openpayAPI.subscriptions().create(String customerId, Subscription request);
openpayAPI.SubscriptionService.Create(string customer_id, Subscription request);
openpay.customers.subscriptions.create(customerId, subscriptionRequest, callback);
#Cliente
@subscriptions=@openpay.create(:subscriptions)
@subscriptions.create(request_hash, customer_id)
Ejemplo de petición
curl https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/customers/ag4nktpdzebjiye1tlze/subscriptions \
-u sk_e568c42a6c384b7ab02cd47d2e407cab: \
-H "Content-type: application/json" \
-X POST -d '{
"card":{
"card_number":"4111111111111111",
"holder_name":"Juan Perez Ramirez",
"expiration_year":"20",
"expiration_month":"12",
"cvv2":"110",
"device_session_id":"kR1MiQhz2otdIuUlQkbEyitIqVMiI16f"
},
"plan_id":"pbi4kb8hpb64x0uud2eb"
}'
<?
$openpay = Openpay::getInstance('moiep6umtcnanql3jrxp', 'sk_3433941e467c1055b178ce26348b0fac');
$subscriptionDataRequest = array(
'trial_end_date' => '2014-01-01',
'plan_id' => 'pbi4kb8hpb64x0uud2eb',
'card' => array(
'card_number' => '4111111111111111',
'holder_name' => 'Juan Perez Ramirez',
'expiration_year' => '20',
'expiration_month' => '12',
'cvv2' => '110',
'device_session_id' => 'kR1MiQhz2otdIuUlQkbEyitIqVMiI16f'));
$customer = $openpay->customers->get('a9ualumwnrcxkl42l6mh');
$subscription = $customer->subscriptions->add($subscriptionDataRequest);
?>
final Calendar trialEndDate = Calendar.getInstance();
trialEndDate.set(2014, 5, 1, 0, 0, 0);
OpenpayAPI api = new OpenpayAPI("https://sandbox-api.openpay.pe", "sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Subscription request = new Subscription();
request.planId("pbi4kb8hpb64x0uud2eb");
request.trialEndDate(trialEndDate.getTime());
Card card = new Card();
card.cardNumber("4111111111111111");
card.holderName("Juan Perez Ramirez");
card.cvv2("110");
card.expirationMonth(12);
card.expirationYear(20);
card.deviceSessionId("kR1MiQhz2otdIuUlQkbEyitIqVMiI16f");
request.card(card);
request = api.subscriptions().create("a9pvykxz4g5rg0fplze0", request);
OpenpayAPI api = new OpenpayAPI("sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Subscription request = new Subscription();
request.PlanId = "idPlan-01001";
request.TrialEndDate = new Datetime(2014, 5, 1);
Card card = new Card();
card.HolderName = "Juan Perez Ramirez";
card.CardNumber = "4111111111111111";
card.Cvv2 = "110";
card.ExpirationMonth = "12";
card.ExpirationYear = "20";
card.DeviceSessionId = "kR1MiQhz2otdIuUlQkbEyitIqVMiI16f";
request.Card = card;
request = api.SubscriptionService.Create("a9pvykxz4g5rg0fplze0", request);
var subscriptionRequest = {
'card':{
'card_number':'4111111111111111',
'holder_name':'Juan Perez Ramirez',
'expiration_year':'20',
'expiration_month':'12',
'cvv2':'110',
'device_session_id':'kR1MiQhz2otdIuUlQkbEyitIqVMiI16f'
},
'plan_id':'pbi4kb8hpb64x0uud2eb'
};
openpay.customers.subscriptions.create(customerId, subscriptionRequest, function(error, subscription){
// ...
});
@openpay=OpenpayApi.new("mzdtln0bmtms6o3kck8f","sk_e568c42a6c384b7ab02cd47d2e407cab")
@subscriptions=@openpay.create(:subscriptions)
card_hash={
"holder_name" => "Juan Perez Ramirez",
"card_number" => "4111111111111111",
"cvv2" => "110",
"expiration_month" => "12",
"expiration_year" => "20",
"device_session_id" => "kR1MiQhz2otdIuUlQkbEyitIqVMiI16f"
}
request_hash={
"plan_id" => "pbi4kb8hpb64x0uud2eb",
"trial_end_date" => "2014-06-20",
"card" => card_hash
}
response_hash=@subscriptions.create(request_hash.to_hash, "a9pvykxz4g5rg0fplze0")
Ejemplo de respuesta
{
"id":"s0gmyor4yqtyv1miqwr0",
"status":"trial",
"card":{
"type":"debit",
"brand":"visa",
"address":null,
"card_number":"411111XXXXXX1111",
"holder_name":"Juan Perez Ramirez",
"expiration_year":"20",
"expiration_month":"12",
"allows_charges":true,
"allows_payouts":true,
"bank_name":"Banamex",
"bank_code":"002"
},
"cancel_at_period_end":false,
"charge_date":"2014-06-21",
"creation_date":"2014-05-22T15:56:18-05:00",
"current_period_number":0,
"period_end_date":"2014-06-20",
"trial_end_date":"2014-06-20",
"plan_id":"pbi4kb8hpb64x0uud2eb",
"customer_id":"ag4nktpdzebjiye1tlze"
}
Crea una suscripción para un cliente existente. Se puede ocupar una tarjeta previamente creada o se pueden enviar los datos de la tarjeta en donde se realizarán los cargos, estos últimos pueden incluir la propiedad device_session_id
para usar la herramienta antifraudes, véase Fraud detection using device data.
Petición
Propiedad | Descripción |
---|---|
plan_id | string (requerido, longitud = 45) Identificador del plan sobre el que se crea la suscripción. |
trial_end_date | string (opcional, longitud = 10) Último día de prueba del cliente. Si no se indica se utilizará el valor de trial_days del plan para calcularlo. Si se indica una fecha anterior al día de hoy, se interpretará como una suscripción sin días de prueba. (Con formato yyy-mm-dd) |
source_id | string (requerido si no se envía card, longitud = 45) Identificador del token o la tarjeta previamente registrada al cliente con la que se cobrará la suscripción. |
card | object (requerido si no se envía source_id) Medio de pago con el cual se cobrará la suscripción. Ver objeto tarjeta |
Respuesta
Regresa el objeto suscripción creado o una respuesta de error si ocurrió algún problema en la creación.
Actualizar una suscripción
Definición
PUT https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/customers/{CUSTOMER_ID}/subscriptions
<?
$customer = $openpay->customers->get(customerId);
$subscription = $customer->subscriptions->get(subscriptionId);
$subscription->save();
?>
openpayAPI.subscriptions().update(Subscription request);
openpayAPI.SubscriptionService.Update(string customer_id, Subscription subscription);
openpay.customers.subscriptions.update(customerId, subscriptionId, subscriptionRequest, callback);
#Cliente
@subscriptions=@openpay.create(:subscriptions)
@subscriptions.update(request_hash, customer_id)
Ejemplo de petición
curl https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/customers/ag4nktpdzebjiye1tlze/subscriptions/s0gmyor4yqtyv1miqwr0 \
-u sk_e568c42a6c384b7ab02cd47d2e407cab: \
-H "Content-type: application/json" \
-X PUT -d '{
"trial_end_date": "2016-01-11",
"card": {
"card_number": "343434343434343",
"holder_name": "Juan Perez Ramirez",
"expiration_year": "20",
"expiration_month": "12",
"cvv2":"1234"
}
}'
<?
$openpay = Openpay::getInstance('moiep6umtcnanql3jrxp', 'sk_3433941e467c1055b178ce26348b0fac');
$customer = $openpay->customers->get('a9ualumwnrcxkl42l6mh');
$subscription = $customer->subscriptions->get('s7ri24srbldoqqlfo4vp');
$subscription->trial_end_date = '2014-12-31';
$subscription->save();
?>
final Calendar trialEndDate = Calendar.getInstance();
trialEndDate.set(2014, 5, 1, 0, 0, 0);
OpenpayAPI api = new OpenpayAPI("https://sandbox-api.openpay.pe", "sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Subscription request = new Subscription();
request.planId("idPlan-01001");
request.trialEndDate(trialEndDate.getTime());
request.sourceId("ktrpvymgatocelsciak7");
request = api.subscriptions().update(request);
OpenpayAPI api = new OpenpayAPI("sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Subscription request = new Subscription();
request.PlanId = "idPlan-01001";
request.TrialEndDate = new Datetime(2014, 5, 1);;
request.CardId = "ktrpvymgatocelsciak7";
request = api.SubscriptionService.Update("a9pvykxz4g5rg0fplze0", request);
var subscriptionRequest = {
'trial_end_date': '2016-01-11',
'card': {
'card_number': '343434343434343',
'holder_name': 'Juan Perez Ramirez',
'expiration_year': '20',
'expiration_month': '12',
'cvv2':'1234'
}
};
openpay.customers.subscriptions.update('ag4nktpdzebjiye1tlze', 's0gmyor4yqtyv1miqwr0', subscriptionRequest,
function(error, subscription){
// ...
});
@openpay=OpenpayApi.new("mzdtln0bmtms6o3kck8f","sk_e568c42a6c384b7ab02cd47d2e407cab")
@subscriptions=@openpay.create(:subscriptions)
request_hash={
"plan_id" => "pbi4kb8hpb64x0uud2eb",
"cancel_at_period_end" => true,
"trial_end_date" => "2014-06-20",
"source_id" => "ktrpvymgatocelsciak7"
}
response_hash=@subscriptions.update(request_hash.to_hash, "pbi4kb8hpb64x0uud2eb")
Ejemplo de respuesta
{
"id":"s0gmyor4yqtyv1miqwr0",
"status":"trial",
"card":{
"type":"credit",
"brand":"american_express",
"address":null,
"card_number":"343434XXXXX4343",
"holder_name":"Juan Perez Ramirez",
"expiration_year":"20",
"expiration_month":"12",
"allows_charges":true,
"allows_payouts":false,
"bank_name":"AMERICAN EXPRESS",
"bank_code":"103"
},
"cancel_at_period_end":false,
"charge_date":"2016-01-12",
"creation_date":"2014-05-22T15:56:18-05:00",
"current_period_number":0,
"period_end_date":"2016-01-11",
"trial_end_date":"2016-01-11",
"plan_id":"pbi4kb8hpb64x0uud2eb",
"customer_id":"ag4nktpdzebjiye1tlze"
}
Actualiza la información de una suscripción activa.
Petición
Propiedad | Descripción |
---|---|
cancel_at_period_end | booelan (opcional) Indica si se cancela la suscripción al terminar el periodo. |
trial_end_date | string (opcional, longitud = 10) Último día de prueba del cliente. Si no se indica se utilizará el valor de trial_days del plan para calcularlo. Si se indica una fecha anterior al día de hoy, se interpretará como una suscripción sin días de prueba. (Con formato yyy-mm-dd) |
source_id | string (opcional, longitud = 45) Identificador del token o la tarjeta previamente registrada al cliente con la que se cobrará la suscripción. |
card | object (opcional) Medio de pago con el cual se cobrará la suscripción. Ver objeto tarjeta |
Respuesta
Regresa el objeto suscripción actualizado o una respuesta de error si ocurrió algún problema en la actualización.
Obtener un suscripción
Definición
GET https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/customers/{CUSTOMER_ID}/subscriptions/{SUBSCRIPTION_ID}
<?
$customer = $openpay->customers->get(customerId);
$subscription = $customer->subscriptions->get(subscriptionId);
?>
openpayAPI.subscriptions().get(String customerId, String customerId);
openpayAPI.SubscriptionService.Get(string customer_id, string subscription_id);
openpay.customers.subscriptions.get(customerId, subscriptionId, callback);
#Cliente
@subscriptions=@openpay.create(:subscriptions)
@subscriptions.get(subscription_id,customer_id)
Ejemplo de petición
curl https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/customers/ag4nktpdzebjiye1tlze/subscriptions/s0gmyor4yqtyv1miqwr0 \
-u sk_e568c42a6c384b7ab02cd47d2e407cab:
<?
$openpay = Openpay::getInstance('moiep6umtcnanql3jrxp', 'sk_3433941e467c1055b178ce26348b0fac');
$customer = $openpay->customers->get('a9ualumwnrcxkl42l6mh');
$subscription = $customer->subscriptions->get('s7ri24srbldoqqlfo4vp');
?>
OpenpayAPI api = new OpenpayAPI("https://sandbox-api.openpay.pe", "sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Subscription subscription = api.subscriptions().get("a9pvykxz4g5rg0fplze0", "s0gmyor4yqtyv1miqwr0");
OpenpayAPI api = new OpenpayAPI("sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Subscription subscription = api.SubscriptionService.Get("a9pvykxz4g5rg0fplze0", "s0gmyor4yqtyv1miqwr0");
openpay.customers.subscriptions.get('ag4nktpdzebjiye1tlze', 's0gmyor4yqtyv1miqwr0', function(error, subscription){
// ...
});
@openpay=OpenpayApi.new("mzdtln0bmtms6o3kck8f","sk_e568c42a6c384b7ab02cd47d2e407cab")
@subscriptions=@openpay.create(:subscriptions)
response_hash=@subscriptions.get("s0gmyor4yqtyv1miqwr0", "pbi4kb8hpb64x0uud2eb")
Ejemplo de respuesta
{
"id":"s0gmyor4yqtyv1miqwr0",
"status":"trial",
"card":{
"type":"credit",
"brand":"american_express",
"address":null,
"card_number":"343434XXXXX4343",
"holder_name":"Juan Perez Ramirez",
"expiration_year":"20",
"expiration_month":"12",
"allows_charges":true,
"allows_payouts":false,
"bank_name":"AMERICAN EXPRESS",
"bank_code":"103"
},
"cancel_at_period_end":false,
"charge_date":"2016-01-12",
"creation_date":"2014-05-22T15:56:18-05:00",
"current_period_number":0,
"period_end_date":"2016-01-11",
"trial_end_date":"2016-01-11",
"plan_id":"pbi4kb8hpb64x0uud2eb",
"customer_id":"ag4nktpdzebjiye1tlze"
}
Obtiene los detalles de la suscripción de un cliente.
Petición
Propiedad | Descripción |
---|---|
id | string (requerido, longitud = 45) Identificador de la suscripción |
Respuesta
Regresa un objeto suscripción
Cancelar suscripción
Definición
DELETE https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/customers/{CUSTOMER_ID}/subscriptions/{SUBSCRIPTION_ID}
<?
$customer = $openpay->customers->get(customerId);
$subscription = $customer->subscriptions->get(subscriptionId);
$subscription->delete();
?>
openpayAPI.subscriptions().delete(String customerId, String subscriptionId);
openpayAPI.SubscriptionService.Delete(string customer_id, string subscription_id);
openpay.customers.subscriptions.delete(customerId, subscriptionId, callback);
#Cliente
@subscriptions=@openpay.create(:subscriptions)
@subscriptions.delete(subscription_id, customer_id)
Ejemplo de petición
curl https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/customers/ag4nktpdzebjiye1tlze/subscriptions/s0gmyor4yqtyv1miqwr0 \
-u sk_e568c42a6c384b7ab02cd47d2e407cab: \
-X DELETE
<?
$openpay = Openpay::getInstance('moiep6umtcnanql3jrxp', 'sk_3433941e467c1055b178ce26348b0fac');
$customer = $openpay->customers->get('a9ualumwnrcxkl42l6mh');
$subscription = $customer->subscriptions->get('s7ri24srbldoqqlfo4vp');
$subscription->delete();
?>
OpenpayAPI api = new OpenpayAPI("https://sandbox-api.openpay.pe", "sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
api.subscriptions().delete("a9pvykxz4g5rg0fplze0", "s0gmyor4yqtyv1miqwr0");
OpenpayAPI api = new OpenpayAPI("sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
api.SubscriptionService.Delete("a9pvykxz4g5rg0fplze0", "s0gmyor4yqtyv1miqwr0");
openpay.customers.subscriptions.delete('ag4nktpdzebjiye1tlze', 's0gmyor4yqtyv1miqwr0', function(error){
// ...
});
@openpay=OpenpayApi.new("mzdtln0bmtms6o3kck8f","sk_e568c42a6c384b7ab02cd47d2e407cab")
@subscriptions=@openpay.create(:subscriptions)
@subscriptions.detele("s0gmyor4yqtyv1miqwr0", "pbi4kb8hpb64x0uud2eb")
Cancela inmediatamente la suscrípción del cliente. Ya no se realizarán más cargos a la tarjeta y todos los cargos pendientes se cancelarán.
Petición
Propiedad | Descripción |
---|---|
id | string (requerido, longitud = 45) Identificador del plan a eliminar |
Respuesta
Si la suscripción se cancelo correctamente la respuesta es vacía, si no se regresa un objeto error indicando el motivo.
Listado de suscripciones
Definición
GET https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/customers/{CUSTOMER_ID}/subscriptions
<?
$customer = $openpay->customers->get(customerId);
$subscriptionList = $customer->subscriptions->getList(findDataRequest);
?>
openpayAPI.subscriptions().list(String customerId, SearchParams request);
openpayAPI.SubscriptionService.List(string customer_id, SearchParams request = null);
openpay.customers.subscriptions.list(customerId, callback);
openpay.customers.subscriptions.list(customerId, searchParams, callback);
#Cliente
@subscriptions=@openpay.create(:subscriptions)
@subscriptions.all(customer_id)
Ejemplo de petición
curl -g "https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/customers/ag4nktpdzebjiye1tlze/subscriptions?limit=10" \
-u sk_e568c42a6c384b7ab02cd47d2e407cab:
<?
$openpay = Openpay::getInstance('moiep6umtcnanql3jrxp', 'sk_3433941e467c1055b178ce26348b0fac');
$findData = array(
'creation[gte]' => '2013-01-01',
'creation[lte]' => '2013-12-31',
'offset' => 0,
'limit' => 5);
$customer = $openpay->customers->get('a9ualumwnrcxkl42l6mh');
$subscriptionList = $customer->subscriptions->getList($findData);
?>
final Calendar dateGte = Calendar.getInstance();
final Calendar dateLte = Calendar.getInstance();
dateGte.set(2014, 5, 1, 0, 0, 0);
dateLte.set(2014, 5, 15, 0, 0, 0);
OpenpayAPI api = new OpenpayAPI("https://sandbox-api.openpay.pe", "sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
SearchParams request = new SearchParams();
request.creationGte(dateGte.getTime());
request.creationLte(dateLte.getTime());
request.offset(0);
request.limit(100);
List<Subscription> subscriptions = api.subscriptions().list("a9pvykxz4g5rg0fplze0", request);
OpenpayAPI api = new OpenpayAPI("sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
SearchParams request = new SearchParams();
request.CreationGte = new Datetime(2014, 5, 1);
request.CreationLte = new DateTime(2014, 5, 15);
request.Offset = 0;
request.Limit = 100;
List<Subscription> subscriptions = api.SubscriptionService.List("a9pvykxz4g5rg0fplze0", request);
var searchParams = {
'limit' : 2
};
openpay.customers.subscriptions.list('ag4nktpdzebjiye1tlze', searchParams, function(error, list){
// ...
});
@openpay=OpenpayApi.new("mzdtln0bmtms6o3kck8f","sk_e568c42a6c384b7ab02cd47d2e407cab")
@subscriptions=@openpay.create(:subscriptions)
@subscriptions.all("pbi4kb8hpb64x0uud2eb")
Ejemplo de respuesta
[
{
"id":"s0gmyor4yqtyv1miqwr0",
"status":"trial",
"card":{
"type":"credit",
"brand":"american_express",
"address":null,
"card_number":"343434XXXXX4343",
"holder_name":"Juan Perez Ramirez",
"expiration_year":"20",
"expiration_month":"12",
"allows_charges":true,
"allows_payouts":false,
"bank_name":"AMERICAN EXPRESS",
"bank_code":"103"
},
"cancel_at_period_end":false,
"charge_date":"2016-01-12",
"creation_date":"2014-05-22T15:56:18-05:00",
"current_period_number":0,
"period_end_date":"2016-01-11",
"trial_end_date":"2016-01-11",
"plan_id":"pbi4kb8hpb64x0uud2eb",
"customer_id":"ag4nktpdzebjiye1tlze"
}
]
Regresa los detalles de todas las suscripciones activas para un cliente en específico.
Petición
Se pueden realizar búsquedas utilizando los siguiente parámetros.
Propiedad | Descripción |
---|---|
creation | date Igual a la fecha de creación. Formato yyyy-mm-dd |
creation[gte] | date Mayor a la fecha de creación. Formato yyyy-mm-dd |
creation[lte] | date Menor a la fecha de creación. Formato yyyy-mm-dd |
offset | numeric Número de registros a omitir al inicio, por defecto 0. |
limit | numeric Número de registros que se requieren, por defecto 10. |
Respuesta
Listado de objetos suscripción que tiene el cliente. Ordenados por fecha de creación en orden descendente.
Recurrencia
Ejecuta tus cobranzas, suscripciones y anulaciones de forma masiva.
Servicio para el envió de datos al sistema MRC
URL Base Sandbox | https://sandbox-mrc.openpay.mx/ |
URL Base Producción | https://mrc.openpay.mx/ |
Petición de cargo recurrente Masivo:
Descripción | |
Servicio | /{merchantId}/transactions/recurrent |
Method | POST |
Petición | { "attemps":"5", "frequency":"24", “execution”:”2022-09-07T14:39”, "transactions":[ { "order_id":"O-00025", "token":"kunntlsw35izlyqke9gm", "amount":"20.00", "currency":"MXN", "description":"Cobro de servicio", "name":"Victor", "last_name":"Flores", "email":"vflores@hotmail.com", "phone_number":"" }, { "order_id":"O-00026", "token":"kzxzkqvrmhr7qppicuyv", "amount":"16.00", "currency":"USD", "description":"Cargo mensual", "name":"Noe", "last_name":"Diezmarin", "email":"Noe.diezamrin@gmail.com", "phone_number":"5534775453" }, { "order_id":"O-00027", "token":"klpaa1ffkz12mrerw7tz", "amount":"19.30", "currency":"MXN", "description":"Servicio de agosto", "name":"Gonzalo", "last_name":"Suarez", "email":"gonzoflores@msn.com", "phone_number":"" }, { "order_id":"O-00028", "token":"kr7jrgqgnahsqh0zsjnq", "amount":"25.91", "currency":"MXN", "description":"Cargo de suscripción", "name":"Luis", "last_name":"Nieves", "email":"lmartinez@bwl.com.mx", "phone_number":"" } ] } |
Respuesta | HTTP Response : 200 OK HTTP Response: 400 Bad Request HTTP Respuesta: 500 Error Interno |
Detalles de la petición:
Name | Tipo | Mandatory | Descripción | Validación |
attemps | string | No | Número de intentos de cargo, mínimo 1, máximo 5 | Numérico entero positivo |
frequency | string | No | Frecuencia de los intentos de cargo, mínimo 1, máximo 24 | Numérico entero positivo |
execution | string | No | Fecha para programar creación del archivo | Formato yyyy-MM-ddTHH:mm, fecha posterior a la actual (Ver Anexo) |
transactions.order_id | string | Yes | Identificador único de la transacción | Valor único por comercio |
transactions.token | string | Yes | Identificador de tarjeta | |
transactions.amount | string | Yes | Monto de la transacción | Numérico a dos decimales |
transactions.currency | string | Yes | Moneda de la transacción | |
transactions.description | string | Yes | Descripción o concepto de la transacción | |
transactions.name | string | Yes | Nombre del cliente | |
transactions.last_name | string | Yes | Apellido del cliente | |
transactions.email | string | Yes | Correo electrónico del cliente | Validación de correo electrónico |
transactions.phone_number | string | No | Teléfono del cliente |
Petición de suscripciones recurrente Masivo:
Descripción | |
Servicio | /{merchantId}/subscriptions/recurrent |
Method | POST |
Petición | { "execution":"2022-10-05T15:02", "subscriptions": [ { "plan_id": "piouqe8a78x4qwer2i27", "trial_end_date": "2022-10-09", "name": "Pedro", "last_name": "Paramo", "email": "test@correo.com.mx", "phone_number": "4421234567", "token": "k4jufxr9llfb2wuzihnb" }, { "plan_id": "piouqe8a78x4qwer2i28", "trial_end_date": "2022-10-09", "name": "Pedro", "last_name": "Martinez", "email": "test@correo.com.mx", "phone_number": "", "token": "ktzkxn2ksvw4fd6xs3dq" } ] } |
Respuesta | HTTP Response : 200 OK HTTP Response: 400 Bad Request HTTP Respuesta: 500 Error Interno |
Detalles de la petición:
Name | Tipo | Mandatory | Descripción | Validación |
execution | string | No | Fecha para programar creación del archivo | Formato yyyy-MM-ddTHH:mm, fecha posterior a la actual |
subscriptions.plan_id | string | Yes | Identificador del plan asociado a la suscripción | |
subscriptions.token | string | Yes | Identificador de tarjeta | |
subscriptions.email | string | Yes | Correo electrónico del cliente | Validación de correo electrónico |
subscriptions.phone_number | string | No | Teléfono del cliente | |
subscriptions.trial_end_date | string | No | Fecha de finalización del periodo de prueba | Formato YYYY-MM-DD |
subscriptions.name | string | No | Nombre del cliente | |
subscriptions.last_name | string | No | Apellido del cliente |
Detalles Formato de fecha de ejecución:
El campo execution acepta una cadena representando una fecha dada siguiendo el formato: yyyy-MM-ddTHH:mm:
yyyy: Año a cuatro dígitos
MM: Mes a dos dígitos
dd: día se la semana a dos dígitos
T: Constante T, separador de tiempo
HH: Hora en formato de 24 horas a dos dígitos
mm: Minutos a dos dígitos, solo minuto 00 permitido
Ejemplo de fechas válidas:
● 2022-09-07T18:00
● 2022-10-17T12:00
● 2022-09-07T05:39
● 2022-03-02T14:39
Ejemplo de fechas NO válidas:
● 2022-09S-0718:45
● 2022-10-17T12:01
● 2022A-09-07T05:10
● 2022-03-02T14:59
Cancelación de suscripciones:
Descripción | |
Servicio | /{merchantId}/subscriptions |
Method | DELETE |
Petición | { "cancelations": [ { "customerId": "aqajpoomx52tbbrxnumb", "subscriptions": [ "se4jtisyz0e3c4ewqwfr", "shrjla8bfvkwetla0q6m", "sh7yjgv6qxfasjlakwhv", "snmo6iig6hsozjly3qda", "sylbsxqpabgxydg7qrtd" ] }, { "customerId": "aqajpoomx52tbbrxnumb1", "subscriptions": [ "se4jtisyz0e3c4ewqwfr", "shrjla8bfvkwetla0q6m", "sh7yjgv6qxfasjlakwhv", "snmo6iig6hsozjly3qda", "sylbsxqpabgxydg7qrtd" ] } ] } |
Respuesta | { "messages": [ { "code": 200, "response": "Ok", "customerId": "aqajpoomx52tbbrxnumb", "subscriptionId": "sh7yjgv6qxfasjlakwhv" }, { "code": 200, "response": "Ok", "customerId": "aqajpoomx52tbbrxnumb", "subscriptionId": "shrjla8bfvkwetla0q6m" } ] } |
Detalles de la petición:
Name | Tipo | Mandatory | Descripción | Validación |
customerId | string | Yes | Identificador del cliente suscripto al plan de cobros | Requerido |
subscriptions | array | Yes | Lista de identificadores de los planes de cobro a cancelar | Requerido, no puede estar vacío |
Webhooks
Estos permiten notificar al cliente cuando un evento ha sucedido en la plataforma, para que el comercio pueda tomar las acciones correspondientes.
Objeto Webhook
Ejemplo de objeto
{
"id" : "wxvanstudf4ssme8khmc",
"url" : "http://requestb.in/11vxrsf1",
"user" : "juanito",
"password" : "passjuanito",
"event_types" : [
"charge.refunded",
"charge.failed",
"charge.cancelled",
"charge.created",
"chargeback.accepted"
],
"status":"verified"
}
Propiedad | Descripción |
---|---|
id | string Identificador único del webhook. |
url | string URL del webhook |
user | string Nombre de usuario para autenticación básica del webhook. |
password | string Contraseña para autenticación básica del webhook. |
event_types | array[string] Listado de eventos a los que responderá el webhook. |
status | string Estado del webhook, indica si está verificado (verified) o no está verificado (unverified). |
Evento | Categoría | Descripción |
---|---|---|
charge.refunded | Cargos | Informa cuando es reembolsado un cargo. |
charge.failed | Cargos | Informa cuando un cargo falló y no se aplico. |
charge.cancelled | Cargos | Informa cuando un cargo es cancelado. |
charge.created | Cargos | Informa cuando un cargo es programado. |
charge.succeeded | Cargos | Informa cuando un cargo es aplicado. |
charge.rescored.to.decline | Cargos | Informa cuando a un cargo le es recalculado su score y es declinado. |
subscription.charge.failed | Suscripción | Informa cuando el cargo de una suscripción falló. |
payout.created | Pagos | Informa cuando un pago fue programado para el siguiente día. |
payout.succeeded | Pagos | Informa cuando un pago programado se ha aplicado. |
payout.failed | Pagos | Informa cuando un pago falló. |
transfer.succeeded | Transferencias | Informa cuando se realiza una transferencia entre dos cuentas Openpay. |
fee.succeeded | Comisiones | Informa cuando se cobra un Fee a un Customer. |
fee.refund.succeeded | Comisiones | Informa cuando se reembolsa un Fee a un Customer. |
spei.received | SPEI | Informa cuando se recibe un pago por SPEI para agregar fondos a la cuenta. |
chargeback.created | Contracargos | Informa cuando se recibió un chargeback de una transacción y se está iniciando la investigación. |
chargeback.rejected | Contracargos | Informa cuando un contracargo fue rechazado. |
chargeback.accepted | Contracargos | Informa cuando un contracargo fue aceptado. |
order.created | Orden | Informa cuando una orden es creada y programada. |
order.activated | Orden | Informa cuando una orden es activada. |
order.payment.received | Orden | Informa cuando el pago de una orden es recibido. |
order.completed | Orden | Informa cuando una orden es completada. |
order.expired | Orden | Informa cuando una orden ha expirado. |
order.cancelled | Orden | Informa cuando una orden es cancelada. |
order.payment.cancelled | Orden | Informa cuando el pago de una orden es cancelado. |
Características de un servicio Webhook válido
- Endpoint: Solo dominios (No IPs). ejemplo: https://notifications.merchant.com
- Puerto: 443/TCP, 8443/TCP y 10443/TCP
- Protocolo: HTTPS/TLS_1.2
- Certificado: Válido (firmado por CA pública y match con dominio).
Crear un Webhook
Definición
POST https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/webhooks
<?
$webhook = $openpay->webhooks->add(webhook);
?>
openpayAPI.webhooks().create(Webhook request);
openpayAPI.WebhooksService.Create(Webhook request);
openpay.webhooks.create(webhook, callback);
@webhooks=@openpay.create(:webhooks)
@webhooks.create(request_hash)
Ejemplo de petición
curl https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/webhooks \
-u sk_e568c42a6c384b7ab02cd47d2e407cab: \
-H "Content-type: application/json" \
-X POST -d '{
"url" : "http://requestb.in/11vxrsf1",
"user" : "juanito",
"password" : "passjuanito",
"event_types" : [
"charge.refunded",
"charge.failed",
"charge.cancelled",
"charge.created",
"chargeback.accepted"
]
}'
<?
$openpay = Openpay::getInstance('moiep6umtcnanql3jrxp', 'sk_3433941e467c1055b178ce26348b0fac');
$webhook = array(
'url' => 'http://requestb.in/11vxrsf1',
'user' => 'juanito',
'password' => 'passjuanito',
'event_types' => array(
'charge.refunded',
'charge.failed',
'charge.cancelled',
'charge.created',
'chargeback.accepted'
)
);
$webhook = $openpay->webhooks->add($webhook);
?>
OpenpayAPI api = new OpenpayAPI("https://sandbox-api.openpay.pe", "sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Webhook request = new Webhook();
request.url("http://requestb.in/11vxrsf1");
request.user("juanito");
request.password("passjuanito");
request.addEventType("charge.refunded");
request.addEventType("charge.failed");
Webhook webhook = api.webhooks().create(request);
OpenpayAPI api = new OpenpayAPI("sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Webhook request = new Webhook();
request.Url = "http://requestb.in/11vxrsf1";
request.User = "juanito";
request.Password = "passjuanito";
request.AddEventType("charge.refunded");
request.AddEventType("charge.failed");
Webhook webhook = api.WebhookService.Create(request);
var webhook_params = {
'url' : 'http://requestb.in/11vxrsf1',
'user' : 'juanito',
'password' : 'passjuanito',
'event_types' : [
'charge.refunded',
'charge.failed',
'charge.cancelled',
'charge.created',
'chargeback.accepted'
]
};
openpay.webhooks.create(webhook_params, function(error, webhook){
// ...
});
@openpay=OpenpayApi.new("mzdtln0bmtms6o3kck8f","sk_e568c42a6c384b7ab02cd47d2e407cab")
@webhooks=@openpay.create(:webhooks)
request_hash={
"url" => "http://requestb.in/11vxrsf1",
"user" => "juanito",
"password" => "passjuanito",
"event_types" => [
"charge.refunded",
"charge.failed",
"charge.cancelled",
"charge.created",
"chargeback.accepted"
]
}
response_hash=@webhooks.create(request_hash.to_hash)
Ejemplo de respuesta
{
"id" : "wkn0t30zfxpmhr5usgfa",
"url" : "http://requestb.in/qt3bq0qt",
"user" : "juanito",
"event_types" : [
"charge.succeeded",
"charge.created",
"charge.cancelled",
"charge.failed"
],
"status" : "verified"
}
Al crear un nuevo webhook se hará una petición a la url indicada para verificar el webhook.
Al momento de guardar el webhook se generará un id que podrá ser usado para eliminar o simplemente obtener la información no sensible del webhook.
Petición
Propiedad | Descripción |
---|---|
url | string URL del webhook |
user | string Nombre de usuario para autenticación básica del webhook. |
password | string Contraseña para autenticación básica del webhook. |
event_types | array[string] Listado de eventos a los que responderá el webhook. |
Respuesta
Regresa un objeto webhook cuando se creó correctamente o una respuesta de error si ocurrió algún problema en la creación.
Obtener un Webhook
Definición
GET https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/webhooks/{WEBHOOK_ID}
<?
$webhook = $openpay->webhooks->get(webhookId);
?>
openpayAPI.webhooks().get(String webhookId);
openpayAPI.WebhooksService.Get(string webhookId);
openpay.webhooks.get(webhookId, callback);
@webhooks=@openpay.create(:webhooks)
@webhooks.get(webhookId)
Ejemplo de petición
curl https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/webhooks/wxvanstudf4ssme8khmc \
-u sk_e568c42a6c384b7ab02cd47d2e407cab: \
-H "Content-type: application/json"
<?
$openpay = Openpay::getInstance('moiep6umtcnanql3jrxp', 'sk_3433941e467c1055b178ce26348b0fac');
$webhook = $openpay->webhooks->get('wxvanstudf4ssme8khmc');
?>
OpenpayAPI api = new OpenpayAPI("https://sandbox-api.openpay.pe", "sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Webhook webhook = api.webhooks().get("wxvanstudf4ssme8khmc");
OpenpayAPI api = new OpenpayAPI("sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
Webhook webhook = api.WebhooksService.Get("wxvanstudf4ssme8khmc");
openpay.webhooks.get('wxvanstudf4ssme8khmc', function(error, webhook){
// ...
});
@openpay=OpenpayApi.new("mzdtln0bmtms6o3kck8f","sk_e568c42a6c384b7ab02cd47d2e407cab")
@webhooks=@openpay.create(:webhooks)
response_hash=@webhooks.get("wxvanstudf4ssme8khmc")
Ejemplo de respuesta
{
"id" : "wxvanstudf4ssme8khmc",
"url" : "http://requestb.in/11vxrsf1",
"user" : "juanito",
"event_types" : [
"verification",
"charge.refunded",
"charge.failed",
"charge.cancelled",
"charge.created",
"charge.succeeded",
"subscription.charge.failed",
"payout.created",
"payout.succeeded",
"payout.failed",
"transfer.succeeded",
"fee.succeeded",
"spei.received",
"chargeback.created",
"chargeback.rejected",
"chargeback.accepted"
],
"status" : "verified"
}
Obtiene los detalles de un webhook solicitándolo con su id.
Petición
Propiedad | Descripción |
---|---|
id | string (requerido, longitud = 45) Identificador único del webhook |
Respuesta
Regresa un objeto webhook
Eliminar un Webhook
Definición
DELETE https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/webhooks/{WEBHOOK_ID}
<?
$webhook = $openpay->webhooks->get(webhookId);
$webhook->delete();
?>
openpayAPI.webhooks().delete(String webhookId);
openpayAPI.WebhooksService.Delete(string webhook_id);
openpay.webhooks.delete(webhookId, callback);
@webhooks=@openpay.create(:webhooks)
@webhooks.delete(webhook_id)
Ejemplo de petición con cliente
curl https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/webhooks/wxvanstudf4ssme8khmc \
-u sk_e568c42a6c384b7ab02cd47d2e407cab: \
-X DELETE
<?
$openpay = Openpay::getInstance('moiep6umtcnanql3jrxp', 'sk_3433941e467c1055b178ce26348b0fac');
$webhook = $openpay->webhooks->get('wxvanstudf4ssme8khmc');
$webhook->delete();
?>
OpenpayAPI api = new OpenpayAPI("https://sandbox-api.openpay.pe", "sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
api.webhooks().delete("wxvanstudf4ssme8khmc");
OpenpayAPI api = new OpenpayAPI("sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
api.WebhooksService.Delete("wxvanstudf4ssme8khmc");
openpay.webhooks.delete('wxvanstudf4ssme8khmc', function(error) {
// ...
});
@openpay=OpenpayApi.new("mzdtln0bmtms6o3kck8f","sk_e568c42a6c384b7ab02cd47d2e407cab")
@webhooks=@openpay.create(:webhooks)
response_hash=@webhooks.delete("wxvanstudf4ssme8khmc")
Elimina un webhook del comercio.
Para eliminarlo sólo es necesario proporcionar el identificador del webhook.
Petición
Propiedad | Descripción |
---|---|
id | string (requerido, longitud = 45) Identificador único del webhook |
Respuesta
Si el webhook se borra correctamente la respuesta es vacía, si no se puede borrar se regresa un objeto error indicando el motivo.
Listado de Webhook
Definición
GET https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/webhooks
<?
$webhookList = $openpay->webhooks->getList();
?>
openpayAPI.webhooks().list();
openpayAPI.WebhooksService.List();
openpay.webhooks.list(callback);
@webhooks=@openpay.create(:webhooks)
@webhooks.all
Ejemplo de petición
curl https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/webhooks \
-u sk_e568c42a6c384b7ab02cd47d2e407cab: \
-H "Content-type: application/json"
<?
$openpay = Openpay::getInstance('moiep6umtcnanql3jrxp', 'sk_3433941e467c1055b178ce26348b0fac');
$webhookList = $openpay->webhooks->getList();
?>
OpenpayAPI api = new OpenpayAPI("https://sandbox-api.openpay.pe", "sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
List<Webhook> webhooks = api.webhooks().list();
OpenpayAPI api = new OpenpayAPI("sk_b05586ec98454522ac7d4ccdcaec9128", "maonhzpqm8xp2ydssovf");
List<Webhook> webhooks = api.WebhooksService.List();
openpay.webhooks.list(function(error, list){
// ...
});
@openpay=OpenpayApi.new("mzdtln0bmtms6o3kck8f","sk_e568c42a6c384b7ab02cd47d2e407cab")
@webhooks=@openpay.create(:webhooks)
response_hash=@webhooks.all
Ejemplo de respuesta
[
{
"id" : "wDashboard185",
"event_types" : [
"verification",
"charge.refunded",
"charge.failed",
"charge.cancelled",
"charge.created",
"charge.succeeded",
"subscription.charge.failed",
"payout.created",
"payout.succeeded",
"payout.failed",
"transfer.succeeded",
"fee.succeeded",
"spei.received",
"chargeback.created",
"chargeback.rejected",
"chargeback.accepted"
],
"url" : "http://requestb.in/11vxrsf1",
"status" : "verified"
},
{
"id" : "wDashboard186",
"event_types" : [
"verification",
"charge.refunded",
"charge.failed",
"charge.cancelled",
"charge.created",
"charge.succeeded",
"subscription.charge.failed"
],
"url" : "http://requestb.in/1fhpiog1",
"status" : "verified"
}
]
Regresa una lista de webhooks registrados por comercio.
Petición
Respuesta
Listado de objetos objeto webhook registrados de acuerdo a los parámetros proporcionados.
Tokens
El objetivo de generar tokens es que se capture la información de la tarjeta desde el navegador o dispositivo del usuario final para que dicha información no viaje a través de tu servidor y así puede evitar o reducir certificaciones PCI.
Para usar esta funcionalidad de la API, te recomendamos usar nuestra librería en JavaScript para cuando tu aplicación esté en Web y nuestros SDK’s de Android o iOS para cuando esté en móvil.
Características
- Se crean a nivel comercio
- No se ligan a ningún cliente
- Después de crearse solo se puede usar una sola vez, para hacer un cargo con token
Objeto Token
Ejemplo de objeto
{
"id":"tokfa4swch8gr4icy2ma",
"card":{
"card_number":"1111",
"holder_name":"Juan Perez Ramirez",
"expiration_year":"20",
"expiration_month":"04",
"address":{
"line1":"Av 5 de febrero",
"line2":"Roble 207",
"line3":"Queretaro",
"state":"Queretaro",
"city":"Queretaro",
"postal_code":"76900",
"country_code":"PE"
},
"creation_date":"2014-01-30T13:53:11-06:00",
"brand":"visa",
"points_card":false
}
}
Propiedad | Descripción |
---|---|
id | string Identificador del token. Esté es el que deberás usar para posteriormente hacer un cargo. |
card | object Datos de la tarjeta asociada al token. Ver objeto tarjeta |
Crear un nuevo token
Definición
POST https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/tokens
Ejemplo de petición
curl https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/tokens \
-u sk_e568c42a6c384b7ab02cd47d2e407cab: \
-H "Content-type: application/json" \
-X POST -d '{
"card_number":"4111111111111111",
"holder_name":"Juan Perez Ramirez",
"expiration_year":"20",
"expiration_month":"12",
"cvv2":"110",
"address":{
"city":"Querétaro",
"country_code":"PE",
"postal_code":"76900",
"line1":"Av 5 de Febrero",
"line2":"Roble 207",
"line3":"col carrillo",
"state":"Queretaro"
}
}'
Ejemplo de respuesta
{
"id":"k1n0mscnjwhxqia8q7cm",
"card":{
"card_number":"411111XXXXXX1111",
"holder_name":"Juan Perez Ramirez",
"expiration_year":"20",
"expiration_month":"12",
"address":{
"line1":"Av 5 de Febrero",
"line2":"Roble 207",
"line3":"col carrillo",
"state":"Queretaro",
"city":"Querétaro",
"postal_code":"76900",
"country_code":"PE"
},
"creation_date":null,
"brand":"visa"
}
}
Para la creación de un token en Openpay es necesario enviar el objeto con la información a registrar. Una vez guardado el token no se puede obtener el número y código de seguridad ya que esta información es encriptada.
Petición
Propiedad | Descripción |
---|---|
holder_name | string (requerido) Nombre del tarjeta habiente. |
card_number | numeric (requerido) Número de tarjeta puede ser de 16 o 19 dígitos. |
cvv2 | string (requerido) Código de seguridad como aparece en la parte de atrás de la tarjeta. Generalmente 3 dígitos. |
expiration_month | numeric (requerido) Mes de expiración tal como aparece en la tarjeta. |
expiration_year | numeric (requerido) Año de expiración tal como aparece en la tarjeta. |
address | object (opcional) Dirección de facturación del tarjeta habiente. |
Repuesta
Regresa el objeto token creado o una respuesta de error si ocurrió algún problema en la creación.
Obtener un token
Definición
GET https://sandbox-api.openpay.pe/v1/{MERCHANT_ID}/tokens/{TOKEN_ID}
Ejemplo de petición
curl https://sandbox-api.openpay.pe/v1/mzdtln0bmtms6o3kck8f/tokens/k1n0mscnjwhxqia8q7cm \
-u sk_e568c42a6c384b7ab02cd47d2e407cab:
Ejemplo de respuesta
{
"id":"k1n0mscnjwhxqia8q7cm",
"card":{
"card_number":"411111XXXXXX1111",
"holder_name":"Juan Perez Ramirez",
"expiration_year":"20",
"expiration_month":"12",
"address":{
"line1":"Av 5 de Febrero",
"line2":"Roble 207",
"line3":"col carrillo",
"state":"Queretaro",
"city":"Querétaro",
"postal_code":"76900",
"country_code":"PE"
},
"creation_date":null,
"brand":"visa"
}
}
Obtiene los detalles de un token. Es necesario tener el id.
Petición
Propiedad | Descripción |
---|---|
id | string (requerido, longitud = 45) Identificador de token. |
Respuesta
Regresa un objeto token
Objetos Comunes
Información de objetos compartidos en peticiones y respuestas.
Objeto Transacción
Ejemplo de Objeto:
{
"id":"trehwr2zarltvae56vxl",
"authorization":null,
"transaction_type":"payout",
"operation_type":"out",
"currency":"PEN",
"method":"bank",
"creation_date":"2013-11-14T18:29:35-06:00",
"order_id":"000001",
"status":"in_progress",
"amount":500,
"description":"Pago de ganancias",
"error_message":null,
"customer_id":"afk4csrazjp1udezj1po",
"bank_account":{
"rfc":ONE316015PM1,
"mobile":null,
"alias":null,
"bank_name":"BANCOMER",
"creation_date":"2013-11-14T18:29:34-06:00",
"clabe":"012XXXXXXXXXX24616",
"holder_name":"Juan Tapia Trejo",
"bank_code":"012"
}
}
Propiedad | Descripción |
---|---|
id | string Identificador único asignado por Openpay al momento de su creación. |
authorization | string Número de autorización generado por el procesador. |
transaction_type | string Tipo de transacción que fue creada: fee, charge, payout, transfer. |
operation_type | string Tipo de afectación en la cuenta: in, out. |
method | string Tipo de método usado en la transacción: card, bank o customer. |
creation_date | datetime Fecha de creación de la transacción en formato ISO 8601. |
order_id | string Referencia única o número de orden/transacción. |
status | string Estatus actual de la transacción. Posibles valores: completed, in_progress, failed. |
amount | numeric Cantidad de la transacción a dos decimales. |
description | string Descripción de la transacción. |
error_message | string Si la transacción está en status: failed, en este campo se mostrará la razón del fallo. |
customer_id | string Identificardor único del cliente al cual pertence la transacción. Si el valor es nulo, la transacción pertenece a la cuenta del comercio. |
currency | string Moneda usada en la operación, por default es PEN. |
bank_account | objeto Datos de la cuenta bancaria usada en la transacción. Ver objeto BankAccoount |
card | objeto Datos de la tarjeta usada en la transacción. Ver objeto Card |
card_points | objeto Datos de los puntos de la tarjeta usados para el pago, si fueron utilizados. Ver objeto CardPoints |
Objeto Dirección
Ejemplo de Objeto:
{
"line1":"Av 5 de Febrero",
"line2":"Roble 207",
"line3":"col carrillo",
"state":"Queretaro",
"city":"Querétaro",
"postal_code":"76900",
"country_code":"PE"
}
Propiedad | Descripción |
---|---|
line1 | string (requerido) Primera línea de dirección del tarjeta habiente. Usada comúnmente para indicar la calle y número exterior e interior. |
line2 | string Segunda línea de la dirección del tarjeta habiente. Usada comúnmente para indicar condominio, suite o delegación. |
line3 | string Tercer línea de la dirección del tarjeta habiente. Usada comúnmente para indicar la colonia. |
postal_code | string (requerido) Código postal del tarjeta habiente |
state | string (requerido) Estado del tarjeta habiente |
city | string (requerido) Ciudad del tarjeta habiente |
country_code | string (requerido) Código del país del tarjeta habiente a dos caracteres en formato ISO_3166-1 |
Objeto Transaction Status
Value | Description |
---|---|
IN_PROGRESS | Transacción en proceso |
COMPLETED | Transacción ejecutada correctamente |
REFUNDED | Transacción reembolsada |
CHARGEBACK_PENDING | Transacción con contracargo pendiente |
CHARGEBACK_ACCEPTED | Transacción con contracargo aceptado |
CHARGEBACK_ADJUSTMENT | Transacción con ajuste de contracargo |
CHARGE_PENDING | Transacción de cargo que no ha sido pagada |
CANCELLED | Transacción de cargo que no fue pagada y se ha cancelado |
FAILED | Transacción que se intentó pagar pero ocurrió algún error |