Parámetros de Entrada y Salida de Pay-me SDK iOS
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 | SI | Contiene los valores de ajustes del comportamiento del formulario de pago. | |
purchase | SI | Contiene información de la compra | |
feature | NO | Características adicionales durante la realización de la transacción. |
Objeto PaymeSettingData
Parámetro | Tipo | Long. | Obligatorio | Descripción |
locale | String | 5 | SI | Localización del idioma que utilizará el formulario para mostrarse. |
Valor - Descripción | ||||
es_PE Español Perú | ||||
brands | Array<String> | 4 | 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 |
Objeto PaymePurchaseData
Parámetro | Tipo | Obligatorio | Descripción |
operation | 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 | SI | Información de datos de facturación de la orden de compra. | |
shipping | NO | Información de datos de envió de la orden de compra. |
Objeto PaymeOperationData
Parámetro | Tipo | Long. | Obligatorio | Descripción |
operationNumber | String | 6 | SI | Número de operación único en la pasarela, el cual será utilizado para realizar la transacción. |
operationDescription | String | 30 | SI | Descripción del producto por el cual se realiza la transacción. |
amount | String | 11 | 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 | - | SI | Información de la moneda con la que se realizará la transacción. |
Objeto PaymeCurrencyData
Parámetro | Tipo | Long. | Obligatorio | Descripción |
code | String | 3 | SI | Código de moneda ISO-4217. |
symbol | String | 5 | 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 | Long. | Obligatorio | Descripción |
firstName | String | 30 | SI | Nombres |
lastName | String | 50 | SI | Apellidos |
String | 50 | SI | Correo electrónico | |
addrLine1 | String | 50 | SI | Dirección |
addrLine2 | String | 50 | NO | Dirección |
countryCode | String | 2 | SI | Código del País en letra. ISO-3166 |
countryNumber | String | 3 | SI | Código del País en número. ISO-3166 |
zip | String | 10 | SI | Código postal |
city | String | 50 | SI | Ciudad/Provincia |
state | String | 15 | SI | Estado/Departamento |
mobilePhone | String | 15 | SI | Código del país y número de celular del titular de la tarjeta (51-958435685) |
homePhone | String | 15 | NO | Código del país y número del teléfono de casa del titular de la tarjeta (51-958435685) |
workPhone | String | 15 | 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 | NO | Contiene los valores de ajustes del comportamiento para activar Wallet. | |
installments | NO | Contiene los valores de ajustes del comportamiento para activar Planes y Cuotas. | |
authentication | NO | Contiene los valores de ajustes del comportamiento de la autenticación |
Objeto PaymeWalletData
Parámetro | Tipo | Long. | 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 | 30 | 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 | Long. | Obligatorio | Descripción |
tdsChallengeInd | String | 2 | 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. |
Parámetros de Salida
Objeto PaymeInternalAction
Parámetro | Tipo | Descripción | Req. |
PaymeInternalAction | Enum | Indicador de acción interna del SDK. Puede tener los siguientes valores
| SI |
Objeto PaymeResponse
Parámetro | Tipo | Long. | Descripción | Req. |
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 |
resultDetail | String | 100 | Detalles adicionales que describe el resultado del procesamiento. | SI |
reserved | Diccionario | - | Contiene los valores de ajustes del comportamiento para los datos reservados que venga desde el comercio. | NO |
payment | - | Resultado del proceso de pago siempre y cuando no ocurra ningún error en el procesamiento de transacción. | NO |
Objeto PaymentProcessResponse
Parámetro | Tipo | Long. | Descripción |
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 | 6 | Número de operación correspondiente a la transacción. |
operationDate | String | 25 | Fecha de procesamiento de la transacción. Ejemplo: 15/06/2023 11:30:49 +0000 ( |
authorizationCode | String | 10 | Identificador de transacción. |
maskedPan | String | 16 | Tarjeta enmascarada |
brand | String | 4 | Marca de la tarjeta |
installments | - | información de planes y cuotas |
Objeto PaymentIntallmentsResponse
Parámetro | Tipo | Long. | Descripción |
type | String | 2 | |
number | String | 2 | |
amount | String | 11 | Valor de la cuota |
currencyCode | String | 2 | Moneda |
firstExpirationDate | String | 10 | Fecha del primer vencimiento de la cuota |