PIX Cashout Auto Approve using Pix Manual

Headers

Parameter	Type	Description	Example
Authorization	String	Bearer + Access_token	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzEzMzAwOTMxLCJpYXQiOjE3MTMyOTczMzEsImp0aSI6Ijc2ZWI4ZTE5ZjM4YjQ4NmZiODdmNzNjNTdkMWVmNDJhIiwidXNlcl9pZCI6MjQ2fQ.5zekMa7CUj9p-MvNHns5ke4ZPhYV3Y1CLOsYL7hDUUo
hmac	String	HMAC (Hash-based Message Authentication Code)	hmac: 57373705c83bc5efe41001790c54642e670088c0c87d56bc8f990f2260c7740b99f4081ff231b87f82118c1e77a959e1f40eacf690a8fa61a827a9ba01d546f6)

Body Details

{
    "source_account_branch_identifier": "xxxx",
    "source_account_number": "xxxxxxx",
    "amount": 0.01,
    "tag": "",
    "recipient_account_branch": "xxxxx",
    "recipient_account_branch_digit": "x",
    "recipient_account_number": "xxxxxxx",
    "recipient_account_number_digit": "x",
    "recipient_account_type": "Current Account",
    "recipient_account_model": "Movement",
    "recipient_name": "SaQCash",
    "recipient_legal_id": "xxxxxxxxxxx",
    "recipient_instution": "xxxxxxxx"
}

Field	Description	Required or Optional
source_account_branch_identifier	In this field, you should provide the number of the originating bank branch from which the money will be withdrawn. The branch number always consists of 4 digits (e.g., 0001).	required
source_account_number	In this field, you should provide the bank account number from which the money will be withdrawn. A bank account number does not have a specific pattern and may vary in length depending on the financial institution. (Example: Accounts registered with SaQ.Digital typically have 6 characters).	required
amount	In this field, you should provide the desired amount for the transfer.	required
Tag	This is an optional field where you can input a custom code that will be associated with the pix cashout to facilitate tracking, management, and payment control.	Optional
recipient_account_branch	In this field, you should provide the destination branch number of the account to which the amount will be transferred.	required
recipient_account_branch_digit	In this field, you should provide the destination branch digit, if applicable, for the account to which the amount will be transferred. If the branch does not have a digit, leave it blank.	Optional
recipient_account_number	In this field, you should provide the destination account number to which the amount will be transferred.	required
recipient_account_number_digit	In this field, you should provide the destination account digit for the account to which the amount will be transferred.	required
recipient_account_type	In this field, you should specify the type of the destination account to which the amount will be transferred. The valid values for this field are: Current Account, Savings, Payment, or Salary. Below is a summary of each account type: Current Account: A Current Account is a type of account offered by banks that allows for numerous transactions. This account typically provides features like easy access to funds through checks, debit cards, and online banking. It is ideal for everyday transactions and managing finances. Savings (Saving Account): A Savings Account is a deposit account that earns interest on the balance held. It is intended for saving money rather than daily transactions. Savings Accounts typically offer lower liquidity compared to Current Accounts but provide a way to accumulate interest over time. Payment (Payment Account)A Payment Account is specifically designed for handling transactions such as receiving and making payments. It often has features geared towards managing transactions efficiently, including direct debits and credit transfers. It may not offer extensive banking services beyond payment functionalities. Salary (Salary Account): A Salary Account is a type of account where an employer deposits an employee’s salary. It typically offers features such as zero balance requirements and may provide additional benefits like lower fees or preferential interest rates. This account is designed to facilitate the payment of wages and manage personal finances.	required
recipient_account_model	In this field, you should specify o modelo de conta do destinatário of the destination account to which the amount will be transferred. The valid values for this field are: Movement, Escrow, Linked. Below is a summary of each account type: Movement: A Movement Account is designed for frequent transactions and managing day-to-day financial operations. This type of account allows for numerous deposits, withdrawals, and transfers, providing flexibility for regular financial activities. It is often used by individuals and businesses to handle ongoing financial transactions efficiently.. Escrow: An Escrow Account is used to hold funds securely until specific conditions are met, often used in transactions involving large sums of money, such as real estate deals. This account ensures that both parties in a transaction fulfill their obligations before the funds are released. It provides security and trust in transactions by acting as a neutral holding place.. LinkedA Linked Account is a bank account that is connected to another account, allowing for seamless transfers and transactions between the two. This setup is useful for managing funds across different accounts, such as linking a savings account to a current account for easy transfers. It provides convenience and efficiency in handling multiple accounts.	required
recipient_name	In this field, you should provide the full name of the recipient, either an individual (PF) or a company (PJ) associated with the account to which the amount will be transferred.	required
recipient_legal_id	In this field, you should provide the document number of the recipient, either an individual (CPF) or a company (CNPJ) associated with the account to which the amount will be transferred.	required
recipient_instution	In this field, you should provide the ISPB code associated with the destination bank to which the amount will be transferred.	required

📘
During the Test Period (POC), the system will return the error of invalid HMAC, along with the correct HMAC that should be inputted.

Response Details

{
    "worked": true,
    "id": 175***,
    "transaction_id": 175***,
    "code_transaction": "E35535*******************X1DV",
    "status": "SU****",
    "amount": 0.01,
    "fee": 0.0,
    "key": "lr4*********@gmail.com",
    "tag": "hsy**********",
    "from_accout": "900***",
    "recipient_instution": "105****",
    "recipient_account_id": "656********",
    "recipient_branch_id": "*",
    "recipient_legal_id": "348********",
    "recipient_name": "Lu***********ha",
    "recipient_account_type": null,
    "operationUuid": "E35535*******************X1DV",
    "erro_descriptor": "",
    "new_erro_descriptor": ""
}

Field	Description
worked	Returns true or false confirming whether the query was successfully returned or not
transaction_id	Unique payment identifier generated. This value never repeats, and it enables querying endpoints to confirm the payment status
code_transaction	Returns the Unique payment identifier generated (UUID). This value never repeats; it's a universal tracking value for the payment among the involved banking institutions.
status	NEW - Payment generated, awaiting payment by the customer PROCESSING - Indicates that the payment is in processing. SUCCESS - Payment successfully completed CANCELED - Payments not approved, expired or cancelled.
amount	Returns the transfer amount. (the same information that was sent in the body)
fee	This field returns the fee charged to the SaQ.Digital customer when using the PIX Transfer (Cash Out) endpoint
key	Returns the Pix key (the same information that was sent in the request body)
from_accout	Returns the account number of the originating account that performed the transfer.
Tag	Returns the optional tag field where you can input a custom code if applicable
recipient_name	Returns the full name of the recipient, either an individual (PF) or a company (PJ)
recipient_instution	Returns the ISPB code associated with the destination bank.
recipient_branch_identifier	Returns the bank branch of the recipient (Agency).
recipient_account_id	Returns the account number of the recipient.
recipient_legal_id	Returns the document number of the recipient, either an individual (PF) or a company (PJ).
operationUuid	Returns the operationUuid, also known as the “EndtoEnd” value. This value never repeats, and it enables querying endpoints to confirm the payment status
erro_descriptor	Returns an error message, if applicable
new_erro_descriptor	Returns an error message, if applicable