curl --request POST \
--url https://production.api.noodle.cx/external/contacts/accounts \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"contact_id": "<string>",
"bank_name": "<string>",
"bank_code": "<string>",
"bank_ispb": "<string>",
"agency": "<string>",
"account_number": "<string>",
"account_type": "<string>",
"pix_key": "<string>",
"pix_key_type": "<string>"
}
'import requests
url = "https://production.api.noodle.cx/external/contacts/accounts"
payload = {
"contact_id": "<string>",
"bank_name": "<string>",
"bank_code": "<string>",
"bank_ispb": "<string>",
"agency": "<string>",
"account_number": "<string>",
"account_type": "<string>",
"pix_key": "<string>",
"pix_key_type": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contact_id: '<string>',
bank_name: '<string>',
bank_code: '<string>',
bank_ispb: '<string>',
agency: '<string>',
account_number: '<string>',
account_type: '<string>',
pix_key: '<string>',
pix_key_type: '<string>'
})
};
fetch('https://production.api.noodle.cx/external/contacts/accounts', 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://production.api.noodle.cx/external/contacts/accounts",
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([
'contact_id' => '<string>',
'bank_name' => '<string>',
'bank_code' => '<string>',
'bank_ispb' => '<string>',
'agency' => '<string>',
'account_number' => '<string>',
'account_type' => '<string>',
'pix_key' => '<string>',
'pix_key_type' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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://production.api.noodle.cx/external/contacts/accounts"
payload := strings.NewReader("{\n \"contact_id\": \"<string>\",\n \"bank_name\": \"<string>\",\n \"bank_code\": \"<string>\",\n \"bank_ispb\": \"<string>\",\n \"agency\": \"<string>\",\n \"account_number\": \"<string>\",\n \"account_type\": \"<string>\",\n \"pix_key\": \"<string>\",\n \"pix_key_type\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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://production.api.noodle.cx/external/contacts/accounts")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"contact_id\": \"<string>\",\n \"bank_name\": \"<string>\",\n \"bank_code\": \"<string>\",\n \"bank_ispb\": \"<string>\",\n \"agency\": \"<string>\",\n \"account_number\": \"<string>\",\n \"account_type\": \"<string>\",\n \"pix_key\": \"<string>\",\n \"pix_key_type\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production.api.noodle.cx/external/contacts/accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contact_id\": \"<string>\",\n \"bank_name\": \"<string>\",\n \"bank_code\": \"<string>\",\n \"bank_ispb\": \"<string>\",\n \"agency\": \"<string>\",\n \"account_number\": \"<string>\",\n \"account_type\": \"<string>\",\n \"pix_key\": \"<string>\",\n \"pix_key_type\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"bank_name": "<string>",
"bank_code": "<string>",
"bank_ispb": "<string>",
"agency": "<string>",
"account_number": "<string>",
"account_type": "<string>",
"pix_key": "<string>",
"pix_key_type": "<string>",
"tax_id": "<string>",
"tax_id_manager": "<string>",
"contact_id": "<string>",
"is_favorite": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Criar Conta do Contato
Use este endpoint para criar uma nova conta para um contato existente.
curl --request POST \
--url https://production.api.noodle.cx/external/contacts/accounts \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"contact_id": "<string>",
"bank_name": "<string>",
"bank_code": "<string>",
"bank_ispb": "<string>",
"agency": "<string>",
"account_number": "<string>",
"account_type": "<string>",
"pix_key": "<string>",
"pix_key_type": "<string>"
}
'import requests
url = "https://production.api.noodle.cx/external/contacts/accounts"
payload = {
"contact_id": "<string>",
"bank_name": "<string>",
"bank_code": "<string>",
"bank_ispb": "<string>",
"agency": "<string>",
"account_number": "<string>",
"account_type": "<string>",
"pix_key": "<string>",
"pix_key_type": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contact_id: '<string>',
bank_name: '<string>',
bank_code: '<string>',
bank_ispb: '<string>',
agency: '<string>',
account_number: '<string>',
account_type: '<string>',
pix_key: '<string>',
pix_key_type: '<string>'
})
};
fetch('https://production.api.noodle.cx/external/contacts/accounts', 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://production.api.noodle.cx/external/contacts/accounts",
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([
'contact_id' => '<string>',
'bank_name' => '<string>',
'bank_code' => '<string>',
'bank_ispb' => '<string>',
'agency' => '<string>',
'account_number' => '<string>',
'account_type' => '<string>',
'pix_key' => '<string>',
'pix_key_type' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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://production.api.noodle.cx/external/contacts/accounts"
payload := strings.NewReader("{\n \"contact_id\": \"<string>\",\n \"bank_name\": \"<string>\",\n \"bank_code\": \"<string>\",\n \"bank_ispb\": \"<string>\",\n \"agency\": \"<string>\",\n \"account_number\": \"<string>\",\n \"account_type\": \"<string>\",\n \"pix_key\": \"<string>\",\n \"pix_key_type\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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://production.api.noodle.cx/external/contacts/accounts")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"contact_id\": \"<string>\",\n \"bank_name\": \"<string>\",\n \"bank_code\": \"<string>\",\n \"bank_ispb\": \"<string>\",\n \"agency\": \"<string>\",\n \"account_number\": \"<string>\",\n \"account_type\": \"<string>\",\n \"pix_key\": \"<string>\",\n \"pix_key_type\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production.api.noodle.cx/external/contacts/accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contact_id\": \"<string>\",\n \"bank_name\": \"<string>\",\n \"bank_code\": \"<string>\",\n \"bank_ispb\": \"<string>\",\n \"agency\": \"<string>\",\n \"account_number\": \"<string>\",\n \"account_type\": \"<string>\",\n \"pix_key\": \"<string>\",\n \"pix_key_type\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"bank_name": "<string>",
"bank_code": "<string>",
"bank_ispb": "<string>",
"agency": "<string>",
"account_number": "<string>",
"account_type": "<string>",
"pix_key": "<string>",
"pix_key_type": "<string>",
"tax_id": "<string>",
"tax_id_manager": "<string>",
"contact_id": "<string>",
"is_favorite": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Body
Representa a requisição externa para adicionar uma conta bancária a um contato.
Atributos:
- contact_id (str): ID do contato ao qual a conta será associada.
- bank_name (str, opcional): Nome do banco.
- bank_code (str, opcional): Código do banco.
- bank_ispb (str, opcional): Código ISPB do banco.
- agency (str, opcional): Número da agência bancária.
- account_number (str, opcional): Número da conta bancária.
- account_type (str, opcional): Tipo da conta (ex: 'checking_account').
- pix_key (str, opcional): Chave PIX associada à conta.
- pix_key_type (str, opcional): Tipo da chave PIX (ex: 'cpf', 'email').
Validações:
- É obrigatório fornecer os dados de uma chave PIX (
pix_key) ou os dados de uma conta bancária completa (account_number,agency, etc.). - Se uma
pix_keyfor informada, o campopix_key_typetambém é obrigatório. - Se os dados de conta bancária forem informados, os campos
agency,bank_ispb,account_type,bank_nameebank_codesão obrigatórios. - O campo
pix_key_typedeve ser um dos valores permitidos. - O campo
account_typedeve ser um dos valores permitidos.
ID do contato ao qual a conta será associada.
Nome do banco.
Código do banco.
Código ISPB do banco.
Número da agência bancária.
Número da conta bancária.
Tipo da conta (ex: 'checking_account').
Chave PIX associada à conta.
Tipo da chave PIX (ex: 'cpf', 'email').
Response
Successful Response
Representa os dados da conta bancária de um contato.
Atributos:
- id (str, opcional): Identificador único da conta.
- bank_name (str, opcional): Nome do banco.
- bank_code (str, opcional): Código do banco.
- bank_ispb (str, opcional): Código ISPB do banco.
- agency (str, opcional): Número da agência bancária.
- account_number (str, opcional): Número da conta bancária.
- account_type (str, opcional): Tipo da conta (ex: Corrente, Poupança).
- pix_key (str, opcional): Chave PIX associada à conta.
- pix_key_type (str, opcional): Tipo da chave PIX (ex: CPF, Email, Telefone).
- tax_id (str, opcional): CPF ou CNPJ do titular da conta.
- tax_id_manager (str, opcional): CPF ou CNPJ do gestor que cadastrou a conta.
- contact_id (str, opcional): ID do contato ao qual a conta pertence.
- is_favorite (bool, opcional): Indica se a conta é a favorita do contato.
Identificador único da conta.
Nome do banco.
Código do banco.
Código ISPB do banco.
Número da agência bancária.
Número da conta bancária.
Tipo da conta (ex: Corrente, Poupança).
Chave PIX associada à conta.
Tipo da chave PIX (ex: CPF, Email, Telefone).
CPF ou CNPJ do titular da conta.
CPF ou CNPJ do gestor que cadastrou a conta.
ID do contato ao qual a conta pertence.
Indica se a conta é a favorita do contato.