POST api/v2/pedido/efetuarpagamento

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PedidoId	integer	Required
CanalId	integer	Required
TipoCartao	string	Required
EnderecoCobrancaId	integer	Required
NumeroCartao	string	Required
CodigoSeguranca	string	Required
NomeNoCartao	string	Required
DataExpiracao	string	Required
ValorTotal	decimal number	Required
NumeroParcelas	integer	None.
CodigoBandeira	integer	None.
TenantId	globally unique identifier	None.
PagSeguroSenderHash	string	None.
PagSeguroCreditCardToken	string	None.
DataNascimentoTitularCartao	string	None.
CPFTitularCartao	string	None.
DDDTitularCartao	string	None.
TelefoneTitularCartao	string	None.

Request Formats

application/json, text/json

Sample:

{
  "PedidoId": 1,
  "CanalId": 2,
  "TipoCartao": "sample string 3",
  "EnderecoCobrancaId": 4,
  "NumeroCartao": "sample string 5",
  "CodigoSeguranca": "sample string 6",
  "NomeNoCartao": "sample string 7",
  "DataExpiracao": "sample string 8",
  "ValorTotal": 9.0,
  "NumeroParcelas": 10,
  "CodigoBandeira": 11,
  "TenantId": "3ca66738-7145-44be-8306-7d5a8267ff3b",
  "PagSeguroSenderHash": "sample string 13",
  "PagSeguroCreditCardToken": "sample string 14",
  "DataNascimentoTitularCartao": "sample string 15",
  "CPFTitularCartao": "sample string 16",
  "DDDTitularCartao": "sample string 17",
  "TelefoneTitularCartao": "sample string 18"
}

application/xml, text/xml

Sample:

<EfetuarPagamentoBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FormulaCertaAPI.Models">
  <CPFTitularCartao>sample string 16</CPFTitularCartao>
  <CanalId>2</CanalId>
  <CodigoBandeira>11</CodigoBandeira>
  <CodigoSeguranca>sample string 6</CodigoSeguranca>
  <DDDTitularCartao>sample string 17</DDDTitularCartao>
  <DataExpiracao>sample string 8</DataExpiracao>
  <DataNascimentoTitularCartao>sample string 15</DataNascimentoTitularCartao>
  <EnderecoCobrancaId>4</EnderecoCobrancaId>
  <NomeNoCartao>sample string 7</NomeNoCartao>
  <NumeroCartao>sample string 5</NumeroCartao>
  <NumeroParcelas>10</NumeroParcelas>
  <PagSeguroCreditCardToken>sample string 14</PagSeguroCreditCardToken>
  <PagSeguroSenderHash>sample string 13</PagSeguroSenderHash>
  <PedidoId>1</PedidoId>
  <TelefoneTitularCartao>sample string 18</TelefoneTitularCartao>
  <TenantId>3ca66738-7145-44be-8306-7d5a8267ff3b</TenantId>
  <TipoCartao>sample string 3</TipoCartao>
  <ValorTotal>9</ValorTotal>
</EfetuarPagamentoBindingModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

EfetuarPagamentoResult

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

Response Formats

application/json, text/json

Sample:

{
  "Succeeded": true,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<EfetuarPagamentoResult 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>
</EfetuarPagamentoResult>