Pix cashout by pix copy and past

POST https://api.somossimpay.com.br/v2/finance/create-copy-and-paste-transfer

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).	57373705c83bc5efe41001790c54642e670088c0c87d56bc8f990f2260c7740b99f4081ff231b87f82118c1e77a959e1f40eacf690a8fa61a827a9ba01d546f6)

Body Details

Body JSON (Raw)

{
  	"source_account_branch_identifier": "xxxx",
  	"source_account_number": "xxxxxx",
    "amount": 0.01,
    "pix_copy_and_paste": "xxxxxxxxxxxxxx14br.gov.bcb.pix0114xxxxxxxxxxxxxxxxxxxxxxxx.025802BR5923YURI RIBEIRO DOS SANTOS6009SAO PAULO622905xxxxxxxxxxxxxxxxxxxxxx7"
}

Field	Description	Required or Optional
source_account_branch_identifier	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
pix_copy_and_paste	Field referring to the copy-and-paste code generated by the payment requesting bank.	required
tag	Returns the optional tag field where you can input a custom code if applicable	optional

Response Details

Response

{
    "worked": true,
    "id": 000004,
    "transaction_id": 0000004,
    "code_transaction": null,
    "status": "PROCESSING",
    "amount": 0.01,
    "fee": 0.0,
    "key": null,
    "tag": "",
    "from_accout": "000002",
    "recipient_instution": "0000095",
    "recipient_account_id": "000000-4",
    "recipient_branch_id": "0001",
    "recipient_legal_id": "14481478444",
    "recipient_name": "Fulano de tal",
    "recipient_account_type": "Current Account",
    "operationUuid": null,
    "erro_descriptor": "",
    "new_erro_descriptor": ""
}

Field	Type	Description
worked	Boolean	Returns true or false confirming whether the query was successfully returned or not
transaction_id	Decimal	Unique payment identifier generated. This value never repeats, and it enables querying endpoints to confirm the payment status
code_transaction	String	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	String	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	Decimal	Returns the transfer amount. (the same information that was sent in the body)
fee	Decimal	This field returns the fee charged to the SaQ.Digital customer when using the PIX Transfer (Cash Out) endpoint
key	String	Returns the Pix key (the same information that was sent in the request body)
from_accout	String	Returns the account number of the originating account that performed the transfer.
Tag	String	Returns the optional tag field where you can input a custom code if applicable
recipient_name	String	Returns the full name of the recipient, either an individual (PF) or a company (PJ)
recipient_branch_identifier	String	Returns the bank branch of the recipient (Agency).
recipient_account_id	String	Returns the account number of the recipient.
recipient_legal_id	String	Returns the document number of the recipient, either an individual (PF) or a company (PJ).
operationUuid	String	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	String	Returns an error message, if applicable
new_erro_descriptor	String	Returns an error message, if applicable