← iOSIOS / REFERENCE

Choose platform Integration checklist Security & best practices

Fits: Input and Output parameters Alignet One SDK iOS

The following are details of the entry and output parameters of Alignet One SDK for autoization flow.

Input Parameters

PAYMEChargesRequest

Parameter	Type	Description	Mandatory
transaction	PAYMETransactionData	Contains transaction information	Yes
setting	PAYMESettingData	It contains information about the performance of the payment form.	No

PAYMETransactionData

Parameter	Type	Long.	Description	Mandatory
operationNumber	String	12	A unique operation number at the gateway, which will be used to conduct the transaction. (6 to 12 digits).	Yes
amount	String	11	That’s how bad I get. The dateway will apply the decimal separator. Example: If the amount is 0.50 → Send 50 / If the amount is 10.000 → Send 1000	Yes
currency	String	-	Currency code ISO-4217.	Yes
additionalFields	Dictionary	-	It contains additional information provided by the merchant.	No
billing	PAYMEAddressData	-	Billing information from the purchase order.	Yes
shipping	PAYMEAddressData	-	To send information about the purchase order.	No
customer	PAYMEAddressData	-	The buyer’s information.	No

PAYMEAddressData

Parameter	Type	Long.	Description	Mandatory
firstName	String	30	Names	Yes
lastName	String	50	Surname	Yes
email	String	50	Email	Yes
phone	String	15	Country code and phone number of the card holder (51- 958435685)	Yes
identityDocument	PAYMEIdentityDocument	-	Object containing information about the buyer’s identity document. Only available for CUSTOMER.	No
line1	String	50	Address	Yes
line2	String	50	Additional address	No
city	String	50	City / Province	Yes
state	String	15	Status / Department	Yes
country	String	2	Country code in letter. ISO3166. Example: Peru → PE	Yes

PAYMEIdentityDocument

Parameter	Type	Long.	Description	Mandatory
country	String	2	Country code in letter. ISO3166. Example: Peru → PE	Yes
type	String	20	Type of identity document: DNI / CARNET_EXTRANJERIA / PASAPORTE / OTROS	Yes
identifier	String	20	Identification number	Yes

PAYMESettingData

Parameter	Type	Long.	Description	Mandatory
locale	String	5	Localization of the form’s language. Value: `es_PE` (Peru)	Yes
walletUserId	String	15	Identifier of the wallet user.	No
paymentMethods	Array[String]	-	List of payment methods to be charged by SDK. If it isn’t sent, the merchant configuration will be used. Values: `CARD`, `YAPE`, `CUOTEALO`, `QR`, `BANK_TRANSFER`, `PAGO_EFECTIVO`	No
urlNotification	String	200	URL where the notification will be made after authorisation of the transaction. Optional if set up by back.	No

Output parameters

PaymeEvents Object

Parameter	Type	Description	Req.
PaymeEvents	Enum	Internal action indicator SDK. Possible values: `BUILD_FORM(methods:[String])`, `CHOOSE_PAYMENT_METHOD(method: String)`, `RETURN_LIST_PAYMENT_METHODS`, `CANCEL_PAYMENT_METHOD(method: String)`, `PRESS_PAY_BUTTON(method: String)`, `CLOSE_PAYME`	Yes

PAYMEChargesResponse

Parameter	Type	Long.	Description	Mandatory
success	Boolean	-	`true` if the process was correct, `false` if a mistake happened.	Yes
resultCode	String	2	Processing result code.	Yes
resultMessage	String	30	Text describing the result of processing.	Yes
result	PAYMETransactionResult	-	Detail of the transaction result.	No

PAYMETransactionResult

Parameter	Type	Long.	Description	Mandatory
transactionId	String	25	Unique identifier of transaction generated by Alignet One	Yes
operationNumber	String	12	Operation number sent by merchant	Yes
state	String	-	Status of transaction: `PENDIENTE`, `INVALIDO`, `AUTORIZADO`, `DENEGADO`	Yes
stateReason	String	100	Reason for the transaction state.	Yes
amount	String	11	Authorisation amount	Yes
currency	String	3	Currency used at authorization	Yes
additionalFields	Dictionary	-	Additional information provided by the merchant.	No
paymentMethod	PAYMEPaymentMethod	-	Purpose of the payment method.	Yes
expirationDate	String	-	Date in format UNIX where the transaction expires. Available for QR and PAGO_EFECTIVO.	No
processorResponse	String	500	JSON String with the processor’s response.	No
lifecycle	Array PAYMETransactionLifecycle	-	Array of times and states through which you passed the transaction.	Yes

PAYMEPaymentMethod

Parameter	Type	Long.	Description	Mandatory
name	String	-	Method of payment used: `CARD`, `YAPE`, `QR`, `CUOTEALO`, `BANK_TRANSFER`, `PAGO_EFECTIVO`	Yes
methodDetail	String	500	JSON String with information from the used card. Available for CARD, YAPE and QR.	No

PAYMETransactionLifecycle

Parameter	Type	Long.	Description	Mandatory
state	String	-	Status of transaction: `REGISTRADO`, `PENDIENTE`, `INVALIDO`, `AUTORIZADO`, `DENEGADO`	Yes
utcTime	String	-	Date in format UTC where the transaction changed status.	Yes
unixTime	String	-	Date in format UNIX where the transaction changed status.	Yes