Introduction

Security and transparency in account management are essential for any financial system. To meet these needs, specific endpoints have been developed to enable the emergency blocking and unblocking of accounts in a fast and secure manner.

This document presents the account blocking API, ensuring that suspicious transactions or risk situations can be addressed immediately. Additionally, it describes the unblocking endpoint, which allows the reversal of a previously applied block, provided the necessary criteria are met.

Both endpoints enforce strict control measures, requiring clear justifications for each action and ensuring full traceability of operations through detailed records. With this approach, the system maintains compliance with security and regulatory guidelines, offering a reliable experience for users and partners.

Account Blocking

method: BlockAccount

Description

This endpoint allows for the emergency blocking of accounts, instantly changing their status to "blocked." It supports different blocking types and requires specific justifications, ensuring a secure and transparent process.

{
    "Method": "BlockAccount", 
    "PartnerId": 896, 
    "BusinessUnitId": 1261, 
    "BlockType": 1, 
    "Justification": 0, 
    "Account": {
        "OwnerTaxNumber": "50231669020", 
        "AccountKey": "", 
        "Banks": {  
            "Bank": 450, 
            "BankBranch": "0001",
            "BankAccount": "380380",
            "BankAccountDigit": "3"
        }
    }
}

Required Parameters

Blocking Justifications

📌

Validation Rules BlockAccount

• The account cannot be blocked for the same blocking type.
• If the account is already blocked, the request will not be processed again.
• The blocking action will be recorded with status "Blocked (3)" and reason "Emergency Blocking (13)."

Response Example

👍

Sucess

JSON

{
    "status": "success",
    "message": "Conta desbloqueada com sucesso."
}

❗️

Error: Account Not Blocked

JSON

{
    "status": "error",
    "message": "A conta já está bloqueada para o tipo informado."
}

Account Unblocking

method: UnlockAccount

Description

This endpoint allows for the unblocking of accounts that were previously blocked using the BlockAccount method. Unblocking is only permitted if the account is currently blocked and matches the previously registered blocking type.

{
    "Method": "UnlockAccount", 
    "PartnerId": 896, 
    "BusinessUnitId": 1261, 
    "UnlockType": 1, 
    "Justification": 0, 
    "Account": {
        "OwnerTaxNumber": "50231669020", 
        "AccountKey": "", 
        "Banks": {  
            "Bank": 450, 
            "BankBranch": "0001",
            "BankAccount": "380380",
            "BankAccountDigit": "3"
        }
    }
}

Required Parameters

Unlocking Justifications

📌

Validation Rules UnlockAccount

• Unblocking is only permitted if the account was previously blocked using the BlockAccount method.
• If the account is not blocked for the specified type, the system will return a generic success message, but no changes will be made.
• If the account is already unblocked, the operation will be rejected.

Response Example

👍

Sucess

JSON

{
    "status": "sucess",
    "mensagem": "Conta desbloqueada com sucesso."
}

❗️

Error: Account Not Blocked

JSON

{
    "status": "success",
    "message": "Nenhum bloqueio encontrado para o tipo informado."
}

❗️

Error: Account Already Unblocked

JSON

{
    "status": "error",
    "message": "A conta já está desbloqueada."
}

Unlocked accounts will have their status restored to the condition they were in before the block.