Listar contas bancárias

curl --request GET \
  --url https://api.chargefy.io/v1/payout-accounts

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.chargefy.io/v1/payout-accounts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.chargefy.io/v1/payout-accounts"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.chargefy.io/v1/payout-accounts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "object": "<string>",
  "data": [
    {}
  ],
  "has_more": true,
  "url": "<string>"
}

Retorna uma página de payout_account no payload de lista canônico. A listagem é escopada pela organização atuante: API key de organização lista contas da própria organização; API key de plataforma lista contas da organização conectada a ela, indicada no header Organization. Contas desconectadas da organização atuante não aparecem na lista. Para exibir apenas a conta principal atual no admin da plataforma, prefira GET /v1/organizations/{id} e leia organization.payout_account. Use a listagem quando precisar mostrar histórico de contas conectadas ou quando ainda não tiver o pa_* de uma conta específica.

Autenticação

Credencial	Acesso
API key da organização	Apenas a própria organização da key.
API key da plataforma	Organização conectada indicada no header `Organization`.

Parâmetros de query

integer

default:"10"

Itens por página. Máximo 100.

string

Cursor para buscar a próxima página depois do ID informado.

string

Cursor para buscar a página anterior antes do ID informado.

boolean

Filtra a conta principal (true) ou contas anteriores (false). Esse campo não informa se os repasses foram creditados.

boolean

Filtro informativo. O valor não representa elegibilidade para recebimentos; não o use para decidir se uma conta pode receber repasses.

string

Filtra pelo tipo da conta para saques.

Valor	Descrição
`checking`	Conta corrente.
`savings`	Conta poupança.

string

Filtra contas criadas a partir deste timestamp.

string

Filtra contas criadas depois deste timestamp.

string

Filtra contas criadas até este timestamp.

string

Filtra contas criadas antes deste timestamp.

cURL

curl -X GET "https://api.chargefy.io/v1/payout-accounts?limit=10&is_active=true" \
  -H "Authorization: Bearer {{API_KEY}}" \
  -H "Organization: org_HamUxDFN6Jy4F7Mc"

Resposta

string

Sempre "list".

array

Lista de objetos payout_account.

boolean

true quando existe próxima página.

string

Caminho canônico da coleção: /v1/payout-accounts.

200

{
  "object": "list",
  "data": [
    {
      "id": "pa_PFsmG18brKR11HFD",
      "object": "payout_account",
      "account_number_last4": "5678",
      "bank_code": "001",
      "bank_name": "Banco Exemplo S.A.",
      "created_at": "2026-05-16T14:09:27Z",
      "holder_name": "Acme Ltda",
      "is_active": true,
      "is_verified": false,
      "livemode": true,
      "metadata": {},
      "routing_number": "0001",
      "type": "checking",
      "updated_at": "2026-05-16T14:20:00Z"
    }
  ],
  "has_more": false,
  "url": "/v1/payout-accounts"
}

Erros

Status	Quando
`401`	Credencial ausente, inválida, revogada ou expirada.
`403`	Credencial sem acesso à organização.
`409`	Contas para saques ainda não são suportadas no sandbox.
`500`	Erro temporário listando contas para saques. Faça retry.

400

{
  "error": {
    "code": "invalid_request",
    "message": "limit must be between 1 and 100.",
    "param": "limit",
    "type": "invalid_request_error"
  }
}

401

{
  "error": {
    "code": "authentication_failed",
    "message": "Invalid API key provided.",
    "type": "authentication_error"
  }
}

Listar contas bancárias

curl --request GET \
  --url https://api.chargefy.io/v1/payout-accounts

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.chargefy.io/v1/payout-accounts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.chargefy.io/v1/payout-accounts"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.chargefy.io/v1/payout-accounts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "object": "<string>",
  "data": [
    {}
  ],
  "has_more": true,
  "url": "<string>"
}

Fundamentos da API

Objetos de sistema

Webhooks e eventos

SDKs

MCP

Listar contas bancárias

Autenticação

Parâmetros de query

Resposta

Erros

​Autenticação

​Parâmetros de query

​Resposta

​Erros

Autenticação

Parâmetros de query

Resposta

Erros