A continuación, se detallan los parámetros de entrada y salida de Pay-me SDK.

Parámetros de Entrada

Objeto PaymeRequest

Parámetro

Tipo

Obligatorio

Descripción

setting

PaymeSettingData

SI

Contiene los valores de ajustes del comportamiento del formulario de pago.

purchase

PaymePurchaseData

SI

Contiene información de la compra

feature

PaymeFeatureData

NO

Características adicionales durante la realización de la transacción.

Objeto PaymePurchaseData

Parámetro

Tipo

Obligatorio

Descripción

operation

PaymeOperationData

SI

Contiene los datos de la operación con la cual se procesará la transacción.

addrMatch

Boolean

No

Campo que indica si la dirección de envío(shipping) será igual a la dirección de facturación(billing) .

billing

PaymePersonData

SI

Información de datos de facturación de la orden de compra.

shipping

PaymePersonData

NO

Información de datos de envió de la orden de compra.

Objeto PaymeOperationData

Parámetro

Tipo

Obligatorio

Descripción

operationNumber

String

SI

Número de operación único en la pasarela, el cual será utilizado para realizar la transacción.

operationDescription

String

SI

Descripción del producto por el cual se realiza la transacción.

amount

String

SI

Monto a cobrar por la pasarela de pago, se debe considerar punto como separador de decimales y máximo de dos dígitos decimales (#0.00).

currency

PaymeCurrencyData

SI

Información de la moneda con la que se realizará la transacción.

Objeto PaymeCurrencyData

Parámetro

Tipo

Obligatorio

Descripción

code

String

SI

Código de moneda ISO-4217.

symbol

String

SI

Símbolo de moneda con el cual se visualizará el monto en el formulario, no tiene ningún efecto en la transacción. Se recomienda el uso de los símbolos determinados en el ISO-4217

Objeto PaymePersonData

Parámetro

Tipo

Obligatorio

Descripción

firstName

String

SI

Nombres

lastName

String

SI

Apellidos

email

String

SI

Correo electrónico

addrLine1

String

SI

Dirección

addrLine2

String

NO

Dirección

countryCode

String

SI

Código del País en letra. ISO-3166

countryNumber

String

SI

Código del País en número. ISO-3166

zip

String

SI

Código postal

city

String

SI

Ciudad/Provincia

state

String

SI

Estado/Departamento

mobilePhone

String

SI

Código del país y número de celular del titular de la tarjeta (51-958435685)

homePhone

String

NO

Código del país y número del teléfono de casa del titular de la tarjeta (51-958435685)

workPhone

String

NO

Código del país y número de teléfono del trabajo del titular de la tarjeta (51-958435685)

Objeto PaymeFeatureData

Parámetro

Tipo

Obligatorio

Descripción

reserved

Diccionario

NO

Contiene los valores de ajustes del comportamiento para los datos reservados que venga desde el comercio.

wallet

PaymeWalletData

NO

Contiene los valores de ajustes del comportamiento para activar Wallet.

installments

PaymeInstallmentsData

NO

Contiene los valores de ajustes del comportamiento para activar Planes y Cuotas.

authentication

PaymeAuthenticationData

NO

Contiene los valores de ajustes del comportamiento de la autenticación

Objeto PaymeWalletData

Parámetro

Tipo

Obligatorio

Descripción

enable

Boolean

NO

Campo para poder activar el uso de wallet. Recordar que el comercio debe tener habilitado la funcionalidad del wallet en el servicio configurador.

userID

String

NO

Valor para identificar el wallet de un usuario. Es obligatorio cuando el parámetro enable es true.

Objeto PaymeInstallmentsData

Parámetro

Tipo

Obligatorio

Descripción

enable

Boolean

NO

Campo para poder activar el uso de planes y cuotas. Recordar que el comercio debe tener habilitado la funcionalidad installments en el servicio configurador.

Objeto PaymeAuthenticationData

Parámetro

Tipo

Obligatorio

Descripción

tdsChallengeInd

String

NO

Indica si el flujo challenge es requerido para la transacción.

01 = Sin preferencias

02 = No requiere challenge

03 = Challenge requerido: Preferencia del 3DSRequestor

04 = Challenge requerido: Obligatorio

Este parámetro sólo será considerado si el comercio tiene habilitado la autenticación 3DS.

Objeto PaymeSettingData

Parámetro

Tipo

Obligatorio

Descripción

locale

String

SI

Localización del idioma que utilizará el formulario para mostrarse.

Valor - Descripción

es_PE Español Perú

brands

Array<String>

SI

Contiene los valores de las marcas que serán habilitadas para el formulario de pago.

Valor - Descripción

VISA Visa

MSCD MasterCard

AMEX American Express

DINC Diners Club

Parámetros de Salida

Objeto PaymeInternalAction

Parámetro

Tipo

Obligatorio

PaymeInternalAction

Enum

Indicador de acción interna del SDK. Puede tener los siguientes valores

  • PRESS_PAY_BUTTON: Indica que el usuario presionó el botón pagar.

  • START_SCORING: Inicia al proceso evaluación de reglas (RBA - Drools).

  • END_SCORING: Finaliza el proceso evaluación de reglas.

  • START_TDS: Inicia el proceso de autenticación 3DS.

  • END_TDS: Finaliza el proceso de autenticación 3DS.

  • START_AUTHORIZATION: Inicia la autorización.

Objeto PaymeResponse

Parámetro

Tipo

Obligatorio

success

Boolean

Tiene valor true si se realizó el proceso correctamente, false si ocurrió algún error durante el procesamiento del pago.

resultCode

String

Código de resultado del procesamiento.

resultMessage

String

Texto que describe el resultado del procesamiento.

resultDetail

String

Detalles adicionales que describe el resultado del procesamiento.

reserved

Diccionario

Contiene los valores de ajustes del comportamiento para los datos reservados que venga desde el comercio.

payment

PaymentProcessResponse

Resultado del proceso de pago siempre y cuando no ocurra ningún error en el procesamiento de transacción.

Objeto PaymentProcessResponse

Parámetro

Tipo

Obligatorio

accepted

Boolean

Tiene valor true cuando el pago ha sido procesado correctamente, false si se ha rechazado por alguna razón al momento de realizar la transacción.

operationNumber

String

Número de operación correspondiente a la transacción.

operationDate

String

Fecha de procesamiento de la transacción.

authorizationCode

String

Identificador de transacción.

maskedPan

String

Tarjeta enmascarada

brand

String

Marca de la tarjeta

installments

PaymentIntallmentsResponse

información de planes y cuotas

Objeto PaymentIntallmentsResponse

Parámetro

Tipo

Obligatorio

type

String

number

String

amount

String

Valor de la cuota

currencyCode

String

Moneda

firstExpirationDate

String

Fecha del primer vencimiento de la cuota

Continuar a Inicializar Pay-me SDK iOS ➡️