列出抗议

抗议列表将返回符合请求中发送的查询参数的所有钱包票据公证处抗议记录。

Request

ENDPOINT

/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/protests

MÉTODO

GET

Path parameters

字段	类型	描述	字符数
account_key	uuidv4	账户唯一标识键，uuid v4 格式	36
requester_profile_key	uuidv4	钱包唯一标识键，uuid v4 格式	36

Query parameters

字段	类型	描述	字符数
protest_key	uuidv4	抗议唯一标识键，uuid v4 格式	36
request_control_key	uuidv4	请求唯一标识键，uuid v4 格式	36
protest_status	string	抗议状态	Enumeradores protest_status
bank_slip_key	uuidv4	票据唯一标识键，uuid v4 格式	36
protocol_number	string	协议号码	36
protocol_date	string	协议日期（格式"YYYY-MM-DD"）	10
page_size	integer	每页大小	-
from_date	string	起始日期（格式"YYYY-MM-DD"）	10
to_date	string	结束日期（格式"YYYY-MM-DD"）	10

Enumeradores protest_status

枚举值	描述
accepted	已接受，但尚未发送至公证处
submitted	已发送至公证处
cancellation_requested	已申请中止抗议
cancelled	发送已取消，或抗议已中止
rejected	抗议申请被拒绝
at_notary_office	在公证处，处于三日期间
paid_at_notary_office	票据已在公证处支付
protested	票据已被抗议并核销
removal_requested	票据已被抗议，已申请取消
removed	抗议已取消

Response

STATUS

200

Response Body

{
    "data": [
        {
            "protest_key": "ad44278d-7cf1-4ac7-9545-410649a47dde",
            "request_control_key": "7e40ebab-f00c-4dbf-88be-ff34434ab358",
            "protest_status": "protested",
            "bank_slip_key": "7bf086ac-f520-4498-abd4-5a7d2173fd1c",
            "requester_profile_code": "329-09-0001-1467576",
            "protest_type": "protest",
            "protocol_number": "0000000004",
            "protocol_date": "2024-11-27",
            "notary_office": {
                "city": "SAO PAULO",
                "uf": "SP"
            }
        },
        {
            "protest_key": "0087f425-5e54-4b4c-ab17-a57bc80f223a",
            "request_control_key": "c413cedc-78ac-4deb-ace8-d94d4e98197c",
            "protest_status": "at_notary_office",
            "bank_slip_key": "e345c0b3-012b-4a4b-9d6b-6981f40b1a7c",
            "requester_profile_code": "329-09-0001-1467576",
            "protest_type": "protest",
            "protocol_number": "0000000016",
            "protocol_date": "2024-12-10",
            "notary_office": {
                "city": "RIO DE JANEIRO",
                "uf": "RJ"
            }
        },
        {
            "protest_key": "bc34e9b1-42e4-4f17-bfc0-c88f29d5230e",
            "request_control_key": "59515878-50e9-466b-b40d-1aac3939c3fd",
            "protest_status": "accepted",
            "bank_slip_key": "7d3d262b-9b55-44cd-8355-2f00d5b1d142",
            "requester_profile_code": "329-09-0001-1467576",
            "protest_type": "protest"
        }
    ],
    "pagination": {
        "current_page": 1,
        "rows_per_page": 100
    }
}

Response Body Params

字段	类型	描述	字符数
data *	object array	抗议列表	Objeto protest
pagination *	object	分页信息	Objeto pagination

Objeto protest

字段	类型	描述	字符数
protest_key *	uuidv4	抗议唯一标识键，uuid v4 格式	36
request_control_key *	uuidv4	客户使用的请求唯一标识键，uuid v4 格式	36
protest_status *	string	抗议状态	Enumeradores protest_status
bank_slip_key *	uuidv4	票据唯一标识键，uuid v4 格式	36
requester_profile_code *	string	钱包唯一识别码	10
protest_type *	string	抗议类型	Enumeradores protest_type
protocol_number	string	协议号码	10
protocol_date	string	协议日期（格式"YYYY-MM-DD"）	10
notary_office	object	公证处数据	Objeto notary_office

Objeto pagination

字段	类型	描述	字符数
current_page *	integer	当前页码	-
rows_per_page *	integer	每页记录数	-

Enumeradores protest_type

枚举值	描述
protest	普通抗议
bankruptcy_protest	破产抗议

Enumeradores protest_status

枚举值	描述
accepted	已接受，但尚未发送至公证处
submitted	已发送至公证处
cancellation_requested	已申请中止抗议
cancelled	发送已取消，或抗议已中止
rejected	抗议申请被拒绝
at_notary_office	在公证处，处于三日期间
paid_at_notary_office	票据已在公证处支付
protested	票据已被抗议并核销
removal_requested	票据已被抗议，已申请取消
removed	抗议已取消

Objeto notary_office

字段	类型	描述	字符数
city *	string	公证处所在城市	-
uf *	string	公证处所在州（UF）	2

Error Response

STATUS

4xx

Response Body: Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}

HTTP 状态码 status	QI 代码 code	标题 title	描述（英文） description	描述（葡文） translation
403	BKS000005	Forbidden	User is not allowed to do this action	Usuário não tem autorização para fazer essa ação
404	BKS000006	Not Found	The source account key was not found.	A chave da conta de origem não foi encontrada.
400	BKS000007	Bad Request	It was not possible to consult the source account at this time. Please try again in a few minutes.	Não foi possível consultar a conta de origem neste momento. Por favor, tente novamente em alguns minutos.
400	BKS000008	Bad Request	The source account is closed.	A conta de origem está fechada.
400	BKS000009	Bad Request	The source account is blocked.	A conta de origem está bloqueada.
400	BKS000012	Bad Request	Invalid integer value for page or size query string parameters.	Valor inválido para parâmetros de página ou tamanho de página.
404	BKS000013	Not Found	Requester profile not found	Carteira não encontrada