Skip to main content
Skip table of contents

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

action

String

Action to execute. In this case, it is 'subscribe'.

merchant_affiliation_code

String

Subscription code generated by the merchant.

merchant_code

String

Merchant code that initiates the subscription.

type

String

Subscription type. Only 'MANUAL' is allowed.

frequency

String

No

Charge frequency for the subscription.

amount

String

No

Charge amount to be billed. The amount must be expressed as an integer in cents.

maxAmount

String

No

Maximum amount allowed for recurring payments. The amount must be expressed as an integer in cents.

currency

String (ISO 4217)

Currency for the charges (e.g., '604' = PEN).

beneficiary.first_name

String

Beneficiary first name(s).

beneficiary.last_name

String

Beneficiary last name(s).

beneficiary.email

String

Beneficiary email address.

beneficiary.phone.country_code

String

Country code for the phone number (e.g., '51').

beneficiary.phone.subscriber

String

Beneficiary phone number.

beneficiary.identity_document.type

String

No

Identity document type (e.g., 'DNI').

beneficiary.identity_document.identifier

String

No

Identity document number.

beneficiary.identity_document.country

String (ISO-3166)

No

Document issuing country (e.g., 'PE').

beneficiary.location.line_1

String

Primary address.

beneficiary.location.line_2

String

No

Secondary address (e.g., building, floor).

beneficiary.location.city

String

City of residence.

beneficiary.location.state

String

State/region.

beneficiary.location.country

String (ISO-3166)

ISO country code (e.g., 'PE').

additional_fields.FACTURACION_ID

String

No

Customer or contract ID for billing purposes.

additional_fields.PLAN

String

No

Name or code of the plan the beneficiary subscribes to.

wallet.user_id

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)

Action to execute. In this case, it is 'subscribe'.

affiliation.affiliation_id

String (UUID)

Affiliation code generated by the merchant.

affiliation.merchant_affiliation_code

String

Merchant code initiating the affiliation.

affiliation.merchant_code

String (UUID)

Affiliation type. Only 'MANUAL' is allowed.

affiliation.state

String

Frequency of the affiliation charges.

affiliation.type

String

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)

Beneficiary’s last name(s).

affiliation.beneficiary.first_name

String

Beneficiary’s email address.

affiliation.beneficiary.last_name

String

Country code of the phone number (e.g., '51').

affiliation.beneficiary.email

String

Beneficiary’s phone number.

affiliation.beneficiary.phone.country_code

String

Type of identity document (e.g., 'DNI').

affiliation.beneficiary.phone.subscriber

String

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

City of residence.

affiliation.beneficiary.location.line_2

String

No

State or region.

affiliation.beneficiary.location.city

String

ISO country code (e.g., 'PE').

affiliation.beneficiary.location.state

String

Customer or contract ID for billing purposes.

affiliation.beneficiary.location.country

String (ISO-3166)

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

Affiliation code generated by the merchant.

affiliation.card.brand

String

Merchant code initiating the affiliation.

affiliation.card.bin

String

Affiliation type. Only 'MANUAL' is allowed.

affiliation.card.last_pan

String

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

Maximum amount applied to recurring payments. The amount must be expressed as an integer in cents.

meta.status.code

String

Currency of the charges (e.g., '604' = PEN).

meta.status.message_ilgn[].locale

String

Beneficiary’s first name(s).

meta.status.message_ilgn[].value

String

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.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.