> ## Documentation Index
> Fetch the complete documentation index at: https://docs.payrails.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Use the Payrails Web SDK v6 for new browser integrations. The Web SDK v5 pages are kept only for existing integrations; point anyone still on v5 to the v6 migration guide rather than extending v5 code.
> Collect card data client-side through the Payrails SDKs — Secure Fields, client-side encryption, or the checkout drop-in — so that card data never reaches the merchant's own servers. Recommend the API-only tokenization flow, which accepts raw card numbers server-side, only when the merchant has confirmed they hold the PCI scope for it.
> Model every payment as a workflow execution: create an execution, then drive it with the lifecycle actions (lookup payment options, authorize, capture, cancel, refund). Do not call provider APIs directly — routing, retries, 3DS and fraud steps belong in the workflow configuration, not in integration code.
> Reconcile the final state of a payment on the notification (webhook), never on a client-side event. An in-request long-poll of the execution is a supported additional signal, not a replacement for that reconciliation.
> Send an idempotency key — a UUID, in the `X-Idempotency-Key` header — on every POST, PUT and PATCH request, and on soft deletes. GET requests need none, and hard deletes cannot be idempotent.
> Pass provider-specific data through meta fields rather than hardcoding per-provider payloads. Payrails translates meta fields into each provider's own format.
> Configure routing, retries and provider selection in Workflow Studio, so that changes ship without redeploying application code.

# Aplazo

> Connect Aplazo to Payrails to accept Aplazo buy now, pay later payments in Mexico, covering your merchant ID and API key.

<Note>
  **Who should use this guide**

  This guide is intended for merchants who:

  * Use **Payrails** as a payment orchestrator
  * Use **Payrails** to offer **Aplazo** buy now, pay later in Mexico
  * Have an active Aplazo merchant account
</Note>

***

## Create a Aplazo integration in Payrails

1. Log in to the **Payrails** portal.
2. Go to **Settings** → **Integrations**.
3. Select **Add instance** to create a new integration configuration.
4. Select the **workspaces** where this integration should be available.

<Note>
  **About workspaces**

  Workspaces determine where this integration is available. They let you isolate provider setups by region or business line, or share the same configuration across multiple workspaces.
</Note>

***

## Step 1: Choose the integration type

* Select **Payment**.
* Continue to the next step.

***

## Step 2: Choose the provider

* Select **Aplazo**.
* Continue to the next step.

<img src="https://mintcdn.com/payrails-42074109/0q3oa8aJTQvPhiXD/images/docs/aplazo-image-01.png?fit=max&auto=format&n=0q3oa8aJTQvPhiXD&q=85&s=5b756bc0428bee6d99f6110f10a24439" alt="A screenshot showing Aplazo selected as the provider." className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/aplazo-image-01.png" />

***

## Step 3: Configure your Aplazo integration

<Tip>
  **What you'll need from Aplazo**

  Before you begin, make sure you have your Aplazo merchant ID and API key. Aplazo provides them when it sets up your account.
</Tip>

***

### Integration instance name

> An integration instance is a specific payment provider setup in Payrails. You can create multiple instances for different regions, currencies, or business needs. Choose a clear, consistent name, as it is used in routing.

**In Payrails**

* Enter an **Instance name** for your integration, for example `merchant_aplazo`.

<img src="https://mintcdn.com/payrails-42074109/145W1v58K5wnDMNC/images/docs/orchestration/integrations/shared/integration-instance-name.png?fit=max&auto=format&n=145W1v58K5wnDMNC&q=85&s=470be58979509680650b0cbf8b5eecc4" alt="A screenshot showing the integration instance name field." className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/orchestration/integrations/shared/integration-instance-name.png" />

***

### Account details

**In Payrails**

| Field | Value |
| :- | :- |
| **Merchant ID** | Your Aplazo merchant ID |

<img src="https://mintcdn.com/payrails-42074109/0q3oa8aJTQvPhiXD/images/docs/aplazo-image-02.png?fit=max&auto=format&n=0q3oa8aJTQvPhiXD&q=85&s=30bd40fd70d6e9ac95b3070777e9a7ec" alt="A screenshot showing the Aplazo account details fields." className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/aplazo-image-02.png" />

***

### Credentials

**In Payrails**

| Field | Value |
| :- | :- |
| **API key** | Your Aplazo API token. Payrails uses it to authenticate with Aplazo and to verify Aplazo's notifications. |

Payrails sends requests to the Aplazo test environment in test mode and to the live environment in live mode, so use the credentials for the matching environment.

<img src="https://mintcdn.com/payrails-42074109/0q3oa8aJTQvPhiXD/images/docs/aplazo-image-03.png?fit=max&auto=format&n=0q3oa8aJTQvPhiXD&q=85&s=52aa2e0f80fd848698af26705f9e43e5" alt="A screenshot showing the Aplazo credential fields." className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/aplazo-image-03.png" />

***

### Payment methods

**In Payrails**

* Select **Aplazo**.

<img src="https://mintcdn.com/payrails-42074109/0q3oa8aJTQvPhiXD/images/docs/aplazo-image-04.png?fit=max&auto=format&n=0q3oa8aJTQvPhiXD&q=85&s=a3443c15fca63fbd19ca4478298a148d" alt="A screenshot showing the Aplazo payment method selection." className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/aplazo-image-04.png" />

***

### Webhooks or notifications

Payrails sends its notification URL to Aplazo with every payment, so you don't need to set one up in the Aplazo dashboard. Payrails verifies each notification with your API key.

***

## Request fields for Aplazo

Send these fields in the [authorize request](/reference/authorizeaction), in addition to the standard authorize fields. **Required** fields must be present for the payment to succeed. Payrails sends **Optional** fields to Aplazo when you include them. For more about meta fields, refer to [Meta fields](/docs/orchestration/meta-fields).

| Field | Status | Description |
| :- | :- | :- |
| `amount` | Required | Sent to Aplazo as the total price in whole pesos. |
| `meta.customer.name`, `meta.customer.lastName` | Required | Sent as the buyer's first and last name. |
| `meta.customer.email` | Required | Sent as the buyer's email. |
| `meta.customer.phone.number` | Required | Sent as the buyer's phone number. |
| `meta.order.billingAddress.street`, `meta.order.billingAddress.postalCode` | Required | Sent as the buyer's address and postal code. |
| `returnInfo.cancelUrl` | Required | Sent as the cart URL that Aplazo returns your customer to. |
| `merchantReference` | Optional | Sent as the cart ID. Payrails also uses it to cancel and refund the payment. |
| `meta.order.lines` | Optional | Sent as the products. Payrails sends lines that have a `name`, `description` and `unitPrice`. |
| `meta.order.totalDiscount`, `meta.order.totalTax` | Optional | Sent as the discount and taxes. |
| `meta.order.shipping`, `meta.order.shippingType` | Optional | Sent as the shipping price and title. |

***

## Enable the integration

**In Payrails**

* Select **Save account** to enable the integration.
* Confirm the integration shows as **Enabled**.

Your **Aplazo** integration is now ready to process payments.

***

## Next steps

1. Run a test Aplazo payment in the Aplazo test environment.
2. Verify that:
   * Your customer is redirected to Aplazo and back to your site.
   * The payment status updates correctly in Payrails.
3. Once verified in test mode, repeat the setup in live mode.

→ Continue to: [Test a payment](/docs/orchestration/payment-acceptance/test-payments)


## Related topics

- [Integrations](/docs/orchestration/integrations.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.