Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
PMEAffiliationRequest includes the following:
| Parameter | Type | Description | Mandatory |
|---|---|---|---|
| action | PAYMEAffiliationAction | The action to run. Can be CREATE or UPDATE
| If |
| AffiliationCode | String | Merchant-generated Affiliation code | If |
| 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 |
| Parameter | Type | Long. | Description | Mandatory |
|---|---|---|---|---|
| Type | PAYMEAffiliationType | - | Affiliation type. Values:
| If |
| 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:
| NO |
| maxAmound | 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. | If |
| Additional | Dictionary | - | It contains additional information provided by the merchant. | NO |
| Beneficiaries | PAYMEAddressData | - | Affiliate information | If |
| Parameter | Type | Long. | Description | Mandatory |
|---|---|---|---|---|
| firstName | String | 30 | Names | If |
| last | String | 50 | Surname | If |
| String | 50 | If | ||
| phone | String | 15 | Country code and phone number of the card holder (51- 958435685) | If |
| identityDocument | PAYMEIdentification Object | - | Object containing information about an identity document | NO |
| line1 | String | 50 | Address | If |
| line2 | String | 50 | Address | NO |
| city | String | 50 | City / Province | If |
| status | String | 15 | Status / Department | If |
| Country | String | 2 | Country code in letter. ISO-3166 | If |
| Parameter | Type | Long. | Description | Mandatory |
|---|---|---|---|---|
| Country | String | 2 | Country code in letter. ISO3166. Tube:
| If |
| Type | String | 20 | Type of identity document:
| If |
| identifier | String | 20 | Identification number | If |
| Parameter | Type | Long. | Description | Mandatory |
|---|---|---|---|---|
| locale | String | 5 | Localization of the language using the form to display itself. | If |
| Value - Description | ||||
| It’s_PE Spanish Peru | ||||
| walletUserId | String | 15 | Value to identify a user’s walk. | NO |
PMEAffiliationResponse includes the following:
| 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. | If |
| resultCode | String | 2 | Reprocessing result code. | If |
| resultMessage | String | 30 | Text describing the result of processing. | If |
| result | PAYMEAffiliationResult | - | Detail of the transaction result. | NO |
| Parameter | Type | Long. | Description | Mandatory |
|---|---|---|---|---|
| AffiliationId | String | 36 | To identify unique transaction generated by Alignet One | If |
| AffiliationCode | String | 36 | Operation number sent by merchant | If |
| Type | String | - | Affiliation type. Values:
| If |
| status | String | - | Current status of affiliation, values:
| If |
| 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:
| NO |
| maxAmound | 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. | If |
| Additional | Dictionary | - | It contains additional information provided by the merchant. | NO |
| card | PAYMEAffiliationCard | - | Information about the card used in Affiliation | If |
| Parameter | Type | Long. | Description | Mandatory |
|---|---|---|---|---|
| brand | String | 4 | Card name. The values are:
| If |
| bin | String | 6 | Card bin | If |
| lastPan | String | 4 | Last four digits of the card | If |
| issue | String | 50 | Name of card issuer | NO |
| cardholderName | String | 50 | Name and name of card holder | If |