Getting Started

Consider these points about the Online API integration path:

Obtain API Keys

Before you begin, you’ll need the credentials required to authenticate requests to our API.

• Initially, we’ll provide you with a Merchant ID and API Token.

• After you finish the onboarding process with our commercial team and are ready to dive into the technical details, we’ll share your credentials.

• If needed, send an email to [e-mail] to request your API keys.

---

Authentication

All requests to Aplazo’s Online API must include a valid Bearer token in the header. You’ll obtain this token by calling the Authentication endpoint using your API Token and Merchant ID.

Important: A new Bearer token should be generated for each request to ensure that every API call is properly authenticated.

Example Request

curl --location 'https://api.aplazo.net/api/auth' \
--header 'Content-Type: application/json' \
--data '{
    "apiToken": "93e28f44-e352-42df-af84-7a9ffc9f5734",
    "merchantId": 2639
}'

Example Response

{
    "Authorization": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9..."
}

When you receive the Authorization token, include it in the Authorization header for your immediate API call. For example:

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9...

If you need to make another request, retrieve another new token following the same authentication process.

---

Environments

Development Environment

You can test and validate all scenarios in our development environment before going live.

Endpoint	Description	Development Server
POST /auth	Get Bearer Token for authentication	https://api.aplazo.net/api
POST /loan	Create payment, get checkout url for your customer	https://api.aplazo.net/api
GET /v1/merchant/loan/cancel	Cancel a payment	https://refunds-bifrost.aplazo.net/api
GET /v1/loan/status	Consult payment status	https://merchant.aplazo.net/api
POST /loan/refund-from-cart	Request a partial or full refund	https://merchant.aplazo.net/api
GET /v1/merchant/refund/status	Consult refund status	https://merchant.aplazo.net/api

Production Environment

After thorough testing and certification of your integration, you can switch to production and start offering installment payments to your customers.

When switching to our production environment, replace the .net top-level domain for .mx

---

Webhooks

For each payment request you send, you'll have to provide Aplazo with the URL where you want to receive webhook notifications.

When a payment is completed, Aplazo will send a real-time notification to your configured endpoint, allowing you to keep your system up to date.

Webhook Security

• IP Whitelisting: If necessary, you can whitelist the static IP addresses from which Aplazo sends webhooks.

• Authentication: Aplazo supports sending either Basic or Bearer authentication headers in webhooks for added security.

[View Webhook Documentation →]