Con la integración de Pago en efectivo, tu plataforma de e-commerce adquirirá la capacidad de generar referencias Cash In cuando tus clientes elijan pagar sus órdenes en efectivo. Posteriormente, ellos podrán acudir a cualquiera de los puntos de venta físicos integrados a la red Cash In de para realizar el pago de estas.
En esta documentación encontrarás toda la información necesaria para:
En caso de tener alguna duda, estaremos felices de ayudarte a través del botón de contacto que se encuentra en cada una de las secciones de esta documentación.
dapp cuenta con un sandbox para poder realizar pruebas durante el desarrollo.
Las URL base para cada ambiente son las siguientes:
Sandbox:
https://sandbox.dapp.mx/v2/
Producción:
https://api.dapp.mx/v2/
dapp utiliza "Basic Access Authentication" para el REST API, usando el API KEY como password y dejando el usuario vacío
curl --location --request GET 'https://sandbox.dapp.mx/v2' \ --header 'Authorization: Basic OnlvdXItYXBpLWtleQ=='
var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic OnlvdXItYXBpLWtleQ==");
Request request = new Request.Builder() .addHeader("Authorization", "Basic OnlvdXItYXBpLWtleQ==")
url = "https://sandbox.dapp.mx/v2" payload={} headers = { 'Authorization': 'Basic OnlvdXItYXBpLWtleQ==', } response = requests.request("GET", url, headers=headers, data=payload)
Para poder realizar un pago en efectivo, el usuario primero debe haber generado una referencia numérica que presentará en la caja. Para generar esta referencia, se debe consumir el siguiente endpoint:
cashin/reference
https://sandbox.dapp.mx/v2/cashin/reference
POST
Parámetro |
Descripción |
Requerido u opcional |
---|---|---|
amount |
Monto, máximo 10 dígitos. Ejemplo: 10.0 |
Requerido |
name |
Nombre del usuario. |
Opcional |
|
Correo electrónico del usuario. |
Opcional |
phone |
Teléfono del usuario. |
Opcional |
expiration_minutes |
Tiempo de expiración de la referencia. |
Opcional |
curl --location --request POST 'https://sandbox.dapp.mx/v2/cashin/reference' \ --header 'User-Agent: MyApp 1.0' \ --header 'Authorization: Basic OnlvdXItYXBpLWtleQ==' \ --header 'Content-Type: application/json' \ --data-raw '{ "amount":100.00 }'
var client = new RestClient("https://sandbox.dapp.mx/v2/cashin/reference"); client.Timeout = 60; var request = new RestRequest(Method.POST); client.UserAgent = "MyApp 1.0"; request.AddHeader("Authorization", "Basic OnlvdXItYXBpLWtleQ=="); request.AddHeader("Content-Type", "application/json"); var body = @"{" + "\n" + @" ""amount"":100.00" + "\n" + @"}"; request.AddParameter("application/json", body, ParameterType.RequestBody); IRestResponse response = client.Execute(request);
OkHttpClient client = new OkHttpClient().newBuilder() .build(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\n \"amount\":100.00\n}"); Request request = new Request.Builder() .url("https://sandbox.dapp.mx/v2/cashin/reference") .method("POST", body) .addHeader("User-Agent", "MyApp 1.0") .addHeader("Authorization", "Basic OnlvdXItYXBpLWtleQ==") .addHeader("Content-Type", "application/json") .build(); Response response = client.newCall(request).execute();
import requests import json url = "https://sandbox.dapp.mx/v2/cashin/reference" payload = json.dumps({ "amount": 100 }) headers = { 'User-Agent': 'MyApp 1.0', 'Authorization': 'Basic OnlvdXItYXBpLWtleQ==', 'Content-Type': 'application/json' } response = requests.request("POST", url, headers=headers, data=payload)
{
"rc": 0,
"msg": "Ok",
"data": {
"reference": "028685993190",
"creation_date": "2022-07-27T18:41:40.778225+00:00",
"expiration_date": "2022-08-03T17:20:40.699277+00:00",
"amount": 50.0,
"currency": "MXN"
}
}
Parámetro |
Descripción |
---|---|
reference |
Número de referencia. |
creation_date |
Fecha de creación. |
expiration_date |
Fecha de expiración. |
amount |
Monto de la referencia. |
currency |
Indica la moneda. |
El e-commerce debe exponer un servicio que acepte peticiones donde Dapp le notificará que se ha realizado el pago. Una vez que el cajero haya capturado la referencia presentada por el usuario, dapp enviará esta notificación.
{
"id": "2c2725ca-eada-426a-b928-8bb851128059",
"reference": "20004042284511626341"
"amount": 100.0,
"fee": 10.0,
"total": 110.0,
"currency": "MXN",
"merchant": "Farmacias del Ahorro",
"date": "2020-11-04T18:13:46.613399-06:00",
"refunded": false,
"security": {
"key": "2c2725caeada426ab9288bb851128059",
"version": 1,
"signature":
"L1Xb1RFcDjai0QB7ZZT0+iQC4VyIoF861FBFPlU4z2PEhwkUa1YYGIbHqSk5kyXzReimDkwedhbSldBKAJFrUlGb6mhepGszb4hCNLTcPnKwZIT+vQWOQmx6aXjIHE27qQe537NNfODWF26RBgCDonQQjHKfaUrKYWaCy/kT2bWh4uIedaInmEfuEf9/rnPVY8pJXHAkkFSXIwb8f2+PdNyciJACb5TAYiTRortXNKpAteeo9SFiW83o7I4FKlfpaFf+R37piyRrdS6/McnOLOHYx6pQVzuVOeyJZ1ea0m0FD2kRf/wPAGazqT7ix47mO206IEt5+tHIxHPgBKoRbQ==",
}
}
Sección |
Parámetro |
---|---|
reference |
Indica el número de referencia. |
amount |
Indica el monto de la operación. |
fee |
Indica el monto de comisión. |
total |
Espefica el monto total del pago realizado por el usuario. |
currency |
Especifica la moneda. |
merchant |
Indica el nombre del comercio donde se realizó la operación. |
date |
Indica la fecha de la transacción. |
refunded |
Especifica si la transacción ha sido cancelada o no. |
El JSON de la petición contiene una firma digital como método de autenticación. La firma consiste en una cadena formada por los campos id, reference, amount, fee, currency, refunded, date separados por pipes con una función hash SHA-512.
Ejemplo de cadena antes del hash2c2725ca-eada-426a-b928-8bb851128059|20004042284511626341|100.0|10.0|MXN|false|2020-11-04T18:13:46.613399-06:00
Una vez que el wallet valide la veracidad de la firma, deberá regresar como respuesta un objeto JSON con los campos rc y msg.
rc |
msg |
---|---|
0 |
Operación exitosa |
-10 |
Referencia inválida |
-20 |
Error de validación |
-30 |
Servicio no disponible |
-99 |
Otro |
En casos extraordinarios en los que la caja no pueda recibir la autorización del pago debido a problemas de
conexión, la cadena enviará un reverso automático de la operación original para asegurarse de que la transacción
sea cancelada en caso de haber sido recibida por parte de Dapp y el e-commerce.
En estos casos, Dapp realizará una petición al mismo endpoint al que se envió la notificación del pago. El
contenido de la petición será el mismo que el de la operación original referente al pago con el campo refunded
con un valor True, que servirá para indicar que la operación tuvo que ser cancelada.
static void Main(string[] args) { var cadena = "3c6f084f-3949-4236-a0bc-d85ff9e05495|MXN|10.0|Pago de prueba QR 5|Prueba 5|2021-06-07T17:04:56.900046+00:00"; var cadenaBytes = Encoding.UTF8.GetBytes(cadena); var firma = "hxkqkKaar5jstZMJeCK3Bv3IByGOZrVyb9t+kt1hEL7pt/FrvxATuc+9b/95lkqkeVSnK98/cD0xSs0p2fdkAhskHZJTHbTWu3bbNHWBpIXmqnRNzuhi7zP+tmwsaGJ830o1BL5Vyq5rvqq4ll/ILkJVCEbru4VwE/+0W7OWiETV4Nqe6M9Yhu09/+GtW0KCAgVaX8Yol3SgGGp8z6+T1WJ6hw6K5EIg34UfBujJzHfr+39LpBJvPO2JykGs1lwNrOaon+FYb8AzmVoRAu49VwJ380Gb3Wv6j1oy+O/8Ry3X0b8NY83JA9mdtz5/M0pIVvgqIcNjKH4KBuambSig1g=="; var firmaBytes = Convert.FromBase64String(firma); var fileStream = File.OpenText("../../../dapp_public_prod.pem"); var pemReader = new PemReader(fileStream); var keyParameter = (AsymmetricKeyParameter)pemReader.ReadObject(); ISigner signer = SignerUtilities.GetSigner("SHA-512withRSA"); signer.Init(false, keyParameter); signer.BlockUpdate(cadenaBytes, 0, cadenaBytes.Length); Console.WriteLine(signer.VerifySignature(firmaBytes)); }
import java.io.IOException; import java.math.BigInteger; import java.nio.file.Files; import java.nio.file.Path; import java.nio.file.Paths; import java.security.InvalidKeyException; import java.security.KeyFactory; import java.security.MessageDigest; import java.security.NoSuchAlgorithmException; import java.security.NoSuchProviderException; import java.security.Signature; import java.security.SignatureException; import java.security.interfaces.RSAPublicKey; import java.security.spec.InvalidKeySpecException; import java.security.spec.X509EncodedKeySpec; import java.util.Base64; import java.util.List; import javax.crypto.BadPaddingException; import javax.crypto.IllegalBlockSizeException; import javax.crypto.NoSuchPaddingException; public class dapp { public static String encryptThisString(String input) { try { // getInstance() method is called with algorithm SHA-512 MessageDigest md = MessageDigest.getInstance("SHA-512"); // digest() method is called // to calculate message digest of the input string // returned as array of byte byte[] messageDigest = md.digest(input.getBytes()); // Convert byte array into signum representation BigInteger no = new BigInteger(1, messageDigest); // Convert message digest into hex value String hashtext = no.toString(16); // Add preceding 0s to make it 32 bit while (hashtext.length() < 32) { hashtext = "0" + hashtext; } // return the HashText return hashtext; } // For specifying wrong message digest algorithms catch (NoSuchAlgorithmException e) { throw new RuntimeException(e); } } private static final char[] HEX_ARRAY = "0123456789ABCDEF".toCharArray(); public static String bytesToHex(byte[] bytes) { char[] hexChars = new char[bytes.length * 2]; for (int j = 0; j < bytes.length; j++) { int v = bytes[j] & 0xFF; hexChars[j * 2] = HEX_ARRAY[v >>> 4]; hexChars[j * 2 + 1] = HEX_ARRAY[v & 0x0F]; } return new String(hexChars); } // Driver code public static void main(String args[]) throws NoSuchAlgorithmException, InvalidKeySpecException, IOException, InvalidKeyException, NoSuchPaddingException, BadPaddingException, IllegalBlockSizeException, NoSuchProviderException, SignatureException { String cadena = "3c6f084f-3949-4236-a0bc-d85ff9e05495|MXN|10.0|Pago de prueba QR 5|Prueba 5|2021-06-07T17:04:56.900046+00:00"; String signature = "hxkqkKaar5jstZMJeCK3Bv3IByGOZrVyb9t+kt1hEL7pt/FrvxATuc+9b/95lkqkeVSnK98/cD0xSs0p2fdkAhskHZJTHbTWu3bbNHWBpIXmqnRNzuhi7zP+tmwsaGJ830o1BL5Vyq5rvqq4ll/ILkJVCEbru4VwE/+0W7OWiETV4Nqe6M9Yhu09/+GtW0KCAgVaX8Yol3SgGGp8z6+T1WJ6hw6K5EIg34UfBujJzHfr+39LpBJvPO2JykGs1lwNrOaon+FYb8AzmVoRAu49VwJ380Gb3Wv6j1oy+O/8Ry3X0b8NY83JA9mdtz5/M0pIVvgqIcNjKH4KBuambSig1g=="; String publicKeyContent8 = null; String file8 = "resource/dapp_public_pk8_prod.pem"; Path path8 = Paths.get(file8); List<String> lines8 = Files.readAllLines(path8); publicKeyContent8 = lines8.toString().replaceAll("\\n", "").replace("[-----BEGIN PUBLIC KEY-----", "").replace("-----END PUBLIC KEY-----]", "").replaceAll(", ", ""); KeyFactory kf8 = KeyFactory.getInstance("RSA"); X509EncodedKeySpec keySpecX5098 = new X509EncodedKeySpec(Base64.getDecoder().decode(publicKeyContent8)); RSAPublicKey pubKey8 = (RSAPublicKey) kf8.generatePublic(keySpecX5098); final Signature sig = Signature.getInstance( "SHA512withRSA"); sig.initVerify( pubKey8 ); sig.update( cadena.getBytes("utf8") ); final byte[] signatureBytes = Base64.getDecoder().decode(signature); System.out.println("\n*Signature decode Base64*: " + bytesToHex(signatureBytes)); System.out.println("\n*Verificar*: " + sig.verify( signatureBytes )); } }
import base64 import os from Cryptodome.Hash import SHA512 from Cryptodome.PublicKey import RSA from Cryptodome.Signature import pkcs1_15 def test_signature(): cadena = "3c6f084f-3949-4236-a0bc-d85ff9e05495|MXN|10.0|Pago de prueba QR 5|Prueba 5|2021-06-07T17:04:56.900046+00:00" hash_cadena = SHA512.new(cadena.encode("utf-8")) signature = "hxkqkKaar5jstZMJeCK3Bv3IByGOZrVyb9t+kt1hEL7pt/FrvxATuc+9b/95lkqkeVSnK98/cD0xSs0p2fdkAhskHZJTHbTWu3bbNHWBpIXmqnRNzuhi7zP+tmwsaGJ830o1BL5Vyq5rvqq4ll/ILkJVCEbru4VwE/+0W7OWiETV4Nqe6M9Yhu09/+GtW0KCAgVaX8Yol3SgGGp8z6+T1WJ6hw6K5EIg34UfBujJzHfr+39LpBJvPO2JykGs1lwNrOaon+FYb8AzmVoRAu49VwJ380Gb3Wv6j1oy+O/8Ry3X0b8NY83JA9mdtz5/M0pIVvgqIcNjKH4KBuambSig1g==" b64_bytes = signature.encode("utf-8") byte_str = base64.b64decode(b64_bytes) path = os.path.join("MyPath", 'dapp_public_prod.pem') with open(path, 'r') as myfile: key_data = myfile.read() key = RSA.importKey(key_data) pkcs1_15.new(key).verify(hash_cadena, byte_str)
Te dejamos aquí algunos términos relevantes definidos para facilitar la lectura y entendimiento de nuestras documentaciones.
Código de cobro:
Es el identificador único asignado a una transacción de cobro generada
por un comercio y que está asociado a ciertos parámetros específicos como Nombre del Comercio, Monto,
Moneda, Fecha, Lugar y Hora, entre otros. Un código de cobro puede ser representado como un Código QR para
ser escaneado por el cliente, o ser transferido a un dispositivo móvil a través de un deep link o una
notificación push.
Código QR:
Un código de respuesta rápida (o Código QR) es una representación gráfica
bidimensional de una cadena de texto generado por que generalmente se asocia a un código de cobro.
Código QR dinámico:
Es aquél Código QR asociado a un solo código de cobro y a una sola
transacción única y diferenciable. Sus parámetros pueden tomar valores distintos en cada transacción. Cada
Código QR se verá distinto a los demás ya que representará una cadena de texto distinta.
Código QR estático:
Es aquél Código QR que luce permanentemente igual ya que siempre
representa una misma cadena de texto. Este tipo de códigos son útiles cuando los parámetros asociados a los
códigos de cobro son siempre iguales. Dado que la representación gráfica no cambia, estos códigos pueden ser
impresos y usados múltiples veces para pagar un mismo código de cobro.
Referencia Cash in:
Es un código alfanumérico asociado a una transacción de pago en
efectivo, ya sea para realizar un depósito de efectivo, para realizar un pago de servicios, para realizar el
pago en efectivo de una orden de comercio electrónico, o cualquier otra operación equivalente. Las
referencias Cash In están siempre asociadas a parámetros específicos como Monto, Fecha, Hora, entre otros, y
son generadas a petición del usuario cuando este desea realizar una operación de este tipo.
Súmate a la revolución.
Intégrate ahora.