Confirm bank slip batch scheduling

This endpoint allows validating the two-factor authentication (2FA) token for a bank slip scheduling batch in batch_payment_schedule_status pending_2fa_approval.

Bank slip

A traditional bank slip (digitable line does not start with 8). It is registered in the Interbank Payment Chamber (CIP/Nuclea) and can be paid through financial and payment institutions authorized by the Central Bank.

Request

Request Endpoint

ENDPOINT

/bill_payment/account/ACCOUNT_KEY/payment/schedule_bank_slip/BATCH_PAYMENT_SCHEDULE_KEY/validate_token

METHOD

PATCH

Request Path Params

Field	Type	Description	Characters
`account_key` *	uuid4	Unique account identifier key.	36
`batch_payment_schedule_key` *	uuid4	Unique batch scheduling identifier key.	36

Request Body: Batch scheduling token validation

{
  "token": "329adf"
}

Body Params

Field	Type	Description	Characters
`token`	string	Authentication code sent to the account transaction approver	6

Response

Success Response

STATUS

200

Response Body: Confirmed scheduling batch

{
  "batch_payment_schedule_key": "c4325104-d60b-44f3-aae4-49155564a2ea",
  "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "account_key": "6dc89d57-fac7-4643-b151-cd2ca0a7f68f",
  "total_amount": 1357.3,
  "batch_payment_schedule_status": "scheduled",
  "payment_type": "bank_slip"
}

Response Body Params

Field	Type	Description
`batch_payment_schedule_key` *	uuid4	Unique batch scheduling identifier key.
`request_control_key` *	uuid4	Unique client request identifier key (batch).
`account_key` *	uuid4	Debited account key.
`total_amount` *	number	Sum of item amounts in the batch.
`batch_payment_schedule_status` *	enum	Batch scheduling status after token validation.
`payment_type` *	string	Payment type; for this flow, expected value is `bank_slip`.

Enumerators batch_payment_schedule_status

Enumerator	Description
`pending_2fa_approval`	Pending 2FA approval
`scheduled`	Scheduled
`rejected`	Rejected
`error`	Scheduling error

Error Response

STATUS

4XX

Response Body

{
    "title": "Title",
    "description": "Description in English",
    "translation": "Description in Portuguese",
    "code": "Code"
}

HTTP Code	QI Code	Title	Description (eng)	Description (pt-br)
403	BIP000010	Forbidden	User is not allowed to do this action	User is not allowed to do this action
404	BIP000011	Not Found	The source account key was not found.	The source account key was not found.
400	BIP000058	Bad Request	Error while validating verification token	Error while validating verification token
400	BIP000059	Bad Request	Number of verification token validation attempts exceeded.	Number of verification token validation attempts exceeded.
400	BIP000060	Bad Request	Verification token expired.	Verification token expired.
400	BIP000061	Bad Request	Verification token validation failed.	Verification token validation failed.
400	BIP000065	Bad Request	Payment verification time window exceeded.	Payment verification time window exceeded.
404	BIP000083	Not Found	Batch payment not found by batch payment key.	Batch payment not found by batch payment key.
400	BIP000085	Bad Request	Batch payment status is not pending approval.	Batch payment status is not pending approval.
400	BIP000086	Bad Request	A token is required for SMS or email validation.	A token is required for SMS or email validation.

Request​

Request Endpoint​

Request Path Params​

Body Params​

Response​

Success Response​

Response Body Params​

Enumerators batch_payment_schedule_status​

Error Response​