POST api/pagarme/boleto

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Amount	integer	None.
DaysLimit	integer	None.
BoletoInstructions	string	None.
Nome	string	None.
Email	string	None.
DocumentNumber	string	None.
Street	string	None.
StreetNumber	string	None.
Neighborhood	string	None.
Zipcode	string	None.
Ddd	string	None.
Number	string	None.
PortNumber	string	None.
CardHolderName	string	None.
CardNumber	string	None.
CardExpirationDate	string	None.
PaymentId	string	None.
OrderId	string	None.
TransactionId	string	None.
CardCvv	string	None.
SourceId	integer	None.
IdCustomerPagarme	integer	None.
IdCustomerFoneclube	integer	None.
SelectedPlans	Collection of PlanoStore	None.
Frete	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Amount": 1,
  "DaysLimit": 2,
  "BoletoInstructions": "sample string 3",
  "Nome": "sample string 4",
  "Email": "sample string 5",
  "DocumentNumber": "sample string 6",
  "Street": "sample string 7",
  "StreetNumber": "sample string 8",
  "Neighborhood": "sample string 9",
  "Zipcode": "sample string 10",
  "Ddd": "sample string 11",
  "Number": "sample string 12",
  "PortNumber": "sample string 13",
  "CardHolderName": "sample string 14",
  "CardNumber": "sample string 15",
  "CardExpirationDate": "sample string 16",
  "PaymentId": "sample string 17",
  "OrderId": "sample string 18",
  "TransactionId": "sample string 19",
  "CardCvv": "sample string 20",
  "SourceId": 21,
  "IdCustomerPagarme": 1,
  "IdCustomerFoneclube": 1,
  "SelectedPlans": [
    {
      "id": "sample string 1",
      "provider": "sample string 2",
      "descricao": "sample string 3",
      "ecomStoreId": 4,
      "validity": 5,
      "data": "sample string 6",
      "valor": 7,
      "valorPromocional": 8,
      "totalItensCarrinho": 9,
      "valorFantasia": 10,
      "valorOriginal": 11,
      "apresentacao": "sample string 12",
      "tituloClube": "sample string 13",
      "textoClube": "sample string 14",
      "imagem": "sample string 15",
      "planoOptions1": "sample string 16",
      "planoOptions2": "sample string 17",
      "planoOptions3": "sample string 18",
      "planoOptions4": "sample string 19",
      "txtbeneficio": "sample string 20",
      "isEsim": true,
      "isPort": true,
      "planName": "sample string 23",
      "txtPortNumber": "sample string 24",
      "cartId": 25,
      "count": 1,
      "ActivationCode": "sample string 26",
      "ActivationQrCode": "sample string 27",
      "ICCID": "sample string 28",
      "purchaseId": "sample string 29",
      "orderId": "sample string 30",
      "travelDate": "sample string 31"
    },
    {
      "id": "sample string 1",
      "provider": "sample string 2",
      "descricao": "sample string 3",
      "ecomStoreId": 4,
      "validity": 5,
      "data": "sample string 6",
      "valor": 7,
      "valorPromocional": 8,
      "totalItensCarrinho": 9,
      "valorFantasia": 10,
      "valorOriginal": 11,
      "apresentacao": "sample string 12",
      "tituloClube": "sample string 13",
      "textoClube": "sample string 14",
      "imagem": "sample string 15",
      "planoOptions1": "sample string 16",
      "planoOptions2": "sample string 17",
      "planoOptions3": "sample string 18",
      "planoOptions4": "sample string 19",
      "txtbeneficio": "sample string 20",
      "isEsim": true,
      "isPort": true,
      "planName": "sample string 23",
      "txtPortNumber": "sample string 24",
      "cartId": 25,
      "count": 1,
      "ActivationCode": "sample string 26",
      "ActivationQrCode": "sample string 27",
      "ICCID": "sample string 28",
      "purchaseId": "sample string 29",
      "orderId": "sample string 30",
      "travelDate": "sample string 31"
    }
  ],
  "Frete": 1
}

text/html

Sample:

{"Amount":1,"DaysLimit":2,"BoletoInstructions":"sample string 3","Nome":"sample string 4","Email":"sample string 5","DocumentNumber":"sample string 6","Street":"sample string 7","StreetNumber":"sample string 8","Neighborhood":"sample string 9","Zipcode":"sample string 10","Ddd":"sample string 11","Number":"sample string 12","PortNumber":"sample string 13","CardHolderName":"sample string 14","CardNumber":"sample string 15","CardExpirationDate":"sample string 16","PaymentId":"sample string 17","OrderId":"sample string 18","TransactionId":"sample string 19","CardCvv":"sample string 20","SourceId":21,"IdCustomerPagarme":1,"IdCustomerFoneclube":1,"SelectedPlans":[{"id":"sample string 1","provider":"sample string 2","descricao":"sample string 3","ecomStoreId":4,"validity":5,"data":"sample string 6","valor":7,"valorPromocional":8,"totalItensCarrinho":9,"valorFantasia":10,"valorOriginal":11,"apresentacao":"sample string 12","tituloClube":"sample string 13","textoClube":"sample string 14","imagem":"sample string 15","planoOptions1":"sample string 16","planoOptions2":"sample string 17","planoOptions3":"sample string 18","planoOptions4":"sample string 19","txtbeneficio":"sample string 20","isEsim":true,"isPort":true,"planName":"sample string 23","txtPortNumber":"sample string 24","cartId":25,"count":1,"ActivationCode":"sample string 26","ActivationQrCode":"sample string 27","ICCID":"sample string 28","purchaseId":"sample string 29","orderId":"sample string 30","travelDate":"sample string 31"},{"id":"sample string 1","provider":"sample string 2","descricao":"sample string 3","ecomStoreId":4,"validity":5,"data":"sample string 6","valor":7,"valorPromocional":8,"totalItensCarrinho":9,"valorFantasia":10,"valorOriginal":11,"apresentacao":"sample string 12","tituloClube":"sample string 13","textoClube":"sample string 14","imagem":"sample string 15","planoOptions1":"sample string 16","planoOptions2":"sample string 17","planoOptions3":"sample string 18","planoOptions4":"sample string 19","txtbeneficio":"sample string 20","isEsim":true,"isPort":true,"planName":"sample string 23","txtPortNumber":"sample string 24","cartId":25,"count":1,"ActivationCode":"sample string 26","ActivationQrCode":"sample string 27","ICCID":"sample string 28","purchaseId":"sample string 29","orderId":"sample string 30","travelDate":"sample string 31"}],"Frete":1}

application/xml, text/xml

Sample:

<CheckoutPagarMe xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FoneClube.Business.Commons.Entities.FoneClube">
  <Amount>1</Amount>
  <BoletoInstructions>sample string 3</BoletoInstructions>
  <CardCvv>sample string 20</CardCvv>
  <CardExpirationDate>sample string 16</CardExpirationDate>
  <CardHolderName>sample string 14</CardHolderName>
  <CardNumber>sample string 15</CardNumber>
  <DaysLimit>2</DaysLimit>
  <Ddd>sample string 11</Ddd>
  <DocumentNumber>sample string 6</DocumentNumber>
  <Email>sample string 5</Email>
  <Frete>1</Frete>
  <IdCustomerFoneclube>1</IdCustomerFoneclube>
  <IdCustomerPagarme>1</IdCustomerPagarme>
  <Neighborhood>sample string 9</Neighborhood>
  <Nome>sample string 4</Nome>
  <Number>sample string 12</Number>
  <OrderId>sample string 18</OrderId>
  <PaymentId>sample string 17</PaymentId>
  <PortNumber>sample string 13</PortNumber>
  <SelectedPlans>
    <PlanoStore>
      <ActivationCode>sample string 26</ActivationCode>
      <ActivationQrCode>sample string 27</ActivationQrCode>
      <ICCID>sample string 28</ICCID>
      <apresentacao>sample string 12</apresentacao>
      <cartId>25</cartId>
      <count>1</count>
      <data>sample string 6</data>
      <descricao>sample string 3</descricao>
      <ecomStoreId>4</ecomStoreId>
      <id>sample string 1</id>
      <imagem>sample string 15</imagem>
      <isEsim>true</isEsim>
      <isPort>true</isPort>
      <orderId>sample string 30</orderId>
      <planName>sample string 23</planName>
      <planoOptions1>sample string 16</planoOptions1>
      <planoOptions2>sample string 17</planoOptions2>
      <planoOptions3>sample string 18</planoOptions3>
      <planoOptions4>sample string 19</planoOptions4>
      <provider>sample string 2</provider>
      <purchaseId>sample string 29</purchaseId>
      <textoClube>sample string 14</textoClube>
      <tituloClube>sample string 13</tituloClube>
      <totalItensCarrinho>9</totalItensCarrinho>
      <travelDate>sample string 31</travelDate>
      <txtPortNumber>sample string 24</txtPortNumber>
      <txtbeneficio>sample string 20</txtbeneficio>
      <validity>5</validity>
      <valor>7</valor>
      <valorFantasia>10</valorFantasia>
      <valorOriginal>11</valorOriginal>
      <valorPromocional>8</valorPromocional>
    </PlanoStore>
    <PlanoStore>
      <ActivationCode>sample string 26</ActivationCode>
      <ActivationQrCode>sample string 27</ActivationQrCode>
      <ICCID>sample string 28</ICCID>
      <apresentacao>sample string 12</apresentacao>
      <cartId>25</cartId>
      <count>1</count>
      <data>sample string 6</data>
      <descricao>sample string 3</descricao>
      <ecomStoreId>4</ecomStoreId>
      <id>sample string 1</id>
      <imagem>sample string 15</imagem>
      <isEsim>true</isEsim>
      <isPort>true</isPort>
      <orderId>sample string 30</orderId>
      <planName>sample string 23</planName>
      <planoOptions1>sample string 16</planoOptions1>
      <planoOptions2>sample string 17</planoOptions2>
      <planoOptions3>sample string 18</planoOptions3>
      <planoOptions4>sample string 19</planoOptions4>
      <provider>sample string 2</provider>
      <purchaseId>sample string 29</purchaseId>
      <textoClube>sample string 14</textoClube>
      <tituloClube>sample string 13</tituloClube>
      <totalItensCarrinho>9</totalItensCarrinho>
      <travelDate>sample string 31</travelDate>
      <txtPortNumber>sample string 24</txtPortNumber>
      <txtbeneficio>sample string 20</txtbeneficio>
      <validity>5</validity>
      <valor>7</valor>
      <valorFantasia>10</valorFantasia>
      <valorOriginal>11</valorOriginal>
      <valorPromocional>8</valorPromocional>
    </PlanoStore>
  </SelectedPlans>
  <SourceId>21</SourceId>
  <Street>sample string 7</Street>
  <StreetNumber>sample string 8</StreetNumber>
  <TransactionId>sample string 19</TransactionId>
  <Zipcode>sample string 10</Zipcode>
</CheckoutPagarMe>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CheckoutPagarMe'.

Response Information

Resource Description

TransactionResult

Name	Type	Additional information
Error	string	None.
LinkBoleto	string	None.
Token	string	None.
Id	string	None.
Aquire_Id	integer	None.
StatusPaid	boolean	None.
DescriptionMessage	string	None.
Recusado	boolean	None.
PixQRCode	string	None.
PaymentType	integer	None.
ChargeId	integer	None.
OrderId	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Error": "sample string 1",
  "LinkBoleto": "sample string 2",
  "Token": "sample string 3",
  "Id": "sample string 4",
  "Aquire_Id": 5,
  "StatusPaid": true,
  "DescriptionMessage": "sample string 7",
  "Recusado": true,
  "PixQRCode": "sample string 8",
  "PaymentType": 9,
  "ChargeId": 10,
  "OrderId": 11
}

text/html

Sample:

{"Error":"sample string 1","LinkBoleto":"sample string 2","Token":"sample string 3","Id":"sample string 4","Aquire_Id":5,"StatusPaid":true,"DescriptionMessage":"sample string 7","Recusado":true,"PixQRCode":"sample string 8","PaymentType":9,"ChargeId":10,"OrderId":11}

application/xml, text/xml

Sample:

<PagarMeController.TransactionResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FoneClube.WebAPI.Controllers">
  <Aquire_Id>5</Aquire_Id>
  <ChargeId>10</ChargeId>
  <DescriptionMessage>sample string 7</DescriptionMessage>
  <Error>sample string 1</Error>
  <Id>sample string 4</Id>
  <LinkBoleto>sample string 2</LinkBoleto>
  <OrderId>11</OrderId>
  <PaymentType>9</PaymentType>
  <PixQRCode>sample string 8</PixQRCode>
  <Recusado>true</Recusado>
  <StatusPaid>true</StatusPaid>
  <Token>sample string 3</Token>
</PagarMeController.TransactionResult>