Sync bank accounts for a client
curl --request POST \
--url https://api.artu.ai/clients/{clientId}/bank-accounts/sync \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Environment: <api-key>' \
--data '
{
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountNumber": "<string>",
"bankName": "<string>",
"bankCode": "<string>",
"country": "MX",
"currency": "<string>",
"isPrimary": true,
"isActive": true,
"label": "<string>",
"externalId": "<string>",
"metadata": {},
"clabe": "<string>",
"codigoBanco": "<string>",
"codigoPlaza": "<string>",
"_delete": true
}
],
"replaceMode": true
}
'import requests
url = "https://api.artu.ai/clients/{clientId}/bank-accounts/sync"
payload = {
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountNumber": "<string>",
"bankName": "<string>",
"bankCode": "<string>",
"country": "MX",
"currency": "<string>",
"isPrimary": True,
"isActive": True,
"label": "<string>",
"externalId": "<string>",
"metadata": {},
"clabe": "<string>",
"codigoBanco": "<string>",
"codigoPlaza": "<string>",
"_delete": True
}
],
"replaceMode": True
}
headers = {
"Authorization": "Bearer <token>",
"X-Environment": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Environment': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
items: [
{
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
accountNumber: '<string>',
bankName: '<string>',
bankCode: '<string>',
country: 'MX',
currency: '<string>',
isPrimary: true,
isActive: true,
label: '<string>',
externalId: '<string>',
metadata: {},
clabe: '<string>',
codigoBanco: '<string>',
codigoPlaza: '<string>',
_delete: true
}
],
replaceMode: true
})
};
fetch('https://api.artu.ai/clients/{clientId}/bank-accounts/sync', 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/clients/{clientId}/bank-accounts/sync",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'items' => [
[
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'accountNumber' => '<string>',
'bankName' => '<string>',
'bankCode' => '<string>',
'country' => 'MX',
'currency' => '<string>',
'isPrimary' => true,
'isActive' => true,
'label' => '<string>',
'externalId' => '<string>',
'metadata' => [
],
'clabe' => '<string>',
'codigoBanco' => '<string>',
'codigoPlaza' => '<string>',
'_delete' => true
]
],
'replaceMode' => 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/clients/{clientId}/bank-accounts/sync"
payload := strings.NewReader("{\n \"items\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"accountNumber\": \"<string>\",\n \"bankName\": \"<string>\",\n \"bankCode\": \"<string>\",\n \"country\": \"MX\",\n \"currency\": \"<string>\",\n \"isPrimary\": true,\n \"isActive\": true,\n \"label\": \"<string>\",\n \"externalId\": \"<string>\",\n \"metadata\": {},\n \"clabe\": \"<string>\",\n \"codigoBanco\": \"<string>\",\n \"codigoPlaza\": \"<string>\",\n \"_delete\": true\n }\n ],\n \"replaceMode\": true\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.artu.ai/clients/{clientId}/bank-accounts/sync")
.header("Authorization", "Bearer <token>")
.header("X-Environment", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"accountNumber\": \"<string>\",\n \"bankName\": \"<string>\",\n \"bankCode\": \"<string>\",\n \"country\": \"MX\",\n \"currency\": \"<string>\",\n \"isPrimary\": true,\n \"isActive\": true,\n \"label\": \"<string>\",\n \"externalId\": \"<string>\",\n \"metadata\": {},\n \"clabe\": \"<string>\",\n \"codigoBanco\": \"<string>\",\n \"codigoPlaza\": \"<string>\",\n \"_delete\": true\n }\n ],\n \"replaceMode\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.artu.ai/clients/{clientId}/bank-accounts/sync")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Environment"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"accountNumber\": \"<string>\",\n \"bankName\": \"<string>\",\n \"bankCode\": \"<string>\",\n \"country\": \"MX\",\n \"currency\": \"<string>\",\n \"isPrimary\": true,\n \"isActive\": true,\n \"label\": \"<string>\",\n \"externalId\": \"<string>\",\n \"metadata\": {},\n \"clabe\": \"<string>\",\n \"codigoBanco\": \"<string>\",\n \"codigoPlaza\": \"<string>\",\n \"_delete\": true\n }\n ],\n \"replaceMode\": true\n}"
response = http.request(request)
puts response.read_body{
"created": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountNumber": "<string>",
"bankName": "<string>",
"country": "MX",
"currency": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"bankCode": "<string>",
"type": "checking",
"isPrimary": true,
"isActive": true,
"label": "<string>",
"externalId": "<string>",
"metadata": {},
"clabe": "<unknown>",
"codigoBanco": "<string>",
"codigoPlaza": "<string>"
}
],
"updated": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountNumber": "<string>",
"bankName": "<string>",
"country": "MX",
"currency": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"bankCode": "<string>",
"type": "checking",
"isPrimary": true,
"isActive": true,
"label": "<string>",
"externalId": "<string>",
"metadata": {},
"clabe": "<unknown>",
"codigoBanco": "<string>",
"codigoPlaza": "<string>"
}
],
"deleted": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}Bank Accounts
Sync bank accounts for a client
POST
/
clients
/
{clientId}
/
bank-accounts
/
sync
Sync bank accounts for a client
curl --request POST \
--url https://api.artu.ai/clients/{clientId}/bank-accounts/sync \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Environment: <api-key>' \
--data '
{
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountNumber": "<string>",
"bankName": "<string>",
"bankCode": "<string>",
"country": "MX",
"currency": "<string>",
"isPrimary": true,
"isActive": true,
"label": "<string>",
"externalId": "<string>",
"metadata": {},
"clabe": "<string>",
"codigoBanco": "<string>",
"codigoPlaza": "<string>",
"_delete": true
}
],
"replaceMode": true
}
'import requests
url = "https://api.artu.ai/clients/{clientId}/bank-accounts/sync"
payload = {
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountNumber": "<string>",
"bankName": "<string>",
"bankCode": "<string>",
"country": "MX",
"currency": "<string>",
"isPrimary": True,
"isActive": True,
"label": "<string>",
"externalId": "<string>",
"metadata": {},
"clabe": "<string>",
"codigoBanco": "<string>",
"codigoPlaza": "<string>",
"_delete": True
}
],
"replaceMode": True
}
headers = {
"Authorization": "Bearer <token>",
"X-Environment": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Environment': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
items: [
{
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
accountNumber: '<string>',
bankName: '<string>',
bankCode: '<string>',
country: 'MX',
currency: '<string>',
isPrimary: true,
isActive: true,
label: '<string>',
externalId: '<string>',
metadata: {},
clabe: '<string>',
codigoBanco: '<string>',
codigoPlaza: '<string>',
_delete: true
}
],
replaceMode: true
})
};
fetch('https://api.artu.ai/clients/{clientId}/bank-accounts/sync', 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/clients/{clientId}/bank-accounts/sync",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'items' => [
[
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'accountNumber' => '<string>',
'bankName' => '<string>',
'bankCode' => '<string>',
'country' => 'MX',
'currency' => '<string>',
'isPrimary' => true,
'isActive' => true,
'label' => '<string>',
'externalId' => '<string>',
'metadata' => [
],
'clabe' => '<string>',
'codigoBanco' => '<string>',
'codigoPlaza' => '<string>',
'_delete' => true
]
],
'replaceMode' => 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/clients/{clientId}/bank-accounts/sync"
payload := strings.NewReader("{\n \"items\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"accountNumber\": \"<string>\",\n \"bankName\": \"<string>\",\n \"bankCode\": \"<string>\",\n \"country\": \"MX\",\n \"currency\": \"<string>\",\n \"isPrimary\": true,\n \"isActive\": true,\n \"label\": \"<string>\",\n \"externalId\": \"<string>\",\n \"metadata\": {},\n \"clabe\": \"<string>\",\n \"codigoBanco\": \"<string>\",\n \"codigoPlaza\": \"<string>\",\n \"_delete\": true\n }\n ],\n \"replaceMode\": true\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.artu.ai/clients/{clientId}/bank-accounts/sync")
.header("Authorization", "Bearer <token>")
.header("X-Environment", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"accountNumber\": \"<string>\",\n \"bankName\": \"<string>\",\n \"bankCode\": \"<string>\",\n \"country\": \"MX\",\n \"currency\": \"<string>\",\n \"isPrimary\": true,\n \"isActive\": true,\n \"label\": \"<string>\",\n \"externalId\": \"<string>\",\n \"metadata\": {},\n \"clabe\": \"<string>\",\n \"codigoBanco\": \"<string>\",\n \"codigoPlaza\": \"<string>\",\n \"_delete\": true\n }\n ],\n \"replaceMode\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.artu.ai/clients/{clientId}/bank-accounts/sync")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Environment"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"accountNumber\": \"<string>\",\n \"bankName\": \"<string>\",\n \"bankCode\": \"<string>\",\n \"country\": \"MX\",\n \"currency\": \"<string>\",\n \"isPrimary\": true,\n \"isActive\": true,\n \"label\": \"<string>\",\n \"externalId\": \"<string>\",\n \"metadata\": {},\n \"clabe\": \"<string>\",\n \"codigoBanco\": \"<string>\",\n \"codigoPlaza\": \"<string>\",\n \"_delete\": true\n }\n ],\n \"replaceMode\": true\n}"
response = http.request(request)
puts response.read_body{
"created": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountNumber": "<string>",
"bankName": "<string>",
"country": "MX",
"currency": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"bankCode": "<string>",
"type": "checking",
"isPrimary": true,
"isActive": true,
"label": "<string>",
"externalId": "<string>",
"metadata": {},
"clabe": "<unknown>",
"codigoBanco": "<string>",
"codigoPlaza": "<string>"
}
],
"updated": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountNumber": "<string>",
"bankName": "<string>",
"country": "MX",
"currency": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"bankCode": "<string>",
"type": "checking",
"isPrimary": true,
"isActive": true,
"label": "<string>",
"externalId": "<string>",
"metadata": {},
"clabe": "<unknown>",
"codigoBanco": "<string>",
"codigoPlaza": "<string>"
}
],
"deleted": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}Authorizations
API key authentication. Obtain your API key from the dashboard.
Target environment for the request. Must be "test" or "live".
Path Parameters
Body
application/json
Was this page helpful?
