26 - Include Extra Field

cURL

cURL

curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirCampoExtra \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '
{
  "dto": {
    "codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "codigoOperacao": "<string>",
    "numeroProposta": 123
  },
  "camposExtras": [
    {
      "nomeCampo": "<string>",
      "valorCampo": "<string>"
    }
  ]
}
'

import requests

url = "https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirCampoExtra"

payload = {
    "dto": {
        "codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "codigoOperacao": "<string>",
        "numeroProposta": 123
    },
    "camposExtras": [
        {
            "nomeCampo": "<string>",
            "valorCampo": "<string>"
        }
    ]
}
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
    },
    camposExtras: [{nomeCampo: '<string>', valorCampo: '<string>'}]
  })
};

fetch('https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirCampoExtra', 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/IncluirCampoExtra",
  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
    ],
    'camposExtras' => [
        [
                'nomeCampo' => '<string>',
                'valorCampo' => '<string>'
        ]
    ]
  ]),
  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/IncluirCampoExtra"

	payload := strings.NewReader("{\n  \"dto\": {\n    \"codigoProposta\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"codigoOperacao\": \"<string>\",\n    \"numeroProposta\": 123\n  },\n  \"camposExtras\": [\n    {\n      \"nomeCampo\": \"<string>\",\n      \"valorCampo\": \"<string>\"\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/IncluirCampoExtra")
  .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  \"camposExtras\": [\n    {\n      \"nomeCampo\": \"<string>\",\n      \"valorCampo\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirCampoExtra")

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  \"camposExtras\": [\n    {\n      \"nomeCampo\": \"<string>\",\n      \"valorCampo\": \"<string>\"\n    }\n  ]\n}"

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

200

{
  "msg": "<string>",
  "hasError": true,
  "messages": [
    {
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ],
  "parametros": [
    {
      "nome": "<string>",
      "valor": "<string>"
    }
  ]
}

{
  "msg": "<string>",
  "hasError": true,
  "messages": [
    {
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ]
}

Through this endpoint, the partner inserts unlimited extra fields for use in the printing of CCB. These fields should not be used by our analysts for interpreting business rules. With each submission, previous values are deleted. The process for utilization is: • Define field names in conjunction with our integration technical team. • Define the usage location for each of the extra fields. • Submit the proposal through one of the available methods. • Send the extra fields; the method allows for receiving a list containing “FieldName” and “FieldValue”. • When updating one of the extra fields, the entire batch of fields must be resent. • FieldName is limited to 30 alphanumeric characters. • FieldValue has an unlimited size.

Authorizations

Authorization · string · header · required

Informe o token

Headers

IdempotencyKey · string · required

Body

application/jsontext/jsonapplication/*+json

dto · object

Show child attributes

camposExtras · object[] | null

Show child attributes

Response

200

text/plain

OK

msg · string | null

hasError · boolean

messages · object[] | null

Show child attributes

parametros · object[] | null

Show child attributes