48 - Favored Registration

Cadastra um Favorecido

curl --request POST \
  --url https://api.ext.dbs.moneyp.dev.br/api/Favorecido \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --header 'IgnoraHandshake: <ignorahandshake>' \
  --data '
{
  "contaDto": {
    "agencia": "<string>",
    "agenciaDigito": "<string>",
    "conta": "<string>",
    "contaDigito": "<string>",
    "contaPgto": "<string>"
  },
  "nome": "<string>",
  "documentoFederal": "<string>",
  "numeroBanco": 123,
  "agencia": "<string>",
  "agenciaDigito": "<string>",
  "conta": "<string>",
  "contaDigito": "<string>",
  "contaPagamento": "<string>"
}
'

import requests

url = "https://api.ext.dbs.moneyp.dev.br/api/Favorecido"

payload = {
    "contaDto": {
        "agencia": "<string>",
        "agenciaDigito": "<string>",
        "conta": "<string>",
        "contaDigito": "<string>",
        "contaPgto": "<string>"
    },
    "nome": "<string>",
    "documentoFederal": "<string>",
    "numeroBanco": 123,
    "agencia": "<string>",
    "agenciaDigito": "<string>",
    "conta": "<string>",
    "contaDigito": "<string>",
    "contaPagamento": "<string>"
}
headers = {
    "IdempotencyKey": "<idempotencykey>",
    "IgnoraHandshake": "<ignorahandshake>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    IdempotencyKey: '<idempotencykey>',
    IgnoraHandshake: '<ignorahandshake>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    contaDto: {
      agencia: '<string>',
      agenciaDigito: '<string>',
      conta: '<string>',
      contaDigito: '<string>',
      contaPgto: '<string>'
    },
    nome: '<string>',
    documentoFederal: '<string>',
    numeroBanco: 123,
    agencia: '<string>',
    agenciaDigito: '<string>',
    conta: '<string>',
    contaDigito: '<string>',
    contaPagamento: '<string>'
  })
};

fetch('https://api.ext.dbs.moneyp.dev.br/api/Favorecido', 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.ext.dbs.moneyp.dev.br/api/Favorecido",
  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([
    'contaDto' => [
        'agencia' => '<string>',
        'agenciaDigito' => '<string>',
        'conta' => '<string>',
        'contaDigito' => '<string>',
        'contaPgto' => '<string>'
    ],
    'nome' => '<string>',
    'documentoFederal' => '<string>',
    'numeroBanco' => 123,
    'agencia' => '<string>',
    'agenciaDigito' => '<string>',
    'conta' => '<string>',
    'contaDigito' => '<string>',
    'contaPagamento' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json",
    "IdempotencyKey: <idempotencykey>",
    "IgnoraHandshake: <ignorahandshake>"
  ],
]);

$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.ext.dbs.moneyp.dev.br/api/Favorecido"

	payload := strings.NewReader("{\n  \"contaDto\": {\n    \"agencia\": \"<string>\",\n    \"agenciaDigito\": \"<string>\",\n    \"conta\": \"<string>\",\n    \"contaDigito\": \"<string>\",\n    \"contaPgto\": \"<string>\"\n  },\n  \"nome\": \"<string>\",\n  \"documentoFederal\": \"<string>\",\n  \"numeroBanco\": 123,\n  \"agencia\": \"<string>\",\n  \"agenciaDigito\": \"<string>\",\n  \"conta\": \"<string>\",\n  \"contaDigito\": \"<string>\",\n  \"contaPagamento\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("IdempotencyKey", "<idempotencykey>")
	req.Header.Add("IgnoraHandshake", "<ignorahandshake>")
	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://api.ext.dbs.moneyp.dev.br/api/Favorecido")
  .header("IdempotencyKey", "<idempotencykey>")
  .header("IgnoraHandshake", "<ignorahandshake>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"contaDto\": {\n    \"agencia\": \"<string>\",\n    \"agenciaDigito\": \"<string>\",\n    \"conta\": \"<string>\",\n    \"contaDigito\": \"<string>\",\n    \"contaPgto\": \"<string>\"\n  },\n  \"nome\": \"<string>\",\n  \"documentoFederal\": \"<string>\",\n  \"numeroBanco\": 123,\n  \"agencia\": \"<string>\",\n  \"agenciaDigito\": \"<string>\",\n  \"conta\": \"<string>\",\n  \"contaDigito\": \"<string>\",\n  \"contaPagamento\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ext.dbs.moneyp.dev.br/api/Favorecido")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["IdempotencyKey"] = '<idempotencykey>'
request["IgnoraHandshake"] = '<ignorahandshake>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"contaDto\": {\n    \"agencia\": \"<string>\",\n    \"agenciaDigito\": \"<string>\",\n    \"conta\": \"<string>\",\n    \"contaDigito\": \"<string>\",\n    \"contaPgto\": \"<string>\"\n  },\n  \"nome\": \"<string>\",\n  \"documentoFederal\": \"<string>\",\n  \"numeroBanco\": 123,\n  \"agencia\": \"<string>\",\n  \"agenciaDigito\": \"<string>\",\n  \"conta\": \"<string>\",\n  \"contaDigito\": \"<string>\",\n  \"contaPagamento\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "sucesso": true,
  "mensagem": "<string>",
  "jsonErros": "<string>",
  "codigoFavorecido": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "sucesso": true,
  "mensagem": "<string>"
}

{
  "sucesso": true,
  "mensagem": "<string>"
}

Cadastra um Favorecido

curl --request POST \
  --url https://api.ext.dbs.moneyp.dev.br/api/Favorecido \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --header 'IgnoraHandshake: <ignorahandshake>' \
  --data '
{
  "contaDto": {
    "agencia": "<string>",
    "agenciaDigito": "<string>",
    "conta": "<string>",
    "contaDigito": "<string>",
    "contaPgto": "<string>"
  },
  "nome": "<string>",
  "documentoFederal": "<string>",
  "numeroBanco": 123,
  "agencia": "<string>",
  "agenciaDigito": "<string>",
  "conta": "<string>",
  "contaDigito": "<string>",
  "contaPagamento": "<string>"
}
'

import requests

url = "https://api.ext.dbs.moneyp.dev.br/api/Favorecido"

payload = {
    "contaDto": {
        "agencia": "<string>",
        "agenciaDigito": "<string>",
        "conta": "<string>",
        "contaDigito": "<string>",
        "contaPgto": "<string>"
    },
    "nome": "<string>",
    "documentoFederal": "<string>",
    "numeroBanco": 123,
    "agencia": "<string>",
    "agenciaDigito": "<string>",
    "conta": "<string>",
    "contaDigito": "<string>",
    "contaPagamento": "<string>"
}
headers = {
    "IdempotencyKey": "<idempotencykey>",
    "IgnoraHandshake": "<ignorahandshake>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    IdempotencyKey: '<idempotencykey>',
    IgnoraHandshake: '<ignorahandshake>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    contaDto: {
      agencia: '<string>',
      agenciaDigito: '<string>',
      conta: '<string>',
      contaDigito: '<string>',
      contaPgto: '<string>'
    },
    nome: '<string>',
    documentoFederal: '<string>',
    numeroBanco: 123,
    agencia: '<string>',
    agenciaDigito: '<string>',
    conta: '<string>',
    contaDigito: '<string>',
    contaPagamento: '<string>'
  })
};

fetch('https://api.ext.dbs.moneyp.dev.br/api/Favorecido', 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.ext.dbs.moneyp.dev.br/api/Favorecido",
  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([
    'contaDto' => [
        'agencia' => '<string>',
        'agenciaDigito' => '<string>',
        'conta' => '<string>',
        'contaDigito' => '<string>',
        'contaPgto' => '<string>'
    ],
    'nome' => '<string>',
    'documentoFederal' => '<string>',
    'numeroBanco' => 123,
    'agencia' => '<string>',
    'agenciaDigito' => '<string>',
    'conta' => '<string>',
    'contaDigito' => '<string>',
    'contaPagamento' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json",
    "IdempotencyKey: <idempotencykey>",
    "IgnoraHandshake: <ignorahandshake>"
  ],
]);

$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.ext.dbs.moneyp.dev.br/api/Favorecido"

	payload := strings.NewReader("{\n  \"contaDto\": {\n    \"agencia\": \"<string>\",\n    \"agenciaDigito\": \"<string>\",\n    \"conta\": \"<string>\",\n    \"contaDigito\": \"<string>\",\n    \"contaPgto\": \"<string>\"\n  },\n  \"nome\": \"<string>\",\n  \"documentoFederal\": \"<string>\",\n  \"numeroBanco\": 123,\n  \"agencia\": \"<string>\",\n  \"agenciaDigito\": \"<string>\",\n  \"conta\": \"<string>\",\n  \"contaDigito\": \"<string>\",\n  \"contaPagamento\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("IdempotencyKey", "<idempotencykey>")
	req.Header.Add("IgnoraHandshake", "<ignorahandshake>")
	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://api.ext.dbs.moneyp.dev.br/api/Favorecido")
  .header("IdempotencyKey", "<idempotencykey>")
  .header("IgnoraHandshake", "<ignorahandshake>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"contaDto\": {\n    \"agencia\": \"<string>\",\n    \"agenciaDigito\": \"<string>\",\n    \"conta\": \"<string>\",\n    \"contaDigito\": \"<string>\",\n    \"contaPgto\": \"<string>\"\n  },\n  \"nome\": \"<string>\",\n  \"documentoFederal\": \"<string>\",\n  \"numeroBanco\": 123,\n  \"agencia\": \"<string>\",\n  \"agenciaDigito\": \"<string>\",\n  \"conta\": \"<string>\",\n  \"contaDigito\": \"<string>\",\n  \"contaPagamento\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ext.dbs.moneyp.dev.br/api/Favorecido")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["IdempotencyKey"] = '<idempotencykey>'
request["IgnoraHandshake"] = '<ignorahandshake>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"contaDto\": {\n    \"agencia\": \"<string>\",\n    \"agenciaDigito\": \"<string>\",\n    \"conta\": \"<string>\",\n    \"contaDigito\": \"<string>\",\n    \"contaPgto\": \"<string>\"\n  },\n  \"nome\": \"<string>\",\n  \"documentoFederal\": \"<string>\",\n  \"numeroBanco\": 123,\n  \"agencia\": \"<string>\",\n  \"agenciaDigito\": \"<string>\",\n  \"conta\": \"<string>\",\n  \"contaDigito\": \"<string>\",\n  \"contaPagamento\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "sucesso": true,
  "mensagem": "<string>",
  "jsonErros": "<string>",
  "codigoFavorecido": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "sucesso": true,
  "mensagem": "<string>"
}

{
  "sucesso": true,
  "mensagem": "<string>"
}

The API is responsible for creating favored ones for accounts and payments.

Show Request fields description

Field	Type	Description
agenciaDigito	string	Bank branch check digit.
conta	string	Bank account number.
contaDigito	string	Bank account number check digit.
contaPgto	string	Bank account number followed by the check digit.
tipoConta	integer	Bank account type. 1 for Checking, 2 for Savings, 3 for Payment, and 4 for Payroll.
modeloConta	integer	Bank account model. 1 for Movement, 2 for Escrow, 3 for Payment, and 4 for Payroll.
nome	string	Full name of the beneficiary.
documentoFederal	string	CPF or CNPJ number of the beneficiary.
numeroBanco	integer	Bank identifier code. Example: 001 for Banco do Brasil.
agencia	string	Beneficiary’s bank branch number.
agenciaDigito	string	Beneficiary’s bank branch check digit.
conta	string	Beneficiary’s bank account number.
contaDigito	string	Beneficiary’s bank account number check digit.
contaPagamento	string	Beneficiary’s bank account number followed by the check digit.

Authorizations

Authorization

string

header

required

Copie 'Bearer ' + token

Headers

IdempotencyKey

string

required

IgnoraHandshake

boolean

default:true

required

(somente em homologação)

Body

contaDto

object | null

Objeto detalhado da conta bancária.*

Show child attributes

nome

string | null

Nome completo do favorecido.*

Observação:

O nome completo do favorecido pode ter no máximo 100 caracteres.

documentoFederal

string | null

CPF ou CNPJ do favorecido.*

Observação:

O CPF ou CNPJ do favorecido pode ter no máximo 14 caracteres.

numeroBanco

integer<int32> | null

Código identificador do banco. Exemplo: 001 para Banco do Brasil, 104 para Caixa Econômica Federal, etc.*

agencia

string | null

Número da agência da conta bancária.*

Observação:

O número da agência da conta bancária pode ter no máximo 10 caracteres.

agenciaDigito

string | null

Dígito verificador da agência da conta bancária.*

Observação:

O dígito verificador da agência da conta bancária pode ter no máximo 1 caracter.

conta

string | null

Número da conta bancária.

Observações:

Para conta do tipo pagamento, informar o 'número da conta com dígito' (contaPagamento).
Para conta de outros tipos de informar o 'número da conta' (conta) e o 'dígito verificador' (contaDigito).
Caso nenhum dos campos referentes ao número da conta sejam informados, ocorrerá erro na requisição devido à falta de informação vital.
O número da conta bancária pode ter no máximo 12 caracteres.

contaDigito

string | null

Dígito verificador da conta bancária.

Observação:

O dígito verificador da conta bancária pode ter no máximo 1 caracter.

contaPagamento

string | null

Número da conta bancária seguido do dígito verificador, sem espaços ou caracteres especiais.

Observação:

O número da conta bancária seguido do dígito verificador pode ter no máximo 20 caracteres.

tipoConta

enum<integer> | null

Tipo de conta.*

Valores: -1 - CACC 2 - SVGS 3 - TRAN 4 - SLRY

Available options:

1,

2,

3,

4

Response

Success

sucesso

boolean

mensagem

string | null

jsonErros

string | null

codigoFavorecido

string<uuid>

Initial Guide

Developer's Guide

API References

48 - Favored Registration

Authorizations

Headers

Body

Response