Create or update multiple transactions by external ID
curl --request PUT \
--url https://api.artu.ai/transactions/batch/external \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Environment: <api-key>' \
--data '
{
"items": [
{
"amount": 123,
"currency": "<string>",
"relatedClientIds": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"timestamp": "2023-11-07T05:31:56Z",
"externalId": "<string>",
"scopes": [],
"status": "not_applicable",
"exchangeRates": {},
"description": "<string>",
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"scopeData": {
"MX": {
"actividadVulnerable": {
"AVI": {
"operationType": "buy",
"hash": "<string>",
"cryptoCurrency": "<string>",
"cryptoAmount": 1
},
"JYS": {
"branchInformation": {
"type": "<unknown>",
"postalCode": "<unknown>"
},
"settlementType": "cash"
}
},
"cnbv": {}
},
"US": "<unknown>"
}
}
],
"atomic": true
}
'import requests
url = "https://api.artu.ai/transactions/batch/external"
payload = {
"items": [
{
"amount": 123,
"currency": "<string>",
"relatedClientIds": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"timestamp": "2023-11-07T05:31:56Z",
"externalId": "<string>",
"scopes": [],
"status": "not_applicable",
"exchangeRates": {},
"description": "<string>",
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"scopeData": {
"MX": {
"actividadVulnerable": {
"AVI": {
"operationType": "buy",
"hash": "<string>",
"cryptoCurrency": "<string>",
"cryptoAmount": 1
},
"JYS": {
"branchInformation": {
"type": "<unknown>",
"postalCode": "<unknown>"
},
"settlementType": "cash"
}
},
"cnbv": {}
},
"US": "<unknown>"
}
}
],
"atomic": True
}
headers = {
"Authorization": "Bearer <token>",
"X-Environment": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
Authorization: 'Bearer <token>',
'X-Environment': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
items: [
{
amount: 123,
currency: '<string>',
relatedClientIds: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
timestamp: '2023-11-07T05:31:56Z',
externalId: '<string>',
scopes: [],
status: 'not_applicable',
exchangeRates: {},
description: '<string>',
productId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
metadata: {},
scopeData: {
MX: {
actividadVulnerable: {
AVI: {
operationType: 'buy',
hash: '<string>',
cryptoCurrency: '<string>',
cryptoAmount: 1
},
JYS: {
branchInformation: {type: '<unknown>', postalCode: '<unknown>'},
settlementType: 'cash'
}
},
cnbv: {}
},
US: '<unknown>'
}
}
],
atomic: true
})
};
fetch('https://api.artu.ai/transactions/batch/external', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.artu.ai/transactions/batch/external",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'items' => [
[
'amount' => 123,
'currency' => '<string>',
'relatedClientIds' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'timestamp' => '2023-11-07T05:31:56Z',
'externalId' => '<string>',
'scopes' => [
],
'status' => 'not_applicable',
'exchangeRates' => [
],
'description' => '<string>',
'productId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'metadata' => [
],
'scopeData' => [
'MX' => [
'actividadVulnerable' => [
'AVI' => [
'operationType' => 'buy',
'hash' => '<string>',
'cryptoCurrency' => '<string>',
'cryptoAmount' => 1
],
'JYS' => [
'branchInformation' => [
'type' => '<unknown>',
'postalCode' => '<unknown>'
],
'settlementType' => 'cash'
]
],
'cnbv' => [
]
],
'US' => '<unknown>'
]
]
],
'atomic' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Environment: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.artu.ai/transactions/batch/external"
payload := strings.NewReader("{\n \"items\": [\n {\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"relatedClientIds\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"externalId\": \"<string>\",\n \"scopes\": [],\n \"status\": \"not_applicable\",\n \"exchangeRates\": {},\n \"description\": \"<string>\",\n \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {},\n \"scopeData\": {\n \"MX\": {\n \"actividadVulnerable\": {\n \"AVI\": {\n \"operationType\": \"buy\",\n \"hash\": \"<string>\",\n \"cryptoCurrency\": \"<string>\",\n \"cryptoAmount\": 1\n },\n \"JYS\": {\n \"branchInformation\": {\n \"type\": \"<unknown>\",\n \"postalCode\": \"<unknown>\"\n },\n \"settlementType\": \"cash\"\n }\n },\n \"cnbv\": {}\n },\n \"US\": \"<unknown>\"\n }\n }\n ],\n \"atomic\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Environment", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.artu.ai/transactions/batch/external")
.header("Authorization", "Bearer <token>")
.header("X-Environment", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"relatedClientIds\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"externalId\": \"<string>\",\n \"scopes\": [],\n \"status\": \"not_applicable\",\n \"exchangeRates\": {},\n \"description\": \"<string>\",\n \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {},\n \"scopeData\": {\n \"MX\": {\n \"actividadVulnerable\": {\n \"AVI\": {\n \"operationType\": \"buy\",\n \"hash\": \"<string>\",\n \"cryptoCurrency\": \"<string>\",\n \"cryptoAmount\": 1\n },\n \"JYS\": {\n \"branchInformation\": {\n \"type\": \"<unknown>\",\n \"postalCode\": \"<unknown>\"\n },\n \"settlementType\": \"cash\"\n }\n },\n \"cnbv\": {}\n },\n \"US\": \"<unknown>\"\n }\n }\n ],\n \"atomic\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.artu.ai/transactions/batch/external")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Environment"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"relatedClientIds\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"externalId\": \"<string>\",\n \"scopes\": [],\n \"status\": \"not_applicable\",\n \"exchangeRates\": {},\n \"description\": \"<string>\",\n \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {},\n \"scopeData\": {\n \"MX\": {\n \"actividadVulnerable\": {\n \"AVI\": {\n \"operationType\": \"buy\",\n \"hash\": \"<string>\",\n \"cryptoCurrency\": \"<string>\",\n \"cryptoAmount\": 1\n },\n \"JYS\": {\n \"branchInformation\": {\n \"type\": \"<unknown>\",\n \"postalCode\": \"<unknown>\"\n },\n \"settlementType\": \"cash\"\n }\n },\n \"cnbv\": {}\n },\n \"US\": \"<unknown>\"\n }\n }\n ],\n \"atomic\": true\n}"
response = http.request(request)
puts response.read_body{
"atomic": true,
"data": [
{
"data": {
"relatedClientIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"scopes": [
"base"
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"timestamp": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"isAlerted": true,
"alertedAt": "2023-11-07T05:31:56Z",
"status": "not_applicable",
"amount": "<unknown>",
"currency": "<unknown>",
"exchangeRates": {},
"externalId": "<string>",
"description": "<string>",
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"scopeData": {
"MX": {
"actividadVulnerable": {
"ARI": {
"property": {
"type": "1",
"leaseStartDate": "2023-12-25",
"leaseEndDate": "2023-12-25",
"colonia": "<string>",
"calle": "<string>",
"numeroExterior": "<string>",
"postalCode": "<string>",
"folioReal": "<string>",
"value": "<unknown>",
"numeroInterior": "<string>"
},
"payments": [
{
"paymentDate": "<unknown>",
"paymentForm": "<unknown>",
"monetaryInstrument": "<unknown>",
"currency": "<unknown>",
"amount": "<unknown>"
}
],
"operationType": "1501"
},
"AVI": {
"operationType": "buy",
"cryptoCurrency": "<string>",
"hash": "<unknown>",
"cryptoAmount": "<unknown>"
},
"INM": {
"figuraCliente": "1",
"figuraSO": "1",
"inmuebles": [
{
"type": "<unknown>",
"value": "<unknown>",
"colonia": "<unknown>",
"calle": "<unknown>",
"numeroExterior": "<unknown>",
"numeroInterior": "<unknown>",
"postalCode": "<unknown>",
"dimensionTerreno": "<unknown>",
"dimensionConstruido": "<unknown>",
"folioReal": "<unknown>"
}
],
"contract": {
"type": "<unknown>",
"instrumentNumber": "<unknown>",
"instrumentDate": "<unknown>",
"notaryNumber": "<unknown>",
"notaryStateCode": "<unknown>",
"cadastralValue": "<unknown>"
},
"operationType": "501",
"payments": [
{
"paymentDate": "<unknown>",
"paymentForm": "<unknown>",
"monetaryInstrument": "<unknown>",
"currency": "<unknown>",
"amount": "<unknown>"
}
]
},
"JYS": {
"operationType": "101",
"businessLine": "1",
"operationMethod": "1",
"settlementType": "cash",
"monetaryInstrument": "1",
"branchInformation": "<unknown>"
},
"MJR": {
"operationPostalCode": "<string>",
"goods": [
{
"goodType": "<unknown>",
"unit": "<unknown>",
"quantity": "<unknown>"
}
],
"payments": [
{
"paymentDate": "<unknown>",
"paymentForm": "<unknown>",
"monetaryInstrument": "<unknown>",
"currency": "<unknown>",
"amount": "<unknown>"
}
],
"operationType": "601"
},
"MPC": {
"operationType": "401",
"postalCode": "<string>",
"disbursements": [
{
"disbursementDate": "<unknown>",
"monetaryInstrument": "<unknown>",
"currency": "<unknown>",
"amount": "<unknown>"
}
],
"collateral": [
{
"tipoGarantia": "<unknown>",
"bienMutuo": "<unknown>",
"guarantorClientId": "<unknown>"
}
]
},
"TSC": {
"cardType": "1",
"idNumber": "<string>",
"operationType": "211"
},
"VEH": {
"operationType": "801",
"postalCode": "<string>",
"vehicles": [
null
],
"operationDate": "2023-12-25",
"payments": [
{
"paymentDate": "<unknown>",
"paymentForm": "<unknown>",
"monetaryInstrument": "<unknown>",
"currency": "<unknown>",
"amount": "<unknown>"
}
]
}
},
"cnbv": {
"TRANSMISOR": {
"tipoOperacion": "00",
"instrumentoMonetario": "00",
"sucursal": "<string>",
"localidad": "10100005"
}
}
},
"US": "<unknown>"
},
"relatedClients": [
{
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"role": "base",
"metadata": {}
}
],
"riskAssessments": {},
"tags": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"color": "<string>"
}
]
},
"action": "created"
}
]
}Transactions
Create or update multiple transactions by external ID
PUT
/
transactions
/
batch
/
external
Create or update multiple transactions by external ID
curl --request PUT \
--url https://api.artu.ai/transactions/batch/external \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Environment: <api-key>' \
--data '
{
"items": [
{
"amount": 123,
"currency": "<string>",
"relatedClientIds": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"timestamp": "2023-11-07T05:31:56Z",
"externalId": "<string>",
"scopes": [],
"status": "not_applicable",
"exchangeRates": {},
"description": "<string>",
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"scopeData": {
"MX": {
"actividadVulnerable": {
"AVI": {
"operationType": "buy",
"hash": "<string>",
"cryptoCurrency": "<string>",
"cryptoAmount": 1
},
"JYS": {
"branchInformation": {
"type": "<unknown>",
"postalCode": "<unknown>"
},
"settlementType": "cash"
}
},
"cnbv": {}
},
"US": "<unknown>"
}
}
],
"atomic": true
}
'import requests
url = "https://api.artu.ai/transactions/batch/external"
payload = {
"items": [
{
"amount": 123,
"currency": "<string>",
"relatedClientIds": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"timestamp": "2023-11-07T05:31:56Z",
"externalId": "<string>",
"scopes": [],
"status": "not_applicable",
"exchangeRates": {},
"description": "<string>",
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"scopeData": {
"MX": {
"actividadVulnerable": {
"AVI": {
"operationType": "buy",
"hash": "<string>",
"cryptoCurrency": "<string>",
"cryptoAmount": 1
},
"JYS": {
"branchInformation": {
"type": "<unknown>",
"postalCode": "<unknown>"
},
"settlementType": "cash"
}
},
"cnbv": {}
},
"US": "<unknown>"
}
}
],
"atomic": True
}
headers = {
"Authorization": "Bearer <token>",
"X-Environment": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
Authorization: 'Bearer <token>',
'X-Environment': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
items: [
{
amount: 123,
currency: '<string>',
relatedClientIds: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
timestamp: '2023-11-07T05:31:56Z',
externalId: '<string>',
scopes: [],
status: 'not_applicable',
exchangeRates: {},
description: '<string>',
productId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
metadata: {},
scopeData: {
MX: {
actividadVulnerable: {
AVI: {
operationType: 'buy',
hash: '<string>',
cryptoCurrency: '<string>',
cryptoAmount: 1
},
JYS: {
branchInformation: {type: '<unknown>', postalCode: '<unknown>'},
settlementType: 'cash'
}
},
cnbv: {}
},
US: '<unknown>'
}
}
],
atomic: true
})
};
fetch('https://api.artu.ai/transactions/batch/external', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.artu.ai/transactions/batch/external",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'items' => [
[
'amount' => 123,
'currency' => '<string>',
'relatedClientIds' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'timestamp' => '2023-11-07T05:31:56Z',
'externalId' => '<string>',
'scopes' => [
],
'status' => 'not_applicable',
'exchangeRates' => [
],
'description' => '<string>',
'productId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'metadata' => [
],
'scopeData' => [
'MX' => [
'actividadVulnerable' => [
'AVI' => [
'operationType' => 'buy',
'hash' => '<string>',
'cryptoCurrency' => '<string>',
'cryptoAmount' => 1
],
'JYS' => [
'branchInformation' => [
'type' => '<unknown>',
'postalCode' => '<unknown>'
],
'settlementType' => 'cash'
]
],
'cnbv' => [
]
],
'US' => '<unknown>'
]
]
],
'atomic' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Environment: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.artu.ai/transactions/batch/external"
payload := strings.NewReader("{\n \"items\": [\n {\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"relatedClientIds\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"externalId\": \"<string>\",\n \"scopes\": [],\n \"status\": \"not_applicable\",\n \"exchangeRates\": {},\n \"description\": \"<string>\",\n \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {},\n \"scopeData\": {\n \"MX\": {\n \"actividadVulnerable\": {\n \"AVI\": {\n \"operationType\": \"buy\",\n \"hash\": \"<string>\",\n \"cryptoCurrency\": \"<string>\",\n \"cryptoAmount\": 1\n },\n \"JYS\": {\n \"branchInformation\": {\n \"type\": \"<unknown>\",\n \"postalCode\": \"<unknown>\"\n },\n \"settlementType\": \"cash\"\n }\n },\n \"cnbv\": {}\n },\n \"US\": \"<unknown>\"\n }\n }\n ],\n \"atomic\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Environment", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.artu.ai/transactions/batch/external")
.header("Authorization", "Bearer <token>")
.header("X-Environment", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"relatedClientIds\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"externalId\": \"<string>\",\n \"scopes\": [],\n \"status\": \"not_applicable\",\n \"exchangeRates\": {},\n \"description\": \"<string>\",\n \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {},\n \"scopeData\": {\n \"MX\": {\n \"actividadVulnerable\": {\n \"AVI\": {\n \"operationType\": \"buy\",\n \"hash\": \"<string>\",\n \"cryptoCurrency\": \"<string>\",\n \"cryptoAmount\": 1\n },\n \"JYS\": {\n \"branchInformation\": {\n \"type\": \"<unknown>\",\n \"postalCode\": \"<unknown>\"\n },\n \"settlementType\": \"cash\"\n }\n },\n \"cnbv\": {}\n },\n \"US\": \"<unknown>\"\n }\n }\n ],\n \"atomic\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.artu.ai/transactions/batch/external")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Environment"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"relatedClientIds\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"externalId\": \"<string>\",\n \"scopes\": [],\n \"status\": \"not_applicable\",\n \"exchangeRates\": {},\n \"description\": \"<string>\",\n \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {},\n \"scopeData\": {\n \"MX\": {\n \"actividadVulnerable\": {\n \"AVI\": {\n \"operationType\": \"buy\",\n \"hash\": \"<string>\",\n \"cryptoCurrency\": \"<string>\",\n \"cryptoAmount\": 1\n },\n \"JYS\": {\n \"branchInformation\": {\n \"type\": \"<unknown>\",\n \"postalCode\": \"<unknown>\"\n },\n \"settlementType\": \"cash\"\n }\n },\n \"cnbv\": {}\n },\n \"US\": \"<unknown>\"\n }\n }\n ],\n \"atomic\": true\n}"
response = http.request(request)
puts response.read_body{
"atomic": true,
"data": [
{
"data": {
"relatedClientIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"scopes": [
"base"
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"timestamp": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"isAlerted": true,
"alertedAt": "2023-11-07T05:31:56Z",
"status": "not_applicable",
"amount": "<unknown>",
"currency": "<unknown>",
"exchangeRates": {},
"externalId": "<string>",
"description": "<string>",
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"scopeData": {
"MX": {
"actividadVulnerable": {
"ARI": {
"property": {
"type": "1",
"leaseStartDate": "2023-12-25",
"leaseEndDate": "2023-12-25",
"colonia": "<string>",
"calle": "<string>",
"numeroExterior": "<string>",
"postalCode": "<string>",
"folioReal": "<string>",
"value": "<unknown>",
"numeroInterior": "<string>"
},
"payments": [
{
"paymentDate": "<unknown>",
"paymentForm": "<unknown>",
"monetaryInstrument": "<unknown>",
"currency": "<unknown>",
"amount": "<unknown>"
}
],
"operationType": "1501"
},
"AVI": {
"operationType": "buy",
"cryptoCurrency": "<string>",
"hash": "<unknown>",
"cryptoAmount": "<unknown>"
},
"INM": {
"figuraCliente": "1",
"figuraSO": "1",
"inmuebles": [
{
"type": "<unknown>",
"value": "<unknown>",
"colonia": "<unknown>",
"calle": "<unknown>",
"numeroExterior": "<unknown>",
"numeroInterior": "<unknown>",
"postalCode": "<unknown>",
"dimensionTerreno": "<unknown>",
"dimensionConstruido": "<unknown>",
"folioReal": "<unknown>"
}
],
"contract": {
"type": "<unknown>",
"instrumentNumber": "<unknown>",
"instrumentDate": "<unknown>",
"notaryNumber": "<unknown>",
"notaryStateCode": "<unknown>",
"cadastralValue": "<unknown>"
},
"operationType": "501",
"payments": [
{
"paymentDate": "<unknown>",
"paymentForm": "<unknown>",
"monetaryInstrument": "<unknown>",
"currency": "<unknown>",
"amount": "<unknown>"
}
]
},
"JYS": {
"operationType": "101",
"businessLine": "1",
"operationMethod": "1",
"settlementType": "cash",
"monetaryInstrument": "1",
"branchInformation": "<unknown>"
},
"MJR": {
"operationPostalCode": "<string>",
"goods": [
{
"goodType": "<unknown>",
"unit": "<unknown>",
"quantity": "<unknown>"
}
],
"payments": [
{
"paymentDate": "<unknown>",
"paymentForm": "<unknown>",
"monetaryInstrument": "<unknown>",
"currency": "<unknown>",
"amount": "<unknown>"
}
],
"operationType": "601"
},
"MPC": {
"operationType": "401",
"postalCode": "<string>",
"disbursements": [
{
"disbursementDate": "<unknown>",
"monetaryInstrument": "<unknown>",
"currency": "<unknown>",
"amount": "<unknown>"
}
],
"collateral": [
{
"tipoGarantia": "<unknown>",
"bienMutuo": "<unknown>",
"guarantorClientId": "<unknown>"
}
]
},
"TSC": {
"cardType": "1",
"idNumber": "<string>",
"operationType": "211"
},
"VEH": {
"operationType": "801",
"postalCode": "<string>",
"vehicles": [
null
],
"operationDate": "2023-12-25",
"payments": [
{
"paymentDate": "<unknown>",
"paymentForm": "<unknown>",
"monetaryInstrument": "<unknown>",
"currency": "<unknown>",
"amount": "<unknown>"
}
]
}
},
"cnbv": {
"TRANSMISOR": {
"tipoOperacion": "00",
"instrumentoMonetario": "00",
"sucursal": "<string>",
"localidad": "10100005"
}
}
},
"US": "<unknown>"
},
"relatedClients": [
{
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"role": "base",
"metadata": {}
}
],
"riskAssessments": {},
"tags": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"color": "<string>"
}
]
},
"action": "created"
}
]
}Authorizations
API key authentication. Obtain your API key from the dashboard.
Target environment for the request. Must be "test" or "live".
Body
application/json
Was this page helpful?