🔗 Checkout/Payment Link

This flow allows you to create a Checkout/payment link associated with a wallet, supporting multiple payment methods in a single checkout experience. The payer can choose how they wish to pay. theAPI Reference.

⚠️

Important

Please contact our support team to enable the required methods and currencies for your operation. Certain configurations may vary by account or region.

sequenceDiagram
    participant Merchant
    participant API
    participant Payer
    participant CheckoutPage
    participant Webhook

    Merchant->>API: POST /wallet/payment-link
    API-->>Merchant: Returns payment_link + checkout URL
    Merchant->>Payer: Sends checkout link
    Payer->>CheckoutPage: Accesses checkout page
    CheckoutPage->>Payer: Displays payment method options
    Payer->>CheckoutPage: Selects method and pays
    CheckoutPage->>API: Processes payment
    API-->>Webhook: Sends charge status (paid, confirmed, etc.)
    CheckoutPage-->>Payer: Redirects to redirect_url

✅ Supported Payment Methods

🚀 Flow Overview

1. You create a checkout via the API.
2. Redirect the payer to the checkout page provided in the response.
3. The payer selects a payment method and completes the payment.
4. A webhook notifies your system of the charge status.
5. The payer is redirected to your configured URL after payment.

📬 API – Create Chekout

{
  "wallet_uuid": "71dfc5f7-80e1-4aae-ba2b-86ff8f08996f",
  "merchant_id": "2cd009dc-fb58-4fd1-b4f2-4568c797df2e",
  "region": "BR",
  "currency": "BRL",
  "billing_type": "installment",
  "charge_type": ["pix", "credit_card", "debit_card", "pix_and_card", "card_and_card"],
  "items": [
    {
      "name": "string",
      "img": "string",
      "description": "string",
      "quantity": 0,
      "total_amount": 0,
      "unit_amount": 0,
      "sku": "string",
      "code": "string"
    }
  ],
  "name": "Teste",
  "description": "Teste Payemnt",
  "value": 1,
  "max_installment_count": 4,
  "redirect_url": "https://yourdomain.com/thank-you",
  "webhook_url": "https://yourdomain.com/webhook"
}

{
  "payment_link_uuid": "0b9bffcb-2d96-42bb-8641-279bfc8aac19",
  "status": "active",
  "url": "https://pay.a55.tech/checkout/0b9bffcb-2d96-42bb-8641-279bfc8aac19",
  "local_currency": 1,
  "currency": "BRL",
  "usd_currency": 0.18,
  "eur_currency": 0.16
}

📩 Webhook Payload

Upon payment update, the following payload will be sent to your webhook_url:

{
  "charge_uuid": "string",
  "status": "confirmed | paid | error | refunded | outher",
  "transaction_reference": "string",
  "subscription_uuid": "nullable string",
  "payment_link_uuid": "nullable string"
}

🧭 Checkout Example