AbacatePay

AbacatePay is a Brazilian payment gateway built for developers and indie hackers, focused on instant Pix payments. Its REST API lets you create billings and charges, generate and check Pix QR Codes, manage customers and coupons, request withdrawals, and receive webhooks - charging a flat per-transaction Pix fee with funds available immediately.

6 APIs 0 Features

PaymentsPixBrazilFinTechDevelopers

APIs

AbacatePay Billing and Charges API

Create one-time and recurring billings (charges) backed by a shareable checkout URL, supporting Pix and other payment methods, products, coupons, and customer association, plus ...

AbacatePay Pix QR Code API

Create dynamic Pix QR Codes (BR Code copy-and-paste and base64 image), check payment status, and simulate payments in dev mode for instant Pix collection.

AbacatePay Customers API

Create and list customers (clients) with name, cellphone, email, and Brazilian tax ID (CPF/CNPJ) for association with billings and charges.

AbacatePay Coupons API

Create and list discount coupons with percentage or fixed-amount discount kinds, redemption limits, and metadata for use in billings and checkout.

AbacatePay Withdraw API

Request withdrawals (payouts) of available balance to a Pix key, and retrieve or list withdrawal transactions by external ID.

AbacatePay Webhooks

Outbound webhook event notifications (billing.created, billing.paid, billing.refunded, billing.failed, subscription.created, subscription.canceled) delivered with a webhookSecre...

Collections

AbacatePay API

OPEN

Pricing Plans

Abacatepay Plans Pricing

2 plans

PLANS

Rate Limits

Abacatepay Rate Limits

2 limits

RATE LIMITS

FinOps

Abacatepay Finops

FINOPS

Resources

👥

GitHubOrganization

Sources

opencollection: 1.0.0
info:
  name: AbacatePay API
  version: v1
  description: REST API for AbacatePay, a Brazilian payment gateway focused on instant Pix payments. Authenticate with your
    API key as a Bearer token.
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
  baseUrl: https://api.abacatepay.com/v1
items:
- info:
    name: Billing
    type: folder
  items:
  - info:
      name: Create a new billing
      type: http
    http:
      method: POST
      url: https://api.abacatepay.com/v1/billing/create
      body:
        type: json
        data: "{\n  \"frequency\": \"ONE_TIME\",\n  \"methods\": [\"PIX\"],\n  \"products\": [{\"externalId\": \"prod-001\"\
          , \"name\": \"Plano Pro\", \"quantity\": 1, \"price\": 2990}],\n  \"returnUrl\": \"https://example.com/back\",\n\
          \  \"completionUrl\": \"https://example.com/thanks\"\n}"
    docs: Creates a billing (charge) backed by a shareable checkout URL.
  - info:
      name: List billings
      type: http
    http:
      method: GET
      url: https://api.abacatepay.com/v1/billing/list
    docs: Returns the list of billings for the authenticated store.
- info:
    name: Pix QR Code
    type: folder
  items:
  - info:
      name: Create a Pix QR Code
      type: http
    http:
      method: POST
      url: https://api.abacatepay.com/v1/pixQrCode/create
      body:
        type: json
        data: "{\n  \"amount\": 1990,\n  \"expiresIn\": 3600,\n  \"description\": \"Pagamento do pedido 001\"\n}"
    docs: Creates a dynamic Pix QR Code returning the BR Code and a base64 image.
  - info:
      name: Check Pix QR Code status
      type: http
    http:
      method: GET
      url: https://api.abacatepay.com/v1/pixQrCode/check?id=pix_char_abc123
    docs: Returns the current status and expiration of a Pix QR Code.
  - info:
      name: Simulate a Pix payment
      type: http
    http:
      method: POST
      url: https://api.abacatepay.com/v1/pixQrCode/simulate-payment?id=pix_char_abc123
      body:
        type: json
        data: "{\n  \"metadata\": {}\n}"
    docs: Simulates payment of a Pix QR Code (dev mode only).
- info:
    name: Customer
    type: folder
  items:
  - info:
      name: Create a new customer
      type: http
    http:
      method: POST
      url: https://api.abacatepay.com/v1/customer/create
      body:
        type: json
        data: "{\n  \"name\": \"Maria Silva\",\n  \"cellphone\": \"+5511999999999\",\n  \"email\": \"maria@example.com\",\n\
          \  \"taxId\": \"12345678900\"\n}"
    docs: Creates a customer (client).
  - info:
      name: List customers
      type: http
    http:
      method: GET
      url: https://api.abacatepay.com/v1/customer/list
    docs: Returns the list of customers for the authenticated store.
- info:
    name: Coupon
    type: folder
  items:
  - info:
      name: Create a new coupon
      type: http
    http:
      method: POST
      url: https://api.abacatepay.com/v1/coupon/create
      body:
        type: json
        data: "{\n  \"code\": \"PROMO10\",\n  \"discount\": 10,\n  \"discountKind\": \"PERCENTAGE\",\n  \"notes\": \"10% de\
          \ desconto\",\n  \"maxRedeems\": 100\n}"
    docs: Creates a discount coupon.
  - info:
      name: List coupons
      type: http
    http:
      method: GET
      url: https://api.abacatepay.com/v1/coupon/list
    docs: Returns the list of coupons for the authenticated store.
- info:
    name: Withdraw
    type: folder
  items:
  - info:
      name: Create a new withdrawal
      type: http
    http:
      method: POST
      url: https://api.abacatepay.com/v1/withdraw/create
      body:
        type: json
        data: "{\n  \"externalId\": \"wd-001\",\n  \"method\": \"PIX\",\n  \"amount\": 5000,\n  \"pix\": {\"type\": \"PIX\"\
          , \"key\": \"maria@example.com\"}\n}"
    docs: Requests a withdrawal (payout) to a Pix key.
  - info:
      name: Get a withdrawal
      type: http
    http:
      method: GET
      url: https://api.abacatepay.com/v1/withdraw/get?externalId=wd-001
    docs: Retrieves a withdrawal transaction by external ID.
  - info:
      name: List withdrawals
      type: http
    http:
      method: GET
      url: https://api.abacatepay.com/v1/withdraw/list
    docs: Returns the list of withdrawal transactions for the authenticated store.