API Reference

Deposit Flows (Pay-in)

Overview

The deposit flows are referred to as 'Pay-in,' representing any type of deposit made by a third party.

In this section, we will cover deposits using dynamic QR codes, as well as deposit order retrieve information flows.

All deposit flows require OAuth authentication, so it is highly recommended to review the Authentication tab if you haven't done so already.

Before we begin, there are a few terms you should be familiar with:

Understanding the referenceId

The referenceId is a unique identifier generated by Transfero to track a deposit order. In the pay-in flow, a credit transaction is created with the same referenceId as the deposit order, simplifying the reconciliation process.

As previously mentioned, the externalId can also be used similarly to the referenceId, making it easier for the client to monitor the transaction.

Understanding the ImageOnly

The imageOnly parameter is designed to specify how the endpoint will respond to the request. It is a boolean parameter: if set to true, the response will be in image/jpeg format, and the referenceId of the QR code will be returned in the response header. If set to false, the response will be an object with the following string properties:

  • ReferenceId :Unique deposit order identification
  • QrCodeString: Is a string that can also be used by brazilians to pay the QR Code if the user prefers to copy and paste the string in his bank app instead of scanning the QR Code image.
  • Base64QRCode Is the QR Code image in an array of Bytes base-64.

Understanding the TaxId

TaxId is a common parameter used in many endpoints. It refers to a unique number or code assigned to individuals or businesses by a government authority, primarily for tax purposes.

Different countries use various systems and terms for tax identification, and in some cases, countries may not even have a centralized system for unique personal identification.

In Brazil, there are two types of tax identification numbers: CPF (Cadastro de Pessoa Física), used as a general personal identifier, and CNPJ (Cadastro Nacional de Pessoa Jurídica), used for businesses. The Federal Revenue Service can track all financial activities using these numbers. The CPF consists of eleven digits, typically formatted as XXX.XXX.XXX-XX, while the CNPJ is formatted as XX.XXX.XXX/XXXX-XX. However, it’s important to note that in our endpoints, only the numeric values are used—without any punctuation or special characters.

Each country has its own approach to tax identification. For example, in the United States, individuals use the SSN (Social Security Number), and businesses use the EIN (Employer Identification Number). The formats for SSN and EIN are, respectively: XXX-XX-XXXX and XX-XXXXXXX.

Some countries, like Somalia, do not have a centralized tax identification system at all.

These identification systems play a crucial role in ensuring compliance with tax regulations and facilitating various transactions. Depending on the country, the identifier may also be used for a wide range of activities beyond taxation, such as healthcare, employment, and legal documentation.