SAQ DigitalDocs

    Create Cashout Manual Self-Approve

    Creates a new PIX cashout transaction using manual recipient account details and automatically approves it for processing. This endpoint combines the creation and approval steps, immediately transitioning the transaction from `NEW` to `PROCESSING` status. A background task is initiated to complete the transfer using the provided recipient account information.

    POSThttps://api.saq.digital/v2/finance/create-cashoutmanual-self-approve
    curl --request POST \
      --url 'https://api.saq.digital/v2/finance/create-cashoutmanual-self-approve' \
      --header 'Authorization: Bearer <ACCESS_TOKEN>' \
      --header 'hmac: <HMAC_SIGNATURE>' \
      --header 'Content-Type: application/json' \
      --data '{
      "source_account_branch_identifier": "0001",
      "source_account_number": "123456",
      "amount": 500,
      "recipient_account_branch": "0123",
      "recipient_account_branch_digit": "",
      "recipient_account_number": "987654",
      "recipient_account_number_digit": "3",
      "recipient_account_type": "CURRENT_ACCOUNT",
      "recipient_account_model": "Movement",
      "recipient_name": "Maria Silva",
      "recipient_legal_id": "98765432100",
      "recipient_instution": "60701190"
    }'
    Response200
    {
      "worked": true,
      "id": 789459,
      "transaction_id": 789459,
      "code_transaction": null,
      "status": "PROCESSING",
      "amount": 100.5,
      "fee": 0,
      "key": null,
      "tag": "payment-reference-123",
      "from_accout": "123456",
      "recipient_instution": "12345678",
      "recipient_instution_name": null,
      "recipient_account_id": "654321-9",
      "recipient_branch_id": "0001",
      "recipient_legal_id": "123********01",
      "recipient_name": "John Doe",
      "recipient_account_type": "Current Account",
      "operationUuid": null,
      "idempotency_key": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "erro_descriptor": "",
      "new_erro_descriptor": ""
    }

    Endpoint

    POST /create-cashoutmanual-self-approve

    Headers

    ParameterTypeDescriptionRequired or OptionalExample
    AuthorizationStringBearer + Access_tokenrequiredBearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzEzMzAwOTMxLCJpYXQiOjE3MTMyOTczMzEsImp0aSI6Ijc2ZWI4ZTE5ZjM4YjQ4NmZiODdmNzNjNTdkMWVmNDJhIiwidXNlcl9pZCI6MjQ2fQ.5zekMa7CUj9p-MvNHns5ke4ZPhYV3Y1CLOsYL7hDUUo
    hmacStringHMAC (Hash-based Message Authentication Code) is an authentication algorithm that combines a private key with a message to create a Message Authentication Code (MAC).requiredhmac: 57373705c83bc5efe41001790c54642e670088c0c87d56bc8f990f2260c7740b99f4081ff231b87f82118c1e77a959e1f40eacf690a8fa61a827a9ba01d546f6
    idempotency-keyStringOptional UUID to prevent duplicate transactions. When provided, ensures that retrying the same request will not create multiple transactions. See Idempotency section below.optional550e8400-e29b-41d4-a716-446655440000

    Body Details

    {
      "source_account_branch_identifier": "0001",
      "source_account_number": "123456",
      "amount": 100.50,
      "recipient_account_branch": "0001",
      "recipient_account_branch_digit": "0",
      "recipient_account_number": "654321",
      "recipient_account_number_digit": "9",
      "recipient_account_type": "CURRENT_ACCOUNT",
      "recipient_account_model": "Movement",
      "recipient_name": "John Doe",
      "recipient_legal_id": "12345678901",
      "recipient_instution": "12345678",
      "tag": "payment-reference-123"
    }
    FieldTypeDescriptionRequired or Optional
    source_account_branch_identifierStringBranch identifier of the source account from which the transfer will be made.required
    source_account_numberStringAccount number of the source account from which the transfer will be made.required
    amountDecimalAmount to be transferred. Must be greater than 0 and have up to 2 decimal places.required
    recipient_account_branchStringBranch number of the recipient's bank account.required
    recipient_account_branch_digitStringBranch verification digit. Use empty string if not applicable.optional
    recipient_account_numberStringAccount number of the recipient.required
    recipient_account_number_digitStringAccount number verification digit.required
    recipient_account_typeStringType of recipient's account. See Account Type Values section below for accepted values.required
    recipient_account_modelStringAccount model. Must always be "Movement" (fixed value).required
    recipient_nameStringFull name of the recipient.required
    recipient_legal_idStringCPF or CNPJ of the recipient (numbers only).required
    recipient_instutionStringISPB code of the recipient's financial institution (8 digits).required
    tagStringOptional reference tag for tracking purposes. Free text field for client use.optional

    Request Examples

    Transfer to checking account with auto-approval:

    POST /create-cashoutmanual-self-approve
    Authorization: Bearer <access_token>
    hmac: <computed_hmac>
    Content-Type: application/json
    
    {
      "source_account_branch_identifier": "0001",
      "source_account_number": "123456",
      "amount": 500.00,
      "recipient_account_branch": "0123",
      "recipient_account_branch_digit": "",
      "recipient_account_number": "987654",
      "recipient_account_number_digit": "3",
      "recipient_account_type": "CURRENT_ACCOUNT",
      "recipient_account_model": "Movement",
      "recipient_name": "Maria Silva",
      "recipient_legal_id": "98765432100",
      "recipient_instution": "60701190"
    }

    Transfer with idempotency key:

    POST /create-cashoutmanual-self-approve
    Authorization: Bearer <access_token>
    hmac: <computed_hmac>
    idempotency-key: 7c9e6679-7425-40de-944b-e07fc1f90ae7
    Content-Type: application/json
    
    {
      "source_account_branch_identifier": "0001",
      "source_account_number": "123456",
      "amount": 1250.75,
      "recipient_account_branch": "0001",
      "recipient_account_branch_digit": "0",
      "recipient_account_number": "111222",
      "recipient_account_number_digit": "5",
      "recipient_account_type": "SAVING_ACCOUNT",
      "recipient_account_model": "Movement",
      "recipient_name": "João Santos",
      "recipient_legal_id": "12345678901",
      "recipient_instution": "12345678",
      "tag": "contract-payment-456"
    }

    Response Details

    {
      "worked": true,
      "id": 789459,
      "transaction_id": 789459,
      "code_transaction": null,
      "status": "PROCESSING",
      "amount": 100.5,
      "fee": 0.0,
      "key": null,
      "tag": "payment-reference-123",
      "from_accout": "123456",
      "recipient_instution": "12345678",
      "recipient_instution_name": null,
      "recipient_account_id": "654321-9",
      "recipient_branch_id": "0001",
      "recipient_legal_id": "123********01",
      "recipient_name": "John Doe",
      "recipient_account_type": "Current Account",
      "operationUuid": null,
      "idempotency_key": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "erro_descriptor": "",
      "new_erro_descriptor": ""
    }
    FieldTypeDescription
    workedBooleanAlways true for successful requests.
    idIntegerUnique identifier of the transaction.
    transaction_idIntegerTransaction identifier (same as id).
    code_transactionStringHuman-readable transaction code. Will be null initially for PROCESSING transactions.
    statusStringCurrent status of the transaction. Will be PROCESSING for self-approved cashouts.
    amountFloatAmount transferred.
    feeFloatTransaction fee charged. Currently 0.0 for PIX transactions.
    keyStringPIX key used. Will be null for manual transfers.
    tagStringReference tag provided in the request, or empty string if not provided.
    from_accoutStringSource account number from which the transfer was made.
    recipient_instutionStringISPB code of the recipient's financial institution.
    recipient_instution_nameStringName of the recipient's financial institution. Will be null initially.
    recipient_account_idStringRecipient's account number with verification digit (e.g., "654321-9").
    recipient_branch_idStringRecipient's branch identifier.
    recipient_legal_idStringRecipient's CPF or CNPJ (may be masked for security).
    recipient_nameStringRecipient's name.
    recipient_account_typeStringType of recipient's account (e.g., "Current Account", "Savings Account", "Payment Account").
    operationUuidStringOperation UUID from the payment system, or null if not yet assigned.
    idempotency_keyStringThe idempotency key provided in the request, or null if not provided.
    erro_descriptorStringError description if the transaction failed, or empty string if successful.
    new_erro_descriptorStringAdditional error information, or empty string if not applicable.

    Error Responses

    HTTP CodeError MessageDescription
    400Account not foundThe specified source account does not exist.
    401UnauthorizedInvalid or missing authentication token. Ensure you are sending a valid Bearer token and HMAC signature.
    422Validation errorRequest validation failed. Check that all required fields are present and in the correct format.

    Account Type Values

    When providing manual recipient account details, use these values for recipient_account_type:

    ValueDescription
    CURRENT_ACCOUNTCurrent Account
    PAYMENT_ACCOUNTPayment Account
    SAVING_ACCOUNTSavings Account

    Note: The recipient_account_model field must always be set to "Movement" (fixed value).

    Business Rules

    1. Amount Validation: The amount must be greater than zero and have at most 2 decimal places.
    2. Transaction Status: The transaction is created with NEW status, then immediately transitioned to PROCESSING status.
    3. Background Processing: After the response is returned, a background task processes the cashout approval.
    4. HMAC Validation: The request body must be validated using the provided HMAC signature.
    5. Recipient Information: All recipient account details must be provided accurately to ensure successful transfer.
    6. Account Model: The recipient_account_model field must always be "Movement".

    Idempotency

    This endpoint supports the optional idempotency-key header to prevent duplicate transactions. Since this endpoint automatically approves transactions, using idempotency keys is critically important to avoid duplicate money transfers.

    For complete details on how idempotency works, including key format, response codes, and best practices, see the Idempotency section in the main documentation.

    Differences from Standard Create Cashout Manual

    FeatureCreate Cashout ManualCreate Cashout Manual Self Approve
    Initial StatusNEWPROCESSING
    Approval RequiredYes (separate call)No (automatic)
    Required PermissionsCREATECREATE + APPROVE
    Idempotency ImportanceRecommendedCritical (strongly recommended)
    Background ProcessingAfter approvalImmediate
    Use CaseMulti-step approvalSingle-step, trusted operations

    For more detailed examples and implementation guidance, see the Create Cashout documentation.