Validar Conta Bancária
curl --request POST \
--url https://production.api.noodle.cx/external/validate/account \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"bankCode": "<string>",
"pspId": "<string>",
"agency": "<string>",
"account": "<string>",
"accountType": "<string>",
"pixKeyType": "<string>",
"pixDescription": "<string>",
"pixKey": "<string>",
"taxId": "<string>",
"validateOwnership": true
}
'import requests
url = "https://production.api.noodle.cx/external/validate/account"
payload = {
"name": "<string>",
"bankCode": "<string>",
"pspId": "<string>",
"agency": "<string>",
"account": "<string>",
"accountType": "<string>",
"pixKeyType": "<string>",
"pixDescription": "<string>",
"pixKey": "<string>",
"taxId": "<string>",
"validateOwnership": True
}
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({
name: '<string>',
bankCode: '<string>',
pspId: '<string>',
agency: '<string>',
account: '<string>',
accountType: '<string>',
pixKeyType: '<string>',
pixDescription: '<string>',
pixKey: '<string>',
taxId: '<string>',
validateOwnership: true
})
};
fetch('https://production.api.noodle.cx/external/validate/account', 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/validate/account",
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([
'name' => '<string>',
'bankCode' => '<string>',
'pspId' => '<string>',
'agency' => '<string>',
'account' => '<string>',
'accountType' => '<string>',
'pixKeyType' => '<string>',
'pixDescription' => '<string>',
'pixKey' => '<string>',
'taxId' => '<string>',
'validateOwnership' => true
]),
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/validate/account"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"bankCode\": \"<string>\",\n \"pspId\": \"<string>\",\n \"agency\": \"<string>\",\n \"account\": \"<string>\",\n \"accountType\": \"<string>\",\n \"pixKeyType\": \"<string>\",\n \"pixDescription\": \"<string>\",\n \"pixKey\": \"<string>\",\n \"taxId\": \"<string>\",\n \"validateOwnership\": true\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/validate/account")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"bankCode\": \"<string>\",\n \"pspId\": \"<string>\",\n \"agency\": \"<string>\",\n \"account\": \"<string>\",\n \"accountType\": \"<string>\",\n \"pixKeyType\": \"<string>\",\n \"pixDescription\": \"<string>\",\n \"pixKey\": \"<string>\",\n \"taxId\": \"<string>\",\n \"validateOwnership\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production.api.noodle.cx/external/validate/account")
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 \"name\": \"<string>\",\n \"bankCode\": \"<string>\",\n \"pspId\": \"<string>\",\n \"agency\": \"<string>\",\n \"account\": \"<string>\",\n \"accountType\": \"<string>\",\n \"pixKeyType\": \"<string>\",\n \"pixDescription\": \"<string>\",\n \"pixKey\": \"<string>\",\n \"taxId\": \"<string>\",\n \"validateOwnership\": true\n}"
response = http.request(request)
puts response.read_body{
"valid": true,
"message": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Validacao
Validar Conta Bancária
Use este endpoint para validar uma conta bancária através de transferência PIX de 1 centavo + taxa de validação.
POST
/
validate
/
account
Validar Conta Bancária
curl --request POST \
--url https://production.api.noodle.cx/external/validate/account \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"bankCode": "<string>",
"pspId": "<string>",
"agency": "<string>",
"account": "<string>",
"accountType": "<string>",
"pixKeyType": "<string>",
"pixDescription": "<string>",
"pixKey": "<string>",
"taxId": "<string>",
"validateOwnership": true
}
'import requests
url = "https://production.api.noodle.cx/external/validate/account"
payload = {
"name": "<string>",
"bankCode": "<string>",
"pspId": "<string>",
"agency": "<string>",
"account": "<string>",
"accountType": "<string>",
"pixKeyType": "<string>",
"pixDescription": "<string>",
"pixKey": "<string>",
"taxId": "<string>",
"validateOwnership": True
}
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({
name: '<string>',
bankCode: '<string>',
pspId: '<string>',
agency: '<string>',
account: '<string>',
accountType: '<string>',
pixKeyType: '<string>',
pixDescription: '<string>',
pixKey: '<string>',
taxId: '<string>',
validateOwnership: true
})
};
fetch('https://production.api.noodle.cx/external/validate/account', 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/validate/account",
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([
'name' => '<string>',
'bankCode' => '<string>',
'pspId' => '<string>',
'agency' => '<string>',
'account' => '<string>',
'accountType' => '<string>',
'pixKeyType' => '<string>',
'pixDescription' => '<string>',
'pixKey' => '<string>',
'taxId' => '<string>',
'validateOwnership' => true
]),
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/validate/account"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"bankCode\": \"<string>\",\n \"pspId\": \"<string>\",\n \"agency\": \"<string>\",\n \"account\": \"<string>\",\n \"accountType\": \"<string>\",\n \"pixKeyType\": \"<string>\",\n \"pixDescription\": \"<string>\",\n \"pixKey\": \"<string>\",\n \"taxId\": \"<string>\",\n \"validateOwnership\": true\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/validate/account")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"bankCode\": \"<string>\",\n \"pspId\": \"<string>\",\n \"agency\": \"<string>\",\n \"account\": \"<string>\",\n \"accountType\": \"<string>\",\n \"pixKeyType\": \"<string>\",\n \"pixDescription\": \"<string>\",\n \"pixKey\": \"<string>\",\n \"taxId\": \"<string>\",\n \"validateOwnership\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production.api.noodle.cx/external/validate/account")
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 \"name\": \"<string>\",\n \"bankCode\": \"<string>\",\n \"pspId\": \"<string>\",\n \"agency\": \"<string>\",\n \"account\": \"<string>\",\n \"accountType\": \"<string>\",\n \"pixKeyType\": \"<string>\",\n \"pixDescription\": \"<string>\",\n \"pixKey\": \"<string>\",\n \"taxId\": \"<string>\",\n \"validateOwnership\": true\n}"
response = http.request(request)
puts response.read_body{
"valid": true,
"message": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Body
application/json
Representa os dados para validar uma conta bancária ou chave Pix para pagamentos. Atributos:
- tax_id (str, opcional): CPF ou CNPJ do titular da conta, necessário para validar a propriedade da conta.
- validate_ownership (bool, opcional): Indica se a propriedade da conta deve ser validada, padrão é True.
- name (str, opcional): Nome do titular da conta.
- bank_code (str, opcional): Código do banco.
- psp_id (str, opcional): Identificador do provedor de serviços de pagamento (PSP).
- agency (str, opcional): Número da agência bancária.
- account (str, opcional): Número da conta bancária.
- account_type (str, opcional): Tipo da conta bancária, deve ser um dos valores: "saving_account", "payment_account", "checking_account" ou "salary_account".
- pix_key_type (str, opcional): Tipo da chave Pix, deve ser um dos valores "random_key", "cnpj", "cpf", "phone_number" ou "email".
- pix_description (str, opcional): Descrição da chave Pix.
- pix_key (str, opcional): Chave Pix associada à conta. Validações:
- Pelo menos um dos campos
pix_keyouaccountdeve ser informado. - Se
pix_keyfor informado, o campopix_key_typeé obrigatório. - Para contas bancárias, os campos
agency,psp_id,account_type,nameebank_codesão obrigatórios. - Se
validate_ownershipfor True, o campotax_idé obrigatório.