Aplazo

Who should use this guideThis 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

Create a Aplazo integration in Payrails

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

About workspacesWorkspaces 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.

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.

A screenshot showing Aplazo selected as the provider.

Step 3: Configure your Aplazo integration

What you’ll need from AplazoBefore you begin, make sure you have your Aplazo merchant ID and API key. Aplazo provides them when it sets up your account.

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.

A screenshot showing the integration instance name field.

Account details

In Payrails

Field	Value
Merchant ID	Your Aplazo merchant ID

A screenshot showing the Aplazo account details fields.

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.

A screenshot showing the Aplazo credential fields.

Payment methods

In Payrails

Select Aplazo.

A screenshot showing the Aplazo payment method selection.

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, 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.

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

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

→ Continue to: Test a payment

Getting Started

Payment Orchestration

Token Vault

Analytics & Reporting

Fraud Management

Chargebacks

Monitoring

Resources

Use Cases

Create a Aplazo integration in Payrails

Step 1: Choose the integration type

Step 2: Choose the provider