Listar pacotes de tarifas bancárias

🔽
GET urlServidor/v1/marketplace/fees-bankings

Obs: A palavra urlServidor deve ser substituída pela url do servidor.

Parâmetros da Requisição

Nome	Tipo	Obrigatório	Descrição
`integration-key`	string	Sim	Chave de integração.
`x-token`	string	Sim	Token utilizado para autenticação. Pode ser encontrado no portal da API.
`Authorization`	Auth Type Bearer Token	Sim	Inserir o Bearer Token, gerado na rota Auth

Exemplo de header da requisição

curl--request GET \
--location '{{urlServidor}/v1/marketplace/fees-bankings' \
--header 'integration-key: your_integration_key' \
--header 'x-token: your_x_token' \
--header 'Authorization: Bearer {{bearer_token}}' \

Parâmetros de Query

Nome	Tipo	Obrigatório	Descrição
`filters`	string	Não	JSON com filtros. Exemplo: `{ "status": "CREATED" }`
`search`	string	Não	Texto de busca. Campos buscáveis: `name`
`perPage`	number	Não	Limitado ao máximo de 100 por página.
`page`	number	Não	Página atual.
`sorters`	string	Não	Lista de ordenadores. Exemplo: `[ { "column": "created_at", "direction": "DESC" } ]`

✅ Exemplo de Resposta - 200 OK

{
    "total": 2,
    "page": 1,
    "perPage": 20,
    "lastPage": 1,
    "data": [
        {
            "id": 23,
            "name": "Novo plano",
            "type": "COMMERCIAL",
            "standard": {
                "pix": 51,
                "ted": 451,
                "billet": 251,
                "dynamic_pix": 0
            },
            "markup": {
                "pix": 300,
                "ted": 200,
                "billet": 100,
                "dynamic_pix": 0
            },
            "fees": {
                "pix": 351,
                "ted": 651,
                "billet": 351,
                "dynamic_pix": 0
            },
            "created_at": "2024-08-23T09:49:21.000Z",
            "updated_at": "2024-08-23T09:49:30.000Z"
        },
        {
            "id": 2,
            "name": "Pacote de Tarifa Comercial",
            "type": "COMMERCIAL",
            "standard": {
                "pix": 200,
                "ted": 200,
                "billet": 200,
                "dynamic_pix": 200
            },
            "markup": {
                "pix": 50,
                "ted": 50,
                "billet": 50,
                "dynamic_pix": 50
            },
            "fees": {
                "pix": 250,
                "ted": 250,
                "billet": 250,
                "dynamic_pix": 250
            },
            "created_at": "2023-06-21T19:41:40.000Z",
            "updated_at": "2023-06-21T19:41:40.000Z"
        }
    ]
}

📋 Explicação de Atributos da Resposta

Campo	Tipo	Obrigatório	Descrição
`total`	number	Sim	Número total de registros.
`page`	number	Sim	Página atual.
`perPage`	number	Sim	Número de registros por página.
`lastPage`	number	Sim	Número total de páginas.
`data[].id`	number	Sim	ID do pacote de tarifa bancária.
`data[].name`	string	Sim	Nome identificador do pacote de tarifas.
`data[].type`	string	Sim	Tipo da tarifa bancária. Valores possíveis: `COMMERCIAL`, `STANDARD`.
`data[].standard.pix`	number	Sim	Taxa padrão para transações via PIX.
`data[].standard.ted`	number	Sim	Taxa padrão para transações via TED.
`data[].standard.billet`	number	Sim	Taxa padrão para boletos.
`data[].standard.dynamic_pix`	number	Sim	Taxa padrão para PIX dinâmico.
`data[].markup.pix`	number	Sim	Acréscimo (markup) sobre a taxa padrão de PIX.
`data[].markup.ted`	number	Sim	Acréscimo (markup) sobre a taxa padrão de TED.
`data[].markup.billet`	number	Sim	Acréscimo (markup) sobre a taxa padrão de boleto.
`data[].markup.dynamic_pix`	number	Sim	Acréscimo (markup) sobre a taxa padrão de PIX dinâmico.
`data[].fees.pix`	number	Sim	Taxa final aplicada para PIX (standard + markup).
`data[].fees.ted`	number	Sim	Taxa final aplicada para TED (standard + markup).
`data[].fees.billet`	number	Sim	Taxa final aplicada para boleto (standard + markup).
`data[].fees.dynamic_pix`	number	Sim	Taxa final aplicada para PIX dinâmico (standard + markup).
`data[].created_at`	string (datetime)	Sim	Data de criação do pacote.
`data[].updated_at`	string (datetime)	Sim	Data da última atualização do pacote.

Códigos de Resposta

Consulte a página com os status: Status de respostas

Para mais detalhes sobre os parâmetros e funcionamento da API, acesse a documentação oficial da Paytime.