AbacatePay Customer Portal API

The Customer Portal API from AbacatePay — 1 operation(s) for customer portal.

GitHub OpenAPI

Operations 1

POST /customer-portal/create Criar um link do portal do cliente #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/abacatepay:abacatepay-customer-portal-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

abacatepay-customer-portal-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: AbacatePay Customer Portal API
  description: API para gerenciamento de cobranças e pagamentos usando o AbacatePay.
  version: 1.0.0
servers:
- url: https://api.abacatepay.com/v2
  description: Único servidor para os ambientes de produção e sandbox.
tags:
- name: Customer Portal
paths:
  /customer-portal/create:
    post:
      summary: Criar um link do portal do cliente
      description: 'Gera o link do portal do cliente para um cliente e um checkout que ele pagou. Chamar de novo com o mesmo `customerId` e `checkoutId` devolve o mesmo link.


        O cliente entra no portal com um código de 6 dígitos enviado ao e-mail do cadastro e consegue ver os pagamentos, pedir reembolso, cancelar a assinatura e trocar o cartão.'
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - customerId
              - checkoutId
              additionalProperties: false
              properties:
                customerId:
                  type: string
                  description: ID do cliente que pagou o checkout
                  example: cust_abc123xyz
                checkoutId:
                  type: string
                  description: ID do checkout (avulso ou de assinatura)
                  example: bill_abc123xyz
      responses:
        '200':
          description: Link do portal criado (ou o existente).
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        description: ID do link
                        example: cpl_abc123xyz
                      url:
                        type: string
                        description: Link para mandar ao cliente
                        example: https://portal.abacatepay.com/k3J9xQ2mP7vL1nR8sT4wY6zA0bC5dE2f
                      customerId:
                        type: string
                        example: cust_abc123xyz
                      checkoutId:
                        type: string
                        example: bill_abc123xyz
                      devMode:
                        type: boolean
                        example: false
                      createdAt:
                        type: string
                        format: date-time
                        example: '2026-10-19T12:00:00.000Z'
                  error:
                    type: string
                    nullable: true
                    example: null
                  success:
                    $ref: '#/components/schemas/Success'
        '401':
          description: Não autorizado. Falha na autenticação.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Token de autenticação inválido ou ausente.
      tags:
      - Customer Portal
      operationId: postCustomerPortalCreate
      x-operation-id-source: derived
components:
  schemas:
    Success:
      type: boolean
      description: Se a requisição obteve sucesso ou não.
      example: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Todas as requisições devem incluir sua chave de API no header Authorization usando o formato `Bearer <abacatepay-api-key>`. Sem esse header a requisição será rejeitada.


        Saiba mais sobre como criar e usar chaves de API na [documentação de autenticação](/pages/authentication).

        '