List Immediate Charges

curl --request GET \
  --url https://api.example.com/v1/collections/immediate \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-Id: <x-account-id>'

package main

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

func main() {

	url := "https://api.example.com/v1/collections/immediate"

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

	req.Header.Add("X-Account-Id", "<x-account-id>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

const options = {
  method: 'GET',
  headers: {'X-Account-Id': '<x-account-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.example.com/v1/collections/immediate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/collections/immediate"

headers = {
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

{
  "items": [
    {
      "amount": "100.00",
      "createdAt": "2024-01-15T10:30:00Z",
      "expirationSeconds": 3600,
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "receiverKey": "+5511999999999",
      "status": "ACTIVE",
      "txId": "TXN123456789",
      "updatedAt": "2024-01-15T10:30:00Z",
      "additionalInfo": {
        "customerId": "67890",
        "orderId": "12345"
      },
      "debtorDocument": "52998224725",
      "debtorName": "João da Silva",
      "description": "Payment for order #12345",
      "emv": "00020126580014br.gov.bcb.pix...",
      "locationUrl": "https://api.example.com/qr/550e8400",
      "metadata": {},
      "tags": [
        "ecommerce",
        "subscription"
      ]
    }
  ],
  "limit": 10,
  "page": 1,
  "total": 150
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

GET

collections

immediate

List Immediate Charges

curl --request GET \
  --url https://api.example.com/v1/collections/immediate \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-Id: <x-account-id>'

package main

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

func main() {

	url := "https://api.example.com/v1/collections/immediate"

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

	req.Header.Add("X-Account-Id", "<x-account-id>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

const options = {
  method: 'GET',
  headers: {'X-Account-Id': '<x-account-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.example.com/v1/collections/immediate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/collections/immediate"

headers = {
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

{
  "items": [
    {
      "amount": "100.00",
      "createdAt": "2024-01-15T10:30:00Z",
      "expirationSeconds": 3600,
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "receiverKey": "+5511999999999",
      "status": "ACTIVE",
      "txId": "TXN123456789",
      "updatedAt": "2024-01-15T10:30:00Z",
      "additionalInfo": {
        "customerId": "67890",
        "orderId": "12345"
      },
      "debtorDocument": "52998224725",
      "debtorName": "João da Silva",
      "description": "Payment for order #12345",
      "emv": "00020126580014br.gov.bcb.pix...",
      "locationUrl": "https://api.example.com/qr/550e8400",
      "metadata": {},
      "tags": [
        "ecommerce",
        "subscription"
      ]
    }
  ],
  "limit": 10,
  "page": 1,
  "total": 150
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Account-Id

string<uuid>

requerido

Account ID (UUID format)

Parámetros de consulta

limit

integer<int64>

predeterminado:10

Maximum number of collections per page (1-100)

page

integer<int64>

predeterminado:1

Page number for pagination (starting at 1)

status

string[]

Status filter. Allowed values: ACTIVE, COMPLETED, EXPIRED, DELETED

Respuesta

items

object[]

requerido

Show child attributes

limit

integer<int64>

requerido

Ejemplo:

10

page

integer<int64>

requerido

Ejemplo:

1

total

integer<int64>

requerido

Ejemplo:

150

API de DICT

API de Reclamaciones

MED · Infracciones

MED · Marcadores de fraude

MED · Solicitudes de devolución

MED · Estadísticas

API de Transacciones

API de Códigos QR

API de Cobros

API de Recuperación de Fondos

API de Conciliación

API de Pix Automático

API de Programaciones

API de Informes de Transacción

Tiempos de transacciones

API de Webhooks

Manejo de errores

Eventos

List Immediate Charges

Autorizaciones

Encabezados

Parámetros de consulta

Respuesta