Skip to main content
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": "<unknown>",
              "hash": "<string>",
              "cryptoCurrency": "<string>",
              "cryptoAmount": 1
            },
            "JYS": {
              "branchInformation": {
                "type": "<unknown>",
                "postalCode": "<unknown>"
              },
              "settlementType": "<unknown>"
            }
          },
          "cnbv": {}
        },
        "US": "<unknown>"
      }
    }
  ],
  "atomic": true
}
'
{
  "atomic": "<unknown>",
  "data": [
    {
      "data": {
        "relatedClientIds": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ],
        "scopes": [],
        "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": {
                  "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": "<unknown>",
                "cryptoCurrency": "<string>",
                "hash": "<unknown>",
                "cryptoAmount": "<unknown>"
              },
              "INM": {
                "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": {
                "settlementType": "<unknown>",
                "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": {
                "postalCode": "<string>",
                "disbursements": [
                  {
                    "disbursementDate": "<unknown>",
                    "monetaryInstrument": "<unknown>",
                    "currency": "<unknown>",
                    "amount": "<unknown>"
                  }
                ],
                "collateral": [
                  {
                    "tipoGarantia": "<unknown>",
                    "bienMutuo": "<unknown>",
                    "guarantorClientId": "<unknown>"
                  }
                ]
              },
              "TSC": {
                "idNumber": "<string>",
                "operationType": "211"
              },
              "VEH": {
                "postalCode": "<string>",
                "vehicles": [
                  null
                ],
                "operationDate": "2023-12-25",
                "payments": [
                  {
                    "paymentDate": "<unknown>",
                    "paymentForm": "<unknown>",
                    "monetaryInstrument": "<unknown>",
                    "currency": "<unknown>",
                    "amount": "<unknown>"
                  }
                ]
              }
            },
            "cnbv": {
              "TRANSMISOR": {
                "sucursal": "<string>"
              }
            }
          },
          "US": "<unknown>"
        },
        "relatedClients": [
          {
            "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "metadata": {}
          }
        ],
        "riskAssessments": {},
        "tags": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "color": "<string>"
          }
        ]
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

API key authentication. Obtain your API key from the dashboard.

X-Environment
string
header
required

Target environment for the request. Must be "test" or "live".

Body

application/json
items
object[]
required
Required array length: 1 - 250 elements
atomic
boolean
default:true

Response

200 - application/json

OK

atomic
any
required
data
object[]
required