Listar payouts

GET

https://api.novuspagamentos.com/api/v2/payout

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Consulta

Parâmetros Header

Respostas

🟢200Sucesso

application/json

Body

🟠401Auth Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.novuspagamentos.com/api/v2/payout?pagesize=string&page=string' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json'

Response Example

{
    "data": [
        {
            "id": "5724",
            "status": "completed",
            "amount": 1000,
            "type": "withdrawal",
            "external_id": "DF6251107231309644013239",
            "end_to_end_id": "E071368472025110715131PLUCJFGLJW",
            "can_auto_process": true,
            "has_baas": true,
            "pix_key": "12345678901",
            "pix_key_type": "cpf",
            "postback_url": "https://example.com/webhook",
            "payer": {
                "nome": "Unive Pay",
                "documento": "62.488.920/0001-58",
                "conta": {
                    "agencia": "456",
                    "ispb": null,
                    "numero": "566",
                    "tipo": 1
                }
            },
            "payee": {
                "nome": "LEANDRO DE ARAUJO E SILVA",
                "documento": ".967.198-*",
                "conta": {
                    "agencia": null,
                    "ispb": "31872495",
                    "numero": null,
                    "tipo": null
                }
            }
        },
        {
            "id": "5720",
            "status": "pending",
            "amount": 5000,
            "type": "withdrawal",
            "external_id": "DF6251107231309644013240",
            "can_auto_process": true,
            "has_baas": true,
            "pix_key": "email@example.com",
            "pix_key_type": "email"
        }
    ],
    "message": "Payouts listados com sucesso",
    "pagination": {
        "page": 0,
        "pageSize": 20,
        "totalRecords": 2,
        "totalPages": 1
    }
}