Afiliaciones: Parámetros de Entrada y Salida de Pay-me SDK Android

A continuación, se detallan los parámetros de entrada y salida de Pay-me SDK para el flujo de afiliaciones:

Parámetros de Entrada

El objeto PMEAffiliationRequest está compuesto por los siguientes atributos:

Parámetro	Tipo	Descripción	Obligatorio
action	`PAYMEAffiliationAction`	La acción a ejecutar. Puede ser CREATE o UPDATE `PAYMEAffiliationAction.CREATE` `PAYMEAffiliationAction.UPDATE`	SI
affiliationCode	String	Código de afiliación generado por el comercio	SI
affiliation	Objeto PAYMEAffiliationData	Contiene información de la afiliación. Es obligatorio cuando la acción es CREATE	NO
setting	Objeto PAYMESettingData	Contiene información de ajuste del comportamiento del formulario de afiliacion	NO

Parámetro	Tipo	Long.	Descripción	Obligatorio
type	`PAYMEAffiliationType`	-	Tipo de afiliación. Valores: `FIXED` → NO DISPONIBLE `VARIABLE` → NO DISPONIBLE `MANUAL` → DISPONIBLE	SI
frequency	String	-	Frecuencia de los cobros de la afiliación	NO
amount	String	11	Monto en centavos cobrar por la pasarela de pago. La pasarela se encargar de aplicar el separador decimal. Ejemplo: Si el monto es 0.50 → Enviar 50 Si el monto es 10.00 → Enviar 1000	NO
maxAmount	String	11	Monto máximo que se aplica al monto de hacer los pagos recurrentes. El monto debe expresarse como un entero en centavos	NO
currency	String	-	Código de moneda ISO-4217.	SI
additionalFields	Diccionario	-	Contiene información adicional proporcionado por el comercio.	NO
beneficiary	Objeto PAYMEAddressData	-	Información del afiliado	SI

Parámetro	Tipo	Long.	Descripción	Obligatorio
firstName	String	30	Nombres	SI
lastName	String	50	Apellidos	SI
email	String	50	Correo electrónico	SI
phone	String	15	Código del país y número de celular del titular de la tarjeta (51-958435685)	SI
identityDocument	Objeto PAYMEIdentityDocument	-	Objeto que contiene información de documento de identidad	NO
line1	String	50	Dirección	SI
line2	String	50	Dirección	NO
city	String	50	Ciudad/Provincia	SI
state	String	15	Estado/Departamento	SI
country	String	2	Código del País en letra. ISO-3166	SI

Parámetro	Tipo	Long.	Descripción	Obligatorio
country	String	2	Código del País en letra. ISO-3166. Ejm: Perú → PE	SI
type	String	20	Tipo de documento de identidad: DNI CARNET_EXTRANJERIA PASAPORTE OTROS	SI
identifier	String	20	Número de documento de identidad	SI

Parámetro	Tipo	Long.	Descripción	Obligatorio
locale	String	5	Localización del idioma que utilizará el formulario para mostrarse.	SI
			Valor - Descripción
			es_PE Español Perú
walletUserId	String	15	Valor para identificar el wallet de un usuario.	NO

El objeto PMEAffiliationResponse está compuesto por los siguientes atributos:

Parámetro	Tipo	Long.	Descripción	Obligatorio
success	Boolean	-	Tiene valor true si se realizó el proceso correctamente, false si ocurrió algún error durante el procesamiento del pago.	SI
resultCode	String	2	Código de resultado del procesamiento.	SI
resultMessage	String	30	Texto que describe el resultado del procesamiento.	SI
result	Objeto PAYMEAffiliationResult	-	Detalle del resultado de la transacción.	NO

Parámetro	Tipo	Long.	Descripción	Obligatorio
affiliationId	String	36	Identificar único de la transacción generado por Pay-me	SI
affiliationCode	String	36	Número de operación enviado por el Comercio	SI
type	String	-	Tipo de afiliación. Valores: `FIXED` → NO DISPONIBLE `VARIABLE` → NO DISPONIBLE `MANUAL` → DISPONIBLE	SI
state	String	-	Estado actual de la afiliación, valores: ACTIVE INACTIVE	SI
frequency	String	-	Frecuencia de los cobros de la afiliación	NO
amount	String	11	Monto en centavos cobrar por la pasarela de pago. La pasarela se encargar de aplicar el separador decimal. Ejemplo: Si el monto es 0.50 → Enviar 50 Si el monto es 10.00 → Enviar 1000	NO
maxAmount	String	11	Monto máximo que se aplica al monto de hacer los pagos recurrentes. El monto debe expresarse como un entero en centavos	NO
currency	String	-	Código de moneda ISO-4217.	SI
additionalFields	Diccionario	-	Contiene información adicional proporcionado por el comercio.	NO
card	Objeto PAYMEAffiliationCard	-	Información de la tarjeta usada en la afiliación	SI

Parámetro	Tipo	Long.	Descripción	Obligatorio
brand	String	4	Marca de la tarjeta. Los valores son: VISA MSCD AMEX DINC	SI
bin	String	6	Bin de la tarjeta	SI
lastPan	String	4	Cuatro últimos dígitos de la tarjeta	SI
issuerName	String	50	Nombre del emisor de la tarjeta	NO
cardholderName	String	50	Nombre y Apellidos del titular de la tarjeta	SI