Skip to main content
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:

Objeto PMEAffiliationRequest

Abre tabla en pantalla completaAbrir
ParámetroTipoDescripciónObligatorio
actionPAYMEAffiliationActionLa acción a ejecutar. Puede ser CREATE o UPDATE
  • PAYMEAffiliationAction.CREATE
  • PAYMEAffiliationAction.UPDATE
SI
affiliationCodeStringCódigo de afiliación generado por el comercioSI
affiliationObjeto PAYMEAffiliationDataContiene información de la afiliación. Es obligatorio cuando la acción es CREATENO
settingObjeto PAYMESettingDataContiene información de ajuste del comportamiento del formulario de afiliacionNO

Objeto PAYMEAffiliationData

Abre tabla en pantalla completaAbrir
ParámetroTipoLong.DescripciónObligatorio
typePAYMEAffiliationType-Tipo de afiliación. Valores:
  • FIXED → NO DISPONIBLE
  • VARIABLE → NO DISPONIBLE
  • MANUAL → DISPONIBLE
SI
frequencyString-Frecuencia de los cobros de la afiliaciónNO
amountString11Monto 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
maxAmountString11Monto máximo que se aplica al monto de hacer los pagos recurrentes. El monto debe expresarse como un entero en centavosNO
currencyString-Código de moneda ISO-4217.SI
additionalFieldsDiccionario-Contiene información adicional proporcionado por el comercio.NO
beneficiaryObjeto PAYMEAddressData-Información del afiliadoSI
Objeto PAYMEAddressData
Abre tabla en pantalla completaAbrir
ParámetroTipoLong.DescripciónObligatorio
firstNameString30NombresSI
lastNameString50ApellidosSI
emailString50Correo electrónicoSI
phoneString15Código del país y número de celular del titular de la tarjeta (51-958435685)SI
identityDocumentObjeto PAYMEIdentityDocument-Objeto que contiene información de documento de identidadNO
line1String50DirecciónSI
line2String50DirecciónNO
cityString50Ciudad/ProvinciaSI
stateString15Estado/DepartamentoSI
countryString2Código del País en letra. ISO-3166SI
Objeto PAYMEIdentityDocument
Abre tabla en pantalla completaAbrir
ParámetroTipoLong.DescripciónObligatorio
countryString2Código del País en letra. ISO-3166. Ejm:
  • Perú → PE
SI
typeString20Tipo de documento de identidad:
  • DNI
  • CARNET_EXTRANJERIA
  • PASAPORTE
  • OTROS
SI
identifierString20Número de documento de identidadSI

Objeto PAYMESettingData

Abre tabla en pantalla completaAbrir
ParámetroTipoLong.DescripciónObligatorio
localeString5Localización del idioma que utilizará el formulario para mostrarse.SI
Valor - Descripción
es_PE Español Perú
walletUserIdString15Valor para identificar el wallet de un usuario.NO

Parámetros de Salida

El objeto PMEAffiliationResponse está compuesto por los siguientes atributos:

Objeto PMEAffiliationResponse

Abre tabla en pantalla completaAbrir
ParámetroTipoLong.DescripciónObligatorio
successBoolean-Tiene valor **true **si se realizó el proceso correctamente, **false **si ocurrió algún error durante el procesamiento del pago.SI
resultCodeString2Código de resultado del procesamiento.SI
resultMessageString30Texto que describe el resultado del procesamiento.SI
resultObjeto PAYMEAffiliationResult-Detalle del resultado de la transacción.NO

Objeto PAYMEAffiliationResult

Abre tabla en pantalla completaAbrir
ParámetroTipoLong.DescripciónObligatorio
affiliationIdString36Identificar único de la transacción generado por Pay-meSI
affiliationCodeString36Número de operación enviado por el ComercioSI
typeString-Tipo de afiliación. Valores:
  • FIXED → NO DISPONIBLE
  • VARIABLE → NO DISPONIBLE
  • MANUAL → DISPONIBLE
SI
stateString-Estado actual de la afiliación, valores:
  • ACTIVE
  • INACTIVE
SI
frequencyString-Frecuencia de los cobros de la afiliaciónNO
amountString11Monto 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
maxAmountString11Monto máximo que se aplica al monto de hacer los pagos recurrentes. El monto debe expresarse como un entero en centavosNO
currencyString-Código de moneda ISO-4217.SI
additionalFieldsDiccionario-Contiene información adicional proporcionado por el comercio.NO
cardObjeto PAYMEAffiliationCard-Información de la tarjeta usada en la afiliaciónSI
Objeto PAYMEAffiliationCard
Abre tabla en pantalla completaAbrir
ParámetroTipoLong.DescripciónObligatorio
brandString4Marca de la tarjeta. Los valores son:
  • VISA
  • MSCD
  • AMEX
  • DINC
SI
binString6Bin de la tarjetaSI
lastPanString4Cuatro últimos dígitos de la tarjetaSI
issuerNameString50Nombre del emisor de la tarjetaNO
cardholderNameString50Nombre y Apellidos del titular de la tarjetaSI