Approve PIX Cashout Pix Manual

POST https://api.saq.digital/v2/finance/approve-cashout-manual/

Approve Transfer funds from the business bank account to other accounts using PIX technology

Headers

Parameter	Type	Description	Example
Authorization	String	Bearer + Access_token	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzEzMzAwOTMxLCJpYXQiOjE3MTMyOTczMzEsImp0aSI6Ijc2ZWI4ZTE5ZjM4YjQ4NmZiODdmNzNjNTdkMWVmNDJhIiwidXNlcl9pZCI6MjQ2fQ.5zekMa7CUj9p-MvNHns5ke4ZPhYV3Y1CLOsYL7hDUUo
hmac	String	HMAC (Hash-based Message Authentication Code) is an authentication algorithm that combines a private key with a message to create a Message Authentication Code (MAC).	hmac: 57373705c83bc5efe41001790c54642e670088c0c87d56bc8f990f2260c7740b99f4081ff231b87f82118c1e77a959e1f40eacf690a8fa61a827a9ba01d546f6)

Body Details

Body JSON (Raw)

{
    "id": xxxxxx
}

Field	Description	Required or Optional
id	In this field, you should provide the 'transaction_id' of the transfer generated through the response of the PIX Transfer (Cash Out) endpoint.	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

Response

{
    "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