The following are the input and output parameters of the Pay-me SDK.

Input Parameters

PaymeRequest object

Parameter

Type

Required

Description

setting

PaymeSettingData

Yes

Contains the behavioral settings values of the payment form.

purchase

PaymePurchaseData

Yes

Contains purchase information

feature

PaymeFeatureData

No

Additional features during the transaction.

PaymePurchaseData object

Parameter

Type

Required

Description

operation

PaymeOperationData

Yes

Contains the data of the operation with which the transaction will be processed.

addrMatch

Boolean

No

Field indicating whether the shipping address will be the same as the billing address.

billing

PaymePersonData

Yes

Purchase order billing data information.

shipping

PaymePersonData

No

Purchase order shipment data information.

PaymeOperationData object

Parameter

Type

Required

Description

operationNumber

String

Yes

Unique transaction number in the gateway, which will be used to perform the transaction.

operationDescription

String

Yes

Description of the product for which the transaction is made.

amount

String

Yes

Amount to be charged by the payment gateway, it must be considered point as decimal separator and a maximum of two decimal digits (0.00).

currency

PaymeCurrencyData

Yes

Information of the currency in which the transaction will be made.

PaymeCurrencyData object

Parameter

Type

Required

Description

code

String

Yes

Currency code ISO-4217.

symbol

String

Yes

Currency symbol with which the amount will be displayed on the form has no effect on the transaction. The use of the symbols determined in ISO-4217 is recommended.

PaymePersonData object

Parameter

Type

Required

Description

firstName

String

Yes

Name

lastName

String

Yes

Surname

email

String

Yes

E-mail address

addrLine1

String

Yes

Address

addrLine2

String

No

Address

countryCode

String

Yes

Country Code in letter. ISO-3166

countryNumber

String

Yes

Country code in number. ISO-3166

zip

String

Yes

Postal Code

city

String

Yes

City/Province

state

String

Yes

State/Department

mobilePhone

String

Yes

Cardholder's country code and cell phone number (51-958435685)

homePhone

String

No

Country code and cardholder's home phone number (51-958435685)

workPhone

String

No

Cardholder's country code and work phone number (51-958435685)

PaymeFeatureData object

Parameter

Type

Required

Description

reserved

Dictionary

No

Contains the behavioral settings values for the reserved data coming from the trade.

wallet

PaymeWalletData

No

Contains the behavioral setting values for activating Wallet.

installments

PaymeInstallmentsData

No

Contains the behavioral setting values for activating Plans and Fees.

authentication

PaymeAuthenticationData

No

Contains the values of authentication behavior settings.

PaymeWalletData object

Parameter

Type

Required

Description

enable

Boolean

No

Field to activate the use of wallet. Remember that the merchant must have enabled the wallet functionality in the service configurator.

userID

String

No

Value to identify a user's wallet. It is mandatory when the enable parameter is true.

PaymeInstallmentsData object

Parameter

Type

Required

Description

enable

Boolean

No

Field to activate the use of plans and quotas. Remember that the merchant must have enabled the installments functionality in the configurator service.

PaymeAuthenticationData Object

Parameter

Type

Required

Description

tdsChallengeInd

String

No

Indicates whether the challenge flow is required for the transaction.

01 = No preferences

02 = No challenge required

03 = Challenge required: 3DSRequestor Preference

04 = Challenge required: Required

This parameter will only be considered if the merchant has 3DS authentication enabled.

PaymeSettingData object

Parameter

Type

Required

Description

locale

String

Yes

Localization of the language the form will be displayed in.

Value - Description

es_PE Español Perú

brands

Array<String>

Yes

Contains the values of the marks that will be enabled for the payment form.

Value - Description

VISA Visa

MSCD MasterCard

AMEX American Express

DINC Diners Club

Output Parameters

PaymeInternalAction object

Parameter

Type

Description

PaymeInternalAction

Enum

SDK internal action indicator. It can have the following values

  • PRESS_PAY_BUTTON: Indicates that the user pressed the pay button.

  • START_SCORING: Rules evaluation process begins (RBA - Drools).

  • END_SCORING: Finalize the rules evaluation process.

  • START_TDS: Starts the 3DS authentication process.

  • END_TDS: The 3DS authentication process is finished.

  • START_AUTHORIZATION: Initiates authorization.

PaymeResponse object

Parameter

Type

Description

success

Boolean

It is true if the process was successful, false if an error occurred during payment processing.

resultCode

String

Processing result code.

resultMessage

String

Text describing the result of processing.

resultDetail

String

Additional details describing the result of the processing.

reserved

Diccionario

Contains the behavioral settings values for the reserved data coming from the trade.

payment

PaymentProcessResponse

Result of the payment process as long as no error occurs in the transaction processing.

PaymentProcessResponse object

Parameter

Type

Description

accepted

Boolean

It has value true when the payment has been processed correctly, false if it has been rejected for any reason at the time of the transaction.

operationNumber

String

Transaction number corresponding to the transaction.

operationDate

String

Transaction processing date.

authorizationCode

String

Transaction identifier.

maskedPan

String

Masked card

brand

String

Card brand

installments

PaymentIntallmentsResponse

Information on plans and installments

PaymentIntallmentsResponse Object

Parameter

Type

Description

type

String

number

String

amount

String

Value of the installment

currencyCode

String

Currency

firstExpirationDate

String

Date of first installment due date

Continue to Initialize Pay-me SDK iOS ➡️