Automatic debit

← Checkout Web overviewADVANCED · IN DEVELOPMENT

That functionality was currently under development. Documentation, parameters and flows can be changed before their final availability.

Retiring Automatic Flow component

When a new instance of the component is created a concurrently with the properties are necessary nonce, payload and sittings.

Parameters

Affiliation data

Field	Type	Mandatory	Description
`action`	String	Yes	Action to run. Values: `subscribe` / `update_subscription`
`merchant_affiliation_code`	String	Yes	Affiliation code generated by the merchant.
`merchant_code`	String	Yes	Merchant code that starts Affiliation.
`type`	String	Yes	Affiliation type. It’s only allowed `MANUAL`.
`frequency`	String	No	Frequency of Affiliation collection.
`amount`	String	No	Amount to charge.
`maxAmount`	String	No	Maximum amount for recurrent payments in cents.
`currency`	String (ISO 4217)	Yes	Payment currency. For example: `604` = PEN.

Data of the recipient

Field	Type	Mandatory	Description
`beneficiary.first_name`	String	Yes	Recipient’s first name.
`beneficiary.last_name`	String	Yes	Recipient’s last name.
`beneficiary.email`	String	Yes	Email from the recipient.
`beneficiary.phone.country_code`	String	Yes	Telephone country code. For example: `51`.
`beneficiary.phone.subscriber`	String	Yes	The recipient’s phone number.
`beneficiary.identity_document.type`	String	No	Type of ID. For example: `DNI`.
`beneficiary.identity_document.identifier`	String	No	Identification document number.
`beneficiary.identity_document.country`	String (ISO-3166)	No	Country of issue of document. For example: `PE`.
`beneficiary.location.line_1`	String	Yes	Main address.
`beneficiary.location.line_2`	String	No	Additional address.
`beneficiary.location.city`	String	Yes	The town of residence.
`beneficiary.location.state`	String	Yes	Department or region.
`beneficiary.location.country`	String (ISO-3166)	Yes	Code ISO from the country. For example: `PE`.

Additional fields

Field	Type	Mandatory	Description
`additional_fields.FACTURACION_ID`	String	No	Customer’s ID or billing contract.
`additional_fields.PLAN`	String	No	Name or code of the plan referred to by the recipient.
`wallet.user_id`	String	No	Wallet user ID used to associate a card with the affiliation.

Flow available

autoize

It shows a payment form with the different methods enabling the merchant.

Sample the Affiliation form to register a new automatic debit.

update_Subscription

It shows a form to update an existing affiliation.

Show Alignet One Flex Automatic defect

That’s the final step. It’s indicated within what and DOM form and functions to be shown callback to run during the process.

Callbackes

responseCallback

It runs after the component delivers a response to the process.

trackingCallback

It runs for every event fired during the process.

onErrorCallback

It runs with an error during the process.

Do not use meta.status.code as an authorized or refused payment validator. That code indicates only the result of service processing. For an authorisation, valid transaction status and confirm result from backend before closing order.

Cases of use

Authorisation with Wallet
Affiliation form
Affiliation with Wallet
Updating Affiliation
Updating Affiliation with Wallet

    {
        "action": "authorize",
        "channel": "ecommerce",
        "merchant_code": "your_merchant_code",
        "merchant_operation_number": "976867",
        "payment_details": {
            "amount": "387000",
            "currency": "604",
            "billing": {
                "first_name": "Mateo",
                "last_name": "Zayas Meza",
                "email": "Mateo_ZayasMeza85@yahoo.com",
                "phone": { "country_code": "51", "subscriber": "945831902" },
                "location": {
                    "line_1": "Poblado Concepción 7",
                    "line_2": "Puerta 249",
                    "city": "LIMA",
                    "state": "LIMA",
                    "country": "PE"
                }
            },
            "wallet": { "user_id": "72661927" }
        }
    }

    {
        "action": "subscribe",
        "merchant_affiliation_code": "122947_RPS_USER",
        "merchant_code": "your_merchant_code",
        "type": "MANUAL",
        "currency": "604",
        "beneficiary": {
            "first_name": "Pilar",
            "last_name": "Ordóñez Tirado",
            "email": "Pilar.OrdonezTirado61@gmail.com",
            "phone": { "country_code": "51", "subscriber": "965097539" },
            "identity_document": {
                "type": "DNI",
                "identifier": "38216803",
                "country": "PE"
            },
            "location": {
                "line_1": "Colonia Victor Manuel 2498",
                "city": "LIMA",
                "state": "LIMA",
                "country": "PE"
            }
        },
        "additional_fields": {
            "FACTURACION_ID": "133445",
            "PLAN": "POST PAGO 250"
        }
    }

    {
        "action": "subscribe",
        "merchant_affiliation_code": "023007_RPS_USER",
        "merchant_code": "your_merchant_code",
        "type": "MANUAL",
        "currency": "604",
        "beneficiary": {
            "first_name": "Mónica",
            "last_name": "Duarte Deleón",
            "email": "Monica.DuarteDeleon89@nearbpo.com",
            "phone": { "country_code": "51", "subscriber": "944169494" },
            "identity_document": {
                "type": "DNI",
                "identifier": "41134394",
                "country": "PE"
            },
            "location": {
                "line_1": "Ferrocarril Pilar Quintairos 45",
                "city": "LIMA",
                "state": "LIMA",
                "country": "PE"
            }
        },
        "additional_fields": {
            "FACTURACION_ID": "133445",
            "PLAN": "POST PAGO 250"
        },
        "wallet": { "user_id": "72661927" }
    }

    {
        "action": "update_subscription",
        "merchant_affiliation_code": "10011_LEVIS",
        "merchant_code": "your_merchant_code"
    }

    {
        "action": "update_subscription",
        "merchant_affiliation_code": "10011_LEVIS",
        "merchant_code": "your_merchant_code",
        "wallet": { "user_id": "72661927" }
    }

Affiliation response

Affiliation data

Field	Type	Mandatory	Description
`success`	Boolean	Yes	It indicates if the process was performed correctly.
`affiliation.affiliation_id`	String (UUID)	Yes	A system-generated affiliation ID.
`affiliation.merchant_affiliation_code`	String	Yes	Affiliation code generated by the merchant.
`affiliation.merchant_code`	String (UUID)	Yes	Merchant code.
`affiliation.state`	String	Yes	Affiliation status. For example: `ACTIVE`.
`affiliation.type`	String	Yes	Affiliation type. For example: `MANUAL`.
`affiliation.frequency`	String	No	Charge frequency.
`affiliation.amount`	String	No	Affiliation amount in minor currency units.
`affiliation.max_amount`	String	No	Maximum amount allowed.
`affiliation.currency`	String (ISO 4217)	Yes	Payment currency.

Data of the recipient

Field	Type	Mandatory	Description
`affiliation.beneficiary.first_name`	String	Yes	Recipient’s first name.
`affiliation.beneficiary.last_name`	String	Yes	Recipient’s last name.
`affiliation.beneficiary.email`	String	Yes	Email.
`affiliation.beneficiary.phone.country_code`	String	Yes	Telephone country code.
`affiliation.beneficiary.phone.subscriber`	String	Yes	phone number.
`affiliation.beneficiary.identity_document.type`	String	No	Type of document.
`affiliation.beneficiary.identity_document.identifier`	String	No	document number.
`affiliation.beneficiary.identity_document.country`	String	No	Country of document.
`affiliation.beneficiary.location.line_1`	String	Yes	Main address.
`affiliation.beneficiary.location.city`	String	Yes	City.
`affiliation.beneficiary.location.state`	String	Yes	Department or region.
`affiliation.beneficiary.location.country`	String	Yes	Country.

Card details

Field	Type	Mandatory	Description
`affiliation.card.token`	String	Yes	Token from the affiliated card.
`affiliation.card.brand`	String	Yes	Card brand. For example: VISA, MSCD.
`affiliation.card.bin`	String	Yes	BIN from the card.
`affiliation.card.last_pan`	String	Yes	Last 4 digits of the card.
`affiliation.card.issuer_name`	String	No	Name of the card issuer.
`affiliation.card.card_holder_name`	String	Yes	Name of the card holder.
`meta.status.code`	String	Yes	Code of technical result of processing. It does not apply if a payment was authorized or refused.
`meta.status.message_ilgn[].locale`	String	Yes	Language of response message.
`meta.status.message_ilgn[].value`	String	Yes	A description of the result.

Getting started

Integration

Migration

Payments

Retiring Automatic Flow component

Parameters

Flow available

autoize

Subscribe

update_Subscription

Show Alignet One Flex Automatic defect

Callbackes

responseCallback

trackingCallback

onErrorCallback

Cases of use

Affiliation response

​Retiring Automatic Flow component

​Parameters

​Flow available

autoize

Subscribe

update_Subscription

​Show Alignet One Flex Automatic defect

​Callbackes

responseCallback

trackingCallback

onErrorCallback

​Cases of use

​Affiliation response

Retiring Automatic Flow component

Parameters

Flow available

Show Alignet One Flex Automatic defect

Callbackes

Cases of use

Affiliation response