2. Outbound Transaction
Step by step of how to create an outbound transaction in Corporate API.
📑 Summary
- Objective
- Functionalities
- Outbound Transaction Flow
- Data for Creating an Outbound Transaction
- Outbound Transaction Sequence Diagram
- Outbound Transaction Statuses
Objective
The objective of this module is to explain how the process of creating an international outbound transaction in Corporate API works.
Functionalities
Through the transaction module, it is possible to:
Outbound Transaction Flow
After creating a quote and accepting it, the last step in the API is to create an outbound transaction. The API gets all accepted quotes (not bound to a transaction), and creates a transaction with the sum of USD or EUR amounts and the weighted average of exchange rates.
Before creating the transaction, it is possible to check all the accepted quotes through the endpoint GET transaction quotes.
Beneficiary
The beneficiary's information and bank details are defined in advance and associated with the partner's profile. If the beneficiary or the bank details have been changed, please let us know so we can update the client's profile on our end.
Transaction Payment
Transactions can only be created in business days from 9am to 5:00pm (BRT Time). Also, The BRL funds need to be transferred on the same day the transaction was created. Otherwise the transaction will be canceled.
Settlement Date
Corporate API does not work for future settlements, only with spot exchange. Which means that the transaction, after being paid, will have it's liquidity date settled for T+0, T+1 or T+2, depending on the time that the payment was made. The table below shows the time box for T+0 operatations:
If payment does not occur in the time box shown below, settlement will be made on T+1 or T+2.
After creating the transaction, the partner needs to transfer the funds in the equivalent amount in BRL specified in the transaction. You can check Remessa Online's partner Bank Account details below:
Field Name | Description |
---|---|
Bank | Banco Topázio SA (082) |
Agency | 0001 |
Checking Account Number | 6685193-2 |
Favored | Banco Topázio SA |
CNPJ | 07.679.404/0001-00 |
Account Type | Checking Account (Conta Corrente) |
Transaction Type | TED (Credit in Checking Account) |
PIX Key |
---|
c027f762-36df-4301-addd-c3d8995c43f7 |
📍 1. Data for Creating an Outbound Transaction
To create an inbound transaction, you need to provide the required parameters:
Field Name | Is required | Description |
---|---|---|
currency | Yes | Output currency which you want to create the transaction, based on accepted quotes. |
purpose | Yes | Transaction purpose. |
counterpartyId | Yes | Transaction beneficiary identification. This information will be sent in advance by Remessa Online's team. The counterpartyId refers to the beneficiary ID that will receive the money abroad. |
direction | Yes | Transaction direction. |
externalId | No | Currency in ISO format which the client wants to sell. |
Below you can see an example of a full request for creating an outbound transaction for the Crypto purpose:
curl --request POST \
--url https://fx-sandbox.remessaonline.com.br/corporate/v1/transaction/OUTBOUND \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--header 'User-Agent: {partnername}-remessa' \
--header 'accept: application/json' \
--header 'x-token: {{x-token}}' \
--data '
{
"externalId": "1f8c4581-9d17-4b45-a0f6-d27277867c2d",
"currency": "USD",
"purpose": "CRYPTO",
"counterpartyId": "ph23c4581-9d17-4b45-a0f6-d27277867c2d"
}
Outbound Transaction Sequence Diagram
Outbound Transaction Statuses
Transaction Flow Statuses
Order | Status | Description |
---|---|---|
1º | AWAITING_PAYMENT | We are waiting for the transaction payment in Remessa Online's partner bank account. |
2º | PAYMENT_CONFIRMED | The payment was confirmed we will start the settlement soon. |
3º | SETTLEMENT_IN_PROGRESS | The settlement is in progress. |
4º | CONTRACT_IN_PROGRESS | The settlement was concluded and Remessa Online is creating de foreign exchange contract. |
5º | REGISTERED_TRANSACTION | The contract was registered with the Brazilian Central Bank. |
6º | TRANSACTION_COMPLETED | The money was sent to the beneficiary. |
Other Statuses
Status | Description |
---|---|
CANCELED | The transaction was canceled. |
PAYMENT_ISSUE | The amount was insufficient, it's necessary to send the correct amount. |
TRANSACTION_DOCUMENT_ISSUE | Missing documents to continue the transaction. |
REFUNDED | The transaction was canceled and the amount was returned. |
INVALID_PROOF_OF_PAYMENT | Despite the proof of payment received, the amount was not identified. Please redo according to the instructions. |
SETTLEMENT_ISSUE | The foreign currency was not liquidated to the beneficiary, it's necessary to contact our support. |
Partners can be notified through webhooks when the transaction status changes. More details can be found here
Updated about 1 year ago