Approve batch transaction with Two-Factor Authentication

Request

ENDPOINT

/account/ACCOUNT_KEY/pix_transfer_batch/PIX_TRANSFER_BATCH_KEY/validate_token

METHOD

PUT

Path Params

Field	Type	Description	Characters
account_key	uuidv4	Unique account identification key.	36
pix_transfer_batch_key	uuidv4	Unique identification key for the pix batch transfer.	36

Authentication via Email and SMS

Request Body

{
  "token": "329adf"
}

Authentication via Device

To approve and finalize device authentication, the request must be sent with an empty payload. Validation occurs internally, with no additional information required in the request body. Note that this endpoint should only be used after the batch transaction request has been initiated.

Request Body

{

}

Body Params

Field	Type	Description	Characters
token	string	Authentication code sent to the account's transaction approver required for TFA via SMS or email	6

Response

STATUS

201

Response Body: Transfer sent

{
  "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "pix_transfer_batch_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "pix_transfer_batch_status": "approved"
}

STATUS

4xx

Response Body: Transfer rejected

{
  "title": "titulo",
  "description": "description in English",
  "translation": "description in portuguese",
  "code": "codigo",
  "extra_fields": {
    "pix_transfer_batch_data": {
      "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
      "pix_transfer_batch_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
      "pix_transfer_batch_status": "rejected"
    }
  }
}

STATUS

4xx

Response Body: Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "description in portuguese",
  "code": "codigo",
  "extra_fields": {}
}

HTTP Code status	QI Code code	Title title	Description (eng) description	Description (ptbr) translation
404	PXT000178	Pix Transfer Batch not found	A pix_transfer_batch not found	Uma pix_transfer_batch não encontrada
400	PXT000180	Invalid Status	Pix transfer Batch not in pending_2fa_approval status	Pix transfer em lote não está pendente de aprovação por autenticação de dois fatores
400	PXT000171	Number of token validation attempts exceeded	The maximum number of failed token validation attempts has been reached	Número máximo de tentativas de validação de token atingida
400	PXT000172	Token Expired	Token has expired. Resend token or recreate transferToken has expired. Resend token or recreate transfer	Token expirado. Reenvie token ou recrie a transferência
400	PXT000173	Incorrect Token	Token sent does not match expected	Token enviado não condiz com, o esperado
400	PXT000189	Token Required	A token is required for SMS or email validation.	Um token é necessário para validação via SMS ou email.