dapp
PagoEfectivo

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 para realizar el pago de estas.

En esta documentación encontrarás toda la información necesaria para:

  • Generación de referencia numérica
  • Obtener notificación del pago

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.

Paso a Paso
Ambientes

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/
Autenticación

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)
Generación de referencia numérica

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

Url completa en sandbox:
https://sandbox.dapp.mx/v2/cashin/reference

Método HTTP
POST

Parámetros Aceptados

Parámetro

Descripción

Requerido u opcional

amount

Monto, máximo 10 dígitos. Ejemplo: 10.0

Requerido

name

Nombre del usuario.

Opcional

email

Correo electrónico del usuario.

Opcional

phone

Teléfono del usuario.

Opcional

expiration_minutes

Tiempo de expiración de la referencia.
Por default toma el valor de un día.

Opcional



Ejemplos de código
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)
Ejemplo de respuesta:
{ "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ámetros devueltos:

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.


Recibir notificación del pago

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.

Petición de ejemplo
{ "id": "28e62e93-c26b-4c26-a25b-7aea2bbbfbad", "amount": "5.00", "currency": "MXN", "reference": null, "reference_num": "123456", "description": "chocolates", "date": "2018-03-28T06:24:49.167657+00:00", "code": "XM5BOqZ6", "refunded": 0, "payments": [ { "id": "821b9950-a60c-4bf5-b9ee-02b290e1e6c4", "amount": "5.00", "currency": "MXN", "reference_num": "123456", "Product": { "id": 1, "name": "saldo" }, "wallet": "QR Pago", "refunds": [ { "id": "821b9950-a60c-4bf5-b9ee-02b290e1e6c4", "amount": "1.00", "currency": "MXN", "date": "2018-03-30T06:24:49.167657+00:00" } ], "client": { "name": "Nombre del cliente" } } ], "security": { "key": "1020a1fd5a0a127eadb044ce2e96f009", "version": 1, "signature": "ikekwTR5jKd9mXlijovOmTkVjm3dPNrgEas0IZ1ooqAXvuiZh/HEWezyQAnNT/4Pq0QSLE9930ty4Pq0QSLE9930ty4+ESg74sNL VoiAbbHWKfxQjIViXCUG79wya9s/4ZW1cpN5ZdKXJ6HRs095SQrRAZzfQprMc/csZ3+d4qRwzwADfRfKCE52X311XJY5FnQcI2v/k Mx8H3oogMWzbb0PP0MFYmZb7/x2BtNMlog3KrRCQdHL2PgfvrBRLbQvKAmACIbb6yPIiKtMgj43nwJoz+pypFUPW3zsh5tOxTiwOmpBr B1HhhVhv0lO23qw73N1VrY1o2IIXrCWWDK1x4KW265r9SAo2/Fg==" } }
Parametros devueltos

Sección

Parámetro

Descripción

 

id

Ticket id de la operación

 

amount

Indica el monto de la operación.

 

currency

Indica la moneda.

 

reference

Referencia interna del comercio.

 

reference_num

Número de referencia.

 

description

Descripción del cobro.

 

date

Fecha en que se realizó la operación.

 

code

Código identificador del Código QR.

 

refunded

Estatus del reverso. ‘0’= no, ‘1’ = reverso total.

Payments

Id

Id del pago.

amount

Monto del pago.

currency

Moneda del pago.

reference_num

Número de referencia.

Product

Id

Id del producto

name

 

Nombre del producto. Recibe 1 = saldo, 2 = CoDi®, 3 = Crédito, 4 = bnpl, 5 = vales, 6 = tarjeta de débito, 7 = tarjeta de crédito, 8 = cashin, 9 = cashout, 10 = crédito 3 msi, 11 = crédito 6 msi, 12 = crédito 9 msi, 13 = crédito 12 msi. 14 = crédito 18 msi, 15 = crédito 24 msi, 16 = Enrolamiento de tarjetas

 

wallet

Nombre del wallet pagador.

Refunds

id

Id del reverso.

amount

Monto del reverso.

currency

Moneda del reverso.

date

Fecha del reverso.

Client

name

Nombre del cliente.

Parámetros Devueltos:

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 hash
28e62e93-c26b-4c26-a25b-7aea2bbbfbad|MXN|5.00|chocolates||2018-03-28T06:24:49.167657+00:00
Ejemplos de firmas
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)

Reversos

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 2, que servirá para indicar que la operación tuvo que ser cancelada.

Glosario

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.


Join the revolution.
Join now.

Join the revolution.
Join now.

I want to join
This is the contact form, please enter a correct email address.
The number must be at least 10 digits long.







Forgot my password