跳到主要内容

查询账户的 Pix 交易预约列表

Request​

ENDPOINT
/account/ACCOUNT_KEY/pix_schedules
MÉTODO
GET

Path Params​

字段类型描述字符数
account_keyuuidv4账户的唯一标识键。36

Query Params​

字段类型描述字符数
request_control_keyuuidv4客户使用的请求唯一标识键。36
schedule_statusstring预约状态。可以以列表形式发送。Enumerador schedule_status
pageinteger请求的页码。默认为 1
page_sizeinteger查询中请求的页面大小。默认及最大值为 30最大值为 30

Enumerador schedule_status​

枚举值描述
scheduled交易已预约
sent预约完成并成功发送。最终状态
rejected预约在创建或执行期间被拒绝。最终状态
cancelled应客户申请取消预约。最终状态
pending_2fa_approval待双因素认证批准
pending_creation预约正在创建（批量预约的过渡状态）
waiting_batch_approval预约已创建并关联到批次，等待双因素认证批准

Response​

STATUS
200
Response Body
{
  "data": [
    {
      "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
      "schedule_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
      "schedule_status": "scheduled",
      "schedule_date": "2024-12-31",
      "created_at": "2023-03-13T19:00:28.440Z"
    },
    {
      "request_control_key": "bf6b0a4b-c7a5-446b-9dad-1ae10b25342a",
      "schedule_key": "2479a5cd-079e-4d72-bf4e-16a695bda45e",
      "schedule_status": "cancelled",
      "schedule_date": "2024-12-31",
      "created_at": "2023-03-13T19:00:28.440Z"
    },
    {
      "request_control_key": "9d36c03e-2db7-4c90-87ed-6c9ddb3c03c7",
      "schedule_key": "5d6b14b9-053f-408c-bcd7-61ecf9224f2c",
      "schedule_status": "rejected",
      "schedule_date": "2024-12-31",
      "created_at": "2023-03-13T19:00:28.440Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "next_page": null,
    "rows_per_page": 30
  }
}