cURL
curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirAssinaturaCCB \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '
{
"dto": {
"codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoOperacao": "<string>",
"numeroProposta": 123
},
"assinantes": [
{
"nome": "<string>",
"email": "<string>",
"documento": "<string>",
"descricao": "<string>",
"telefoneCelular": "<string>",
"notificarPorEmail": true,
"notificarPorWhatsApp": true,
"notificarPorSMS": true,
"codigoIdentificador": "<string>",
"dtLimiteAssinatura": "2023-11-07T05:31:56Z"
}
]
}
'import requests
url = "https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirAssinaturaCCB"
payload = {
"dto": {
"codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoOperacao": "<string>",
"numeroProposta": 123
},
"assinantes": [
{
"nome": "<string>",
"email": "<string>",
"documento": "<string>",
"descricao": "<string>",
"telefoneCelular": "<string>",
"notificarPorEmail": True,
"notificarPorWhatsApp": True,
"notificarPorSMS": True,
"codigoIdentificador": "<string>",
"dtLimiteAssinatura": "2023-11-07T05:31:56Z"
}
]
}
headers = {
"IdempotencyKey": "<idempotencykey>",
"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>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
dto: {
codigoProposta: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
codigoOperacao: '<string>',
numeroProposta: 123
},
assinantes: [
{
nome: '<string>',
email: '<string>',
documento: '<string>',
descricao: '<string>',
telefoneCelular: '<string>',
notificarPorEmail: true,
notificarPorWhatsApp: true,
notificarPorSMS: true,
codigoIdentificador: '<string>',
dtLimiteAssinatura: '2023-11-07T05:31:56Z'
}
]
})
};
fetch('https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirAssinaturaCCB', 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.bmpdigital.moneyp.dev.br/Proposta/IncluirAssinaturaCCB",
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([
'dto' => [
'codigoProposta' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'codigoOperacao' => '<string>',
'numeroProposta' => 123
],
'assinantes' => [
[
'nome' => '<string>',
'email' => '<string>',
'documento' => '<string>',
'descricao' => '<string>',
'telefoneCelular' => '<string>',
'notificarPorEmail' => true,
'notificarPorWhatsApp' => true,
'notificarPorSMS' => true,
'codigoIdentificador' => '<string>',
'dtLimiteAssinatura' => '2023-11-07T05:31:56Z'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"IdempotencyKey: <idempotencykey>"
],
]);
$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.bmpdigital.moneyp.dev.br/Proposta/IncluirAssinaturaCCB"
payload := strings.NewReader("{\n \"dto\": {\n \"codigoProposta\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"codigoOperacao\": \"<string>\",\n \"numeroProposta\": 123\n },\n \"assinantes\": [\n {\n \"nome\": \"<string>\",\n \"email\": \"<string>\",\n \"documento\": \"<string>\",\n \"descricao\": \"<string>\",\n \"telefoneCelular\": \"<string>\",\n \"notificarPorEmail\": true,\n \"notificarPorWhatsApp\": true,\n \"notificarPorSMS\": true,\n \"codigoIdentificador\": \"<string>\",\n \"dtLimiteAssinatura\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("IdempotencyKey", "<idempotencykey>")
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.bmpdigital.moneyp.dev.br/Proposta/IncluirAssinaturaCCB")
.header("IdempotencyKey", "<idempotencykey>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"dto\": {\n \"codigoProposta\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"codigoOperacao\": \"<string>\",\n \"numeroProposta\": 123\n },\n \"assinantes\": [\n {\n \"nome\": \"<string>\",\n \"email\": \"<string>\",\n \"documento\": \"<string>\",\n \"descricao\": \"<string>\",\n \"telefoneCelular\": \"<string>\",\n \"notificarPorEmail\": true,\n \"notificarPorWhatsApp\": true,\n \"notificarPorSMS\": true,\n \"codigoIdentificador\": \"<string>\",\n \"dtLimiteAssinatura\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirAssinaturaCCB")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["IdempotencyKey"] = '<idempotencykey>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"dto\": {\n \"codigoProposta\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"codigoOperacao\": \"<string>\",\n \"numeroProposta\": 123\n },\n \"assinantes\": [\n {\n \"nome\": \"<string>\",\n \"email\": \"<string>\",\n \"documento\": \"<string>\",\n \"descricao\": \"<string>\",\n \"telefoneCelular\": \"<string>\",\n \"notificarPorEmail\": true,\n \"notificarPorWhatsApp\": true,\n \"notificarPorSMS\": true,\n \"codigoIdentificador\": \"<string>\",\n \"dtLimiteAssinatura\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"msg": "<string>",
"hasError": true,
"messages": [
{
"messageType": 1,
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"parametros": [
{
"nome": "<string>",
"valor": "<string>"
}
]
}{
"msg": "<string>",
"hasError": true,
"messages": [
{
"messageType": 1,
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
]
}Assinaturas
11 - Eletrônica
cURL
curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirAssinaturaCCB \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '
{
"dto": {
"codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoOperacao": "<string>",
"numeroProposta": 123
},
"assinantes": [
{
"nome": "<string>",
"email": "<string>",
"documento": "<string>",
"descricao": "<string>",
"telefoneCelular": "<string>",
"notificarPorEmail": true,
"notificarPorWhatsApp": true,
"notificarPorSMS": true,
"codigoIdentificador": "<string>",
"dtLimiteAssinatura": "2023-11-07T05:31:56Z"
}
]
}
'import requests
url = "https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirAssinaturaCCB"
payload = {
"dto": {
"codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoOperacao": "<string>",
"numeroProposta": 123
},
"assinantes": [
{
"nome": "<string>",
"email": "<string>",
"documento": "<string>",
"descricao": "<string>",
"telefoneCelular": "<string>",
"notificarPorEmail": True,
"notificarPorWhatsApp": True,
"notificarPorSMS": True,
"codigoIdentificador": "<string>",
"dtLimiteAssinatura": "2023-11-07T05:31:56Z"
}
]
}
headers = {
"IdempotencyKey": "<idempotencykey>",
"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>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
dto: {
codigoProposta: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
codigoOperacao: '<string>',
numeroProposta: 123
},
assinantes: [
{
nome: '<string>',
email: '<string>',
documento: '<string>',
descricao: '<string>',
telefoneCelular: '<string>',
notificarPorEmail: true,
notificarPorWhatsApp: true,
notificarPorSMS: true,
codigoIdentificador: '<string>',
dtLimiteAssinatura: '2023-11-07T05:31:56Z'
}
]
})
};
fetch('https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirAssinaturaCCB', 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.bmpdigital.moneyp.dev.br/Proposta/IncluirAssinaturaCCB",
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([
'dto' => [
'codigoProposta' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'codigoOperacao' => '<string>',
'numeroProposta' => 123
],
'assinantes' => [
[
'nome' => '<string>',
'email' => '<string>',
'documento' => '<string>',
'descricao' => '<string>',
'telefoneCelular' => '<string>',
'notificarPorEmail' => true,
'notificarPorWhatsApp' => true,
'notificarPorSMS' => true,
'codigoIdentificador' => '<string>',
'dtLimiteAssinatura' => '2023-11-07T05:31:56Z'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"IdempotencyKey: <idempotencykey>"
],
]);
$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.bmpdigital.moneyp.dev.br/Proposta/IncluirAssinaturaCCB"
payload := strings.NewReader("{\n \"dto\": {\n \"codigoProposta\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"codigoOperacao\": \"<string>\",\n \"numeroProposta\": 123\n },\n \"assinantes\": [\n {\n \"nome\": \"<string>\",\n \"email\": \"<string>\",\n \"documento\": \"<string>\",\n \"descricao\": \"<string>\",\n \"telefoneCelular\": \"<string>\",\n \"notificarPorEmail\": true,\n \"notificarPorWhatsApp\": true,\n \"notificarPorSMS\": true,\n \"codigoIdentificador\": \"<string>\",\n \"dtLimiteAssinatura\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("IdempotencyKey", "<idempotencykey>")
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.bmpdigital.moneyp.dev.br/Proposta/IncluirAssinaturaCCB")
.header("IdempotencyKey", "<idempotencykey>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"dto\": {\n \"codigoProposta\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"codigoOperacao\": \"<string>\",\n \"numeroProposta\": 123\n },\n \"assinantes\": [\n {\n \"nome\": \"<string>\",\n \"email\": \"<string>\",\n \"documento\": \"<string>\",\n \"descricao\": \"<string>\",\n \"telefoneCelular\": \"<string>\",\n \"notificarPorEmail\": true,\n \"notificarPorWhatsApp\": true,\n \"notificarPorSMS\": true,\n \"codigoIdentificador\": \"<string>\",\n \"dtLimiteAssinatura\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirAssinaturaCCB")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["IdempotencyKey"] = '<idempotencykey>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"dto\": {\n \"codigoProposta\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"codigoOperacao\": \"<string>\",\n \"numeroProposta\": 123\n },\n \"assinantes\": [\n {\n \"nome\": \"<string>\",\n \"email\": \"<string>\",\n \"documento\": \"<string>\",\n \"descricao\": \"<string>\",\n \"telefoneCelular\": \"<string>\",\n \"notificarPorEmail\": true,\n \"notificarPorWhatsApp\": true,\n \"notificarPorSMS\": true,\n \"codigoIdentificador\": \"<string>\",\n \"dtLimiteAssinatura\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"msg": "<string>",
"hasError": true,
"messages": [
{
"messageType": 1,
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"parametros": [
{
"nome": "<string>",
"valor": "<string>"
}
]
}{
"msg": "<string>",
"hasError": true,
"messages": [
{
"messageType": 1,
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
]
}Por meio deste endpoint o parceiro será direcionado ao nosso ambiente para realizar a assinatura da proposta.
- Nesse contexto é permitida a inclusão de assinantes da proposta.
- O procedimento padrão determina que a proposta só pode ser finalizada se todos os assinantes cadastrados tenham realizado a assinatura da proposta. Sendo assim, de acordo com os proeminentes, o sistema auxiliar irá controlar as assinaturas de cada indivíduo.
- Os assinantes que receberem a notificação por e-mail terão acesso a proposta para assinar a mesma e também terão possibilidade de gerenciar as assinaturas pendentes, desde que parametrizados para isto, podendo notificar os assinantes.
- O método exige os parâmetros de autenticação e de localização da proposta, assim como uma lista de assinantes.
Mensagens de erro
Mostrar Mensageria - Proposta Assinatura CCB
Mostrar Mensageria - Proposta Assinatura CCB
| Categoria | Operação | Ação | Código | Código Detalhado | Mensagem |
|---|---|---|---|---|---|
| Proposta | PropostaAssinaturaCCB | IncluirAssinaturaCCB | C0060 | V0001 | Não foram enviados assinantes para esta proposta |
| Proposta | PropostaAssinaturaCCB | IncluirAssinaturaCCB | C0060 | V0002 | Não é possível incluir assinantes na proposta. Proposta encontra-se ” + SituacaoPropostaEnum.GetDescricao(proposta.Situacao) |
| Proposta | PropostaAssinaturaCCB | IncluirAssinaturaCCB | C0060 | V0003 | Não é possível incluir assinantes, proposta deve estar aprovada |
| Proposta | PropostaAssinaturaCCB | IncluirAssinaturaCCB | C0060 | V0004 | Notificação por E-mail não parametrizado |
| Proposta | PropostaAssinaturaCCB | IncluirAssinaturaCCB | C0060 | V0005 | Notificação por WhatsApp não parametrizado |
| Proposta | PropostaAssinaturaCCB | IncluirAssinaturaCCB | C0060 | V0006 | O telefone + Telefone + possui restrição de envio de mensagem através do WhatsApp |
| Proposta | PropostaAssinaturaCCB | IncluirAssinaturaCCB | C0112 | V0001 | Proposta não encontrada |
| Proposta | PropostaAssinaturaCCB | IncluirAssinaturaCCB | C0112 | V0002 | A Proposta não pertence à esta Integração |
| Proposta | PropostaAssinaturaCCB | IncluirAssinaturaCCB | T0668 | D0001 | E-mail inválido |
| Proposta | PropostaAssinaturaCCB | IncluirAssinaturaCCB | T0668 | D0002 | Proposta não encontrada |
| Proposta | PropostaAssinaturaCCB | IncluirAssinaturaCCB | T0668 | D0003 | Nome deve ser informado |
| Proposta | PropostaAssinaturaCCB | IncluirAssinaturaCCB | T0668 | D0004 | Documento deve ser informado [{Nome}], “Documento |
| Proposta | PropostaAssinaturaCCB | IncluirAssinaturaCCB | T0668 | D0005 | E-mail deve ser informado [{Nome}]”, “Email |
| Proposta | PropostaAssinaturaCCB | IncluirAssinaturaCCB | T0668 | D0006 | E-mail inválido [{Nome}] |
| Proposta | PropostaAssinaturaCCB | IncluirAssinaturaCCB | T0668 | D0007 | Telefone Celular deve ser informado [{Nome}]”, “TelefoneCelular |
| Proposta | PropostaAssinaturaCCB | IncluirAssinaturaCCB | T0668 | D0008 | Telefone Celular deve conter 11 dígitos. Exemplo: (11) 9 9999-9999”, “TelefoneCelular |
| Proposta | PropostaAssinaturaCCB | IncluirAssinaturaCCB | T0668 | D0009 | O celular deve ter 11 dígitos. Ex: (XX) XXXXX-XXXX”, “TelefoneCelular |
| Proposta | PropostaAssinaturaCCB | IncluirAssinaturaCCB | T0668 | D0010 | O número do celular deve iniciar com os dígitos 6,7,8 ou 9”, “TelefoneCelular |
| Proposta | PropostaAssinaturaCCB | IncluirAssinaturaCCB | T0668 | D0011 | O celular deve ter 11 dígitos. Ex: (XX) XXXXX-XXXX |
| Proposta | PropostaAssinaturaCCB | IncluirAssinaturaCCB | T0668 | D0012 | ERR01 - Já existe assinante com este nome e papel |
| Proposta | PropostaAssinaturaCCB | IncluirAssinaturaCCB | T0668 | D0013 | ERR02 - Já existe assinante com este e-mail ou telefone celular |
Autorizações
Informe o token
Cabeçalhos
Corpo
application/jsontext/jsonapplication/*+json
Esta página foi útil?