API - Documentation
API Endpoint
https://api-investment-ar-test.pcntassets.comIntroduction ¶
Authentication
The authentication method is through a login using an access_key and secret that will be provided. Upon calling the /login/api endpoint, a token (JWT) will be returned.
This JWT never expires as long as it is in use. Additionally, we support having multiple JWTs generated simultaneously under the same access_key and secret, which is useful when using the API from multiple microservices at once.
When the JWT expires due to inactivity, the APIs return an HTTP 401.
Headers
- organization: Acronym of the organization invoking the service. It must be sent with the key provided along with the access_key and secret.
- account: Brokerage account number invoking the service. This header is only required for those APIs involving account operations.
- Authorization: The token obtained at the login endpoint is sent. The word JWT must be concatenated before the token. Example: Authorization: JWT FDASFFAFDSF#$23423DSADSDAS=
ThirdPartyId
This is an ID generated by the API consumer. This ID must be unique as the concept of idempotency is applied to it.
Idempotency In all our transactional APIs, we implement this mathematical concept. This means that under the same thirdPartyId, we will always return the same response. In other words, each thirdPartyId must correspond to a single operation.
https://en.wikipedia.org/wiki/Idempotence
Organization
These are acronyms that unequivocally determine a specific organization. Everywhere in the documentation where <organization> is seen, it must be replaced by the provided acronyms that determine your organization.
Example If the provided organization is XXXX, change
<organization>to XXXX.
Auth ¶
Login ¶
Headers
Content-Type: application/json
organization: <organization>Body
{
"username": "generated_access_key",
"password": "generated_secret",
}Headers
Content-Type: application/jsonBody
{
"token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20A"
}Headers
Content-Type: application/jsonBody
{
"code": "INVALID_LOGIN",
"process": "948595173290356736",
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Authenticate in pcnt d1cPOST/profile/v1/login/api
This service authenticates using an access_key / secret and returns a JWT that must be used in subsequent requests.
| Field | Type | Description |
|---|---|---|
| organization | String | Acronym of the organization invoking the service |
| Field | Type | Description |
|---|---|---|
| username | String (required) | The provided 'access_key' |
| password | String (required) | The provided 'secret' |
| Field | Type | Description |
|---|---|---|
| token | String | Authentication JWT token |
| expires_in_seconds | Number | Expiration time |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
Account ¶
Account creation ¶
Headers
Content-Type: application/json
organization: <organization>
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"thirdPartyId": "XU231A",
"person": {
"naturalPerson": true,
"name": "Romina Paola",
"lastname": "Pizzo",
"nationality": "AR",
"residenceCountry": "AR",
"identificationType": "DNI",
"identification": "28334194",
"identificationCountry": "AR",
"maritalState": "SINGLE",
"birthDate": "1978-03-04",
"birthPlace": "AR",
"gender": "F",
"taxInformation": {
"type": "CUIT",
"number": "27283341947",
"businessActivity": "11341",
"pep": {
"isPep": true,
"description": "Diputado Nacional"
},
"incomeInscription": {
"type": "EXE",
"date": "1998-10-04"
},
"ivaCondition": "RI",
"countryTaxResidence": "AR",
"fatca": {
"isFatca": true,
"ssn": "1491949991"
},
"ocde": {
"isOcde": true,
"countryTaxResidencePrincipal": "UY",
"nitPrincipal": "12355550",
"countryTaxResidenceOptional": "BR",
"nitOptional": "12355554"
},
"subjectsBound": {
"isSubjectsBound": true,
"createdDate": "1998-10-04"
}
}
},
"address": {
"type": "LEGAL",
"street": "Helguera",
"number": "2177",
"floor": "3",
"apartment": "A",
"block": "1",
"sector": "A",
"tower": "1",
"zipCode": "1752",
"country": "AR",
"state": "AR",
"locality": "CABA"
},
"contact": {
"email": "ejemplo@mail.com",
"phone": "12341234",
"areaCode": "011"
},
"documents": [
{
"type": "FRONT_DNI",
"description": "Front DNI",
"filename": "frente.png",
"extension": ".png",
"verified": true,
"file": {
"url": "http://contentcdn.com/imagenes/12345.png"
}
}
],
"identityVerification": {
"id": "21223213213"
},
"banks": {
"identification": "0000347730000000049606",
"type": "CVU"
}
}Headers
Content-Type: application/jsonBody
{
"account": "234234"
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Headers
Content-Type: application/json
organization: <organization>
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"thirdPartyId": "XU231A",
"person": {
"naturalPerson": true,
"name": "Romina Paola",
"lastname": "Pizzo",
"nationality": "AR",
"residenceCountry": "AR",
"identificationType": "DNI",
"identification": "28334194",
"identificationCountry": "AR",
"maritalState": "SINGLE",
"birthDate": "1978-03-04",
"birthPlace": "AR",
"gender": "F",
"taxInformation": {
"type": "CUIT",
"number": "27283341947",
"businessActivity": "11341",
"pep": {
"isPep": true,
"description": "Diputado Nacional"
},
"incomeInscription": {
"type": "EXE",
"date": "1998-10-04"
},
"ivaCondition": "RI",
"countryTaxResidence": "AR",
"fatca": {
"isFatca": true,
"ssn": "1491949991"
},
"ocde": {
"isOcde": true,
"countryTaxResidencePrincipal": "UY",
"nitPrincipal": "12355550",
"countryTaxResidenceOptional": "BR",
"nitOptional": "12355554"
},
"subjectsBound": {
"isSubjectsBound": true,
"createdDate": "1998-10-04"
}
}
},
"address": {
"type": "LEGAL",
"street": "Helguera",
"number": "2177",
"floor": "3",
"apartment": "A",
"block": "1",
"sector": "A",
"tower": "1",
"zipCode": "1752",
"country": "AR",
"state": "AR",
"locality": "CABA"
},
"contact": {
"email": "ejemplo@mail.com",
"phone": "12341234",
"areaCode": "011"
},
"documents": [
{
"type": "FRONT_DNI",
"description": "Front DNI",
"filename": "frente.png",
"extension": ".png",
"verified": true,
"file": {
"base64": "WEREWREWREWREWREREWRWE...."
}
}
],
"identityVerification": {
"id": "21223213213"
},
"banks": {
"identification": "0000347730000000049606",
"type": "CVU"
}
}Headers
Content-Type: application/jsonBody
{
"account": "234234"
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Account creationPOST/profile/v1/account
Service for creating a new account.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token" |
| organization | String | Acronym of the organization invoking the service |
| Field | Type | Description |
|---|---|---|
| thirdPartyId | String (require) | External ID |
| person | Object [Person] | Person data see Person |
| address | Object [Address] | Address see Address |
| contact | Object [Contact] | Contact see Contact |
| documents | Object [Document] | Document see Document |
| identityVerification | Object [IdentityVerification] | IdentityVerification see IdentityVerification |
| banks | Object [Bank] | Bank see Bank |
| Person - Object | ||
|---|---|---|
| Field | Type | Description |
| naturalPerson | Boolean (require) | Indicates if it is a natural person, with possible values true or false |
| name | String (require) | Name |
| lastname | String (require) | Last name |
| nationality | String (require) | Nationality - two-letter country ISO code - See appendix |
| residenceCountry | String (require) | Residence country - two-letter country ISO code - See appendix |
| identificationType | String (require) | Identity document type. Possible values: DNI |
| identification | String (require) | Identity document number |
| identificationCountry | String (require) | Issuing country of the identity document - two-letter country ISO code - See appendix |
| maritalState | String (require) | Marital state. Possible values:
|
| birthDate | String (require) | Birth date |
| birthPlace | String (require) | Birth place (Country) - two-letter country ISO code - See appendix |
| gender | String (require) | Gender. Possible values
|
| taxInformation | Object [TaxInformation] | Tax information see TaxInformation |
| TaxInformation - Object | ||
|---|---|---|
| Field | Type | Description |
| type | String (require) | Identity document type. Possible values:
|
| number | String (require) | Identity document number |
| businessActivity | String | AFIP commercial activity code see list of AFIP codes |
| pep | Object [Pep] | Politically Exposed Person Information see Pep |
| incomeInscription | Object [IncomeInscription] | Income tax status see IncomeInscription |
| ivaCondition | String (require) | IVA status see Codes |
| countryTaxResidence | String | Tax residence country - two-letter country ISO code - See appendix |
| fatca | Object [Facta] | FATCA see Facta |
| ocde | Object [Ocde] | OECD see Ocde |
| subjectsBound | Object [SubjectsBound] | Subject Bound see SubjectsBound |
| Pep - Object | ||
|---|---|---|
| Field | Type | Description |
| isPep | Boolean (require) | Indicates if the person is a Politically Exposed Person |
| description | String (require) | Politically Exposed Person description |
| IncomeInscription - Object | ||
|---|---|---|
| Field | Type | Description |
| type | String (require) | Income tax status type see Codes |
| date | String (require) | Date since being an income tax payer |
| Fatca - Object | ||
|---|---|---|
| Field | Type | Description |
| isFatca | Boolean (require) | Indicates if the person is covered by FATCA |
| ssn | String (require) | FATCA number |
| Ocde - Object | ||
|---|---|---|
| Field | Type | Description |
| isOcde | Boolean (require) | Indicates if the person is covered by OECD |
| countryTaxResidencePrincipal | String | Primary tax residence country | Send two-letter country ISO code (See country code appendix) |
| nitPrincipal | String | TIN of the primary residence country |
| countryTaxResidenceOptional | String | Optional tax residence country | Send two-letter country ISO code (See country code appendix) |
| nitOptional | String | TIN of the optional residence country |
| SubjectsBound - Object | ||
|---|---|---|
| Field | Type | Description |
| isSubjectsBound | Boolean (require) | Indicates if the person is a subject bound |
| type | String | Subject Bound type |
| createdDate | String | Date since being a Subject Bound |
| Contact - Object | ||
|---|---|---|
| Field | Type | Description |
| areaCode | String | Area code of the primary member's phone |
| String | Email of the primary member | |
| phone | String | Phone of the primary member |
| Document - Object | ||
|---|---|---|
| Field | Type | Description |
| type | String |
|
| description | String (required) | Document description |
| filename | String (required) | Filename |
| extension | String (required) | File extension |
| verified | Boolean (required) | Indicates if the document is verified |
| file | File (required) | File associated with the document see File |
| File - Object | ||
|---|---|---|
| Field | Type | Description |
| url | String | File URL |
| base64 | String | Base64 string of the file |
| IdentityVerification - Object | ||
|---|---|---|
| Field | Type | Description |
| id | String | Biometrics ID |
| Bank - Object | ||
|---|---|---|
| Field | Type | Description |
| type | String | Bank identification type. Possible values:
|
| identification | String | Bank identification |
| Address - Object | ||
|---|---|---|
| Field | Type | Description |
| type | String | Address type. Possible values:
|
| street | String | Street |
| number | String | Number |
| floor | String | Floor |
| apartment | String | Apartment |
| block | String | Block |
| sector | String | Sector |
| tower | String | Tower |
| zipCode | String | Zip code |
| country | String | Country - two-letter country ISO code - See appendix |
| state | String | Province/State - two-letter province code - See appendix |
| locality | String | Locality |
| Field | Type | Description |
|---|---|---|
| account | String | Brokerage account number |
| status | String | Account status See appendix |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
| REQUIRED_FIELD_WITH_NULL_VALUE | Required field. |
| THIRD_PARTY_ID_ALREADY_USE_FOR_ANOTHER_TAX_IDENTIFICATION | Third party already used for another CUIT. |
| INVALID_TAX_INFORMATION_NUMBER | Invalid CUIT or problems with AFIP. |
| HIT_ON_BLACK_LIST_15 | Hit against blacklist number 15. |
| HIT_ON_BLACK_LIST_37 | Hit against blacklist number 37. |
| HIT_ON_BLACK_LIST_41 | Hit against blacklist number 41. |
| INVALID_NAME | Invalid person name. |
| INVALID_LAST_NAME | Invalid person last name. |
| INVALID_COUNTRY_TYPE | Invalid country. |
| INVALID_IDENTIFICATION_TYPE | Invalid tax identification type. |
| INVALID_IDENTIFICATION | Invalid tax identification. |
| INVALID_MARIAL_STATE_TYPE | Invalid marital state. |
| PERSON_IS_NOT_LEGAL_AGE | Not of legal age. |
| INVALID_DATE_FORMAT | Invalid date format. |
| INVALID_GENDER_TYPE | Invalid gender. |
| IMPOSSIBLE_CREATE_ACCOUNT_IVSA_RESTRICTION | Cannot create user due to IVSA restriction. |
| INVALID_IVA_CONDITION_TYPE | Invalid IVA condition. |
| INVALID_ADDRESS_TYPE | Invalid address type. |
| INVALID_EMAIL | Invalid email. |
| INVALID_PHONE_NUMBER | Invalid phone number. |
| INVALID_AREA_CODE_PHONE | Invalid phone area code. |
| INVALID_STATE_TYPE | Invalid province. |
| INVALID_IDENTIFICATION_TYPE | Invalid document identification type. |
| INVALID_URL | Invalid document download URL. |
| INVALID_BANKS_TYPE | Invalid account identifier type. |
| INVALID_EMAIL | Invalid email. |
| INVALID_EMAIL | Invalid email. |
| INVALID_EMAIL | Invalid email. |
| INVALID_EMAIL | Invalid email. |
| INVALID_EMAIL | Invalid email. |
Account creation for multiple owners ¶
Headers
Content-Type: application/json
organization: <organization>
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"thirdPartyId": "XU231A",
"account": "3123312312321",
"persons": [
{
"person": {
"naturalPerson": true,
"name": "Romina Paola",
"lastname": "Pizzo",
"nationality": "AR",
"residenceCountry": "AR",
"identificationType": "DNI",
"identification": "28334194",
"identificationCountry": "AR",
"maritalState": "SINGLE",
"birthDate": "1978-03-04",
"birthPlace": "AR",
"gender": "F",
"taxInformation": {
"type": "CUIT",
"number": "27283341947",
"businessActivity": "11341",
"pep": {
"isPep": true,
"description": "Diputado Nacional"
},
"incomeInscription": {
"type": "EXE",
"date": "1998-10-04"
},
"ivaCondition": "RI",
"countryTaxResidence": "AR",
"fatca": {
"isFatca": true,
"ssn": "1491949991"
},
"ocde": {
"isOcde": true,
"countryTaxResidencePrincipal": "UY",
"nitPrincipal": "12355550",
"countryTaxResidenceOptional": "BR",
"nitOptional": "12355554"
},
"subjectsBound": {
"isSubjectsBound": true,
"createdDate": "1998-10-04"
}
}
},
"address": {
"type": "LEGAL",
"street": "Helguera",
"number": "2177",
"floor": "3",
"apartment": "A",
"block": "1",
"sector": "A",
"tower": "1",
"zipCode": "1752",
"country": "AR",
"state": "AR",
"locality": "CABA"
},
"contact": {
"email": "ejemplo@mail.com",
"phone": "12341234",
"areaCode": "011"
},
"documents": [
{
"type": "FRONT_DNI",
"description": "Front DNI",
"filename": "frente.png",
"extension": ".png",
"verified": true,
"file": {
"url": "http://contentcdn.com/imagenes/12345.png"
}
}
],
"identityVerification": {
"id": "21223213213"
}
}
],
"banks": {
"identification": "0000347730000000049606",
"type": "CVU"
}
}Headers
Content-Type: application/jsonBody
{
"account": "234234"
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Headers
Content-Type: application/json
organization: <organization>
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"thirdPartyId": "XU231A",
"person": {
"naturalPerson": true,
"name": "Romina Paola",
"lastname": "Pizzo",
"nationality": "AR",
"residenceCountry": "AR",
"identificationType": "DNI",
"identification": "28334194",
"identificationCountry": "AR",
"maritalState": "SINGLE",
"birthDate": "1978-03-04",
"birthPlace": "AR",
"gender": "F",
"taxInformation": {
"type": "CUIT",
"number": "27283341947",
"businessActivity": "11341",
"pep": {
"isPep": true,
"description": "Diputado Nacional"
},
"incomeInscription": {
"type": "EXE",
"date": "1998-10-04"
},
"ivaCondition": "RI",
"countryTaxResidence": "AR",
"fatca": {
"isFatca": true,
"ssn": "1491949991"
},
"ocde": {
"isOcde": true,
"countryTaxResidencePrincipal": "UY",
"nitPrincipal": "12355550",
"countryTaxResidenceOptional": "BR",
"nitOptional": "12355554"
},
"subjectsBound": {
"isSubjectsBound": true,
"createdDate": "1998-10-04"
}
}
},
"address": {
"type": "LEGAL",
"street": "Helguera",
"number": "2177",
"floor": "3",
"apartment": "A",
"block": "1",
"sector": "A",
"tower": "1",
"zipCode": "1752",
"country": "AR",
"state": "AR",
"locality": "CABA"
},
"contact": {
"email": "ejemplo@mail.com",
"phone": "12341234",
"areaCode": "011"
},
"documents": [
{
"type": "FRONT_DNI",
"description": "Front DNI",
"filename": "frente.png",
"extension": ".png",
"verified": true,
"file": {
"base64": "WEREWREWREWREWREREWRWE...."
}
}
],
"identityVerification": {
"id": "21223213213"
},
"banks": {
"identification": "0000347730000000049606",
"type": "CVU"
}
}Headers
Content-Type: application/jsonBody
{
"account": "234234"
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Account creation for multiple ownersPOST/profile/v1/account/multi/owners
Service for creating a new account when an account has more than one owner.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token" |
| organization | String | Acronym of the organization invoking the service |
| Field | Type | Description |
|---|---|---|
| thirdPartyId | String (require) | External ID |
| account | String | External account |
| persons | Array [PersonItem] | List of persons see PersonItem |
| banks | Object [Bank] | Bank see Bank |
| PersonItem - Object | ||
|---|---|---|
| Field | Type | Description |
| person | Object [Person] | Person data see Person |
| address | Object [Address] | Address see Address |
| contact | Object [Contact] | Contact see Contact |
| documents | Object [Document] | Document see Document |
| identityVerification | Object [IdentityVerification] | IdentityVerification see IdentityVerification |
| Person - Object | ||
|---|---|---|
| Field | Type | Description |
| naturalPerson | Boolean (require) | Indicates if it is a natural person, with possible values true or false |
| name | String (require) | Name |
| lastname | String (require) | Last name |
| nationality | String (require) | Nationality - two-letter country ISO code - See appendix |
| residenceCountry | String (require) | Residence country - two-letter country ISO code - See appendix |
| identificationType | String (require) | Identity document type. Possible values: DNI |
| identification | String (require) | Identity document number |
| identificationCountry | String (require) | Issuing country of the identity document - two-letter country ISO code - See appendix |
| maritalState | String (require) | Marital state. Possible values:
|
| birthDate | String (require) | Birth date |
| birthPlace | String (require) | Birth place (Country) - two-letter country ISO code - See appendix |
| gender | String (require) | Gender. Possible values
|
| taxInformation | Object [TaxInformation] | Tax information see TaxInformation |
| TaxInformation - Object | ||
|---|---|---|
| Field | Type | Description |
| type | String (require) | Identity document type. Possible values:
|
| number | String (require) | Identity document number |
| businessActivity | String | AFIP commercial activity code see list of AFIP codes |
| pep | Object [Pep] | Politically Exposed Person Information see Pep |
| incomeInscription | Object [IncomeInscription] | Income tax status see IncomeInscription |
| ivaCondition | String (require) | IVA status see Codes |
| countryTaxResidence | String | Tax residence country - two-letter country ISO code - See appendix |
| fatca | Object [Facta] | FATCA see Facta |
| ocde | Object [Ocde] | OECD see Ocde |
| subjectsBound | Object [SubjectsBound] | Subject Bound see SubjectsBound |
| Pep - Object | ||
|---|---|---|
| Field | Type | Description |
| isPep | Boolean (require) | Indicates if the person is a Politically Exposed Person |
| description | String (require) | Politically Exposed Person description |
| IncomeInscription - Object | ||
|---|---|---|
| Field | Type | Description |
| type | String (require) | Income tax status type see Codes |
| date | String (require) | Date since being an income tax payer |
| Fatca - Object | ||
|---|---|---|
| Field | Type | Description |
| isFatca | Boolean (require) | Indicates if the person is covered by FATCA |
| ssn | String (require) | FATCA number |
| Ocde - Object | ||
|---|---|---|
| Field | Type | Description |
| isOcde | Boolean (require) | Indicates if the person is covered by OECD |
| countryTaxResidencePrincipal | String | Primary tax residence country | Send two-letter country ISO code (See country code appendix) |
| nitPrincipal | String | TIN of the primary residence country |
| countryTaxResidenceOptional | String | Optional tax residence country | Send two-letter country ISO code (See country code appendix) |
| nitOptional | String | TIN of the optional residence country |
| SubjectsBound - Object | ||
|---|---|---|
| Field | Type | Description |
| isSubjectsBound | Boolean (require) | Indicates if the person is a subject bound |
| type | String | Subject Bound type |
| createdDate | String | Date since being a Subject Bound |
| Contact - Object | ||
|---|---|---|
| Field | Type | Description |
| areaCode | String | Area code of the primary member's phone |
| String | Email of the primary member | |
| phone | String | Phone of the primary member |
| Document - Object | ||
|---|---|---|
| Field | Type | Description |
| type | String |
|
| description | String (required) | Document description |
| filename | String (required) | Filename |
| extension | String (required) | File extension |
| verified | Boolean (required) | Indicates if the document is verified |
| file | File (required) | File associated with the document see File |
| File - Object | ||
|---|---|---|
| Field | Type | Description |
| url | String | File URL |
| base64 | String | Base64 string of the file |
| IdentityVerification - Object | ||
|---|---|---|
| Field | Type | Description |
| id | String | Biometrics ID |
| Bank - Object | ||
|---|---|---|
| Field | Type | Description |
| type | String | Bank identification type. Possible values:
|
| identification | String | Bank identification |
| Address - Object | ||
|---|---|---|
| Field | Type | Description |
| type | String | Address type. Possible values:
|
| street | String | Street |
| number | String | Number |
| floor | String | Floor |
| apartment | String | Apartment |
| block | String | Block |
| sector | String | Sector |
| tower | String | Tower |
| zipCode | String | Zip code |
| country | String | Country - two-letter country ISO code - See appendix |
| state | String | Province/State - two-letter province code - See appendix |
| locality | String | Locality |
| Field | Type | Description |
|---|---|---|
| account | String | Brokerage account number |
| status | String | Account status See appendix |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
| REQUIRED_FIELD_WITH_NULL_VALUE | Required field. |
| THIRD_PARTY_ID_ALREADY_USE_FOR_ANOTHER_TAX_IDENTIFICATION | Third party already used for another CUIT. |
| INVALID_TAX_INFORMATION_NUMBER | Invalid CUIT or problems with AFIP. |
| HIT_ON_BLACK_LIST_15 | Hit against blacklist number 15. |
| HIT_ON_BLACK_LIST_37 | Hit against blacklist number 37. |
| HIT_ON_BLACK_LIST_41 | Hit against blacklist number 41. |
| INVALID_NAME | Invalid person name. |
| INVALID_LAST_NAME | Invalid person last name. |
| INVALID_COUNTRY_TYPE | Invalid country. |
| INVALID_IDENTIFICATION_TYPE | Invalid tax identification type. |
| INVALID_IDENTIFICATION | Invalid tax identification. |
| INVALID_MARIAL_STATE_TYPE | Invalid marital state. |
| PERSON_IS_NOT_LEGAL_AGE | Not of legal age. |
| INVALID_DATE_FORMAT | Invalid date format. |
| INVALID_GENDER_TYPE | Invalid gender. |
| IMPOSSIBLE_CREATE_ACCOUNT_IVSA_RESTRICTION | Cannot create user due to IVSA restriction. |
| INVALID_IVA_CONDITION_TYPE | Invalid IVA condition. |
| INVALID_ADDRESS_TYPE | Invalid address type. |
| INVALID_EMAIL | Invalid email. |
| INVALID_PHONE_NUMBER | Invalid phone number. |
| INVALID_AREA_CODE_PHONE | Invalid phone area code. |
| INVALID_STATE_TYPE | Invalid province. |
| INVALID_IDENTIFICATION_TYPE | Invalid document identification type. |
| INVALID_URL | Invalid document download URL. |
| INVALID_BANKS_TYPE | Invalid account identifier type. |
| INVALID_EMAIL | Invalid email. |
| INVALID_EMAIL | Invalid email. |
| INVALID_EMAIL | Invalid email. |
| INVALID_EMAIL | Invalid email. |
| INVALID_EMAIL | Invalid email. |
Account detail query ¶
Headers
Content-Type: application/json
organization: <organization>
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20AHeaders
Content-Type: application/jsonBody
{
"identification": "31252804",
"taxIdentification": "20312528046",
"name": "Mariano",
"lastname": "Martino",
"bankIdentificationCvu": "0000590940090418135232",
"privateAccount": "10810",
"publicAccount": "10810",
"bindBankAccountIdentification": "3220001889007355170018",
"bindBankAccountLabel": "este.es.mialias",
"bindBankAccountLabelState": "INFORMED"
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Query accountGET/profile/v1/customer
The details of an account are queried
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token" |
| organization | String | Acronym of the organization invoking the service |
| account | String | Brokerage account number invoking the service. |
It is necessary to send the account number in the URL
| Field | Type | Description |
|---|---|---|
| account | String | Brokerage account number |
| Field | Type | Description |
|---|---|---|
| identification | String | DNI |
| taxIdentification | String | CUIT |
| name | String | Name |
| lastname | String | Last name |
| bankIdentificationCvu | String | CVU |
| privateAccount | String | Brokerage account number |
| publicAccount | String | Brokerage account number |
| bindBankAccountIdentification | String | CBU created in Bind |
| bindBankAccountLabel | String | Alias of the CBU created in Bind |
| bindBankAccountLabelState | String | Determines if the CBU is reported on the networks or not Possible values:
|
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
| INVALID_CUSTOMER_SEARCH | The account number does not exist. |
| INVALID_BANKS_SEARCH | The account has no linked banks. |
Query account enabled to operate ¶
Headers
organization: <organization>
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20AHeaders
Content-Type: application/jsonBody
{
"enabled": true
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Headers
organization: <organization>
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20AHeaders
Content-Type: application/jsonBody
{
"enabled": false,
"detail": [
"OP_COMEX_EXCH"
]
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Query account enabled to operateGET/account-validator/v1/account/enabled
Check if an account is available to operate.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token" |
| organization | String | Acronym of the organization invoking the service |
| account | String | Brokerage account number invoking the service. |
| Field | Type | Description |
|---|---|---|
| enabled | Boolean | Determines whether the account is enabled or not |
| detail | Array | Array [String] Only displayed if the enabled field is 'false' see list |
| List of possible causes | |
|---|---|
| Code | Description |
| OP_LOAN_6937 | Loans |
| OP_LOAN_6937_7006 | Loans |
| OP_COMEX_EXCH | COMEX and FX operations |
| OP_LOAN_POSTDATA | Loans with post-dated installments |
| OP_CEDEARS | Purchased CEDEAR in the last 90 days |
| OP_TRANSF_TIT_EXT | Clients with securities transfers abroad in the last 90 days |
| OP_GUARANTEE | The client has active borrower collateral (cauciones) |
| OP_CREDITCARD_0_GRANTED | Clients with Loans GRANTED at 0% Rate with Credit Card |
| OP_CREDITCARD_REFINAN | The client has active credit card refinancings |
| OP_CREDITCARD_0_AUTH | 0% Rate Loan Authorized |
| BLACKLIST_HIT | Blacklist hit |
| ANTI_MONEY_LANDRYING | Possible money laundering |
| NO_REQUIRED_DOCUMENTATION_PRESENT | AML Block |
| HIT_BLACK_LIST | Confirmed blacklist hit |
| OWNERSHIT_CHANGED | Ownership change |
| BLOQUEO_BASE_DE_CLIENTES | BC Block |
| BIND_DECISION_PLD | AML By unilateral BIND decision |
| BLOQUEO_BC_PEP | BC PEP Block |
| BLOQUEO_BC_FATCA | BC FATCA Block |
| BLOQUEO_BC_SO | BC SO Block |
| BLOQUEO_BC_VTO_OPERADOR | BC Operator Block |
| BLOQUEO_BC_VTO_SOCIEDAD | BC Company Exp Block |
| BLOQUEO_DDR_AUT | DDR Automatic Block |
| BLOQUEO_DDR_MAN | DDR Manual Block |
| BIND_DECISION_BC | C By unilateral BIND decision |
| BLOQUEO_AUT | DDC Automatic Block |
| BLOQUEO_MAN | DDC Manual Block |
| BIND_DECISION_DDC | DDC By unilateral BIND decision |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
Market Data ¶
BYMA Market Information ¶
Headers
organization: <organization>
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"name": "Bolsas y Mercados Argentinos",
"schedules": {
"T0": {
"openTime": "11:00:00",
"closeTime": "16:20:00",
"open": false
},
"T1": {
"openTime": "11:00:00",
"closeTime": "16:20:00",
"open": false
},
"T2": {
"openTime": "11:00:00",
"closeTime": "16:20:00",
"open": false
}
},
"timeZone": "America/Argentina/Buenos_Aires",
"locale": "es-AR",
"nextOperationDate": "2024-08-06"
}Body
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Headers
organization: <organization>
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"name": "Bolsas y Mercados Argentinos",
"schedules": {
"T0": {
"openTime": "11:00:00",
"closeTime": "16:20:00",
"open": true
},
"T1": {
"openTime": "11:00:00",
"closeTime": "16:20:00",
"open": true
},
"T2": {
"openTime": "11:00:00",
"closeTime": "16:20:00",
"open": true
}
},
"timeZone": "America/Argentina/Buenos_Aires",
"locale": "es-AR",
"nextOperationDate": "2024-08-06"
}Body
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}BYMA Market InformationGET/marketdata/v1/market/code/BYMA
This service provides BYMA market information.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| Field | Type | Description |
|---|---|---|
| name | String | Description |
| schedules | Array | Array [Term] see Term |
| timeZone | String | Time Zone |
| locale | String | Locale |
| nextOperationDate | String | Next operation day |
| Term - Object | ||
|---|---|---|
| Field | Type | Description |
| T0 / T1 / T2 | Array | Array [Schedule] see Schedule |
| Schedule - Object | ||
|---|---|---|
| Field | Type | Description |
| openTime | String | Opening time |
| closeTime | String | Closing time |
| open | Boolean | Flag that determines whether the market is open or closed at the time of the query. |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
| MARKET_NOT_FOUND | Invalid market. |
FX Market Information ¶
Headers
organization: <organization>
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"name": "Bolsas y Mercados Argentinos",
"schedules": {
"T0": {
"openTime": "11:00:00",
"closeTime": "16:20:00",
"open": false
},
"T1": {
"openTime": "11:00:00",
"closeTime": "16:20:00",
"open": false
},
"T2": {
"openTime": "11:00:00",
"closeTime": "16:20:00",
"open": false
}
},
"timeZone": "America/Argentina/Buenos_Aires",
"locale": "es-AR",
"nextOperationDate": "2024-08-06"
}Body
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Headers
organization: <organization>
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"name": "Bolsas y Mercados Argentinos",
"schedules": {
"T0": {
"openTime": "11:00:00",
"closeTime": "16:20:00",
"open": true
},
"T1": {
"openTime": "11:00:00",
"closeTime": "16:20:00",
"open": true
},
"T2": {
"openTime": "11:00:00",
"closeTime": "16:20:00",
"open": true
}
},
"timeZone": "America/Argentina/Buenos_Aires",
"locale": "es-AR",
"nextOperationDate": "2024-08-06"
}Body
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}FX Market InformationGET/marketdata/v1/market/code/FX
This service provides FX market information.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| Field | Type | Description |
|---|---|---|
| name | String | Description |
| schedules | Array | Array [Term] see Term |
| timeZone | String | Time Zone |
| locale | String | Locale |
| nextOperationDate | String | Next operation day |
| Term - Object | ||
|---|---|---|
| Field | Type | Description |
| T0 / T1 / T2 | Array | Array [Schedule] see Schedule |
| Schedule - Object | ||
|---|---|---|
| Field | Type | Description |
| openTime | String | Opening time |
| closeTime | String | Closing time |
| open | Boolean | Flag that determines whether the market is open or closed at the time of the query. |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
| MARKET_NOT_FOUND | Invalid market. |
Headers
organization: <organization>
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
[
{
"code": "PELLE.2345",
"name": "PELLEGRINI FONDO 2345",
"market": "PELLE",
"settlementTerm": "T0",
"data": {
"DAY_PERCENTAGE_CHANGE": 1.010363,
"CLAZZ": "B",
"CURRENCY": "USD",
"NOW_PRICE": 0.989744,
"DAY_PRICE_CHANGE": 1.00000071707,
"YIELD": 23,
"UPDATE_TIME": "2021-04-28T20:16:42.305+00:00"
}
}
]Body
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Search Mutual Funds (FCI)GET/marketdata/v1/market/code/FX
This service provides information about FUND-type market instruments.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| Field | Type | Description |
|---|---|---|
| code | String | Fund code. |
| Field | Type | Description |
|---|---|---|
| market | String | Market |
| name | String | Name |
| settlementTerm | String | Term see values |
| data | Array [Data] | Information see Data |
| Data - Object | ||
|---|---|---|
| Field | Type | Description |
| CURRENCY | String | Currency |
| CLAZZ | String | Fund class |
| NOW_PRICE | number | Current price |
| DAY_PERCENTAGE_CHANGE | number | Daily percentage variation |
| DAY_PRICE_CHANGE | number | Daily variation |
| YIELD | number | Yield |
| UPDATE_TIME | date | Last update |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
Dollar 1 Click ¶
Dollar MEP Quote ¶
Headers
Content-Type: application/json
organization: <organization>
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20AHeaders
Content-Type: application/jsonBody
{
"buyPrice": 1481.82,
"sellPrice": 1274.23,
"timestamp": "2024-08-06T08:09:02Z"
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Dollar MEP QuoteGET/marketdata/v1/price/usdmep
This service provides the Dollar MEP quote.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| Field | Type | Description |
|---|---|---|
| buyPrice | Number | Buy Price |
| sellPrice | Number | Sell Price |
| timestamp | String | Quote timestamp |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
Get Buy Expenses ¶
Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"amount": 200700
}Headers
Content-Type: application/jsonBody
{
"amount": 200700,
"gross": 198208,
"net": 200224.72,
"totalExpenses": 2016.72,
"endOperationDate": "2024-08-07T12:00:00Z",
"startOperationDate": "2024-08-06T12:00:00Z",
"marketIsOpen": false,
"totalExpensesCurrency": "ARS",
"price": 1481.82,
"taxes": [
{
"name": "IDC",
"subtype": "M",
"aliquotApplied": 0.05,
"amount": 100,
"currency": "ARS",
"registerDate": "2025-12-01"
}
]
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Get Buy ExpensesPOST/investment-operation-flow/v1/exchange/usdmep/preview/BUY
This service allows getting the expenses for a Dollar MEP purchase.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| account | String | Brokerage account number invoking the service. |
| Field | Type | Description |
|---|---|---|
| amount | Number | Amount in Argentine pesos. |
| Field | Type | Description |
|---|---|---|
| amount | Number | Amount |
| gross | Number | Gross amount |
| net | Number | Net amount |
| totalExpenses | Number | Total operation expenses |
| endOperationDate | String | Date when the operation is completed at the time of the query |
| startOperationDate | String | Date when the operation starts at the time of the query |
| marketIsOpen | Boolean | Determines if the market is open or closed at the time of the query |
| totalExpensesCurrency | String | Currency of the returned expenses |
| price | Number | Approximate operation price |
| taxes | Array | Array [Tax] see Tax |
| Tax | ||
|---|---|---|
| Field | Type | Description |
| name | String | Description |
| subtype | String | Subtype |
| aliquotApplied | Number | Applied aliquot |
| amount | Number | Amount |
| currency | String | Currency |
| registerDate | String | Registry date Format: yyyy-mm-dd |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
| VALUE_MUST_BE_POSITIVE | The amount must be positive. |
Place Buy Order ¶
Headers
Content-Type: application/json
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"thirdPartyId": "joel-test-uat-20240628-0010",
"amount": 600000,
"price": "1330.66",
"disclaimer": {
"accepted": true,
"timestamp": "32321321312"
}
}Headers
Content-Type: application/jsonBody
{
"operationId": "412412411"
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Place Buy OrderPOST/investment-operation-flow/v1/exchange/usdmep/BUY
This service allows placing a Dollar MEP buy order.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| account | String | Brokerage account number invoking the service. |
| location | String | URL to send the webhook. |
| Field | Type | Description |
|---|---|---|
| thirdPartyId | Number | Unique external ID. |
| amount | Number | Amount to invest. |
| price | String | Reference price. |
| disclaimer | Object | Object [Disclaimer] see Disclaimer |
| Disclaimer - Object | ||
|---|---|---|
| Field | Type | Description |
| accepted | Boolean | Acceptance of the DDJJ (Affidavits) |
| timestamp | String | Timestamp of the DDJJ acceptance |
| Field | Type | Description |
|---|---|---|
| operationId | String | Operation ID. |
| endOperationDate | String | Operation end date. |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
| DISCLAIMER_NOT_ACCEPTED | The DDJJ cannot be rejected. |
| VALUE_MUST_BE_POSITIVE | The value must be positive. |
| ACCOUNT_DISABLED_TO_OPERATE | Inactive account. |
| CLOSED_MARKET | The market is closed. |
| CLOSED_OPERATION | Operation closed. |
| MONTHLY_SUM_EXCEEDED | The monthly maximum allowed for operations was exceeded. |
| INVALID_MIN_USD | Minimum amount of dollars to buy not allowed. |
| OUTDATED_REFERENCE_PRICE | Outdated prices between what meli sends and what the market returns at the time of receiving the request. |
Information defined and provided by the third-party team.
{
"id":"00014fuk9x",
"external_id":"1270022436872830976",
"status":"APPROVED",
"amount":599605.16,
"taxes": [
{
"name": "IDC",
"subtype": "M",
"aliquotApplied": 0.05,
"amount": 100,
"currency":"ARS",
"registerDate": "2025-12-01"
}
]
}
| Field | Type | Description |
|---|---|---|
| id | String | Unique ID. |
| external_id | String | External ID. |
| status | String | Status. |
| amount | Number | Amount. |
| taxes | Array | Array [Tax] see Tax |
| Tax | ||
|---|---|---|
| Field | Type | Description |
| name | String | Description |
| subtype | String | Subtype |
| aliquotApplied | Number | Applied aliquot |
| amount | Number | Amount |
| currency | String | Currency |
| registerDate | String | Registry date Format: yyyy-mm-dd |
Information defined and provided by the third-party team.
{
"id":"00014j8x7a",
"external_id":"1270384740564017152",
"status":"EXCHANGED",
"amount":2.3500000000,
"exchange_amount":3119.66,
"taxes": [
{
"name": "IDC",
"subtype": "M",
"aliquotApplied": 0.05,
"amount": 100,
"currency":"ARS",
"registerDate": "2025-12-01"
}
]
}
| Field | Type | Description |
|---|---|---|
| id | String | Unique ID. |
| external_id | String | External ID. |
| status | String | Status. |
| amount | Number | Amount. |
| exchange_amount | Number | Converted amount. |
| taxes | Array | Array [Tax] see Tax |
| Tax | ||
|---|---|---|
| Field | Type | Description |
| name | String | Description |
| subtype | String | Subtype |
| aliquotApplied | Number | Applied aliquot |
| amount | Number | Amount |
| currency | String | Currency |
| registerDate | String | Registry date Format: yyyy-mm-dd |
Information defined and provided by the third-party team.
{
"id":"00014j8x7a",
"external_id":"1270384740564017152",
"status":"EXCHANGED",
"amount":2.3500000000,
"exchange_amount":3119.66,
"taxes": [
{
"name": "IDC",
"subtype": "M",
"aliquotApplied": 0.05,
"amount": 100,
"currency":"ARS",
"registerDate": "2025-12-01"
}
]
}
| Field | Type | Description |
|---|---|---|
| id | String | Unique ID. |
| external_id | String | External ID. |
| status | String | Status. |
| amount | Number | Amount. |
| exchange_amount | Number | Converted amount. |
| taxes | Array | Array [Tax] see Tax |
| Tax | ||
|---|---|---|
| Field | Type | Description |
| name | String | Description |
| subtype | String | Subtype |
| aliquotApplied | Number | Applied aliquot |
| amount | Number | Amount |
| currency | String | Currency |
| registerDate | String | Registry date Format: yyyy-mm-dd |
Get Sell Expenses ¶
Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"amount": 15
}Headers
Content-Type: application/jsonBody
{
"amount": 15,
"gross": 14.7,
"net": 14.85,
"totalExpenses": 191.13,
"endOperationDate": "2024-08-06T12:00:00Z",
"startOperationDate": "2024-08-06T12:00:00Z",
"marketIsOpen": false,
"totalExpensesCurrency": "USD",
"price": 1274.23,
"taxes": [
{
"name": "IDC",
"subtype": "M",
"aliquotApplied": 0.05,
"amount": 100,
"currency": "ARS",
"registerDate": "2025-12-01"
}
]
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Get Sell ExpensesPOST/investment-operation-flow/v1/exchange/usdmep/preview/SELL
This service allows getting the expenses for a Dollar MEP sale.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| account | String | Brokerage account number invoking the service. |
| Field | Type | Description |
|---|---|---|
| amount | Number | Amount in Argentine pesos. |
| Field | Type | Description |
|---|---|---|
| amount | Number | Amount |
| gross | Number | Gross amount |
| net | Number | Net amount |
| totalExpenses | Number | Total operation expenses |
| endOperationDate | String | Date when the operation is completed at the time of the query |
| startOperationDate | String | Date when the operation starts at the time of the query |
| marketIsOpen | Boolean | Determines if the market is open or closed at the time of the query |
| totalExpensesCurrency | String | Currency of the returned expenses |
| price | Number | Approximate operation price |
| taxes | Array | Array [Tax] see Tax |
| Tax | ||
|---|---|---|
| Field | Type | Description |
| name | String | Description |
| subtype | String | Subtype |
| aliquotApplied | Number | Applied aliquot |
| amount | Number | Amount |
| currency | String | Currency |
| registerDate | String | Registry date Format: yyyy-mm-dd |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
| VALUE_MUST_BE_POSITIVE | The amount must be positive. |
Place Sell Order ¶
Headers
Content-Type: application/json
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"thirdPartyId": "joel-test-uat-20240628-0010",
"amount": 240,
"price": "1330.66",
"disclaimer": {
"accepted": true,
"timestamp": "32321321312"
}
}Headers
Content-Type: application/jsonBody
{
"operationId": "412412411"
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Place Sell OrderPOST/investment-operation-flow/v1/exchange/usdmep/SELL
This service allows placing a Dollar MEP sell order.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| account | String | Brokerage account number invoking the service. |
| location | String | URL to send the webhook. |
| Field | Type | Description |
|---|---|---|
| thirdPartyId | Number | Unique external ID. |
| amount | Number | Amount to invest. |
| price | String | Reference price. |
| disclaimer | Object | Object [Disclaimer] see Disclaimer |
| Disclaimer - Object | ||
|---|---|---|
| Field | Type | Description |
| accepted | Boolean | Acceptance of the DDJJ (Affidavits) |
| timestamp | String | Timestamp of the DDJJ acceptance |
| Field | Type | Description |
|---|---|---|
| operationId | String | Operation ID. |
| endOperationDate | String | Operation end date. |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
| DISCLAIMER_NOT_ACCEPTED | The DDJJ cannot be rejected. |
| VALUE_MUST_BE_POSITIVE | The value must be positive. |
| ACCOUNT_DISABLED_TO_OPERATE | Inactive account. |
| CLOSED_MARKET | The market is closed. |
| CLOSED_OPERATION | Operation closed. |
| NOT_MONEY_AVAILABLE | Insufficient balance. |
Get Operation ¶
Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"thirdPartyId": "0000tbx5oa",
"amount": 1100000,
"account": "1680043",
"state": "EXCHANGED",
"result": {
"totalInvested": 1099048.91,
"totalObtained": 979.24
},
"id": "27293924800256",
"operation": "BUY",
"startDate": "2024-05-20T18:58:21",
"endDate": "2024-05-21T19:10:27",
"relatedOperations": [
{
"instrument": "BYMA.AL30",
"term": "T0",
"state": "FILLED",
"amount": 1088396.1,
"quantity": 1683,
"cumQuantity": 1683,
"leavesQuantity": 0,
"expenses": {
"byMarket": 108.81,
"byOperation": 10880.6,
"total": 10989.41
},
"finalAmount": 1088059.5,
"finalQuantity": 1683,
"date": "2024-05-20T18:58:38",
"currency": "ARS",
"operation": "BUY"
},
{
"instrument": "BYMA.AL30D",
"term": "T0",
"state": "FILLED",
"quantity": 1683,
"cumQuantity": 1683,
"leavesQuantity": 0,
"expenses": {
"byMarket": 0.1,
"byOperation": 0,
"total": 0.1
},
"finalAmount": 979.34,
"finalQuantity": 1683,
"date": "2024-05-21T14:38:49",
"currency": "USD",
"operation": "SELL"
}
],
"taxes": [
{
"name": "IDC",
"subtype": "M",
"aliquotApplied": 0.05,
"amount": 100,
"currency": "ARS",
"registerDate": "2025-12-01"
}
]
}Body
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"thirdPartyId": "0000tbx5oa",
"amount": 1100000,
"account": "1680043",
"state": "ERROR",
"result": {
"totalInvested": 0,
"totalObtained": 0
},
"id": "27293924800256",
"operation": "BUY",
"startDate": "2024-05-20T18:58:21",
"endDate": "2024-05-21T19:10:27",
"relatedOperations": []
}Body
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Get OperationGET/investment-operation-flow/v1/exchange
With this service, you can obtain the status and details of an operation.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| account | String | Brokerage account number invoking the service. |
| Field | Type | Description |
|---|---|---|
| thirdPartyId | String | External ID. |
| operationId | String | Operation ID. |
| Field | Type | Description |
|---|---|---|
| thirdPartyId | String | External ID. |
| amount | Number | Amount. |
| account | String | Brokerage account number. |
| state | String | State. Possible values:
|
| result | Object | Object [Result] see Result |
| operation | String | Operation type. Possible values:
|
| id | String | Operation ID |
| startDate | String | Operation start date |
| endDate | String | Operation end date. |
| instrumentDescription | String | Instrument description. |
| relatedOperations | Array | Array [RelatedOperations] see RelatedOperations |
| taxes | Array | Array [Tax] see Tax |
| Result - Object | ||
|---|---|---|
| Field | Type | Description |
| totalInvested | Number | Total invested amount |
| totalObtained | Number | Total obtained amount |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
| INVALID_OPERATION | Invalid operation. |
Query an affidavit for USDMEP ¶
Headers
Content-Type: application/jsonBody
{
"disclaimer": "According to BCRA Communication A 7552, I declare that in the last 90 calendar days I have not accessed the exchange market for the purchase of foreign currency (including swaps or arbitrations) nor am I subject to any legal or regulatory restriction to carry out the operation.",
"createdDate": "2023-11-16 11:43:43",
"key": "D1C_OPERATION"
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Query an affidavit for USDMEPGET/investment-operation-flow/v1/disclaimer/usdmep
With this service, the affidavit is obtained.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token" |
| organization | String | Acronym of the organization invoking the service |
| Disclaimer - Object | ||
|---|---|---|
| Field | Type | Description |
| disclaimer | String | Affidavit content |
| createdDate | String | Creation date |
| key | String | Unique Id |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
| DICLAIMER_NOT_AVAILABLE | Affidavit not available. |
-
Example Request (application/json)
-
Headers
organization: <organization> Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20A
-
Active Operation ¶
Headers
organization: <organization>
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20AHeaders
Content-Type: application/jsonBody
{
"enabled": true
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Headers
organization: <organization>
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20AHeaders
Content-Type: application/jsonBody
{
"enabled": false
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Active OperationGET/investment-operation-flow/v1/operation/enabled
This service provides information on whether the D1C product is active for use.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| Field | Type | Description |
|---|---|---|
| enabled | Boolean | Active |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
Dollar Combi ¶
Combi Dollar Quote ¶
Headers
Content-Type: application/jsonBody
{
"buyPrice": 1481.82,
"sellPrice": 1274.23,
"timestamp": "2024-08-06T08:09:02Z",
"hash": "xwY250QG1haWxpbmF0b3IuY29tIiwib3Mi",
"priceLimitTime": "2024-08-06T08:19:02Z",
"priceLimitTimeInSeconds": "600"
}Headers
Content-Type: application/json
organization: <organization>
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Headers
Content-Type: application/jsonBody
{
"buyPrice": 1481.82,
"sellPrice": 1274.23,
"timestamp": "2024-08-06T08:09:02Z",
"hash": "xwY250QG1haWxpbmF0b3IuY29tIiwib3Mi",
"priceLimitTime": "2024-08-06T08:19:02Z",
"priceLimitTimeInSeconds": "600"
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Combi Dollar QuoteGET/marketdata/v1/price/usdmep
This service provides the Combi Dollar quote.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| Field | Type | Description |
|---|---|---|
| buyPrice | Number | Buy Price |
| sellPrice | Number | Sell Price |
| timestamp | String | Quote timestamp |
| hash | String | Hash representing the price |
| priceLimitTime | String | Price limit time |
| priceLimitTimeInSeconds | String | Price lifetime in seconds |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
-
Example Request (application/json)
-
Headers
organization: <organization> Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20A
-
Get purchase expenses ¶
Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"amount": 200700,
"priceHash": "WxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1d"
}Headers
Content-Type: application/jsonBody
{
"amount": 200700,
"gross": 198208,
"net": 200224.72,
"totalExpenses": 2016.72,
"endOperationDate": "2024-08-07T12:00:00Z",
"startOperationDate": "2024-08-06T12:00:00Z",
"marketIsOpen": false,
"totalExpensesCurrency": "ARS",
"price": 1481.82
}Headers
Content-Type: application/json
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"amount": 200700,
"priceHash": "WxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1d"
}Headers
Content-Type: application/jsonBody
{
"amount": 200700,
"gross": 198208,
"net": 200224.72,
"totalExpenses": 2016.72,
"endOperationDate": "2024-08-07T12:00:00Z",
"startOperationDate": "2024-08-06T12:00:00Z",
"marketIsOpen": false,
"totalExpensesCurrency": "ARS",
"price": 1481.82
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Get purchase expensesPOST/investment-operation-flow/v1/exchange/usdmep/preview/BUY
This service allows getting the expenses of a Combi Dollar purchase.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| account | String | Investment account number invoking the service. |
| Field | Type | Description |
|---|---|---|
| amount | Number | Amount in Argentine pesos. |
| priceHash | String | Hash corresponding to the provided price. |
| Field | Type | Description |
|---|---|---|
| amount | Number | Amount |
| gross | Number | Net amount |
| net | Number | Gross amount |
| totalExpenses | Number | Total operation expenses |
| endOperationDate | String | Date the operation completes at the time of query |
| startOperationDate | String | Date the operation starts at the time of query |
| marketIsOpen | Boolean | Determines if the market is open or closed at the time of query |
| totalExpensesCurrency | String | Currency of the returned expenses |
| price | Number | Approximate operation price |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
| VALUE_MUST_BE_POSITIVE | The amount must be positive. |
| INVALID_PRICE_HASH | Invalid hash linked to the provided price. |
Enter Purchase ¶
Headers
Content-Type: application/jsonBody
{
"operationId": "412412411"
}Headers
Content-Type: application/json
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"thirdPartyId": "joel-test-uat-20240628-0010",
"amount": 600000,
"price": "1330.66",
"priceHash": "WxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1d",
"disclaimer": {
"accepted": true,
"timestamp": "32321321312"
}
}Headers
Content-Type: application/jsonBody
{
"operationId": "412412411"
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Enter PurchasePOST/investment-operation-flow/v1/exchange/usdmep/BUY
This service allows purchasing Combi Dollar.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| account | String | Investment account number invoking the service. |
| Field | Type | Description |
|---|---|---|
| thirdPartyId | Number | External unique ID. |
| amount | Number | Amount to invest. |
| price | String | Reference price. |
| priceHash | String | Hash corresponding to the provided price. |
| disclaimer | Object | Object [Disclaimer] see Disclaimer |
| Disclaimer - Object | ||
|---|---|---|
| Field | Type | Description |
| accepted | Boolean | Acceptance of the Affidavits |
| timestamp | String | Timestamp of the acceptance of the Affidavits |
| Field | Type | Description |
|---|---|---|
| operationId | String | Operation ID. |
| endOperationDate | String | Operation end date. |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
| DISCLAIMER_NOT_ACCEPTED | The Affidavits cannot be rejected. |
| VALUE_MUST_BE_POSITIVE | The value must be positive. |
| ACCOUNT_DISABLED_TO_OPERATE | Inactive account. |
| CLOSED_MARKET | The market is closed. |
| CLOSED_OPERATION | Closed operation. |
| MONTHLY_SUM_EXCEEDED | The maximum allowed to operate in the month was exceeded. |
| INVALID_MIN_USD | Minimum quantity of dollars to buy not allowed. |
| OUTDATED_REFERENCE_PRICE | Prices outdated between what meli sends and what the market returns at the time of receiving the request. |
| INVALID_PRICE_HASH | Invalid hash linked to the provided price. |
-
Example Request (application/json)
-
Headers
organization: <organization> account: 101357 Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20A -
Body
{ "thirdPartyId": "joel-test-uat-20240628-0010", "amount": 600000, "price": "1330.66", "priceHash": "WxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1d", "disclaimer": { "accepted": true, "timestamp": "32321321312" } }
-
Get sale expenses ¶
Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"amount": 15,
"priceHash": "WxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1d"
}Headers
Content-Type: application/jsonBody
{
"amount": 15,
"gross": 14.7,
"net": 14.85,
"totalExpenses": 191.13,
"endOperationDate": "2024-08-06T12:00:00Z",
"startOperationDate": "2024-08-06T12:00:00Z",
"marketIsOpen": false,
"totalExpensesCurrency": "USD",
"price": 1274.23
}Headers
Content-Type: application/json
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"amount": 15,
"priceHash": "WxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1d"
}Headers
Content-Type: application/jsonBody
{
"amount": 15,
"gross": 14.7,
"net": 14.85,
"totalExpenses": 191.13,
"endOperationDate": "2024-08-06T12:00:00Z",
"startOperationDate": "2024-08-06T12:00:00Z",
"marketIsOpen": false,
"totalExpensesCurrency": "USD",
"price": 1274.23
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Get sale expensesPOST/investment-operation-flow/v1/exchange/usdmep/preview/SELL
This service allows getting the expenses of a Combi Dollar sale.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| account | String | Investment account number invoking the service. |
| Field | Type | Description |
|---|---|---|
| amount | Number | Amount in Argentine pesos. |
| priceHash | String | Hash corresponding to the provided price. |
| Field | Type | Description |
|---|---|---|
| amount | Number | Amount |
| gross | Number | Net amount |
| net | Number | Gross amount |
| totalExpenses | Number | Total operation expenses |
| endOperationDate | String | Date the operation completes at the time of query |
| startOperationDate | String | Date the operation starts at the time of query |
| marketIsOpen | Boolean | Determines if the market is open or closed at the time of query |
| totalExpensesCurrency | String | Currency of the returned expenses |
| price | Number | Approximate operation price |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
| VALUE_MUST_BE_POSITIVE | The amount must be positive. |
| INVALID_PRICE_HASH | Invalid hash linked to the provided price. |
Enter Sale ¶
Headers
Content-Type: application/jsonBody
{
"operationId": "412412411"
}Headers
Content-Type: application/json
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"thirdPartyId": "joel-test-uat-20240628-0010",
"amount": 240,
"price": "1330.66",
"priceHash": "WxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1d",
"disclaimer": {
"accepted": true,
"timestamp": "32321321312"
}
}Headers
Content-Type: application/jsonBody
{
"operationId": "412412411"
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Enter SalePOST/investment-operation-flow/v1/exchange/usdmep/SELL
This service allows selling Combi Dollar.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| account | String | Investment account number invoking the service. |
| location | String | URL to send the webhook. |
| Field | Type | Description |
|---|---|---|
| thirdPartyId | Number | External unique ID. |
| amount | Number | Amount to invest. |
| price | String | Reference price. |
| priceHash | String | Hash corresponding to the provided price. |
| disclaimer | Object | Object [Disclaimer] see Disclaimer |
| Disclaimer - Object | ||
|---|---|---|
| Field | Type | Description |
| accepted | Boolean | Acceptance of the Affidavits |
| timestamp | String | Timestamp of the acceptance of the Affidavits |
| Field | Type | Description |
|---|---|---|
| operationId | String | Operation ID. |
| endOperationDate | String | Operation end date. |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
| DISCLAIMER_NOT_ACCEPTED | The Affidavits cannot be rejected. |
| VALUE_MUST_BE_POSITIVE | The value must be positive. |
| ACCOUNT_DISABLED_TO_OPERATE | Inactive account. |
| CLOSED_MARKET | The market is closed. |
| CLOSED_OPERATION | Closed operation. |
| NOT_MONEY_AVAILABLE | Insufficient balance. |
| INVALID_PRICE_HASH | Invalid hash linked to the provided price. |
-
Example Request (application/json)
-
Headers
organization: <organization> account: 101357 Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20A -
Body
{ "thirdPartyId": "joel-test-uat-20240628-0010", "amount": 240, "price": "1330.66", "priceHash": "WxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1d", "disclaimer": { "accepted": true, "timestamp": "32321321312" } }
-
Dollar FX ¶
FX Dollar Quote ¶
Headers
Content-Type: application/jsonBody
{
"buyPrice": 1481.82,
"sellPrice": 1274.23,
"timestamp": "2024-08-06T08:09:02Z",
"market": "MULC",
"hash": "xwY250QG1haWxpbmF0b3IuY29tIiwib3Mi",
"priceLimitTime": "2024-08-06T08:19:02Z",
"priceLimitTimeInSeconds": "600"
}Headers
Content-Type: application/json
organization: <organization>
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Headers
Content-Type: application/jsonBody
{
"buyPrice": 1481.82,
"sellPrice": 1274.23,
"timestamp": "2024-08-06T08:09:02Z",
"market": "MULC",
"hash": "xwY250QG1haWxpbmF0b3IuY29tIiwib3Mi",
"priceLimitTime": "2024-08-06T08:19:02Z",
"priceLimitTimeInSeconds": "600"
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}FX Dollar QuoteGET/marketdata/v1/price/fx
This service provides the FX Dollar quote
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| Field | Type | Description |
|---|---|---|
| buyPrice | Number | Buy Price |
| sellPrice | Number | Sell Price |
| timestamp | String | Quote timestamp |
| market | String | Market |
| hash | String | Hash representing the price |
| priceLimitTime | String | Price limit time |
| priceLimitTimeInSeconds | String | Price lifetime in seconds |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
-
Example Request (application/json)
-
Headers
organization: <organization> Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20A
-
Get purchase expenses ¶
Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"amount": 200700,
"priceHash": "WxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1d"
}Headers
Content-Type: application/jsonBody
{
"amount": 500000,
"gross": 1348,
"net": 1348,
"totalExpenses": 0,
"endOperationDate": "2025-05-05T12:00:00Z",
"startOperationDate": "2025-05-05T12:00:00Z",
"marketIsOpen": true,
"totalExpensesCurrency": "ARS",
"price": 370.95,
"effectivePrice": 370.5
}Headers
Content-Type: application/json
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"amount": 200700,
"priceHash": "WxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1d"
}Headers
Content-Type: application/jsonBody
{
"amount": 500000,
"gross": 1348,
"net": 1348,
"totalExpenses": 0,
"endOperationDate": "2025-05-05T12:00:00Z",
"startOperationDate": "2025-05-05T12:00:00Z",
"marketIsOpen": true,
"totalExpensesCurrency": "ARS",
"price": 370.95,
"effectivePrice": 370.5
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Get purchase expensesPOST/investment-operation-flow/v1/exchange/fx/preview/BUY
This service allows getting the expenses of an FX Dollar purchase.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| account | String | Investment account number invoking the service. |
| Field | Type | Description |
|---|---|---|
| amount | Number | Amount in Argentine pesos. |
| priceHash | String | Hash corresponding to the provided price. |
| Field | Type | Description |
|---|---|---|
| amount | Number | Amount |
| gross | Number | Net amount |
| net | Number | Gross amount |
| totalExpenses | Number | Total operation expenses |
| endOperationDate | String | Date the operation completes at the time of query |
| startOperationDate | String | Date the operation starts at the time of query |
| marketIsOpen | Boolean | Determines if the market is open or closed at the time of query |
| totalExpensesCurrency | String | Currency of the returned expenses |
| price | Number | Operation price |
| effectivePrice | Number | Resulting price after applying rounding to the amount operated by the user |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
| VALUE_MUST_BE_POSITIVE | The amount must be positive. |
| INVALID_PRICE_HASH | Invalid hash linked to the provided price. |
Enter Purchase ¶
Headers
Content-Type: application/jsonBody
{
"operationId": "412412411"
}Headers
Content-Type: application/json
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"thirdPartyId": "joel-test-uat-20240628-0010",
"amount": 600000,
"price": "1330.66",
"priceHash": "WxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1d",
"disclaimer": {
"accepted": true,
"timestamp": "32321321312"
}
}Headers
Content-Type: application/jsonBody
{
"operationId": "412412411"
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Enter PurchasePOST/investment-operation-flow/v1/exchange/fx/BUY
This service allows purchasing FX Dollar.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| account | String | Investment account number invoking the service. |
| location | String | URL to send the webhook. |
| Field | Type | Description |
|---|---|---|
| thirdPartyId | Number | External unique ID. |
| amount | Number | Amount to invest. |
| price | String | Reference price. |
| priceHash | String | Hash corresponding to the provided price. |
| disclaimer | Object | Object [Disclaimer] see Disclaimer |
| Disclaimer - Object | ||
|---|---|---|
| Field | Type | Description |
| accepted | Boolean | Acceptance of the Affidavits |
| timestamp | String | Timestamp of the acceptance of the Affidavits |
| Field | Type | Description |
|---|---|---|
| operationId | String | Operation ID. |
| endOperationDate | String | Operation end date. |
Message sent once the operation was completed.
{
"id":"00014j8x7a",
"external_id":"1270384740564017152",
"status":"EXCHANGED",
"amount":2.3500000000,
"exchange_amount":3119.6600000000
}
| Field | Type | Description |
|---|---|---|
| id | String | Unique ID. |
| external_id | String | External ID. |
| status | String | Status. |
| amount | Number | Amount. |
| exchange_amount | Number | Converted amount. |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
| DISCLAIMER_NOT_ACCEPTED | The Affidavits cannot be rejected. |
| VALUE_MUST_BE_POSITIVE | The value must be positive. |
| ACCOUNT_DISABLED_TO_OPERATE | Inactive account. |
| CLOSED_MARKET | The market is closed. |
| CLOSED_OPERATION | Closed operation. |
| MONTHLY_SUM_EXCEEDED | The maximum allowed to operate in the month was exceeded. |
| INVALID_MIN_USD | Minimum quantity of dollars to buy not allowed. |
| OUTDATED_REFERENCE_PRICE | Prices outdated between what meli sends and what the market returns at the time of receiving the request. |
| INVALID_PRICE_HASH | Invalid hash linked to the provided price. |
-
Example Request (application/json)
-
Headers
organization: <organization> account: 101357 Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20A -
Body
{ "thirdPartyId": "joel-test-uat-20240628-0010", "amount": 600000, "price": "1330.66", "priceHash": "WxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1d", "disclaimer": { "accepted": true, "timestamp": "32321321312" } }
-
Get sale expenses ¶
Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"amount": 15,
"priceHash": "WxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1d"
}Headers
Content-Type: application/jsonBody
{
"amount": 500,
"gross": 52035,
"net": 52035,
"totalExpenses": 0,
"endOperationDate": "2025-05-05T12:00:00Z",
"startOperationDate": "2025-05-05T12:00:00Z",
"marketIsOpen": true,
"totalExpensesCurrency": "ARS",
"price": 104.07
}Headers
Content-Type: application/json
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"amount": 15,
"priceHash": "WxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1d"
}Headers
Content-Type: application/jsonBody
{
"amount": 500,
"gross": 52035,
"net": 52035,
"totalExpenses": 0,
"endOperationDate": "2025-05-05T12:00:00Z",
"startOperationDate": "2025-05-05T12:00:00Z",
"marketIsOpen": true,
"totalExpensesCurrency": "ARS",
"price": 104.07
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Get sale expensesPOST/investment-operation-flow/v1/exchange/fx/preview/SELL
This service allows getting the expenses of an FX Dollar sale.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| account | String | Investment account number invoking the service. |
| Field | Type | Description |
|---|---|---|
| amount | Number | Amount in Argentine pesos. |
| priceHash | String | Hash corresponding to the provided price. |
| Field | Type | Description |
|---|---|---|
| amount | Number | Amount |
| gross | Number | Net amount |
| net | Number | Gross amount |
| totalExpenses | Number | Total operation expenses |
| endOperationDate | String | Date the operation completes at the time of query |
| startOperationDate | String | Date the operation starts at the time of query |
| marketIsOpen | Boolean | Determines if the market is open or closed at the time of query |
| totalExpensesCurrency | String | Currency of the returned expenses |
| price | Number | Operation price |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
| VALUE_MUST_BE_POSITIVE | The amount must be positive. |
| INVALID_PRICE_HASH | Invalid hash linked to the provided price. |
Enter Sale ¶
Headers
Content-Type: application/jsonBody
{
"operationId": "412412411"
}Headers
Content-Type: application/json
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"thirdPartyId": "joel-test-uat-20240628-0010",
"amount": 240,
"price": "1330.66",
"priceHash": "WxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1d",
"disclaimer": {
"accepted": true,
"timestamp": "32321321312"
}
}Headers
Content-Type: application/jsonBody
{
"operationId": "412412411"
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Enter SalePOST/investment-operation-flow/v1/exchange/fx/SELL
This service allows selling FX Dollar.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| account | String | Investment account number invoking the service. |
| location | String | URL to send the webhook. |
| location | String | URL to send the webhook. |
| Field | Type | Description |
|---|---|---|
| thirdPartyId | Number | External unique ID. |
| amount | Number | Amount to invest. |
| price | String | Reference price. |
| priceHash | String | Hash corresponding to the provided price. |
| disclaimer | Object | Object [Disclaimer] see Disclaimer |
| Disclaimer - Object | ||
|---|---|---|
| Field | Type | Description |
| accepted | Boolean | Acceptance of the Affidavits |
| timestamp | String | Timestamp of the acceptance of the Affidavits |
| Field | Type | Description |
|---|---|---|
| operationId | String | Operation ID. |
| endOperationDate | String | Operation end date. |
Message sent once the operation was completed.
{
"id":"00014j8x7a",
"external_id":"1270384740564017152",
"status":"EXCHANGED",
"amount":2.3500000000,
"exchange_amount":3119.6600000000
}
| Field | Type | Description |
|---|---|---|
| id | String | Unique ID. |
| external_id | String | External ID. |
| status | String | Status. |
| amount | Number | Amount. |
| exchange_amount | Number | Converted amount. |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
| DISCLAIMER_NOT_ACCEPTED | The Affidavits cannot be rejected. |
| VALUE_MUST_BE_POSITIVE | The value must be positive. |
| ACCOUNT_DISABLED_TO_OPERATE | Inactive account. |
| CLOSED_MARKET | The market is closed. |
| CLOSED_OPERATION | Closed operation. |
| NOT_MONEY_AVAILABLE | Insufficient balance. |
| INVALID_PRICE_HASH | Invalid hash linked to the provided price. |
-
Example Request (application/json)
-
Headers
organization: <organization> account: 101357 Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20A -
Body
{ "thirdPartyId": "joel-test-uat-20240628-0010", "amount": 240, "price": "1330.66", "priceHash": "WxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1d", "disclaimer": { "accepted": true, "timestamp": "32321321312" } }
-
Get Operation ¶
Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"thirdPartyId": "0000tbx5oa",
"amount": 1100000,
"account": "1680043",
"state": "EXCHANGED",
"result": {
"totalInvested": 1099048.91,
"totalObtained": 979.24
},
"id": "27293924800256",
"operation": "BUY",
"startDate": "2024-05-20T18:58:21",
"endDate": "2024-05-21T19:10:27",
"relatedOperations": [
{
"instrument": "BYMA.AL30",
"term": "T0",
"state": "FILLED",
"amount": 1088396.1,
"quantity": 1683,
"cumQuantity": 1683,
"leavesQuantity": 0,
"expenses": {
"byMarket": 108.81,
"byOperation": 10880.6,
"total": 10989.41
},
"finalAmount": 1088059.5,
"finalQuantity": 1683,
"date": "2024-05-20T18:58:38",
"currency": "ARS",
"operation": "BUY"
},
{
"instrument": "BYMA.AL30D",
"term": "T0",
"state": "FILLED",
"quantity": 1683,
"cumQuantity": 1683,
"leavesQuantity": 0,
"expenses": {
"byMarket": 0.1,
"byOperation": 0,
"total": 0.1
},
"finalAmount": 979.34,
"finalQuantity": 1683,
"date": "2024-05-21T14:38:49",
"currency": "USD",
"operation": "SELL"
}
]
}Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"thirdPartyId": "0000tbx5oa",
"amount": 1100000,
"account": "1680043",
"state": "EXCHANGED",
"result": {
"totalInvested": 1099048.91,
"totalObtained": 979.24
},
"id": "27293924800256",
"operation": "BUY",
"startDate": "2024-05-20T18:58:21",
"endDate": "2024-05-21T19:10:27",
"relatedOperations": [
{
"instrument": "BYMA.AL30",
"term": "T0",
"state": "FILLED",
"amount": 1088396.1,
"quantity": 1683,
"cumQuantity": 1683,
"leavesQuantity": 0,
"expenses": {
"byMarket": 108.81,
"byOperation": 10880.6,
"total": 10989.41
},
"finalAmount": 1088059.5,
"finalQuantity": 1683,
"date": "2024-05-20T18:58:38",
"currency": "ARS",
"operation": "BUY"
},
{
"instrument": "BYMA.AL30D",
"term": "T0",
"state": "FILLED",
"quantity": 1683,
"cumQuantity": 1683,
"leavesQuantity": 0,
"expenses": {
"byMarket": 0.1,
"byOperation": 0,
"total": 0.1
},
"finalAmount": 979.34,
"finalQuantity": 1683,
"date": "2024-05-21T14:38:49",
"currency": "USD",
"operation": "SELL"
}
]
}Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"thirdPartyId": "0000tbx5oa",
"amount": 1100000,
"account": "1680043",
"state": "ERROR",
"result": {
"totalInvested": 0,
"totalObtained": 0
},
"id": "27293924800256",
"operation": "BUY",
"startDate": "2024-05-20T18:58:21",
"endDate": "2024-05-21T19:10:27",
"relatedOperations": []
}Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"thirdPartyId": "0000tbx5oa",
"amount": 1100000,
"account": "1680043",
"state": "EXCHANGED",
"result": {
"totalInvested": 1099048.91,
"totalObtained": 979.24
},
"id": "27293924800256",
"operation": "BUY",
"startDate": "2024-05-20T18:58:21",
"endDate": "2024-05-21T19:10:27",
"relatedOperations": [
{
"instrument": "BYMA.AL30",
"term": "T0",
"state": "FILLED",
"amount": 1088396.1,
"quantity": 1683,
"cumQuantity": 1683,
"leavesQuantity": 0,
"expenses": {
"byMarket": 108.81,
"byOperation": 10880.6,
"total": 10989.41
},
"finalAmount": 1088059.5,
"finalQuantity": 1683,
"date": "2024-05-20T18:58:38",
"currency": "ARS",
"operation": "BUY"
},
{
"instrument": "BYMA.AL30D",
"term": "T0",
"state": "FILLED",
"quantity": 1683,
"cumQuantity": 1683,
"leavesQuantity": 0,
"expenses": {
"byMarket": 0.1,
"byOperation": 0,
"total": 0.1
},
"finalAmount": 979.34,
"finalQuantity": 1683,
"date": "2024-05-21T14:38:49",
"currency": "USD",
"operation": "SELL"
}
]
}Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"thirdPartyId": "0000tbx5oa",
"amount": 1100000,
"account": "1680043",
"state": "ERROR",
"result": {
"totalInvested": 0,
"totalObtained": 0
},
"id": "27293924800256",
"operation": "BUY",
"startDate": "2024-05-20T18:58:21",
"endDate": "2024-05-21T19:10:27",
"relatedOperations": []
}Body
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Get OperationGET/investment-operation-flow/v1/exchange/fx
This service obtains the status and details of an operation.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| account | String | Investment account number invoking the service. |
| Field | Type | Description |
|---|---|---|
| thirdPartyId | String | External ID. |
| operationId | String | Operation ID. |
| Field | Type | Description |
|---|---|---|
| thirdPartyId | String | External ID. |
| amount | Number | Amount. |
| account | String | Investment account number. |
| state | String | Status. Possible values:
|
| result | Object | Object [Result] see Result |
| operation | String | Operation type. Possible values:
|
| id | String | Operation ID |
| startDate | String | Operation start date |
| endDate | String | Operation end date. |
| instrumentDescription | String | Instrument description. |
| relatedOperations | Array | Array [RelatedOperations] see RelatedOperations |
| Result - Object | ||
|---|---|---|
| Field | Type | Description |
| totalInvested | Number | Total amount invested |
| totalObtained | Number | Total amount obtained |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
| INVALID_OPERATION | Invalid operation. |
Query an affidavit for FX ¶
Headers
Content-Type: application/jsonBody
{
"disclaimer": "According to BCRA Communication A 7552, I declare that in the last 90 calendar days I have not accessed the exchange market for the purchase of foreign currency (including swaps or arbitrations) nor am I subject to any legal or regulatory restriction to carry out the operation.",
"createdDate": "2023-11-16 11:43:43",
"key": "D1C_OPERATION"
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Query an affidavit for FXGET/investment-operation-flow/v1/disclaimer/fx
With this service, the FX affidavit is obtained.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token" |
| organization | String | Acronym of the organization invoking the service |
| Disclaimer - Object | ||
|---|---|---|
| Field | Type | Description |
| disclaimer | String | Affidavit content |
| createdDate | String | Creation date |
| key | String | Unique Id |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
| DICLAIMER_NOT_AVAILABLE | Affidavit not available. |
-
Example Request (application/json)
-
Headers
organization: <organization> Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20A
-
Interest Bearing Account ¶
Fund Price ¶
Headers
Content-Type: application/json
organization: <organization>
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20AHeaders
Content-Type: application/jsonBody
{
"code": "1483",
"price": 1.55,
"date": "2024-10-01",
"currency": "USD",
"class": "A"
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Fund PriceGET/marketdata/v1/price/fund/
This service provides the Fund's price.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| Field | Type | Description |
|---|---|---|
| code | String | MM Fund Code |
| price | Number | Unit value |
| date | String | Date |
| currency | String | Currency |
| class | String | Fund category |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
Subscriptions ¶
Headers
Content-Type: application/json
organization: <organization>
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"datetime": "2012-11-21T03:00:00Z",
"total": {
"data_size": 1,
"total_amount": "30500.30"
},
"data": [
{
"fund": "2",
"account": "4652",
"value": {
"amount": "30500.30"
},
"third_party_information": {
"id": "123",
"transaction_id": "trx-1342-232SAF",
"detail": "free text"
}
}
],
"third_party_information": {
"packet_id": "ewqeq_312321_3123_edewqeq",
"type": "A",
"description": "package description"
}
}Headers
Content-Type: application/jsonBody
{
"created_datetime": "2012-11-21T03:00:00Z",
"bundle_id": "43",
"packet_id": "1234",
"total_request": 1
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}SubscriptionsPOST/bundle-worker/v1/investment/operate/fund/bulk/SUBSCRIPTION
This service provides information for sending subscriptions to the fund.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| location | String | URL for notification webhook. |
| Field | Type | Description |
|---|---|---|
| datetime | String | Date |
| total | Object | Object IntegrityDataTotal see IntegrityDataTotal |
| data | Object | Object [Data] see Data |
| third_party_information | Object | Object ThirdPartyInformation see ThirdPartyInformation |
| IntegrityDataTotal - Object | ||
|---|---|---|
| Field | Type | Description |
| data_size | Integer | Number of operations |
| total_amount | String | Total sum of operation amounts |
| ThirdPartyInformation - Object | ||
|---|---|---|
| Field | Type | Description |
| packet_id | String | External packet ID |
| type | String | Type |
| description | String | Description |
| Data - Object | ||
|---|---|---|
| Field | Type | Description |
| fund | String | Fund code |
| account | String | Investment account |
| value | Object | Object DataValue see DataValue |
| third_party_information | Object | Object ThirdPartyInformation see ThirdPartyInformation |
| DataValue - Object | ||
|---|---|---|
| Field | Type | Description |
| amount | String | Amount |
| ThirdPartyInformation - Object | ||
|---|---|---|
| Field | Type | Description |
| id | String | External operation ID |
| transaction_id | String | External transaction ID |
| detail | String | Description |
Withdrawals ¶
Headers
Content-Type: application/json
organization: <organization>
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"datetime": "2012-11-21T03:00:00Z",
"total": {
"data_size": 1,
"total_amount": "30500.30"
},
"data": [
{
"fund": "2",
"account": "4652",
"value": {
"amount": "30500.30"
},
"third_party_information": {
"id": "123",
"transaction_id": "trx-1342-232SAF",
"detail": "free text"
}
}
],
"third_party_information": {
"packet_id": "ewqeq_312321_3123_edewqeq",
"type": "A",
"description": "package description"
}
}Headers
Content-Type: application/jsonBody
{
"created_datetime": "2012-11-21T03:00:00Z",
"bundle_id": "43",
"packet_id": "1234",
"total_request": 1
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Headers
Content-Type: application/json
organization: <organization>
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"datetime": "2012-11-21T03:00:00Z",
"total": {
"data_size": 1,
"total_amount": "0"
},
"data": [
{
"fund": "2",
"account": "4652",
"value": {
"totalWithdraw": true
},
"third_party_information": {
"id": "123",
"transaction_id": "trx-1342-232SAF",
"detail": "free text"
}
}
],
"third_party_information": {
"packet_id": "ewqeq_312321_3123_edewqeq",
"type": "A",
"description": "package description"
}
}Headers
Content-Type: application/jsonBody
{
"created_datetime": "2012-11-21T03:00:00Z",
"bundle_id": "43",
"packet_id": "1234",
"total_request": 1
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}WithdrawalsPOST/bundle-worker/v1/investment/operate/fund/bulk/WITHDRAW
This service provides information for sending withdrawals to the fund.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| location | String | URL for notification webhook. |
| Field | Type | Description |
|---|---|---|
| datetime | String | Date |
| total | Object | Object IntegrityDataTotal see IntegrityDataTotal |
| data | Object | Object [Data] see Data |
| third_party_information | Object | Object ThirdPartyInformation see ThirdPartyInformation |
| IntegrityDataTotal - Object | ||
|---|---|---|
| Field | Type | Description |
| data_size | Integer | Number of operations |
| total_amount | String | Total sum of operation amounts |
| ThirdPartyInformation - Object | ||
|---|---|---|
| Field | Type | Description |
| packet_id | String | External packet ID |
| type | String | Type |
| description | String | Description |
| Data - Object | ||
|---|---|---|
| Field | Type | Description |
| fund | String | Fund code |
| account | String | Investment account |
| value | Object | Object DataValue see DataValue |
| third_party_information | Object | Object ThirdPartyInformation see ThirdPartyInformation |
| DataValue - Object | ||
|---|---|---|
| Field | Type | Description |
| amount | String | Amount |
| totalWithdraw | Boolean | Total withdrawal |
| ThirdPartyInformation - Object | ||
|---|---|---|
| Field | Type | Description |
| id | String | External operation ID |
| transaction_id | String | External transaction ID |
| detail | String | Description |
Finished sending notice ¶
Headers
organization: <organization>
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"packetQuantity": 1,
"concretionDate": "2025-04-24"
}Body
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Finished sending noticePOST/bundle-worker/v1/investment/operate/finishedSendingOperations
Finished sending operations notice. It is used to determine that no more operation packages will be sent for the day.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| Field | Type | Description |
|---|---|---|
| packetQuantity | Number | Number of sent packages |
| concretionDate | String | Date. Format: YYYY-MM-DD |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
Bundle query ¶
Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"id": "2",
"operation": "SUBSCRIPTION",
"total": {
"amount": 8.54,
"quantity": 8.54,
"packets_ok": 1,
"packets_fail": 0,
"request_ok": 1,
"request_fail": 0,
"request_total": 1,
"packets_total": 1
},
"details": [
{
"id": "2",
"state": "PROCESSED_OK",
"bundle": "2"
}
],
"state": "PROCESSED_OK_AND_PRICE",
"created_datetime": "2024-12-05T16:06:45Z",
"start_process": "2024-12-05T16:06:46Z",
"end_process": "2024-12-05T16:18:49Z",
"transaction_ids": [
"2"
],
"extra_data": [
{
"fund": "1483",
"price": 1
}
]
}Body
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Bundle queryGET/bundle-worker/v1/investment/operate/bundle/
This service provides the status and information of a specific bundle.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| Field | Type | Description |
|---|---|---|
| id | String | Bundle ID. |
| operation | String | Operation type. Possible values:
|
| total | Object [TotalInfo] | Object [TotalInfo] see TotalInfo |
| details | Object [Detail] | Object [Detail] see Detail |
| state | String | Status. Possible values:
|
| created_datetime | String | Creation date |
| start_process | String | Process start date |
| end_process | String | Process end date |
| transaction_ids | Array[String] | List of IDs of all packages. |
| extra_data | Object [ExtraData] | Object [ExtraData] see ExtraData |
| TotalInfo - Object | ||
|---|---|---|
| Field | Type | Description |
| quantity | Number | Total quantity successfully processed |
| packets_ok | Number | Number of packages successfully processed |
| packets_fail | Number | Number of packages processed with error |
| request_ok | Number | Number of requests successfully processed |
| request_fail | Number | Number of unprocessed requests |
| request_total | Number | Total number of requests |
| packets_total | Number | Total number of packages |
| Result - Detail | ||
|---|---|---|
| Field | Type | Description |
| id | String | Package ID |
| state | String | Status Possible values:
|
| bundle | String | Bundle ID |
| ExtraData - Object | ||
|---|---|---|
| Field | Type | Description |
| fund | String | Fund ID |
| price | Number | VCP value |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
Package query ¶
Headers
organization: <organization>
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"id": "2",
"requests": [
{
"fund": "1483",
"account": "1281918",
"state": "OK",
"request_number": "1",
"third_party_information": {
"id": "539c2880-4c06-48ba-94a8-f509670da956"
},
"settlement": {
"price": 1,
"amount": 8.54,
"quantity": 8.54
}
}
],
"state": "PROCESSED_OK",
"bundle": "2",
"start_process": "2024-12-05T16:06:46Z",
"end_process": "2024-12-05T16:18:49Z",
"total_request_ok": 1,
"total_request_fail": 0,
"webhook": "https://api.mercadopago.com/asset-mgmt/v1/providers/370647bc-9dc4-4f19-9041-5700b4da9ae2/packets/fff45782-b27a-4497-9966-2cd59f5a0210/confirmed",
"third_party_information": {
"packet_id": "fff45782-b27a-4497-9966-2cd59f5a0210"
}
}Body
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Headers
organization: <organization>
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"id": "2",
"requests": [
{
"fund": "1483",
"account": "1281918",
"state": "OK",
"request_number": "1",
"third_party_information": {
"id": "539c2880-4c06-48ba-94a8-f509670da956"
},
"settlement": {
"price": 1,
"amount": 8.54,
"quantity": 8.54
}
}
],
"state": "PROCESSED_OK",
"bundle": "2",
"start_process": "2024-12-05T16:06:46Z",
"end_process": "2024-12-05T16:18:49Z",
"total_request_ok": 1,
"total_request_fail": 0,
"webhook": "https://api.mercadopago.com/asset-mgmt/v1/providers/370647bc-9dc4-4f19-9041-5700b4da9ae2/packets/fff45782-b27a-4497-9966-2cd59f5a0210/confirmed",
"third_party_information": {
"packet_id": "fff45782-b27a-4497-9966-2cd59f5a0210"
}
}Body
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Package queryGET/bundle-worker/v1/investment/operate/packet/
This service provides the status and information of a specific package.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| Field | Type | Description |
|---|---|---|
| id | String | Package ID. |
| requests | Object [RequestInfo] | Object [RequestInfo] see RequestInfo |
| state | String | Status. Possible values:
|
| bundle | String | Bundle ID. |
| start_process | String | Process start date |
| end_process | String | Process end date |
| total_request_ok | Number | Total requests successfully processed |
| total_request_fail | Number | Total unprocessed requests |
| webhook | String | URL where to give notice of package processing end |
| third_party_information | Object [ExtraData] | Object [ExtraData] see ExtraData |
| RequestInfo - Object | ||
|---|---|---|
| Field | Type | Description |
| fund | String | Fund code |
| account | String | Account |
| state | String | Status. Possible values:
|
| request_number | Number | Request number |
| third_party_information | Object [ExtraData] | Object [ExtraData] see ExtraData |
| settlement | Object [SettlementInfo] | Object [SettlementInfo] see SettlementInfo |
| Result - SettlementInfo | ||
|---|---|---|
| Field | Type | Description |
| price | Number | VCP value |
| amount | Number | Settled amount |
| quantity | Number | Settled quantity |
| ExtraData - Object | ||
|---|---|---|
| Field | Type | Description |
| id | String | External request ID |
| packet_id | String | External package ID |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
Processing finished webhook ¶
Headers
Content-Type: application/jsonBody
{
"datetime": "2023-10-09T10:00:00Z",
"funds": [
{
"price": 1091.0594,
"id": "2",
"rejected_request": [
{
"packet_id": "287020",
"account_id": "3213",
"reason": {
"code": "REJECTED_BY_BACKEND",
"description": "rejected_by_backend"
}
}
]
}
]
}Processing finished webhookPOST/url-provided-by-user
Processing finished message
| Field | Type | Description |
|---|---|---|
| datetime | String | Date |
| funds | Object [Funds] | Object [Funds] see Funds |
| Funds - Object | ||
|---|---|---|
| Field | Type | Description |
| price | Number | Share value |
| id | String | Fund ID |
| rejected_request | Array [RejectedRequest] | Array [RejectedRequest] see RejectedRequest |
| RejectedRequest - Object | ||
|---|---|---|
| Field | Type | Description |
| packet_id | String | Package ID |
| account_id | String | Account number |
| reason | Object [Reason] | Object [Reason] see Reason |
| Reason - Object | ||
|---|---|---|
| Field | Type | Description |
| code | String | Code |
| description | String | Description |
- Example Request (application/json)
Get interest earned per user ¶
Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"page": 1,
"itemsPerPage": 2,
"totalPages": 4,
"account": "21341",
"from": "20250203",
"to": "20250204",
"sort": "ASC",
"result": [
{
"date": "20250203",
"amount": 23.34
},
{
"date": "20250204",
"amount": 3.65
}
]
}Body
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Get interest earned per userGET/bundle-worker/v1/investment/interest/earned
This service provides the interest earned daily per user.
Filters are mandatory.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| account | String | Account number invoking the service. |
| Field | Type | Description |
|---|---|---|
| from | String | Start date. Format: YYYYMMDD |
| to | String | End date. Format: YYYYMMDD |
| sort | String | Sorting. Default value: ASC Possible values:
|
| page | Number | Page. Value 1 is interpreted as the first page Default value: 1 |
| itemsPerPage | Number | Items per page. Default value: 50 Maximum value: 365 |
| Field | Type | Description |
|---|---|---|
| page | Number | Page number. |
| itemsPerPage | Number | Items per page. |
| totalPages | Number | Total number of pages. |
| account | String | Brokerage account number. |
| from | String | Start date. |
| to | String | End date. |
| sort | String | Sorting. |
| result | Object | Object [Element] see Element |
| Element - Object | ||
|---|---|---|
| Field | Type | Description |
| date | String | Date. Format: YYYYMMDD |
| amount | Number | Amount |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
| INVALID_OPERATION | Invalid operation. |
| INVALID_PAGE | Invalid page. |
| INVALID_ITEMS_PER_PAGE | Invalid number of items per page. |
Get settlements per user ¶
Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"page": 1,
"itemsPerPage": 2,
"totalPages": 4,
"account": "21341",
"from": "20250203",
"to": "20250204",
"sort": "ASC",
"result": [
{
"date": "20250203",
"type": "SUBSCRIPTION",
"fund": "Fund XYZ",
"price": "1.0000900",
"amount": 500,
"totalWithdraw": false,
"settledAmount": 499.99,
"settledQuantity": 499.9550040,
"uniqueId": "65030175753367552"
},
{
"date": "20250204",
"type": "WITHDRAW",
"fund": "Fund XYZ",
"price": "1.0020200",
"amount": null,
"totalWithdraw": true,
"settledAmount": 497.07,
"settledQuantity": 496.0682020,
"uniqueId": "47684888820912324"
},
]
}Body
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Get settlements per userGET/bundle-worker/v1/investment/settlement/info
This service provides information about settlements per user.
Filters are mandatory.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| account | String | Account number invoking the service. |
| Field | Type | Description |
|---|---|---|
| from | String | Start date. Format: YYYYMMDD |
| to | String | End date. Format: YYYYMMDD |
| sort | String | Sorting. Default value: ASC Possible values:
|
| page | Number | Page. Value 1 is interpreted as the first page Default value: 1 |
| itemsPerPage | Number | Items per page. Default value: 50 Maximum value: 365 |
| Field | Type | Description |
|---|---|---|
| page | Number | Page number. |
| itemsPerPage | Number | Items per page. |
| totalPages | Number | Total number of pages. |
| account | String | Brokerage account number. |
| from | String | Start date. |
| to | String | End date. |
| sort | String | Sorting. |
| result | Object | Object [Element] see Element |
| Element - Object | ||
|---|---|---|
| Field | Type | Description |
| date | String | Date. Format: YYYYMMDD |
| type | String | Type Possible values:
|
| fund | String | MMF |
| price | Number | Unit value |
| amount | Number | Requested amount |
| totalWithdraw | Boolean | Total redemption |
| settledAmount | Number | Settled amount |
| settledQuantity | Number | Settled quantity |
| uniqueId | String | Unique identifier |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
| INVALID_OPERATION | Invalid operation. |
| INVALID_PAGE | Invalid page. |
| INVALID_ITEMS_PER_PAGE | Invalid number of items per page. |
Treasury ¶
Money withdrawal ¶
Headers
Content-Type: application/jsonBody
{
"uniqueId": "1266122743860322304",
"originBankAccount": {
"identification": "3220001812000036580135",
"account": "12000036580135",
"taxIdentification": "30642023876",
"name": "IVSA"
}
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}
{
"code": "INVALID_BANK_ACCOUNT_IDENTIFICATION",
"message": "Error in field: identificationBankAccount",
"process": "1297944803973484544"
}
{
"code": "INVALID_CURRENCY",
"message": "Error in field: currency",
"process": "1298368615609225216"
}8615609225216"
}Money withdrawalPOST/cash-management/v1/transaction/OUT
This API allows sending money to the bank account loaded in the investment account.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token" |
| organization | String | Acronym of the organization invoking the service |
| account | String | Account number invoking the service |
| location | String | URL to send the webhook. |
| Field | Type | Description |
|---|---|---|
| currency | String | Currency |
| amount | Number | Amount |
| identificationBankAccount | String | CBU / CVU to which the money should be sent |
| thirdPartyId | Number | External ID |
| Field | Type | Description |
|---|---|---|
| uniqueId | String | Unique ID |
| originBankAccount | Object | Object [OriginBankAccount] see OriginBankAccount |
| OriginBankAccount - Object | ||
|---|---|---|
| Field | Type | Description |
| identification | String | Origin CBU of the operation |
| account | String | Origin account of the operation |
| taxIdentification | String | Origin CUIT of the operation |
| name | String | Origin name of the operation |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| NOT_MONEY_AVAILABLE | No money available. |
| INVALID_BANK_ACCOUNT_IDENTIFICATION | Invalid bank account. |
| INVALID_CURRENCY | Invalid currency. |
Information defined and provided by the third-party team.
{
"id":"4108790013120",
"state":"CONCILIATION",
"thirdPartyId":"CPO70354163788"
}
| Field | Type | Description |
|---|---|---|
| id | String | Unique ID. |
| external_id | String | External ID. |
| status | String | Status. |
Information defined and provided by the third-party team.
{
"id":"1270716284670738432",
"state":"ERROR",
"thirdPartyId":"CPO84652607424",
"errorDetail": {
"final":false,
"code":"GENERAL_ERROR"
}
}
| Field | Type | Description |
|---|---|---|
| id | String | Unique ID. |
| external_id | String | External ID. |
| status | String | Status. |
| errorDetail | Object | Object [ErrorDetail] see ErrorDetail |
| ErrorDetail - Object | ||
|---|---|---|
| Field | Type | Description |
| code | String | Code see list |
| final | String | Is retryable |
-
Money transfer request
-
Headers
organization: <organization> account: 1802 Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20A -
Body
{ "currency": "USD", "identificationBankAccount": "0720432088000036009622", "amount": 0.01, "thirdPartyId": "prueba-cash-out-913502" }
-
Money withdrawal query ¶
Headers
Content-Type: application/jsonBody
{
"id": "3256651256",
"state": "ACCEPTED",
}Headers
Content-Type: application/json
organization: <organization>
account: 1802
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"id": "1270455805277278208",
"state": "ERROR",
"errorDetail": {
"code": "APIBANK_VALIDATION_ERROR",
"final": true
},
"thirdPartyId": "joel-test-uat-20240731-04"
}Headers
Content-Type: application/jsonBody
{
"id": "3256651256",
"state": "ACCEPTED",
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Money withdrawal queryGET/cash-management/v1/transaction
This API allows querying the status of money sent to the bank account loaded in the investment account.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token" |
| organization | String | Acronym of the organization invoking the service |
| account | String | Account number invoking the service |
| Field | Type | Description |
|---|---|---|
| thirdPartyId | String | External ID. |
| transactionId | String | Operation ID. |
| Field | Type | Description |
|---|---|---|
| id | String | Unique ID |
| state | String | Status Possible values:
|
| thirdPartyId | String | External ID |
| errorDetail | Object | Object [ErrorDetail] see ErrorDetail |
| ErrorDetail - Object | ||
|---|---|---|
| Field | Type | Description |
| code | String | Code see list |
| final | String | Is retryable |
| Error list | ||
|---|---|---|
| Code | Description | Is retryable |
| APIBANK_VALIDATION_ERROR | Code | Code |
| APIBANK_INVALID_DESTINATION_ACCOUNT | Is retryable | Yes |
| APIBANK_INVALID_CBU_CVU | Is retryable | Yes |
| APIBANK_INVALID_ALIAS | Is retryable | Yes |
| EXTERNAL_REJECTION_INEXISTENT_CBU | Is retryable | Yes |
| ERROR_APIBANK_DESTINATION_ACCOUNT_CANT_RECEIVE_TRANSFER | Is retryable | Yes |
| EXTERNAL_REJECTION_INVALID_CBU | Is retryable | Yes |
| EXTERNAL_REJECTION_CBU_NOT_ENABLED_FOR_BANKING_NET | Is retryable | Yes |
| APIBANK_GENENERAL_ERROR | Is retryable | No |
| APIBANK_EXTERNAL_NETS_ARE_UNAVAILABLE | Is retryable | No |
| ERROR_TO_PROCESS_OPERATION | Is retryable | No |
| GENERIC_ERROR | Is retryable | No |
| GENERIC_INTERNAL_ERROR | Is retryable | No |
| ERROR_READ_TIME_OUT | Is retryable | No |
| ERROR_TIME_OUT | Is retryable | No |
| CONNECTION_ERROR | Is retryable | No |
| ERROR_TO_PROCESS_TRANSFER | Is retryable | No |
| ERROR_CHECK_CBU | Is retryable | No |
| ERROR_BANELCO_RESPONSE_DONT_KNOW | Is retryable | No |
| UNKNOW_GENERAL_ERROR | Is retryable | No |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
| INVALID_BANK_TRANSACTION | Invalid operation. |
-
Money transfer query request
-
Headers
organization: <organization> account: 1802 Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20A -
Body
{ "id": "1270455805277278208", "state": "ERROR", "errorDetail": { "code": "APIBANK_VALIDATION_ERROR", "final": true }, "thirdPartyId": "joel-test-uat-20240731-04" }
-
P2P ¶
Perform P2P transfer ¶
Headers
Content-Type: application/jsonBody
{
"uniqueId": "123456789"
}Headers
Content-Type: application/json
organization: <organization>
account: 1802
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"currency": "USD",
"destinationAccount": "7108",
"amount": 10,
"thirdPartyId": "joel-p2p-0005"
}Headers
Content-Type: application/jsonBody
{
"uniqueId": "123456789"
}Headers
Content-Type: application/jsonBody
{
"code": "INVALID_CURRENCY",
"message": "Error in field: currency",
"process": "1296929556928090112"
}
{
"code": "NOT_MONEY_AVAILABLE",
"process": "1296928429226545152"
}Perform P2P transferPOST/cash-management/v1/p2p/transfer
This service allows sending money through a P2P transfer.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token" |
| organization | String | Acronym of the organization invoking the service |
| account | String | Account number invoking the service |
| location | String | URL to send the webhook. |
| Field | Type | Description |
|---|---|---|
| thirdPartyId | Number | External unique ID. |
| amount | Number | Amount to transfer. |
| currency | String | Currency |
| destinationAccount | String | Destination account |
| Field | Type | Description |
|---|---|---|
| uniqueId | String | Unique ID |
| errorDetail | Object | Object [ErrorDetail] see ErrorDetail |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| NOT_MONEY_AVAILABLE | Not enough money in the account |
| REQUIRED_FIELD_WITH_NULL_VALUE | Invalid operation. |
| INVALID_CURRENCY | Invalid currency |
Information defined and provided by the third-party team.
{
"id":"4108790013120",
"state":"CONCILIATION",
"thirdPartyId":"CPO70354163788"
}
| Field | Type | Description |
|---|---|---|
| id | String | Unique ID. |
| external_id | String | External ID. |
| status | String | Status. |
Information defined and provided by the third-party team.
{
"id":"1270716284670738432",
"state":"ERROR",
"thirdPartyId":"CPO84652607424",
"errorDetail": {
"final":false,
"code":"GENERAL_ERROR"
}
}
| Field | Type | Description |
|---|---|---|
| id | String | Unique ID. |
| external_id | String | External ID. |
| status | String | Status. |
| errorDetail | Object | Object [ErrorDetail] see ErrorDetail |
| ErrorDetail - Object | ||
|---|---|---|
| Field | Type | Description |
| code | String | Code see list |
| final | String | Is retryable |
-
Perform P2P transfer request
-
Headers
organization: <organization> account: 1802 Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20A -
Body
{ "currency":"USD", "destinationAccount":"7108", "amount":10.00, "thirdPartyId":"joel-p2p-0005" }
-
Get P2P transfer details ¶
Headers
Content-Type: application/jsonBody
{
"startDate": "2024-07-23 10:28:27.000",
"endDate": "2024-07-23 10:30:26.000",
"originAccount": "7091",
"destinationAccount": "7108",
"currency": "USD",
"sentAmount": 1,
"status": "PROCESSED",
"uniqueId": "1265299495371112448",
"thirdPartyId": "joel-p2p-0005"
}Headers
Content-Type: application/json
organization: <organization>
account: 1802
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"code": "GENERAL_ERROR",
"process": "1296916182169243648"
}
{
"code": "INVALID_PEER_TO_PEER_TRANSFER",
"process": "1296921571233320960"
}Headers
Content-Type: application/jsonBody
{
"startDate": "2024-07-23 10:28:27.000",
"endDate": "2024-07-23 10:30:26.000",
"originAccount": "7091",
"destinationAccount": "7108",
"currency": "USD",
"sentAmount": 1,
"status": "PROCESSED",
"uniqueId": "1265299495371112448",
"thirdPartyId": "joel-p2p-0005"
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "1296916182169243648"
}
{
"code": "INVALID_PEER_TO_PEER_TRANSFER",
"process": "1296921571233320960"
}Get P2P transfer detailsGET/cash-management/v1/p2p
This service allows getting the details of a P2P transfer.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token" |
| organization | String | Acronym of the organization invoking the service |
| account | String | Account number invoking the service |
| Field | Type | Description |
|---|---|---|
| thirdPartyId | String | External ID. |
| transactionId | String | Operation ID. |
| Field | Type | Description |
|---|---|---|
| startDate | String | Start date |
| endDate | String | End date |
| originAccount | String | Origin account |
| destinationAccount | String | Destination account |
| currency | String | Currency |
| sentAmount | Number | Sent amount |
| status | String | Transaction status |
| uniqueId | String | Unique ID |
| thirdPartyId | String | External ID |
| state | String | Status Possible values:
|
| errorDetail | Object | Object [ErrorDetail] see ErrorDetail |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_PEER_TO_PEER_TRANSFER | Invalid P2P account. |
-
Get P2P transfer details request
-
Headers
organization: <organization> account: 1802 Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20A
-
P2P transfer preview ¶
Headers
Content-Type: application/jsonBody
{
"startDate": "2026-01-27 16:39:50.957",
"endDate": "2026-01-27 16:39:51.143",
"originAccount": "7091",
"destinationAccount": "12667",
"currency": "USD",
"sentAmount": 5,
"receivedAmount": 4.69,
"originTaxDetail": [
{
"subtype": "DEFAULT",
"amount": 0.03,
"currency": "USD",
"aliquotApplied": 0.006,
"name": "IDC",
"registerDate": "2026-01-27"
}
],
"destinationTaxDetail": [
{
"subtype": "DEFAULT",
"amount": 0.03,
"currency": "USD",
"aliquotApplied": 0.006,
"name": "IDC",
"registerDate": "2026-01-27"
},
{
"subtype": "M",
"amount": 0.25,
"currency": "USD",
"aliquotApplied": 0.05,
"name": "IIBB",
"registerDate": "2025-12"
}
]
}Headers
Content-Type: application/json
organization: <organization>
account: 7091
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"currency": "USD",
"destinationAccount": "12667",
"amount": 10
}Headers
Content-Type: application/jsonBody
{
"startDate": "2026-01-27 16:39:50.957",
"endDate": "2026-01-27 16:39:51.143",
"originAccount": "7091",
"destinationAccount": "12667",
"currency": "USD",
"sentAmount": 5,
"receivedAmount": 4.69,
"originTaxDetail": [
{
"subtype": "DEFAULT",
"amount": 0.03,
"currency": "USD",
"aliquotApplied": 0.006,
"name": "IDC",
"registerDate": "2026-01-27"
}
],
"destinationTaxDetail": [
{
"subtype": "DEFAULT",
"amount": 0.03,
"currency": "USD",
"aliquotApplied": 0.006,
"name": "IDC",
"registerDate": "2026-01-27"
},
{
"subtype": "M",
"amount": 0.25,
"currency": "USD",
"aliquotApplied": 0.05,
"name": "IIBB",
"registerDate": "2025-12"
}
]
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR"
}P2P transfer previewPOST/cash-management/v1/p2p/preview
This service allows the preview of sending money through a P2P transfer.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token" |
| organization | String | Acronym of the organization invoking the service |
| account | String | Account number invoking the service |
| Field | Type | Description |
|---|---|---|
| currency | String | Currency |
| destinationAccount | String | Destination account |
| amount | Number | Amount to transfer. |
| Field | Type | Description |
|---|---|---|
| startDate | String | Operation start date |
| endDate | String | Operation end date |
| originAccount | String | Origin account |
| destinationAccount | String | Destination account |
| currency | String | Currency |
| sentAmount | Number | Sent amount |
| receivedAmount | Number | Received amount |
| originTaxDetail | Object |
Object [OriginTaxDetail] see OriginTaxDetail |
| destinationTaxDetail | Object |
Object [DestinationTaxDetail] see DestinationTaxDetail |
| OriginTaxDetail - Object | ||
|---|---|---|
| Field | Type | Description |
| subtype | String | Preferential rate |
| amount | Number | Perceived amount |
| currency | String | Currency |
| aliquotApplied | Number | Applied rate |
| name | String | Applied tax name |
| registerDate | String | Day the perception was made |
| DestinationTaxDetail - Object | ||
|---|---|---|
| Field | Type | Description |
| subtype | String | Preferential rate |
| amount | Number | Perceived amount |
| currency | String | Currency |
| aliquotApplied | Number | Applied rate |
| name | String | Applied tax name |
| registerDate | String | Day the perception was made |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
-
Perform P2P transfer request
-
Headers
organization: <organization> account: 7091 Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20A -
Body
{ "currency":"USD", "destinationAccount":"12667", "amount":10.00 }
-
Payments ¶
Credit Card Payment ¶
Headers
organization: <organization>
account: 1802
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"currency": "USD",
"amount": 10,
"thirdPartyId": "payment-credit-card-0005",
"destinationBankAccountIdentification": "3220001805000036580500"
}Headers
Content-Type: application/jsonBody
{
"uniqueId": "123456789",
"state": "APPROVED"
}Headers
Content-Type: application/jsonBody
{
"code": "INVALID_CURRENCY",
"message": "Error in field: currency",
"process": "1296929556928090112"
}
{
"code": "NOT_MONEY_AVAILABLE",
"process": "1296928429226545152"
}Credit Card PaymentPOST/payments/v1/credit/card
This service allows deducting available funds and linking them to a credit card payment.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token" |
| organization | String | Acronym of the organization invoking the service |
| account | String | Account number invoking the service |
| Field | Type | Description |
|---|---|---|
| thirdPartyId | Number | Unique external ID. |
| amount | Number | Amount to invest. |
| currency | String | Currency |
| destinationBankAccountIdentification | String | Destination Bind-CBU |
| Field | Type | Description |
|---|---|---|
| uniqueId | String | Unique ID |
| state | String | State.
|
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| NOT_MONEY_AVAILABLE | Insufficient funds in the account |
| REQUIRED_FIELD_WITH_NULL_VALUE | Invalid operation. |
| INVALID_CURRENCY | Invalid currency |
| INVALID_AMOUNT | Invalid amount |
| INVALID_BIND_BANK_ACCOUNT_IDENTIFICATION | The destination CBU does not correspond to Banco Industrial |
Get Credit Card Payment ¶
Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"account": "11325",
"currency": "USD",
"amount": 10,
"destinationBankAccountIdentification": "3220001805000036580148",
"uniqueId": "1410269712204152832",
"thirdPartyId": "payment-credit-card-0005",
"state": "APPROVED",
"status": "SENT_TO_CORE",
"createdDate": "2025-08-27T11:28:21"
}Body
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}Get Credit Card PaymentGET/payments/v1/credit/card
With this service, you can obtain the status and details of a credit card payment.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| account | String | Brokerage account number invoking the service. |
| Field | Type | Description |
|---|---|---|
| thirdPartyId | String | External ID. |
| uniqueId | String | Operation ID. |
| Field | Type | Description |
|---|---|---|
| account | String | Brokerage account number. |
| currency | String | Currency. |
| amount | Number | Amount. |
| destinationBankAccountIdentification | String | Collection CBU within Bind. |
| uniqueId | String | Unique ID. |
| thirdPartyId | String | External ID. |
| state | String | State. Possible values:
|
| status | String | Status. Possible values:
|
| createdDate | String | Creation date. |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
| INVALID_OPERATION | Invalid operation. |
Collections and Payments - Buyer ¶
Headers
organization: <organization>
account: 1802
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"destinationBankIdentification": "3220001805000036580500",
“amount”: 500,
"grossAmount": 500,
"currency": "USD",
"totalTaxAmount" : 25,
"totalFeeAmount" : 50,
"destinationBankIdentificationAmount": 425
“transactionId”: "12344646",
“transactionDate”: “2025-04-15 13:25:00”,
“transactionType”: "payment",
“thirdPartyId”: "money-transfer-0001",
"reverseTransfer": false,
"fee":[
{
"name":"name".
"amount: 50,
"currency": "USD"
}
],
“taxDetail”: [
{
"subtype": "M",
"amount": 25,
"currency": "USD",
"aliquotApplied": 0.05,
"name": "IIBB",
"registerDate": "2025-12-01"
}
]
}Headers
Content-Type: application/jsonBody
{
"uniqueId": "123456789"
}Headers
Content-Type: application/jsonBody
{
"code": "INVALID_CURRENCY",
"message": "Error in field: currency",
"process": "1296929556928090112"
}
{
"code": "NOT_MONEY_AVAILABLE",
"process": "1296928429226545152"
}Collections and Payments - BuyerPOST/payments/v1/money/transfer/buyer
This service allows deducting available funds to make a payment.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token" |
| organization | String | Acronym of the organization invoking the service |
| account | String | Buyer's account number |
| Field | Type | Description |
|---|---|---|
| destinationBankIdentification | String | Destination CBU. |
| amount | Number | Amount to invest. |
| grossAmount | Number | Gross Amount. |
| currency | String | Currency |
| totalTaxAmount | Number | Total amount of taxes collected |
| totalFeeAmount | Number | Total fee amount |
| destinationBankIdentificationAmount | Number | Final amount sent to the destination account |
| transactionId | String | Transaction ID |
| transactionDate | String | Transaction date |
| transactionType | String | Transaction type |
| thirdPartyId | Number | Unique external ID. |
| reverseTransfer | Boolean | Flag indicating if it is a reversal. |
| fee | Object |
Object [Fee] see Fee |
| taxDetail | Object |
Object [TaxDetail] see TaxDetail |
| Fee - Object | ||
|---|---|---|
| Field | Type | Description |
| name | String | Fee description |
| amount | Number | Fee amount |
| currency | String | Currency |
| TaxDetail - Object | ||
|---|---|---|
| Field | Type | Description |
| subtype | String | Preferential rate |
| amount | Number | Applied tax amount |
| currency | String | Currency |
| aliquotApplied | Number | Applied rate |
| name | String | Tax name |
| registerDate | String | Collection date |
| Field | Type | Description |
|---|---|---|
| uniqueId | String | Unique ID |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| NOT_MONEY_AVAILABLE | Insufficient funds in the account |
| REQUIRED_FIELD_WITH_NULL_VALUE | Invalid operation. |
| INVALID_CURRENCY | Invalid currency |
| INVALID_AMOUNT | Invalid amount |
| INVALID_BIND_BANK_ACCOUNT_IDENTIFICATION | The destination CBU does not correspond to Banco Industrial |
Collections and Payments - Seller ¶
Headers
organization: <organization>
account: 1802
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"originBankIdentification": "3220001805000036580500",
“amount”: 500,
"grossAmount": 500,
"currency": "USD",
"totalTaxAmount" : 25,
"totalFeeAmount" : 50,
"destinationBankIdentificationAmount": 425
“transactionId”: "12344646",
“transactionDate”: “2025-04-15 13:25:00”,
“transactionType”: "payment",
“thirdPartyId”: "money-transfer-0001",
"reverseTransfer": false,
"fee":[
{
"name":"name".
"amount: 50,
"currency": "USD"
}
],
“taxDetail”: [
{
"subtype": "M",
"amount": 25,
"currency": "USD",
"aliquotApplied": 0.05,
"name": "IIBB",
"registerDate": "2025-12-01"
}
]
}Headers
Content-Type: application/jsonBody
{
"uniqueId": "123456789"
}Headers
Content-Type: application/jsonBody
{
"code": "INVALID_CURRENCY",
"message": "Error in field: currency",
"process": "1296929556928090112"
}
{
"code": "NOT_MONEY_AVAILABLE",
"process": "1296928429226545152"
}Collections and Payments - SellerPOST/payments/v1/money/transfer/seller
This service allows deducting available funds to make a payment.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token" |
| organization | String | Acronym of the organization invoking the service |
| account | String | Buyer's account number |
| Field | Type | Description |
|---|---|---|
| originBankIdentification | String | Origin CBU. |
| amount | Number | Amount to invest. |
| grossAmount | Number | Gross Amount. |
| currency | String | Currency |
| totalTaxAmount | Number | Total amount of taxes collected |
| totalFeeAmount | Number | Total fee amount |
| destinationBankIdentificationAmount | Number | Final amount sent to the destination account |
| transactionId | String | Transaction ID |
| transactionDate | String | Transaction date |
| transactionType | String | Transaction type |
| thirdPartyId | Number | Unique external ID. |
| reverseTransfer | Boolean | Flag indicating if it is a reversal. |
| fee | Object |
Object [Fee] see Fee |
| taxDetail | Object |
Object [TaxDetail] see TaxDetail |
| Fee - Object | ||
|---|---|---|
| Field | Type | Description |
| name | String | Fee description |
| amount | Number | Fee amount |
| currency | String | Currency |
| TaxDetail - Object | ||
|---|---|---|
| Field | Type | Description |
| subtype | String | Preferential rate |
| amount | Number | Applied tax amount |
| currency | String | Currency |
| aliquotApplied | Number | Applied rate |
| name | String | Tax name |
| registerDate | String | Collection date |
| Field | Type | Description |
|---|---|---|
| uniqueId | String | Unique ID |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| NOT_MONEY_AVAILABLE | Insufficient funds in the account |
| REQUIRED_FIELD_WITH_NULL_VALUE | Invalid operation. |
| INVALID_CURRENCY | Invalid currency |
| INVALID_AMOUNT | Invalid amount |
| INVALID_BIND_BANK_ACCOUNT_IDENTIFICATION | The destination CBU does not correspond to Banco Industrial |
CAP ¶
Transactional Profile Change ¶
Headers
Content-Type: application/json
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"income_amount": 1000.5,
"upload_date": "2024-10-21T10:00:00Z",
"documents": [
"document1.pdf",
"document2.pdf"
]
}Headers
Content-Type: application/jsonBody
{
"uniqueId": "1265296147712167936"
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
}
{
"code": "LIST_IS_EMPTY",
"message": "Error in field: documents",
"process": "1297923355284295680"
}Transactional Profile ChangePOST/investment-operation-flow/v1/cap/change
Allows changing the transactional profile.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| account | String | Brokerage account number invoking the service. |
| Field | Type | Description |
|---|---|---|
| incomeAmount | Number | Income amount. |
| uploadDate | String | Document upload date |
| documents | Array[String] | List of documents required to perform the profile change |
| Field | Type | Description |
|---|---|---|
| uniqueId | String | Unique ID |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| LIST_IS_EMPTY | Document list is empty |
Trade ¶
Get Buy Order Preview ¶
Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"amount": 1000,
"ticker": "ALUA",
"limitPrice": 50.5,
"operationByAmount": true,
"settlementTerm": "T1",
"type": "LIMIT",
"actions": [
{
"type": "STOP_LOSS",
"amount": 200,
"requiredUserAuthorization": true
}
]
}Headers
Content-Type: application/jsonBody
{
"amount": 5000,
"expensesTotal": 25.5,
"gross": 4981.06,
"net": 4955.56,
"price": 5299
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736"
}Get Buy Order PreviewPOST/trade/v1/trade/BUY/preview
This service provides the expenses of a buy order.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| account | String | Brokerage account number invoking the service. |
| Field | Type | Description |
|---|---|---|
| amount | Number | Amount |
| ticker | String | Ticker |
| limitPrice | Number | Limit price. Do not send if type is MARKET. |
| operationByAmount | Boolean | Indicates if operating by amount. If true, the amount field is mandatory; if false, the quantity field becomes mandatory. |
| quantity | String | Quantity |
| settlementTerm | String (required) | Order term. see values |
| type | String (required) | Indicates if operating by LIMIT or MARKET. LIMIT sets a maximum price for an operation, MARKET allows operating at the price set by the market. Possible values:
|
| actions | Array [Action] | Indicates if it is STOP_LOSS or TAKE_PROFIT |
| Action - Object | ||
|---|---|---|
| Field | Type | Description |
| type | String | Action type Possible values:
|
| amount | Number | Amount |
| requiredUserAuthorization | Boolean | Indicates if user authorization is required |
| Field | Type | Description |
|---|---|---|
| amount | Number | Amount |
| gross | Number | Total expenses of the operation |
| expensesTotal | Number | Expenses (in the currency of the operated instrument) |
| net | Number | Gross amount (in the currency of the operated instrument) |
| price | Number | Price |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
| INSTRUMENT_IDENTIFICATION_NOT_FOUND | The specified instrument was not found. |
| INSUFFICIENT_FUNDS | Insufficient funds. |
| MARKET_CLOSED | The market is closed. |
| MINIMUM_DOLLAR_AMOUNT_ERROR | The dollar amount is less than the minimum allowed. |
| ERROR_DURING_CURRENCY_CONVERSION_PREVIEW | Error validating the instrument price. |
Enter Buy Order ¶
Headers
Content-Type: application/json
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"thirdPartyId": "123456",
"ticker": "ALUA",
"settlementTerm": "T2",
"amount": "12000",
"type": "LIMIT",
"limitPrice": "1500",
"operationByAmount": true,
"actions": [
{
"type": "STOP_LOSS",
"amount": "1100"
}
]
}Headers
Content-Type: application/jsonBody
{
"operationId": "753991010"
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736"
}Headers
Content-Type: application/json
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"thirdPartyId": "123456",
"ticker": "ALUA",
"settlementTerm": "T2",
"quantity": "4",
"type": "LIMIT",
"limitPrice": "1500",
"operationByAmount": false
}Headers
Content-Type: application/jsonBody
{
"operationId": "753991010"
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736"
}Enter Buy OrderPOST/trade/v1/trade/BUY
This service allows entering a buy order.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| account | String | Brokerage account number invoking the service. |
| Field | Type | Description |
|---|---|---|
| thirdPartyId | Number (required) | Unique external ID. |
| ticker | String (required) | Ticker |
| settlementTerm | String (required) | Order term. see values |
| amount | Number | Amount |
| type | String (required) | Order type Possible values:
|
| quantity | Number | Quantity |
| limitPrice | Number | Limit price. Do not send if type is MARKET. |
| operationByAmount | Boolean (required) | Indicates if the operation is by amount |
| actions | Array [Action] | Associated actions see Action |
| Action - Object | ||
|---|---|---|
| Field | Type | Description |
| type | String (required) | Action type Possible values:
|
| amount | Number (required) | Amount |
| Field | Type | Description |
|---|---|---|
| operationId | String | Operation ID. |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
| INSTRUMENT_IDENTIFICATION_NOT_FOUND | The specified instrument was not found. |
| INSUFFICIENT_FUNDS | Insufficient funds. |
| INVALID_AMOUNT_TO_OPERATE | The specified amount to operate is invalid. |
| MARKET_CLOSED | The market is closed. |
| ERROR_DURING_CURRENCY_CONVERSION_PREVIEW | Error validating the instrument price. |
| ERROR_DURING_OPERATION | Error performing the operation. |
Get Sell Order Preview ¶
Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"ticker": "AL30",
"currency": "ARS",
"type": "LIMIT",
"quantity": 94,
"amount": 5000,
"limitPrice": 5299,
"operationByAmount": true,
"settlementTerm": "T1"
}Headers
Content-Type: application/jsonBody
{
"amount": 5000,
"expensesTotal": 25.5,
"gross": 4981.06,
"net": 4955.56,
"price": 5299
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736"
}Get Sell Order PreviewPOST/trade/v1/trade/SELL/preview
This service provides the expenses of a sell order.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| account | String | Brokerage account number invoking the service. |
| Field | Type | Description |
|---|---|---|
| amount | Number | Amount |
| ticker | String | Ticker |
| limitPrice | Number | Limit price. Do not send if type is MARKET. |
| operationByAmount | Boolean | Indicates if operating by amount. If true, the amount field is mandatory; if false, the quantity field becomes mandatory. |
| quantity | Number | Quantity |
| settlementTerm | String (required) | Order term. see values |
| type | String (required) | Indicates if operating by LIMIT or MARKET. LIMIT sets a maximum price for an operation, MARKET allows operating at the price set by the market. Possible values:
|
| Action - Object | ||
|---|---|---|
| Field | Type | Description |
| type | String | Action type Possible values:
|
| amount | Number | Amount |
| requiredUserAuthorization | Boolean | Indicates if user authorization is required |
| Field | Type | Description |
|---|---|---|
| amount | Number | Amount |
| gross | Number | Total expenses of the operation |
| expensesTotal | Number | Expenses (in the currency of the operated instrument) |
| net | Number | Gross amount (in the currency of the operated instrument) |
| price | Number | Price |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
| INSTRUMENT_IDENTIFICATION_NOT_FOUND | The specified instrument was not found. |
| INSUFFICIENT_FUNDS | Insufficient funds. |
| MARKET_CLOSED | The market is closed. |
| MINIMUM_DOLLAR_AMOUNT_ERROR | The dollar amount is less than the minimum allowed. |
| ERROR_DURING_CURRENCY_CONVERSION_PREVIEW | Error validating the instrument price. |
Place Sell Order ¶
Headers
Content-Type: application/json
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"thirdPartyId": "123456",
"ticker": "ALUA",
"settlementTerm": "T2",
"amount": "12000",
"type": "LIMIT",
"limitPrice": "1500",
"operationByAmount": true,
"actions": [
{
"type": "STOP_LOSS",
"amount": "1100"
}
]
}Headers
Content-Type: application/jsonBody
{
"operationId": "753991010"
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736"
}Headers
Content-Type: application/json
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"thirdPartyId": "123456",
"ticker": "ALUA",
"settlementTerm": "T2",
"quantity": "4",
"type": "LIMIT",
"limitPrice": "1500",
"operationByAmount": false
}Headers
Content-Type: application/jsonBody
{
"operationId": "753991010"
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736"
}Place Sell OrderPOST/trade/v1/trade/SELL
This service allows placing a sell order.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| account | String | Brokerage account number invoking the service. |
| Field | Type | Description |
|---|---|---|
| thirdPartyId | Number (required) | Unique external ID. |
| ticker | String (required) | Ticker |
| settlementTerm | String (required) | Order term. see values |
| amount | Number | Amount |
| type | String (required) | Order type Possible values:
|
| quantity | Number | Quantity |
| limitPrice | Number | Limit price. Do not send if type is MARKET. |
| operationByAmount | Boolean (required) | Indicates if the operation is by amount |
| actions | Array [Action] | Associated actions see Action |
| Action - Object | ||
|---|---|---|
| Field | Type | Description |
| type | String (required) | Action type Possible values:
|
| amount | Number (required) | Amount |
| Field | Type | Description |
|---|---|---|
| operationId | String | Operation ID. |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
| INSTRUMENT_IDENTIFICATION_NOT_FOUND | The specified instrument was not found. |
| INSUFFICIENT_FUNDS | Insufficient funds. |
| INVALID_AMOUNT_TO_OPERATE | The specified amount to operate is invalid. |
| MARKET_CLOSED | The market is closed. |
| ERROR_DURING_CURRENCY_CONVERSION_PREVIEW | Error validating the instrument price. |
| ERROR_DURING_OPERATION | Error performing the operation. |
Get Order ¶
Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"id": 32,
"thirdPartyId": "qwepoi",
"operation": "BUY",
"instrumentType": FUND,
"instrumentDescription": "AdCap Ahorro Pesos Fondo de Dinero",
"currency": "ARS",
"date": "2022-03-04T12:48:42",
"state": "PENDING_APPLY",
"amount": 1000.00,
"concretionDate": "2022-03-04",
"settlementTerm": "T2",
"totalWithdraw": false
}Body
{
"code": "GENERAL_ERROR",
"process": "948595173290356736"
}Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"id": 32,
"thirdPartyId": "qwepoi",
"operation": "BUY",
"instrumentType": FUND,
"instrumentDescription": "AdCap Ahorro Pesos Fondo de Dinero",
"currency": "ARS",
"date": "2022-03-04T12:48:42",
"state": "PENDING_APPLY",
"concretionDate": "2022-03-04",
"settlementTerm": "T2",
"totalWithdraw": true
}Body
{
"code": "GENERAL_ERROR",
"process": "948595173290356736"
}Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"id": 32,
"thirdPartyId": "qwepoi",
"operation": "BUY",
"instrumentType": FUND,
"instrumentDescription": "AdCap Ahorro Pesos Fondo de Dinero",
"currency": "ARS",
"date": "2022-03-04T12:48:42",
"state": "FILLED",
"concretionDate": "2022-03-04",
"settlementTerm": "T2",
"price": 1.8846780000,
"amount": 1000.00,
"totalWithdraw": false
}Body
{
"code": "GENERAL_ERROR",
"process": "948595173290356736"
}Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"id": 32,
"thirdPartyId": "qwepoi",
"operation": "BUY",
"instrumentType": EQUITY,
"ticker": "YPF",
"instrumentDescription": "YPF",
"currency": "ARS",
"date": "2022-03-04T12:48:42",
"state": "PENDING_APPLY",
"price": 1.8846780000,
"amount": 1000.0000000000,
"leavesQuantity": 1,
"cumQuantity": 1,
"quantity": 1,
"concretionDate": "2022-03-04",
"settlementTerm": "T2"
}Body
{
"code": "GENERAL_ERROR",
"process": "948595173290356736"
}Get OrderGET/trade/v1/order/
This service provides the status and detail of an order.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| account | String | Brokerage account number invoking the service. |
| Field | Type | Description |
|---|---|---|
| orderId | String | Unique identifier for the order. It can be a thirdPartyId or uniqueId. |
| Field | Type | Description |
|---|---|---|
| id | Number | Order ID. |
| thirdPartyId | String | External ID referencing the order. |
| operation | String | Indicates the operation type. Possible values:
|
| instrumentType | String | Indicates the instrument type. see values |
| ticker | String | Instrument identification in the market |
| instrumentDescription | String | Instrument description. |
| currency | String | Currency. |
| date | String | Date the order was issued. |
| state | String | Order state. Possible values:
|
| price | Number | Order price |
| amount | Number | Amount bought |
| leavesQuantity | Number | Quantity still remaining to operate |
| cumQuantity | Number | Quantity already operated |
| quantity | Number | Total quantity |
| concretionDate | String | Date the order is processed |
| settlementTerm | String | Execution term of the order. see values |
| totalWithdraw | Boolean | Indicates if it is total redemption. |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
Cancel Order ¶
Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736"
}Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736"
}Cancel OrderDELETE/trade/v1/order/
This service allows canceling an order.
| Field | Type | Description |
|---|---|---|
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| account | String | Brokerage account number invoking the service. |
| Field | Type | Description |
|---|---|---|
| orderId | String | Unique identifier for the order. It can be a thirdPartyId or uniqueId. |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
Mutual Funds ¶
Place Subscription ¶
Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"instrument": "ADAR-FCI.1195",
"currency": "ARS",
"amount": 50000,
"thirdPartyId": "323ewqewqe"
}Headers
Content-Type: application/jsonBody
{
"operationType": "FUND",
"operationId": "412412411"
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736"
}Place SubscriptionPOST/trade/v1/fund/BUY
This service allows making a subscription to a specific Mutual Fund (FCI).
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| account | String | Brokerage account number invoking the service. |
| Field | Type | Description |
|---|---|---|
| instrument | String | Instrument code. This code can be obtained from the Mutual Fund (FCI) instruments query, from the "code" attribute in the response. |
| currency | String | Currency |
| amount | Number | Amount |
| thirdPartyId | Number (required) | Unique external ID. |
| Field | Type | Description |
|---|---|---|
| operationId | String | Operation ID. |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
| INSTRUMENT_IDENTIFICATION_NOT_FOUND | The specified instrument was not found. |
| INSUFFICIENT_FUNDS | Insufficient funds. |
| INVALID_AMOUNT_TO_OPERATE | The specified amount to operate is invalid. |
Place Redemption ¶
Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"instrument": "ADAR-FCI.1195",
"currency": "ARS",
"amount": 50000,
"thirdPartyId": "3ewewq312312"
}Headers
Content-Type: application/jsonBody
{
"operationType": "FUND",
"operationId": "412412411"
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736"
}Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"instrument": "1071",
"currency": "ARS",
"totalWithdraw": true,
"thirdPartyId": "3ewewq312312"
}Headers
Content-Type: application/jsonBody
{
"operationType": "FUND",
"operationId": "412412411"
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736"
}Place RedemptionPOST/trade/v1/fund/SELL
This service allows making a redemption from a specific Mutual Fund (FCI).
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| account | String | Brokerage account number invoking the service. |
| Field | Type | Description |
|---|---|---|
| instrument | String | Instrument code. This code can be obtained from the Mutual Fund (FCI) instruments query, from the "code" attribute in the response. |
| currency | String | Operation currency. |
| amount | Number | Operation amount. |
| totalWithdraw | Boolean | Indicates if it is a total redemption. If provided, the 'amount' attribute should not be sent as it will be ignored. |
| Field | Type | Description |
|---|---|---|
| operationType | String | Operation type. Possible values:
|
| operationId | String | Operation ID. |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
| INSTRUMENT_IDENTIFICATION_NOT_FOUND | The specified instrument was not found. |
| INSUFFICIENT_FUNDS | Insufficient funds. |
| INVALID_AMOUNT_TO_OPERATE | The specified amount to operate is invalid. |
Get Order ¶
Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"id": 32,
"thirdPartyId": "qwepoi",
"operation": "BUY",
"instrumentType": FUND,
"instrumentDescription": "AdCap Ahorro Pesos Fondo de Dinero",
"currency": "ARS",
"date": "2022-03-04T12:48:42",
"state": "PENDING_APPLY",
"amount": 1000.00,
"concretionDate": "2022-03-04",
"settlementTerm": "T2",
"totalWithdraw": false
}Body
{
"code": "GENERAL_ERROR",
"process": "948595173290356736"
}Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"id": 32,
"thirdPartyId": "qwepoi",
"operation": "BUY",
"instrumentType": FUND,
"instrumentDescription": "AdCap Ahorro Pesos Fondo de Dinero",
"currency": "ARS",
"date": "2022-03-04T12:48:42",
"state": "PENDING_APPLY",
"concretionDate": "2022-03-04",
"settlementTerm": "T2",
"totalWithdraw": true
}Body
{
"code": "GENERAL_ERROR",
"process": "948595173290356736"
}Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"id": 32,
"thirdPartyId": "qwepoi",
"operation": "BUY",
"instrumentType": FUND,
"instrumentDescription": "AdCap Ahorro Pesos Fondo de Dinero",
"currency": "ARS",
"date": "2022-03-04T12:48:42",
"state": "FILLED",
"concretionDate": "2022-03-04",
"settlementTerm": "T2",
"price": 1.8846780000,
"amount": 1000.00,
"totalWithdraw": false
}Body
{
"code": "GENERAL_ERROR",
"process": "948595173290356736"
}Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"id": 32,
"thirdPartyId": "qwepoi",
"operation": "BUY",
"instrumentType": EQUITY,
"ticker": "YPF",
"instrumentDescription": "YPF",
"currency": "ARS",
"date": "2022-03-04T12:48:42",
"state": "PENDING_APPLY",
"price": 1.8846780000,
"amount": 1000.0000000000,
"leavesQuantity": 1,
"cumQuantity": 1,
"quantity": 1,
"concretionDate": "2022-03-04",
"settlementTerm": "T2"
}Body
{
"code": "GENERAL_ERROR",
"process": "948595173290356736"
}Get OrderGET/trade/v1/order/
This service provides the status and detail of an order.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| account | String | Brokerage account number invoking the service. |
| Field | Type | Description |
|---|---|---|
| orderId | String | Unique identifier for the order. It can be a thirdPartyId or uniqueId. |
| Field | Type | Description |
|---|---|---|
| id | Number | Order ID. |
| thirdPartyId | String | External ID referencing the order. |
| operation | String | Indicates the type of operation. Possible values:
|
| instrumentType | String | Indicates the instrument type. see values |
| ticker | String | Instrument identification in the market |
| instrumentDescription | String | Instrument description. |
| currency | String | Currency. |
| date | String | Date the order was issued. |
| state | String | Order status. Possible values:
|
| price | Number | Order price |
| amount | Number | Purchased quantity |
| leavesQuantity | Number | Quantity remaining to be operated |
| cumQuantity | Number | Quantity already operated |
| quantity | Number | Total quantity |
| concretionDate | String | Date the order is processed |
| settlementTerm | String | Order execution term. see values |
| totalWithdraw | Boolean | Indicates if it is a total redemption. |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
Cancel Order ¶
Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736"
}Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20ABody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736"
}Cancel OrderDELETE/trade/v1/order/
This service allows canceling an order.
| Field | Type | Description |
|---|---|---|
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token". |
| organization | String | Acronym of the organization invoking the service. |
| account | String | Brokerage account number invoking the service. |
| Field | Type | Description |
|---|---|---|
| orderId | String | Unique identifier for the order. It can be a thirdPartyId or uniqueId. |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
Portfolio ¶
Asset Query ¶
Headers
organization: ADAR
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20AHeaders
Content-Type: application/jsonBody
[
{
"instrumentTicker": "BONO REP ARG USD STEP UP 2030",
"instrumentName": "BONO REP ARG USD STEP UP 2030",
"currency": "ARS",
"price": 57.3,
"quantity": 4723,
"available": 4723,
"pendingSettlements": false,
"availability": [
{
"term": "T1",
"quantity": 4723,
"monetaryValue": {
"currency": "ARS",
"amount": 270627.9
}
},
{
"term": "T3",
"quantity": 4723,
"monetaryValue": {
"currency": "ARS",
"amount": 270627.9
}
},
{
"term": "T2",
"quantity": 4723,
"monetaryValue": {
"currency": "ARS",
"amount": 270627.9
}
},
{
"term": "T0",
"quantity": 4723,
"monetaryValue": {
"currency": "ARS",
"amount": 270627.9
}
}
],
"monetaryValue": {
"currency": "ARS",
"amount": 270627.9
},
"hasRelatedActions": false
}
]Asset queryGET/portfolio/v1/assets
This API allows querying the assets of an account.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token" |
| organization | String | Acronym of the organization invoking the service |
| account | String | Account number invoking the service |
| Array [Asset] |
|---|
| A list of the Asset object is returned |
| Asset - Object | ||
|---|---|---|
| Field | Type | Description |
| ticker | String | Instrument identification in the market |
| name | String | Instrument name |
| type | String | Indicates the instrument type |
| Clazz | String | Class Only applies to instruments of type FUND |
| currency | String | Currency |
| price | String | Price |
| quantity | Number | Quantity |
| available | Number | Available |
| availability | Array [AssetAvailability] | List of available terms see AssetAvailability |
| quantityDetail | Object [QuantityDetail] | Quantity detail see QuantityDetail |
| AssetAvailability - Object | ||
|---|---|---|
| Field | Type | Description |
| term | String | Term |
| quantity | number | Quantity |
| monetaryValue | Object [Money] | Money detail see Money |
| QuantityDetail - Object | ||
|---|---|---|
| Field | Type | Description |
| total | number | Total |
| available | number | Available |
| blocked | number | Blocked quantity |
| Money - Object | ||
|---|---|---|
| Field | Type | Description |
| currency | string | Currency |
| amount | number | Quantity |
Query Available Balance ¶
Headers
organization: <organization>
account: 101357
Authorization: JWT eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJBREFSL2pvZWxwY250QG1haWxpbmF0b3IuY29tIiwib3MiOiJVTktOT1dOIiwib3JnIjoiQURBUiIsImNyZWF0ZWQiOjE2NDM4MzQyNDE3MzEsImJybyI6IlVOS05PV04ifQ.dk4JkEe0c5Ed7NbweA7tHfgSADO4av8_v0cFnmBzj_8IUA094eZ8GgPBVaKwngmmpU6avX98yQepShgaK9p20AHeaders
Content-Type: application/jsonBody
{
"T0": [
{
"currency": "ARS",
"amount": 50000
},
{
"currency": "USD",
"amount": 10000
}
],
"T1": [
{
"currency": "ARS",
"amount": 98000
},
{
"currency": "USD",
"amount": 12000
}
],
"T2": [
{
"currency": "ARS",
"amount": 99000
},
{
"currency": "USD",
"amount": 12000
}
]
}Headers
Content-Type: application/jsonBody
{
"code": "GENERAL_ERROR",
"process": "948595173290356736"
}Query available balance to operateGET/portfolio/v1/balances/available
The available balance to operate is queried.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | application/json |
| Authorization | String | Contains the authentication JWT Allowed values: "JWT :token" |
| organization | String | Acronym of the organization invoking the service |
| account | String | Account number invoking the service |
| Field | Type | Description |
|---|---|---|
| T0 | Object [Available] | Represents the available balance to operate in CI (Settled) see Available |
| T1 | Object [Available] | Represents the available balance to operate in 24h see Available |
| T2 | Object [Available] | Represents the available balance to operate in 48h see Available |
| Available - Object | ||
|---|---|---|
| Field | Type | Description |
| currency | String | Currency |
| amount | Number | Amount |
| Code | Description |
|---|---|
| GENERAL_ERROR | Generic error. |
| INVALID_LOGIN | Invalid access. |
Errors ¶
Format
All controlled errors return HTTP 409 and the following response format:
{
"code": "GENERAL_ERROR",
"process": "948595173290356736",
"message": "You must enter a valid date"
}
Code Appendix ¶
Income Tax Status
| Code | Description |
|---|---|
| EXE | Exempt |
| INS | Registered |
| NOINS | Not Registered |
VAT Status
| Code | Description |
|---|---|
| RI | Registered Responsible |
| RNI | Non-Registered Responsible |
| EX | Exempt |
| RM | Monotax Responsible |
| CF | Final Consumer |
Provinces
| Code | Description |
|---|---|
| AR-C | Autonomous City of Buenos Aires |
| AR-B | Buenos Aires |
| AR-K | Catamarca |
| AR-H | Chaco |
| AR-U | Chubut |
| AR-X | Cordoba |
| AR-W | Corrientes |
| AR-E | Entre Rios |
| AR-P | Formosa |
| AR-Y | Jujuy |
| AR-L | La Pampa |
| AR-F | La Rioja |
| AR-M | Mendoza |
| AR-N | Misiones |
| AR-Q | Neuquen |
| AR-R | Rio Negro |
| AR-A | Salta |
| AR-J | San Juan |
| AR-D | San Luis |
| AR-Z | Santa Cruz |
| AR-S | Santa Fe |
| AR-G | Santiago del Estero |
| AR-V | Tierra del Fuego, Antarctica and South Atlantic Islands |
| AR-T | Tucuman |
Countries
| Code | Description |
|---|---|
| AF | Afghanistan |
| AX | Åland Islands |
| AL | Albania |
| DZ | Algeria |
| AS | American Samoa |
| AD | Andorra |
| AO | Angola |
| AI | Anguilla |
| AQ | Antarctica |
| AG | Antigua and Barbuda |
| AR | Argentina |
| AM | Armenia |
| AW | Aruba |
| AU | Australia |
| AT | Austria |
| AZ | Azerbaijan |
| BS | Bahamas |
| BH | Bahrain |
| BD | Bangladesh |
| BB | Barbados |
| BY | Belarus |
| BE | Belgium |
| BZ | Belize |
| BJ | Benin |
| BM | Bermuda |
| BT | Bhutan |
| BO | Bolivia |
| BA | Bosnia and Herzegovina |
| BW | Botswana |
| BV | Bouvet Island |
| BR | Brazil |
| IO | British Indian Ocean Territory |
| BN | Brunei Darussalam |
| BG | Bulgaria |
| BF | Burkina Faso |
| BI | Burundi |
| KH | Cambodia |
| CM | Cameroon |
| CA | Canada |
| CV | Cape Verde |
| KY | Cayman Islands |
| CF | Central African Republic |
| TD | Chad |
| CL | Chile |
| CN | China |
| CX | Christmas Island |
| CC | Cocos (Keeling) Islands |
| CO | Colombia |
| KM | Comoros |
| CG | Congo |
| CD | Congo, The Democratic Republic of the |
| CK | Cook Islands |
| CR | Costa Rica |
| CI | Cote D'Ivoire |
| HR | Croatia |
| CU | Cuba |
| CY | Cyprus |
| CZ | Czech Republic |
| DK | Denmark |
| DJ | Djibouti |
| DM | Dominica |
| DO | Dominican Republic |
| EC | Ecuador |
| EG | Egypt |
| SV | El Salvador |
| GQ | Equatorial Guinea |
| ER | Eritrea |
| EE | Estonia |
| ET | Ethiopia |
| FK | Falkland Islands (Malvinas) |
| FO | Faroe Islands |
| FJ | Fiji |
| FI | Finland |
| FR | France |
| GF | French Guiana |
| PF | French Polynesia |
| TF | French Southern Territories |
| GA | Gabon |
| GM | Gambia |
| GE | Georgia |
| DE | Germany |
| GH | Ghana |
| GI | Gibraltar |
| GR | Greece |
| GL | Greenland |
| GD | Grenada |
| GP | Guadeloupe |
| GU | Guam |
| GT | Guatemala |
| GG | Guernsey |
| GN | Guinea |
| GW | Guinea-Bissau |
| GY | Guyana |
| HT | Haiti |
| HM | Heard Island and Mcdonald Islands |
| VA | Holy See (Vatican City State) |
| HN | Honduras |
| HK | Hong Kong |
| HU | Hungary |
| IS | Iceland |
| IN | India |
| ID | Indonesia |
| IR | Iran, Islamic Republic Of |
| IQ | Iraq |
| IE | Ireland |
| IM | Isle of Man |
| IL | Israel |
| IT | Italy |
| JM | Jamaica |
| JP | Japan |
| JE | Jersey |
| JO | Jordan |
| KZ | Kazakhstan |
| KE | Kenya |
| KI | Kiribati |
| KP | Korea, Democratic People's Republic of |
| KR | Korea, Republic of |
| KW | Kuwait |
| KG | Kyrgyzstan |
| LA | Lao People's Democratic Republic |
| LV | Latvia |
| LB | Lebanon |
| LS | Lesotho |
| LR | Liberia |
| LY | Libyan Arab Jamahiriya |
| LI | Liechtenstein |
| LT | Lithuania |
| LU | Luxembourg |
| MO | Macao |
| MK | Macedonia, The Former Yugoslav Republic of |
| MG | Madagascar |
| MW | Malawi |
| MY | Malaysia |
| MV | Maldives |
| ML | Mali |
| MT | Malta |
| MH | Marshall Islands |
| MQ | Martinique |
| MR | Mauritania |
| MU | Mauritius |
| YT | Mayotte |
| MX | Mexico |
| FM | Micronesia, Federated States of |
| MD | Moldova, Republic of |
| MC | Monaco |
| MN | Mongolia |
| MS | Montserrat |
| MA | Morocco |
| MZ | Mozambique |
| MM | Myanmar |
| NA | Namibia |
| NR | Nauru |
| NP | Nepal |
| NL | Netherlands |
| AN | Netherlands Antilles |
| NC | New Caledonia |
| NZ | New Zealand |
| NI | Nicaragua |
| NE | Niger |
| NG | Nigeria |
| NU | Niue |
| NF | Norfolk Island |
| MP | Northern Mariana Islands |
| NO | Norway |
| OM | Oman |
| PK | Pakistan |
| PW | Palau |
| PS | Palestinian Territory, Occupied |
| PA | Panama |
| PG | Papua New Guinea |
| PY | Paraguay |
| PE | Peru |
| PH | Philippines |
| PN | Pitcairn |
| PL | Poland |
| PT | Portugal |
| PR | Puerto Rico |
| QA | Qatar |
| RE | Reunion |
| RO | Romania |
| RU | Russian Federation |
| RW | RWANDA |
| SH | Saint Helena |
| KN | Saint Kitts and Nevis |
| LC | Saint Lucia |
| PM | Saint Pierre and Miquelon |
| VC | Saint Vincent and the Grenadines |
| WS | Samoa |
| SM | San Marino |
| ST | Sao Tome and Principe |
| SA | Saudi Arabia |
| SN | Senegal |
| CS | Serbia and Montenegro |
| SC | Seychelles |
| SL | Sierra Leone |
| SG | Singapore |
| SK | Slovakia |
| SI | Slovenia |
| SB | Solomon Islands |
| SO | Somalia |
| ZA | South Africa |
| GS | South Georgia and the South Sandwich Islands |
| ES | Spain |
| LK | Sri Lanka |
| SD | Sudan |
| SR | Suriname |
| SJ | Svalbard and Jan Mayen |
| SZ | Swaziland |
| SE | Sweden |
| CH | Switzerland |
| SY | Syrian Arab Republic |
| TW | Taiwan, Province of China |
| TJ | Tajikistan |
| TZ | Tanzania, United Republic of |
| TH | Thailand |
| TL | Timor-Leste |
| TG | Togo |
| TK | Tokelau |
| TO | Tonga |
| TT | Trinidad and Tobago |
| TN | Tunisia |
| TR | Turkey |
| TM | Turkmenistan |
| TC | Turks and Caicos Islands |
| TV | Tuvalu |
| UG | Uganda |
| UA | Ukraine |
| AE | United Arab Emirates |
| GB | United Kingdom |
| US | United States |
| UM | United States Minor Outlying Islands |
| UY | Uruguay |
| UZ | Uzbekistan |
| VU | Vanuatu |
| VE | Venezuela |
| VN | Viet Nam |
| VG | Virgin Islands, British |
| VI | Virgin Islands, U.S. |
| WF | Wallis and Futuna |
| EH | Western Sahara |
| YE | Yemen |
| ZM | Zambia |
| ZW | Zimbabwe |
Instrument Types
| Code | Description |
|---|---|
| EQUITY | Stock |
| CERTIFICATE | Cedear |
| BOND | Bond |
Affidavit Formats
| Code | Description |
|---|---|
| PLAIN_TEXT | Affidavit in plain text format. |
| LINK | Link to the affidavit in PDF format. |
| PDF file of the affidavit. | |
| HTML | Affidavit in HTML format. |
Settlement Terms
| Code | Description |
|---|---|
| T0 | I.C. (Immediate Cash) |
| T1 | 24hrs |
| T2 | 48hrs |
Account States
| Code | Description |
|---|---|
| INACTIVE | Inactive |
| ACTIVE | Active |
Generated by aglio on 05 May 2026