← AndroidANDROID / REFERENCE
Fits: Input and Output parameters Alignet One SDK Android
The following are details of the entry and output parameters of Alignet One SDK.Input Parameters
PAYMEChargesRequest
Open complete board| Parameter | Type | Description | Mandatory |
|---|---|---|---|
| transaction | PAYMETransactionData | Contains transaction information | Yes |
| setting | PAYMESettingData | It contains information about the performance of the payment form. | No |
PAYMETransactionData
Open complete board| 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 be charged with applying the decimal separator. Example:
| Yes |
| currency | String | 3 | Currency code ISO-4217 (3 numerical digits)
| Yes |
| additionalFields | Dictionary | - | It contains additional information provided by the merchant. | No |
| billing | PAYMEAddressData | - | Billing information from the purchase order. | Yes |
| shipping | PAYMEAddressData | - | Shipping information for the purchase order. | No |
| customer | PAYMEAddressData | - | The buyer’s information. | No |
PAYMEAddressData
Open complete board| Parameter | Type | Long. | Description | Mandatory |
|---|---|---|---|---|
| firstName | String | 30 | Names | Yes |
| lastName | String | 50 | Surname | Yes |
| String | 50 | 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 | Address | No |
| city | String | 50 | City / Province | Yes |
| state | String | 15 | Status / Department | Yes |
| country | String | 2 | Country code in letter. ISO3166. Tube:
| Yes |
PAYMEIdentityDocument
Open complete board| Parameter | Type | Long. | Description | Mandatory |
|---|---|---|---|---|
| country | String | 2 | Country code in letter. ISO3166. Tube:
| Yes |
| type | String | 20 | Type of identity document:
| 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 |
| paymentMethods | Arrays[String] | - | Loan of methods of payments that will carry SDKif you do not send, the list of the merchant configuration shall be used | No |
| Value - Description | ||||
| CARD - Credit and debit cards | ||||
| YAPE - Yape payment | ||||
| CUOTEALO - Payment with Cuotéalo BCP | ||||
| QR - Payment with mobile wallets | ||||
| BANK_TRANSFER - Payment for Banking Transfer | ||||
| PAGO_EFECTIVO - Payment by PagoEfectivo | ||||
urlNotification | String | 200 | URL where the notification will be made after authorisation of the transaction. It’s optional as it can be set by back | No |
Output parameters
PaymeEvents Object
Open complete board| Parameter | Type | Description | Req. |
|---|---|---|---|
| PaymeEvents | Enum | Internal action indicator SDK. Can have the following values
| Yes |
PAYMEChargesResponse includes the following:
PAYMEChargesResponse
Open complete board| Parameter | Type | Long. | Description | Mandatory |
|---|---|---|---|---|
| success | Boolean | - | It’s got value.**true**if the process was performed correctly,**Fasse**if 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 | PAYMETransactionResult | - | Detail of the transaction result. | No |
PAYMETransactionResult
Open complete board| Parameter | Type | Long. | Description | Mandatory |
|---|---|---|---|---|
| transactionId | String | 25 | To identify unique transaction generated by Alignet One | Yes |
| operationNumber | String | 12 | Operation number sent by merchant | Yes |
| state | String | - | Status of transaction:
| 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 | - | It contains additional information provided by the merchant. | No |
| paymentMethod | PAYMEPaymentMethod | - | Purpose of the payment method | Yes |
| expirationDate | String | - | Date in format UNIX where the transaction will be terminated. Available for QR and PAGO_EFECTIVO | No |
| processorResponse | String | 500 | JSON String with a response from the processor. | No |
| lifecycle | Array PAYMETransactionLifecycle | - | Array of times and states by which I pass the transaction | Yes |
PAYMEPaymentMethod
Open complete board| Parameter | Type | Long. | Description | Mandatory |
|---|---|---|---|---|
| name | String | - | Payment method used to approve the transaction:
| Yes |
| methodDetail | String | 500 | JSON String that contains information from the card used for authorization, these data are available in methods CARD - YAPE - QR. | No |
PAYMETransactionLifecycle
Open complete board| Parameter | Type | Long. | Description | Mandatory |
|---|---|---|---|---|
| state | String | - | Status of transaction:
| Yes |
| utcTime | String | - | Date in format UTC with the transaction changing status. | Yes |
| unixTime | String | - | Date in format UNIX with the transaction changing status. | Yes |