Guía para desarrolladores de aplicaciones de pago Android

Descubre cómo adaptar tu app de pagos para Android para que funcione con pagos web y brindar una mejor experiencia del usuario a los clientes.

Eiji Kitamura

Yuichi Araki

La API de Payment Request lleva a la Web una interfaz integrada basada en el navegador que permite a los usuarios ingresar la información de pago requerida más fácil que nunca. La API también puede invocar apps de pago específicas de la plataforma.

En comparación con el uso solo de intents de Android, los pagos web permiten una mejor integración con el navegador, la seguridad y la experiencia del usuario:

• La app de pagos se inicia como un diálogo modal en el contexto del sitio web del comercio.
• La implementación es complementaria a tu app de pagos existente, lo que te permite aprovechar tu base de usuarios.
• Se verifica la firma de la app de pago para evitar el sideloading.
• Las aplicaciones de pago pueden admitir varias formas de pago.
• Se puede integrar cualquier forma de pago, como criptomonedas, transferencias bancarias y mucho más. Las apps de pago en dispositivos Android incluso pueden integrar métodos que requieren acceso al chip de hardware del dispositivo.

Para implementar los pagos web en una app de pagos para Android, debes seguir cuatro pasos:

1. Permite que los comercios descubran tu app de pagos.
2. Informar a un comercio si un cliente tiene un instrumento inscrito (como una tarjeta de crédito) listo para pagar
3. Permite que un cliente realice un pago.
4. Verifica el certificado de firma del emisor.

Para ver los pagos web en acción, consulta la demo de android-web-payment.

Paso 1: Permite que los comercios descubran tu app de pagos

Para que un comercio use tu app de pagos, debe usar la Payment Request API y especificar la forma de pago que admites con el identificador de forma de pago.

Si tienes un identificador de forma de pago único para tu app de pagos, puedes configurar tu propio manifiesto de forma de pago para que los navegadores puedan descubrir tu app.

Paso 2: Informa al comercio si un cliente tiene un instrumento inscrito listo para pagar

El comercio puede llamar a hasEnrolledInstrument() para consultar si el cliente puede realizar un pago. Puedes implementar IS_READY_TO_PAY como servicio de Android para responder esta búsqueda.

AndroidManifest.xml

Declara tu servicio con un filtro de intents que tenga la acción org.chromium.intent.action.IS_READY_TO_PAY.

<service
  android:name=".SampleIsReadyToPayService"
  android:exported="true">
  <intent-filter>
    <action android:name="org.chromium.intent.action.IS_READY_TO_PAY" />
  </intent-filter>
</service>

El servicio IS_READY_TO_PAY es opcional. Si no hay un controlador de intents de este tipo en la app de pagos, el navegador web supone que la app siempre puede realizar pagos.

AIDL

La API del servicio IS_READY_TO_PAY se define en AIDL. Crea dos archivos AIDL con el siguiente contenido:

app/src/main/aidl/org/chromium/IsReadyToPayServiceCallback.aidl

package org.chromium;
interface IsReadyToPayServiceCallback {
    oneway void handleIsReadyToPay(boolean isReadyToPay);
}

app/src/main/aidl/org/chromium/IsReadyToPayService.aidl

package org.chromium;
import org.chromium.IsReadyToPayServiceCallback;

interface IsReadyToPayService {
    oneway void isReadyToPay(IsReadyToPayServiceCallback callback);
}

Cómo implementar IsReadyToPayService

La implementación más simple de IsReadyToPayService se muestra en el siguiente ejemplo:

class SampleIsReadyToPayService : Service() {
  private val binder = object : IsReadyToPayService.Stub() {
    override fun isReadyToPay(callback: IsReadyToPayServiceCallback?) {
      callback?.handleIsReadyToPay(true)
    }
  }

  override fun onBind(intent: Intent?): IBinder? {
    return binder
  }
}

Respuesta

El servicio puede enviar su respuesta a través del método handleIsReadyToPay(Boolean).

callback?.handleIsReadyToPay(true)

Permiso

Puedes usar Binder.getCallingUid() para verificar quién es el emisor. Ten en cuenta que debes hacer esto en el método isReadyToPay, no en onBind.

override fun isReadyToPay(callback: IsReadyToPayServiceCallback?) {
  try {
    val callingPackage = packageManager.getNameForUid(Binder.getCallingUid())
    // …

Consulta Cómo verificar el certificado de firma del llamador para saber cómo verificar que el paquete de llamada tenga la firma correcta.

Paso 3: Permite que un cliente realice el pago

El comercio llama a show() para iniciar la app de pagos de modo que el cliente pueda realizar un pago. La app de pagos se invoca a través de un intent PAY de Android con información de transacción en los parámetros del intent.

La app de pagos responde con methodName y details, que son específicos de la app de pagos y son opacos para el navegador. El navegador convierte la cadena details en un objeto JavaScript para el comercio a través de la desserialización de JSON, pero no aplica ninguna validez más allá de eso. El navegador no modifica el details; el valor de ese parámetro se pasa directamente al comercio.

AndroidManifest.xml

La actividad con el filtro de intents PAY debe tener una etiqueta <meta-data> que identifique el identificador de forma de pago predeterminada de la app.

Para admitir varias formas de pago, agrega una etiqueta <meta-data> con un recurso <string-array>.

<activity
  android:name=".PaymentActivity"
  android:theme="@style/Theme.SamplePay.Dialog">
  <intent-filter>
    <action android:name="org.chromium.intent.action.PAY" />
  </intent-filter>

  <meta-data
    android:name="org.chromium.default_payment_method_name"
    android:value="https://bobbucks.dev/pay" />
  <meta-data
    android:name="org.chromium.payment_method_names"
    android:resource="@array/method_names" />
</activity>

resource debe ser una lista de cadenas, cada una de las cuales debe ser una URL absoluta válida con un esquema HTTPS, como se muestra aquí.

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <string-array name="method_names">
        <item>https://alicepay.com/put/optional/path/here</item>
        <item>https://charliepay.com/put/optional/path/here</item>
    </string-array>
</resources>

Parámetros

Los siguientes parámetros se pasan a la actividad como extras de intent:

• methodNames
• methodData
• topLevelOrigin
• topLevelCertificateChain
• paymentRequestOrigin
• total
• modifiers
• paymentRequestId

val extras: Bundle? = intent?.extras

methodNames

Los nombres de los métodos que se usan. Los elementos son las claves del diccionario methodData. Estas son las formas que admite la app de pagos.

val methodNames: List<String>? = extras.getStringArrayList("methodNames")

methodData

Una asignación de cada uno de los methodNames a methodData

val methodData: Bundle? = extras.getBundle("methodData")

merchantName

Es el contenido de la etiqueta HTML <title> de la página de confirmación de la compra del comercio (el contexto de navegación de nivel superior del navegador).

val merchantName: String? = extras.getString("merchantName")

topLevelOrigin

El origen del comercio sin el esquema (el origen sin esquema del contexto de navegación de nivel superior) Por ejemplo, https://mystore.com/checkout se pasa como mystore.com.

val topLevelOrigin: String? = extras.getString("topLevelOrigin")

topLevelCertificateChain

La cadena de certificados del comercio (la cadena de certificados del contexto de navegación de nivel superior). Es nulo para localhost y el archivo en el disco, que son contextos seguros sin certificados SSL. Cada Parcelable es un paquete con una clave certificate y un valor de array de bytes.

val topLevelCertificateChain: Array<Parcelable>? =
    extras.getParcelableArray("topLevelCertificateChain")
val list: List<ByteArray>? = topLevelCertificateChain?.mapNotNull { p ->
  (p as Bundle).getByteArray("certificate")
}

paymentRequestOrigin

El origen sin esquema del contexto de navegación del iframe que invocó el constructor new PaymentRequest(methodData, details, options) en JavaScript. Si el constructor se invocó desde el contexto de nivel superior, el valor de este parámetro es igual al valor del parámetro topLevelOrigin.

val paymentRequestOrigin: String? = extras.getString("paymentRequestOrigin")

total

Es la cadena JSON que representa el importe total de la transacción.

val total: String? = extras.getString("total")

Este es un ejemplo de contenido de la cadena:

{"currency":"USD","value":"25.00"}

modifiers

El resultado de JSON.stringify(details.modifiers), donde details.modifiers solo contiene supportedMethods y total.

paymentRequestId

El campo PaymentRequest.id que las apps de "pagos push" deben asociar con el estado de la transacción. Los sitios web de los comercios usarán este campo para consultar el estado de la transacción fuera de banda en las apps de "pago directo".

val paymentRequestId: String? = extras.getString("paymentRequestId")

Respuesta

La actividad puede enviar su respuesta a través de setResult con RESULT_OK.

setResult(Activity.RESULT_OK, Intent().apply {
  putExtra("methodName", "https://bobbucks.dev/pay")
  putExtra("details", "{\"token\": \"put-some-data-here\"}")
})
finish()

Debes especificar dos parámetros como extras de Intent:

• methodName: Es el nombre del método que se usa.
• details: Es una cadena JSON que contiene la información necesaria para que el comercio complete la transacción. Si el valor es true, details debe construirse de tal manera que JSON.parse(details) funcione correctamente.

Puedes pasar RESULT_CANCELED si la transacción no se completó en la app de pagos, por ejemplo, si el usuario no ingresó el código PIN correcto de su cuenta en la app de pagos. El navegador puede permitirle elegir otra app de pagos.

setResult(RESULT_CANCELED)
finish()

Si el resultado de la actividad de una respuesta de pago recibida de la app de pagos invocada se establece en RESULT_OK, Chrome buscará methodName y details que no estén vacíos en sus elementos adicionales. Si la validación falla, Chrome mostrará una promesa rechazada de request.show() con uno de los siguientes mensajes de error que el desarrollador puede ver:

'Payment app returned invalid response. Missing field "details".'
'Payment app returned invalid response. Missing field "methodName".'

Permiso

La actividad puede verificar al llamador con su método getCallingPackage().

val caller: String? = callingPackage

El último paso es verificar el certificado de firma del llamador para confirmar que el paquete de llamada tenga la firma correcta.

Paso 4: Verifica el certificado de firma del emisor

Puedes verificar el nombre del paquete del llamador con Binder.getCallingUid() en IS_READY_TO_PAY y con Activity.getCallingPackage() en PAY. Para verificar que el llamador es el navegador que tienes en mente, debes verificar su certificado de firma y asegurarte de que coincida con el valor correcto.

Si tu app está orientada al nivel de API 28 y versiones posteriores, y realizas la integración con un navegador que tiene un solo certificado de firma, puedes usar PackageManager.hasSigningCertificate().

val packageName: String = … // The caller's package name
val certificate: ByteArray = … // The correct signing certificate.
val verified = packageManager.hasSigningCertificate(
  callingPackage,
  certificate,
  PackageManager.CERT_INPUT_SHA256
)

Se prefiere PackageManager.hasSigningCertificate() para los navegadores de un solo certificado, ya que controla correctamente la rotación de certificados. (Chrome tiene un solo certificado de firma). Las apps que tienen varios certificados de firma no pueden rotarlos.

Si necesitas admitir el nivel de API 27 o versiones anteriores, o controlar navegadores con varios certificados de firma, puedes usar PackageManager.GET_SIGNATURES.

val packageName: String = … // The caller's package name
val certificates: Set<ByteArray> = … // The correct set of signing certificates

val packageInfo = getPackageInfo(packageName, PackageManager.GET_SIGNATURES)
val sha256 = MessageDigest.getInstance("SHA-256")
val signatures = packageInfo.signatures.map { sha256.digest(it.toByteArray()) }
val verified = signatures.size == certificates.size &&
    signatures.all { s -> certificates.any { it.contentEquals(s) } }