API Reference

Credit Card

๐Ÿ’ณ Credit Card Payments

โ„น๏ธ For full request and response examples, refer to theAPI Reference.

To fully leverage our credit card capabilities, itโ€™s essential to understand the key concepts in the transaction lifecycle โ€” from authentication to settlement, refund, and dispute management.


โš ๏ธ

For cross-border credit card transactions, it's essential to:

  • Confirm the currency, card brand, and payment method availability.
  • ๐Ÿ“ž Contact our support team to ensure the desired setup is enabled for your account.

Transactions using unsupported configurations may be rejected by issuers or processors.



๐Ÿ“˜ Key Concepts

ConceptDescription
๐Ÿ” Authentication (3DS)3D Secure (3DS) is a protocol used to authenticate the cardholder before authorization. Based on the issuer's response, the flow can be frictionless or require a challenge. If authentication is successful, the chargeback liability shifts from merchant to issuer.
๐Ÿ›ก๏ธ Antifraud (AF)Antifraud systems analyze transactions based on behavioral, device, and historical risk signals. They may approve, reject, or flag a transaction for manual review before it reaches authorization.
๐Ÿฆ AuthorizationThis is when the transaction is sent to the card issuer and scheme (e.g., Visa, Mastercard) for approval. A pre-authorization reserves funds but does not complete the charge until capture.
๐Ÿ“ฅ CaptureFinalizes a previously authorized transaction, charging the customer's card. If capture is set to false in the initial request, you must capture the transaction later using the capture endpoint.
๐Ÿ’ณ InstallmentsAllows the total charge to be split into multiple monthly payments by the cardholder. The merchant receives the full amount upfront, while the customer pays over time. Local regulations and acquirer configurations may apply.
โŒ CancellationCancels an authorized or captured transaction, often due to unfulfilled orders or user action.
๐Ÿ’ธ RefundedIndicates a full or partial return of funds to the customer after the payment has been captured.
โš ๏ธ Chargeback RequestedThe cardholder has disputed the transaction. Funds are temporarily withdrawn from the merchant while the issuer investigates.
โœ… Chargeback RefundedThe dispute was accepted by the issuer. The transaction is finalized with a full reversal of funds to the cardholder.


๐Ÿท๏ธ Accepted Card Brands

Card BrandOne-Time PaymentInstallments (Store)International Support
Visaโœ… Yesโœ… Yesโœ… Yes
MasterCardโœ… Yesโœ… Yesโœ… Yes
American Expressโœ… Yesโœ… Yesโœ… Yes
Eloโœ… Yesโœ… Yesโœ… Yes
Diners Clubโœ… YesโŒ Noโœ… Yes
Discoverโœ… YesโŒ Noโœ… Yes
JCBโŒ NoโŒ NoโŒ No
Auraโœ… Yesโœ… Yesโœ… Yes


๐Ÿ”„ Credit Card Transaction Flow

sequenceDiagram
    participant Buyer as ๐Ÿง‘ Buyer
    participant Merchant as ๐Ÿ›’ Merchant Platform
    participant A55API as ๐Ÿงฉ a55 API
    participant AF as ๐Ÿ›ก๏ธ Antifraud Engine
    participant ThreeDS as ๐Ÿ” 3DS Server
    participant Acquirer as ๐Ÿฆ Acquirer / Provider

    Buyer->>Merchant: 1. Selects credit card as payment method
    Merchant->>A55API: 2. Sends transaction request (card + payer data)
    A55API->>AF: 3. Triggers antifraud analysis
    AF-->>A55API: Risk decision (approve / reject / review)
    A55API->>ThreeDS: 4. Initiates 3DS authentication (if enabled)
    ThreeDS-->>A55API: 5. 3DS result (frictionless / challenge / success / fail)
    A55API->>Acquirer: 6. Sends transaction for authorization
    Acquirer-->>A55API: 7. Returns authorization status
    A55API-->>Merchant: 8. Returns final result

๐Ÿ”„ Sample

{
  "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": "Description of the sample product",
      "quantity": 1,
      "total_amount": 100,
      "unit_amount": 100,
      "sku": "SAMPLE-SKU-123",
      "code": "SAMPLE-CODE-456"
    }
  ],
  "payer_address": {
    "street": "Sample Street",
    "address_number": "123",
    "complement": "Apt 101",
    "neighborhood": "Sample Neighborhood",
    "city": "Sample City",
    "state": "SP",
    "postal_code": "00000-000",
    "country": "BR"
  },
  "currency": "BRL",
  "installment_value": 100,
  "installment_count": 1,
  "due_date": "2025-12-31",
  "description": "Sample transaction description",
  "webhook_url": "https://webhook-test.com/sample-webhook", // receives any status change of this charge
  "redirect_url": "https://example.com/redirect"
}
{
  "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": "Description of the sample product",
      "quantity": 1,
      "total_amount": 100,
      "unit_amount": 100,
      "sku": "SAMPLE-SKU-123",
      "code": "SAMPLE-CODE-456"
    }
  ],
  "payer_address": {
    "street": "Sample Street",
    "address_number": "123",
    "complement": "Apt 101",
    "neighborhood": "Sample Neighborhood",
    "city": "Sample City",
    "state": "SP",
    "postal_code": "00000-000",
    "country": "BR"
  },
  "currency": "BRL",
  "installment_value": 50,
  "installment_count": 2,
  "due_date": "2025-12-31",
  "description": "Sample transaction description",
  "webhook_url": "https://webhook-test.com/sample-webhook", // receives any status change of this charge
  "redirect_url": "https://example.com/redirect"
}
{
  "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": "Description of the sample product",
      "quantity": 1,
      "total_amount": 100,
      "unit_amount": 100,
      "sku": "SAMPLE-SKU-123",
      "code": "SAMPLE-CODE-456"
    }
  ],
  "payer_address": {
    "street": "Sample Street",
    "address_number": "123",
    "complement": "Apt 101",
    "neighborhood": "Sample Neighborhood",
    "city": "Sample City",
    "state": "SP",
    "postal_code": "00000-000",
    "country": "BR"
  },
  "currency": "BRL",
  "installment_value": 100,
  "installment_count": 1,
  "due_date": "2025-12-31",
  "description": "Sample transaction description",
  "type_charge": "credit_card",
  "card_name": "John Doe",
  "card_number": "4111111111111111",
  "card_expiry_month": "12",
  "card_expiry_year": "2030",
  "card_cvv": "123",
  "webhook_url": "https://webhook-test.com/sample-webhook" // receives any status change of this charge
}
{
  "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",
  "capture": false, //you must capture the transaction later using the capture endpoint.
  "items": [
    {
      "name": "Sample Product",
      "description": "Description of the sample product",
      "quantity": 1,
      "total_amount": 100,
      "unit_amount": 100,
      "sku": "SAMPLE-SKU-123",
      "code": "SAMPLE-CODE-456"
    }
  ],
  "payer_address": {
    "street": "Sample Street",
    "address_number": "123",
    "complement": "Apt 101",
    "neighborhood": "Sample Neighborhood",
    "city": "Sample City",
    "state": "SP",
    "postal_code": "00000-000",
    "country": "BR"
  },
  "currency": "BRL",
  "installment_value": 100,
  "installment_count": 1,
  "due_date": "2025-12-31",
  "description": "Sample transaction description",
  "type_charge": "credit_card",
  "card_name": "John Doe",
  "card_number": "4111111111111111",
  "card_expiry_month": "12",
  "card_expiry_year": "2030",
  "card_cvv": "123",
  "webhook_url": "https://webhook-test.com/sample-webhook" // receives any status change of this charge
}
{
  "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",
  "subscription": {
    "cycle": "monthly",
    "end_date": "2025-07-30"
  },
  "payer_address": {
    "street": "Sample Street",
    "address_number": "123",
    "complement": "Apt 101",
    "neighborhood": "Sample Neighborhood",
    "city": "Sample City",
    "state": "SP",
    "postal_code": "00000-000",
    "country": "BR"
  },
  "currency": "BRL",
  "installment_value": 100,
  "installment_count": 1,
  "due_date": "2025-12-31",
  "description": "Sample Subscription",
  "type_charge": "credit_card",
  "card_name": "John Doe",
  "card_number": "4111111111111111",
  "card_expiry_month": "12",
  "card_expiry_year": "2030",
  "card_cvv": "123",
  "webhook_url": "https://webhook-test.com/sample-webhook"
}

โš ๏ธ

Capture

  • capture (boolean) โ€“ Defines whether the transaction should be captured immediately (true) or authorized only (false). If set to false, you must capture the transaction later using the capture endpoint. API Reference.