Create a payment

Environments

Development

https://api.aplazo.net

Production

https://api.aplazo.mx

Create Payment

post

Initiates a new payment process using Aplazo's in-store payment system.

Authorizations

api_tokenmerchant_id

Body

custLoginstring · min: 10 · max: 10Required

Customer phone number.

Example: 5527338972Pattern: ^[0-9]{10}$

shopIdstringRequired

Aplazo identifier for the store.

Example: 475Pattern: ^\d+$

cartIdstringRequired

Identifier in the merchant POS for the order/transaction, unique across all stores.

Example: cart-123

webhookUrlstring · uriRequired

Merchant-provided URL where Aplazo will communicate the payment confirmation.

Example: https://www.merchant-url.com/webhook

totalAmountnumber · floatRequired

Total amount of the order, including discounts.

Example: 116

orderDiscountnumber · floatRequired

Discount at the order level applied in the merchant system (informational only).

Example: 25

discountTypestring · enumRequired

Type of discount applied ("a" for amount, "p" for percentage).

Example: aPossible values:

commChannelstring · enumRequired

Type of communication to be sent to the customer ("w" for WhatsApp, "s" for SMS, "q" for QR code).

Example: qPossible values:

Responses

200

Payment created successfully. Example with commChannel 'q' for QR Code.

application/json

post

HTTPcURLJavaScriptPython

POST /api/pos/loan HTTP/1.1
Host: 
api_token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 585

{
  "custLogin": "5527338972",
  "shopId": "475",
  "cartId": "cart-123",
  "webhookUrl": "https://www.merchant-url.com/webhook",
  "products": [
    {
      "id": "xyz-123",
      "externalId": "item-1",
      "quantity": 1,
      "unitPrice": 300,
      "discount": 0,
      "discountType": "p",
      "discountPrice": 300,
      "title": "T-Shirt",
      "description": "Red Tshirt Size M"
    },
    {
      "id": "abc-456",
      "externalId": "item-2",
      "quantity": 1,
      "unitPrice": 800,
      "discount": 0,
      "discountType": "p",
      "discountPrice": 800,
      "title": "Jeans",
      "description": "Dark Blue Jeans 30 x 32"
    }
  ],
  "taxes": [
    {
      "price": 16,
      "title": "IVA"
    }
  ],
  "totalAmount": 116,
  "orderDiscount": 25,
  "discountType": "a",
  "commChannel": "q"
}

200

Payment created successfully. Example with commChannel 'q' for QR Code.

{
  "custLogin": "5527338972",
  "zipCode": null,
  "shopId": "475",
  "cartId": "cart-123",
  "webhookUrl": "https://www.merchant-url.com/webhook",
  "products": [
    {
      "id": "xyz-123",
      "externalId": "merchant-item-id",
      "quantity": 3,
      "unitPrice": 125,
      "discount": 25,
      "discountType": "a",
      "discountPrice": 100,
      "title": "Cotton Shirt",
      "description": "Cotton Shirt Size: M Color: Red"
    }
  ],
  "taxes": [
    {
      "price": 16,
      "title": "IVA"
    }
  ],
  "totalAmount": 116,
  "orderDiscount": 25,
  "discountType": "a",
  "qr": null
}