API Reference

Integration Checkout Page

The Checkout Page integration allows merchants to redirect payers to a hosted payment page where the entire payment process, including 3DS authentication, is handled by the A55 platform.


Payment Flow Diagram

sequenceDiagram
    autonumber

    participant Payer as Payer
    participant Merchant as Merchant
    participant A55 as A55 Platform

    rect rgb(213,232,255)
        Payer->>Merchant: Initiates payment        
        Merchant->>A55: Creates charge
    end

    rect rgb(255,249,213)
        activate A55
        A55-->>Merchant: Returns checkout page (link)
        Merchant->>Payer: Redirects to A55 checkout
        deactivate A55
        Note right of Merchant: Customer is redirected to the payment interface
    end

    rect rgb(235,255,213)
        Payer->>A55: Fills in data on the checkout page
        activate A55
        A55->>A55: Executes 3DS flow and validations
        Note right of A55: Security authentication (3DS)
        A55->>A55: Completes payment on the checkout page
        deactivate A55
    end

    rect rgb(255,213,218)
        activate A55
        A55-->>Merchant: Sends webhook with status
        deactivate A55
        Note right of Merchant: Merchant receives payment status via webhook
    end

Example Payload

API Route

  • Endpoint: https://core-manager.a55.tech/api/v1/bank/wallet/charge/
  • Method: POST

Request

{
  "wallet_uuid": "00000000-0000-0000-0000-000000000000",
  "merchant_id": "11111111-1111-1111-1111-111111111111",
  "payer_name": "John Doe",
  "payer_email": "[email protected]",
  "payer_cell_phone": "+5511999999999",
  "items": [
    {
      "name": "Sample Product",
      "description": "Sample product description",
      "quantity": 1,
      "total_amount": 100.0,
      "unit_amount": 100.0,
      "sku": "SAMPLE-SKU-123",
      "code": "SAMPLE-CODE-456"
    }
  ],
  "currency": "BRL",
  "installment_value": 100.0,
  "installment_count": 1,
  "due_date": "2025-12-31",
  "description": "Sample purchase description",
  "type_charge": "credit_card",
  "webhook_url": "https://webhook.example.com/endpoint",
  "redirect_url": "https://redirect.example.com"
}

Response

{
    "charge_uuid": "22222222-2222-2222-2222-222222222222",
    "local_currency": 100.0,
    "currency": "BRL",
    "usd_currency": 20.0,
    "eur_currency": 18.0,
    "type": "credit_card",
    "date": "2025-07-24",
    "description": "Sample purchase description",
    "due_date": "2025-12-31",
    "status": "issued",
    "message": null,
    "installment_count": 1,
    "installments": [
        {
            "local_currency": 100.0,
            "currency": "BRL",
            "usd_currency": 20.0,
            "eur_currency": 18.0,
            "due_date": "2025-12-31",
            "status": "issued",
            "installment_number": 1
        }
    ],
    "charge_payment_url": "https://pay.example.com/charge/22222222-2222-2222-2222-222222222222"
}

Notes

  • The Checkout Page integration simplifies the payment process by handling all payment steps, including 3DS authentication, on the A55 platform.
  • Merchants only need to provide minimal data to create a charge and redirect the payer to the checkout page.
  • Webhooks will notify the merchant of the final payment status after the process is completed.
  • The charge_payment_url in the response is the link to the hosted checkout page.