curl --request POST \
  --url https://api.bmpdigital.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>",
    "tipoConta": 1,
    "modeloConta": 1
  },
  "nome": "<string>",
  "documentoFederal": "<string>",
  "numeroBanco": 123,
  "agencia": "<string>",
  "agenciaDigito": "<string>",
  "conta": "<string>",
  "contaDigito": "<string>",
  "contaPagamento": "<string>",
  "tipoConta": 1
}'
{
  "sucesso": true,
  "mensagem": "<string>",
  "jsonErros": "<string>",
  "codigoFavorecido": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

A API tem a função de criar favorecidos para as contas e pagamentos.

Authorizations

​
Authorization
string
header
required

Copie 'Bearer ' + token

Headers

​
IdempotencyKey
string
required

Chave única para garantir que uma operação seja executada apenas uma vez.

​
IgnoraHandshake
boolean
default:true
required

(somente em homologação)

Body

​
contaDto
object

Objeto detalhado da Conta Bancária.

​
nome
string | null

Nome Completo do Favorecido.

​
documentoFederal
string | null

CPF ou CNPJ do Favorecido.

​
numeroBanco
integer | null

Código identificador do Banco. Ex: 001 para Banco do Brasil, etc...

​
agencia
string | null

Número da Agência da Conta Bancária.

​
agenciaDigito
string | null

Dígito verificador da Agência da Conta Bancária.

​
conta
string | null

Número da Conta Bancária.

​
contaDigito
string | null

Dígito verificador da Conta Bancária.

​
contaPagamento
string | null

Combinação do Número da Conta + Dígito da Conta, sem espaços ou caracteres especiais.

​
tipoConta
enum<integer>
Available options:
1,
2,
3,
4

Response

200 - application/json
Success
​
sucesso
boolean

Indica se a operação foi realizada com sucesso.

​
mensagem
string | null

Descrição detalhada do resultado da operação, incluindo informações sobre erros ou mensagens complementares.

​
jsonErros
string | null

Informações de erro no formato JSON.

​
codigoFavorecido
string

Código identificador do Favorecido.

Esta página foi útil?