Initialize Automatic Debit component
When creating a new instance of the component, a configuration object is required with the following properties: nonce (security value to exchange for a token), payload (transaction information to be processed), and settings (form configurations).
Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| String | Sí | Action to execute. In this case, it is 'subscribe'. |
| String | Sí | Subscription code generated by the merchant. |
| String | Sí | Merchant code that initiates the subscription. |
| String | Sí | Subscription type. Only 'MANUAL' is allowed. |
| String | No | Charge frequency for the subscription. |
| String | No | Charge amount to be billed. The amount must be expressed as an integer in cents. |
| String | No | Maximum amount allowed for recurring payments. The amount must be expressed as an integer in cents. |
| String (ISO 4217) | Sí | Currency for the charges (e.g., '604' = PEN). |
| String | Sí | Beneficiary first name(s). |
| String | Sí | Beneficiary last name(s). |
| String | Sí | Beneficiary email address. |
| String | Sí | Country code for the phone number (e.g., '51'). |
| String | Sí | Beneficiary phone number. |
| String | No | Identity document type (e.g., 'DNI'). |
| String | No | Identity document number. |
| String (ISO-3166) | No | Document issuing country (e.g., 'PE'). |
| String | Sí | Primary address. |
| String | No | Secondary address (e.g., building, floor). |
| String | Sí | City of residence. |
| String | Sí | State/region. |
| String (ISO-3166) | Sí | ISO country code (e.g., 'PE'). |
| String | No | Customer or contract ID for billing purposes. |
| String | No | Name or code of the plan the beneficiary subscribes to. |
| String | No | Wallet user ID to associate a card with the subscription. |
Respuesta de Afiliacion
Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
success | Boolean (String en este caso) | Sí | Action to execute. In this case, it is 'subscribe'. |
affiliation.affiliation_id | String (UUID) | Sí | Affiliation code generated by the merchant. |
affiliation.merchant_affiliation_code | String | Sí | Merchant code initiating the affiliation. |
affiliation.merchant_code | String (UUID) | Sí | Affiliation type. Only 'MANUAL' is allowed. |
affiliation.state | String | Sí | Frequency of the affiliation charges. |
affiliation.type | String | Sí | Charge amount. The amount must be expressed as an integer in cents. |
affiliation.frequency | String | No | Maximum amount applied to recurring payments. The amount must be expressed as an integer in cents. |
affiliation.amount | String | No | Currency of the charges (e.g., '604' = PEN). |
affiliation.max_amount | String | No | Beneficiary’s first name(s). |
affiliation.currency | String (ISO 4217) | Sí | Beneficiary’s last name(s). |
affiliation.beneficiary.first_name | String | Sí | Beneficiary’s email address. |
affiliation.beneficiary.last_name | String | Sí | Country code of the phone number (e.g., '51'). |
affiliation.beneficiary.email | String | Sí | Beneficiary’s phone number. |
affiliation.beneficiary.phone.country_code | String | Sí | Type of identity document (e.g., 'DNI'). |
affiliation.beneficiary.phone.subscriber | String | Sí | Identity document number. |
affiliation.beneficiary.identity_document.type | String | No | Country of issuance of the document (e.g., 'PE'). |
affiliation.beneficiary.identity_document.identifier | String | No | Primary address. |
affiliation.beneficiary.identity_document.country | String (ISO-3166) | No | Additional address (e.g., building, floor). |
affiliation.beneficiary.location.line_1 | String | Sí | City of residence. |
affiliation.beneficiary.location.line_2 | String | No | State or region. |
affiliation.beneficiary.location.city | String | Sí | ISO country code (e.g., 'PE'). |
affiliation.beneficiary.location.state | String | Sí | Customer or contract ID for billing purposes. |
affiliation.beneficiary.location.country | String (ISO-3166) | Sí | Name or code of the plan to which the beneficiary subscribes. |
affiliation.additional_fields.FACTURACION_ID | String | No | Wallet user ID to associate a card with the subscription. |
affiliation.additional_fields.PLAN | String | No | Action to execute. In this case, it is 'subscribe'. |
affiliation.card.token | String | Sí | Affiliation code generated by the merchant. |
affiliation.card.brand | String | Sí | Merchant code initiating the affiliation. |
affiliation.card.bin | String | Sí | Affiliation type. Only 'MANUAL' is allowed. |
affiliation.card.last_pan | String | Sí | Frequency of the affiliation charges. |
affiliation.card.issuer_name | String | No | Charge amount. The amount must be expressed as an integer in cents. |
affiliation.card.card_holder_name | String | Sí | Maximum amount applied to recurring payments. The amount must be expressed as an integer in cents. |
meta.status.code | String | Sí | Currency of the charges (e.g., '604' = PEN). |
meta.status.message_ilgn[].locale | String | Sí | Beneficiary’s first name(s). |
meta.status.message_ilgn[].value | String | Sí | Beneficiary’s last name(s). |
Action element to activate the different flows.
action | Descripcion |
|---|---|
authorize | Shows a payment form with the different methods enabled for the merchant. |
subscribe | Shows the subscription form. |
update_subscription | Shows a form to update an existing subscription. |