Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AbacatePay Withdraw API

Create, retrieve, and list withdrawals (payouts) to a Pix key.

AbacatePay Withdraw API is one of 6 APIs that AbacatePay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Withdraw. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 3 paths, and defines 5 schemas. It is described by OpenAPI 3.0.1, at version v1.

Requests are made against a single base URL, https://api.abacatepay.com/v1.

3 operations 3 paths 5 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
v1
Base URL
https://api.abacatepay.com/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

AbacatePay Withdraw API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (API Key) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Authenticate with your AbacatePay API key as a Bearer token: Authorization: Bearer .

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Withdraw 3

Create, retrieve, and list withdrawals (payouts) to a Pix key.

POST
/withdraw/create
Create a new withdrawal
createWithdraw body → 200401
GET
/withdraw/get
Get a withdrawal
getWithdraw 1 param → 200401404
GET
/withdraw/list
List withdrawals
listWithdraws → 200401

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Transaction (6 properties), CreateWithdrawRequest (5 properties), PixKey (2 properties), WithdrawResponse (2 properties). Each schema is shown below with its type and property counts.

Transaction
object
6 properties
Error
object
2 properties
CreateWithdrawRequest
object
5 properties 4 required
WithdrawResponse
object
2 properties
PixKey
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

abacatepay-withdraw-api-openapi.yml Raw ↑

Other APIs AbacatePay publishes across the network.

AbacatePay Webhooks
AbacatePay Billing API
AbacatePay Coupon API
AbacatePay Customer API
AbacatePay Pix QR Code API