Android SDK input and output parameters

← AndroidANDROID / REFERENCE

Choose platform Integration checklist Security & best practices

The following are details of the entry and output parameters of Alignet One SDK for affiliations flow:

Input Parameters

The object PMEAffiliationRequest includes the following:

PMEAffiliationRequest

Open complete board

Parameter	Type	Description	Mandatory
action	`PAYMEAffiliationAction`	The action to run. Can be CREATE or UPDATE `PAYMEAffiliationAction.CREATE` `PAYMEAffiliationAction.UPDATE`	Yes
affiliationCode	String	Merchant-generated Affiliation code	Yes
affiliation	PAYMEAffiliationData	It contains information about Affiliation. It’s obligatory when the action’s CREATE	No
setting	PAYMESettingData	Contains performance titration information from membership form	No

PAYMEAffiliationData

Open complete board

Parameter	Type	Long.	Description	Mandatory
type	`PAYMEAffiliationType`	-	Affiliation type. Values: `FIXED` → NOT AVAILABLE `VARIABLE` → NOT AVAILABLE `MANUAL` → AVAILABLE	Yes
frequency	String	-	Frequency of Affiliation collection	No
amount	String	11	That’s how bad I get. The dateway will be charged with applying the decimal separator. Example: If the amount is 0.50 → Send 50 If the amount is 10.00 → Send 1000	No
maxAmount	String	11	The maximum amount applied to the amount of recurrent payments. The amount should be expressed as an integer in cents	No
currency	String	-	Currency code ISO-4217.	Yes
additionalFields	Dictionary	-	It contains additional information provided by the merchant.	No
beneficiary	PAYMEAddressData	-	Affiliate information	Yes

PAYMEAddressData

Open complete board

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 an identity document	No
line1	String	50	Address	Yes
line2	String	50	Address	No
city	String	50	City / Province	Yes
state	String	15	Status / Department	Yes
country	String	2	Country code in letter. ISO-3166	Yes

PAYMEIdentityDocument

Open complete board

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

PAYMESettingData

Open complete board

Parameter	Type	Long.	Description	Mandatory
locale	String	5	Localization of the language using the form to display itself.	Yes
Value - Description
es_PE — Spanish (Peru)
walletUserId	String	15	Identifier of the wallet user.	No

Output parameters

The object PMEAffiliationResponse includes the following:

PMEAffiliationResponse

Open complete board

Parameter	Type	Long.	Description	Mandatory
success	Boolean	-	It’s got value.trueif the process was performed correctly,Fasseif an error occurred during the payment processing.	Yes
resultCode	String	2	Processing result code.	Yes
resultMessage	String	30	Text describing the result of processing.	Yes
result	PAYMEAffiliationResult	-	Detail of the transaction result.	No

PAYMEAffiliationResult

Open complete board

Parameter	Type	Long.	Description	Mandatory
affiliationId	String	36	To identify unique transaction generated by Alignet One	Yes
affiliationCode	String	36	Operation number sent by merchant	Yes
type	String	-	Affiliation type. Values: `FIXED` → NOT AVAILABLE `VARIABLE` → NOT AVAILABLE `MANUAL` → AVAILABLE	Yes
state	String	-	Current status of affiliation, values: ACTIVE INACTIVE	Yes
frequency	String	-	Frequency of Affiliation collection	No
amount	String	11	That’s how bad I get. The dateway will be charged with applying the decimal separator. Example: If the amount is 0.50 → Send 50 If the amount is 10.00 → Send 1000	No
maxAmount	String	11	The maximum amount applied to the amount of recurrent payments. The amount should be expressed as an integer in cents	No
currency	String	-	Currency code ISO-4217.	Yes
additionalFields	Dictionary	-	It contains additional information provided by the merchant.	No
card	PAYMEAffiliationCard	-	Information about the card used in Affiliation	Yes

PAYMEAffiliationCard

Open complete board

Parameter	Type	Long.	Description	Mandatory
brand	String	4	Card brand. The values are: VISA MSCD AMEX DINC	Yes
bin	String	6	Card bin	Yes
lastPan	String	4	Last four digits of the card	Yes
issuerName	String	50	Name of card issuer	No
cardholderName	String	50	Name and name of card holder	Yes

Getting started

Integration

Migration

Payments

Input Parameters

PMEAffiliationRequest

PAYMEAffiliationData

PAYMEAddressData

PAYMEIdentityDocument

PAYMESettingData

Output parameters

PMEAffiliationResponse

PAYMEAffiliationResult

PAYMEAffiliationCard

​Input Parameters

​PMEAffiliationRequest

​PAYMEAffiliationData

PAYMEAddressData

PAYMEIdentityDocument

​PAYMESettingData

​Output parameters

​PMEAffiliationResponse

​PAYMEAffiliationResult

PAYMEAffiliationCard

Input Parameters

PMEAffiliationRequest

PAYMEAffiliationData

PAYMESettingData

Output parameters

PMEAffiliationResponse

PAYMEAffiliationResult