Listar saques

curl --request GET \
  --url https://api.abacatepay.com/v1/withdraw/list \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "tran_123456",
      "status": "PENDING",
      "devMode": true,
      "receiptUrl": "https://abacatepay.com/receipt/tran_123456",
      "kind": "WITHDRAW",
      "amount": 5000,
      "platformFee": 80,
      "createdAt": "2025-03-24T21:50:20.772Z",
      "updatedAt": "2025-03-24T21:50:20.772Z",
      "externalId": "withdraw-1234"
    }
  ],
  "error": "<unknown>"
}

GET

withdraw

list

Listar saques

curl --request GET \
  --url https://api.abacatepay.com/v1/withdraw/list \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "tran_123456",
      "status": "PENDING",
      "devMode": true,
      "receiptUrl": "https://abacatepay.com/receipt/tran_123456",
      "kind": "WITHDRAW",
      "amount": 5000,
      "platformFee": 80,
      "createdAt": "2025-03-24T21:50:20.772Z",
      "updatedAt": "2025-03-24T21:50:20.772Z",
      "externalId": "withdraw-1234"
    }
  ],
  "error": "<unknown>"
}

Authorizations

Authorization

string

header

required

Cabeçalho de autenticação Bearer no formato Bearer <abacatepay-api-key> onde <abacatepay-api-key> é a sua chave de API.

Response

Lista de saques retornada com sucesso.

data

object[]

Lista de saques criados.

Show child attributes

data.id

string

required

Identificador único da transação.

Example:

"tran_123456"

data.status

enum<string>

required

Status atual da transação.

Available options:

PENDING,

EXPIRED,

CANCELLED,

COMPLETE,

REFUNDED

Example:

"PENDING"

data.devMode

boolean

required

Indica se a transação foi criada em ambiente de testes.

Example:

true

data.receiptUrl

string<uri>

required

URL do comprovante da transação.

Example:

"https://abacatepay.com/receipt/tran_123456"

data.kind

enum<string>

default:WITHDRAW

required

Tipo da transação.

Available options:

PAYMENT,

WITHDRAW

Example:

"WITHDRAW"

data.amount

number

required

Valor da transação em centavos.

Example:

5000

data.platformFee

number

required

Taxa da plataforma em centavos.

Example:

80

data.createdAt

string<date-time>

required

Data de criação da transação.

Example:

"2025-03-24T21:50:20.772Z"

data.updatedAt

string<date-time>

required

Data de atualização da transação.

Example:

"2025-03-24T21:50:20.772Z"

data.externalId

string

Identificador externo da transação.

Example:

"withdraw-1234"

error

null

Buscar saque Obter detalhes da loja

⌘I

API Reference

Authorizations

Response