HomeGuidesAPI Reference

4. Transaction Documents

Step by step of how to send or download documents in Corporate API.

Suggest Edits

📑 Summary

  • Objective
  • Functionalities
  • Documents
    • Document Types Available
    • Data for Uploading the Document
  • Get Transaction Documents
  • Download Transaction Documents
  • Get Transaction Required Documents
  • Upload Transaction Document

Objective

Enable the partner to download or send transaction documents.

Functionalities

UPLOADGETDOWNLOAD
Upload transaction documentGet transaction documentsDownload transaction document
Get transaction required documents

Documents

Documents related to the transaction sent by the partner or provided by Remessa. The type of document and the phase it is requested depends on the transaction's purpose.

📍 Document Types Available

TypeDescriptionPurposeAvailable function
FOREIGN_EXCHANGE_CONTRACTAll purposesDownload
SWIFT_RECEIPTAll purposesDownload
SCE-IDRequested for operations above US$ 100,000. The partner must provide it when sending the operation or request it to Remessa by sending us a letter of attorney.CAPITAL_INCREASEDownload
SOCIAL_CONTRACTContrato Social updated sent by the partnerCAPITAL_INCREASEDownload
ACAM220Document requested when sending PAYMENT PROCESSING operations. This document list all partner operations and its clients related to the transaction sent to Remessa. The document must follow the rules and template of Banco Central.PAYMENT_PROCESSINGUpload

Get Transaction Documents

This endpoint will list all documents attached to a transaction. It is possible to retrieve the document id, which is necessary to identify the document for downloading. 

[
    {
        "id": 10,
        "type": "SWIFT_RECEIPT",
        "createdAt": "2023-08-22T18:23:07.087Z"
    }
]

Download Transaction Documents

This endpoint is used to download documents from a transaction. To download a file, first you need to access Get transaction documents to verify the id of the desired document. After that, simply access Download transaction document giving the transactionId and the documentId and the file will be downloaded in your browser.

curl --request GET \
     --url https://fx-sandbox.remessaonline.com.br/document/{documentId}/transaction/{transactionId}/download \
     --header 'Authorization: Bearer {{token}}' \
     --header 'Content-Type: multipart/form-data' \
     --header 'User-Agent: {partnername}-remessa' \
     --header 'accept: application/json' \
     --header 'x-token: {{x-token}}' \
     --data '

Get Transaction Required Documents

This endpoint will list all required documents related to a transaction. The required documents will vary according to the purpose of the transaction. One example is the ACAM220, required in every PAYMENT_PROCESSING transaction. The endpoint will also bring the status of each required document.

{
    "documents": [
        {
            "name": "ACAM220",
            "status": "PENDING"
        }
    ]
}

Upload Transaction Document

Data for Uploading the Document

To upload a document, you need to provide the required parameters:

Field NameIs requiredDescription
typeYesType of document to be uploaded. Available types: "ACAM220".
transactionIdYesId of the transaction related to the document to be uploaded.
fileYesFile to be uploaded.

Below you can see an example of a full request for uploading a document:

curl --request POST \
     --url https://fx-sandbox.remessaonline.com.br/corporate/v1/document/transaction \
     --header 'Authorization: Bearer {{token}}' \
     --header 'Content-Type: multipart/form-data' \
     --header 'User-Agent: {partnername}-remessa' \
     --header 'accept: application/json' \
     --header 'x-token: {{x-token}}' \
     --data '
{
  "type": "ACAM220",
  "transactionId": "1f8c4581-9d17-4b45-a0f6-d27277867c2d",
  "file": "{{file}}"
}

🚧

Important

  • This endpoint uses multipart/form-data content type
  • The maximum file size is 500MB
  • The token for download will be valid for 7 days starting from the document upload

Updated 6 months ago