Pular para o conteúdo principal

Listar Lotes de Agendamento de uma conta

Request

ENDPOINT
/account/ACCOUNT_KEY/pix_schedule_batches
MÉTODO
GET

Path Params

CampoTipoDescriçãoCaracteres
account_keyuuidv4Chave única de identificação da conta.36

Query Params

CampoTipoDescriçãoCaracteres
request_control_keyuuidv4Chave única de identificação da request utilizada pelo cliente.36
schedule_batch_statusstringStatus do lote de agendamento. Pode ser enviado em forma de lista.20
pageintegerNúmero da página requisitada. 1 por padrão
page_sizeintegerTamanho da página requisitada na consulta. 30 por padrão e valor máximoValor máximo de 30

Response

STATUS
200
Response Body
{
"data": [
{
"request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
"schedule_batch_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
"schedule_batch_status": "approved",
"created_at": "2021-10-22T20:30:23.459Z"
},
{
"request_control_key": "bf6b0a4b-c7a5-446b-9dad-1ae10b25342a",
"schedule_batch_key": "2479a5cd-079e-4d72-bf4e-16a695bda45e",
"schedule_batch_status": "cancelled",
"created_at": "2021-10-22T20:30:23.459Z"
},
{
"request_control_key": "9d36c03e-2db7-4c90-87ed-6c9ddb3c03c7",
"schedule_batch_key": "5d6b14b9-053f-408c-bcd7-61ecf9224f2c",
"schedule_batch_status": "rejected",
"created_at": "2021-10-22T20:30:23.459Z"
}
],
"pagination": {
"current_page": 1,
"next_page": null,
"rows_per_page": 30
}
}

Consultar Lote de Agendamento de uma conta

Request

ENDPOINT
/account/ACCOUNT_KEY/pix_schedule_batch/SCHEDULE_BATCH_KEY
MÉTODO
GET

Path Params

CampoTipoDescriçãoCaracteres
account_keyuuidv4Chave única de identificação da conta.36
schedule_batch_keyuuidv4Chave única de identificação do lote de agendamentos.36

Response

STATUS
200
Response Body
{
"request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
"schedule_batch_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
"schedule_batch_status": "approved",
"created_at": "2021-10-22T20:30:23.459Z"
}