Dashboard

Through Bank Instruction

This document provides a detailed walkthrough on how to send money through recipient's bank details

1. Create a Bank Instruction by calling the Create DICT Key Transaction endpoint:

curl --request POST \
  --url https://faas.sandbox.tracefinance.io/pix/api/transactions/bankInstruction \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data '
{
  "amount": {
    "value": 1500000
  },
  "destination": {
    "taxId": "37041494000162",
    "legalName": "TRACE CORRESPONDENTE CAMBIAL LTDA",
    "accountNumber": "7140025418",
    "accountType": "CHECKING",
    "ispbCode": "54403563",
    "branchCode": "0001"
  },
  "bankAccountId": "9008369c-8837-43c7-b5f2-0229622bd21c",
  "idempotentId": "24b2ae17-5a58-4465-acbb-45e11fdc2496",
  "validations": [
       {
        "key": "TAX_ID_MUST_BE_ACTIVE",
        "value": true
      }
   ]
}
'

Parameters:

  • destination.taxId: is the tax identification number of the account holder. (required)
  • destination.legalName: is the legal name of the account holder. (required)
  • destination.accountNumber: is the bank account number. (required)
  • destination.accountType: is the type of account (e.g., CHECKING, SAVINGS). (required)
  • destination.ispbCode: is the Institution’s Unique Identifier. (required)
  • amount.value: is the transaction amount in cents, following TraceFinance's Data Conventions. The currency is automatically set to BRL by the server. (required)
  • bankAccountIdis the bank account designated to receive the PIX transaction. This information is required only if you have more than one bank account. (conditionally required)
  • idempotentId: is a unique ID to prevent duplicate transactions. (required)
  • validations is the list of validations that the credit transaction originating from this QR code must be submitted. Transaction Validations (optional)

What Happens Next

  • A Transaction Created webhook is triggered to notify you of its creation.
  • If the transaction includes validations, they will be executed. In the event of a validation failure, the Transaction Failed webhook is triggered.
  • If all validations pass, the transaction moves to the processing stage, and a Transaction Processing webhook is triggered to notify that the transaction is now being processed.
  • If the transaction is completed, a Transaction Completed webhook is triggered, confirming the successful completion of the transaction.
  • If an error occurs at any point during the processing, a Transaction Failed webhook is triggered, providing details about the failure and the specific error that occurred.

Note: Monitoring these webhooks is crucial for keeping track of the transaction status and handling any necessary actions based on the transaction's outcome.