Cash Networks Brazil

This service allows you to integrate with different cash networks to query an account’s data and record cash in intents for an account in a cash network.

To deposit funds, you must register a cash in intent in one of the enabled payment networks.

CountryNetworkID
BrazilBoletoBOLETO

Create cash in intent

The /networks/cash/v1/cashout/intents POST endpoint will allow you to generate a cash in intent for a given account.. Each attempt represents the intention to withdraw money from an account balance through a payment network.

Lifecycle

The attempt is resolved when the money deposit is actually performed through a cash network or when the expiration date is reached, whichever occurs first.

The attempt can have different statuses depending on which action has been applied to it::

  • ACTIVE: The attempt is active and you can use it until the expiration date ('expires_at').. After the expiration date, you will not be able to use that attempt to deposit money; you will have to generate a new one..
  • REJECTED: The integration with the cash network rejected the creation of the intent..
  • PAID: The intent was paid in full for the amount you requested..
  • PARTIALLY_PAID: The intent was partially paid, meaning that the sum of the payments made on behalf of this intent is less than the amount you requested.. It is possible to make partial payments until the expiration date of the intent..
  • CANCELLED: This status can be reached in different ways.. Firstly, if you canceled the intent with the cancellation endpoint or the cash network provider proactively cancels the intent you generated..
Available parameters
Header Parameters
X-Idempotency-Keystringrequired
countrystringrequired
Example: bra
Body Parameters
account_idstringrequired
Account ID
Example: acc-20I4qJinTCudWvJULZygeC257wy
networkstringrequired
Payment network identifier
Example: BOLETO
amountstringrequired
Amount of income intent
Example: 397.67
Response details
dataobject
Was this section helpful to you?
POST/networks/cash/v1/cashin/intents
{
"account_id":
"acc-20I4qJinTCudWvJULZygeC257wy"
"network":
"BOLETO"
"amount":
"397.67"
}
Response examples

Get cash in intent

The /networks/cash/v1/cashin/intents/{intent_id} GET endpoint will allow you to get all the data of a cash in intent through its ID.
Available parameters
Header Parameters
countrystringrequired
Example: bra
Path Parameters
intent_idstringrequired
Cash in intent ID
Example: cin-20I4qJinTCudWvJULZygeC257wy
Response details
dataobject
Was this section helpful to you?
GET/networks/cash/v1/cashin/intents/{intent_id}
Response examples

Cancel Cash In Intent

El endpoint DELETE /networks/cash/v1/cashin/intents/{intent_id} te permitirá cancelar un cash in intent.
Available parameters
Header Parameters
countrystringrequired
Example: bra
Path Parameters
intent_idstringrequired
Cash in intent ID
Example: cin-20I4qJinTCudWvJULZygeC257wy
Response details
dataobject
Was this section helpful to you?
DELETE/networks/cash/v1/cashin/intents/{intent_id}
Response examples

List cash in intents by account

The /networks/cash/v1/cashin/intents/account/{account_id} GET endpoint will allow you to list all the cash in intents of a particular account.
Available parameters
Header Parameters
countrystringrequired
Example: bra
Query Parameters
filter[status]string
Status
Enum: ACTIVEREJECTEDPAIDPARTIALLY_PAIDCANCELLED
filter[date_from]string(format: date-time)
Fecha desde
filter[date_to]string(format: date-time)
Fecha hasta
page[number]integer(format: int32)
Page
page[size]integer(format: int32)
Page size
Path Parameters
account_idstringrequired
Account ID
Example: acc-20I4qJinTCudWvJULZygeC257wy
Response details
dataarray
metaobject
Was this section helpful to you?
GET/networks/cash/v1/cashin/intents/account/{account_id}
Response examples