POST api/v2/pedido/gerarboleto

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PedidoId	integer	None.
ENDNR	string	None.
MUNIC	string	None.
ENDCP	string	None.
BAIRR	string	None.
UNFED	string	None.
ENDER	string	None.
NRCEP	string	None.
ValorTotal	decimal number	None.
NrCnpj	string	None.
EMAIL	string	None.
NomeCompleto	string	None.
NrDDD	string	None.
Phone	string	None.

Request Formats

application/json, text/json

Sample:

{
  "PedidoId": 1,
  "ENDNR": "sample string 2",
  "MUNIC": "sample string 3",
  "ENDCP": "sample string 4",
  "BAIRR": "sample string 5",
  "UNFED": "sample string 6",
  "ENDER": "sample string 7",
  "NRCEP": "sample string 8",
  "ValorTotal": 9.0,
  "NrCnpj": "sample string 10",
  "EMAIL": "sample string 11",
  "NomeCompleto": "sample string 12",
  "NrDDD": "sample string 13",
  "Phone": "sample string 14"
}

application/xml, text/xml

Sample:

<GerarBoletoBidingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FormulaCertaAPI.Models.v2.BindingModels">
  <BAIRR>sample string 5</BAIRR>
  <EMAIL>sample string 11</EMAIL>
  <ENDCP>sample string 4</ENDCP>
  <ENDER>sample string 7</ENDER>
  <ENDNR>sample string 2</ENDNR>
  <MUNIC>sample string 3</MUNIC>
  <NRCEP>sample string 8</NRCEP>
  <NomeCompleto>sample string 12</NomeCompleto>
  <NrCnpj>sample string 10</NrCnpj>
  <NrDDD>sample string 13</NrDDD>
  <PedidoId>1</PedidoId>
  <Phone>sample string 14</Phone>
  <UNFED>sample string 6</UNFED>
  <ValorTotal>9</ValorTotal>
</GerarBoletoBidingModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GerarBoletoResult

Name	Type	Additional information
BoletoResult	BoletoResult	None.
Succeeded	boolean	None.
Errors	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "BoletoResult": {
    "Assignor": "sample string 1",
    "BarCodeNumber": "sample string 2",
    "BoletoExpirationDate": "sample string 3",
    "BoletoNumber": "sample string 4",
    "BoletoUrl": "sample string 5",
    "Message": "sample string 6",
    "Amount": 7,
    "BraspagTransactionId": "9b8be66d-0b76-4a6a-9636-225d5e448cb9",
    "PaymentMethod": 9
  },
  "Succeeded": true,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<GerarBoletoResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FormulaCertaAPI.Models">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <Succeeded>true</Succeeded>
  <BoletoResult xmlns:d2p1="http://schemas.datacontract.org/2004/07/FormulaCertaAPI.Pagamento">
    <d2p1:Amount>7</d2p1:Amount>
    <d2p1:Assignor>sample string 1</d2p1:Assignor>
    <d2p1:BarCodeNumber>sample string 2</d2p1:BarCodeNumber>
    <d2p1:BoletoExpirationDate>sample string 3</d2p1:BoletoExpirationDate>
    <d2p1:BoletoNumber>sample string 4</d2p1:BoletoNumber>
    <d2p1:BoletoUrl>sample string 5</d2p1:BoletoUrl>
    <d2p1:BraspagTransactionId>9b8be66d-0b76-4a6a-9636-225d5e448cb9</d2p1:BraspagTransactionId>
    <d2p1:Message>sample string 6</d2p1:Message>
    <d2p1:PaymentMethod>9</d2p1:PaymentMethod>
  </BoletoResult>
</GerarBoletoResult>