| Campo | Tipo | Descrição | Obrigatório |
|---|
| BoletoTransactionCollection | Coleção de BoletoTransaction | Coleção de transações de boleto | Não |
| Buyer | Buyer | Objeto com os dados do comprador | Antifraude |
| CreditCardTransactionCollection | Coleção de CreditCardTransaction | Coleção de transações de cartão de crédito | Não |
| Merchant | Merchant | Identificação da loja. Este campo deve ser utilizado por plataformas de e-commerce que desejam identificar a loja que esta realizando a transação | Não |
| Options | CreateSaleOptions | Objeto com as configurações opcionais da transação | Não |
| Order | Order | Objeto com os dados do pedido | Não |
| RequestData | [RequestData] (referências#section-requestdata) | Objeto com os dados adicionais da requisição. | Não |
| ShoppingCartCollection | Coleção de ShoppingCart | Coleção de carrinhos de compra | Antifraude |
| Campo | Tipo | Descrição | Obrigatório |
|---|
| AmountInCents | Integer | Valor do boleto em centavos. R$ 1,00 = 100 | Sim |
| BankNumber | String | Número do banco. Consulte a tabela de BankNumber para saber quais bancos são aceitos | Não |
| BillingAddress | BillingAddress | Endereço de cobrança do cliente | Não |
| DocumentNumber | string | Número do documento no boleto. O conteúdo desse campo é utilizado somente para impressão no boleto | Não |
| Instructions | string | Instruções que serão impressas no boleto. Esse campo é utilizado para instruir o caixa do banco ao receber o pagamento do boleto. Podem ser registradas por exemplo cobranças de multa e juros. | Não |
| Options | BoletoTransactionOptions | Configurações opcionais do boleto | Não |
| TransactionDateInMerchant | string | Data da transação na plataforma da loja. Este campo deve obedecer a máscara -> “yyyy-mm-ddThh:mm:ss” | Não |
| TransactionReference | string | Identificador da transação na sua base | Não |
| Campo | Tipo | Descrição | Obrigatório |
|---|
| CurrencyIso | CurrencyIsoEnum | Moeda | Não |
| DaysToAddInBoletoExpirationDate | Integer | Dias para o vencimento | Não |
| Campo | Tipo | Descrição | Obrigatório |
|---|
| AdressCollection | Coleção de AdressCollection | Coleção de BuyerAddress com os dados do comprador | Antifraude |
| Birthdate | DateTime | Data de nascimento do cliente | Não |
| DocumentNumber | string | Número do documento (CPF/CNPJ) | Sim |
| DocumentType | DocumentTypeEnum | Tipo do documento informado | Sim |
| Email | String | Email do cliente | Antifraude |
| EmailType | EmailTypeEnum | Tipo do email | Antifraude |
| FacebookId | String | Identificação do cliente no Facebook | Não |
| Gender | GenderEnum | Gênero do cliente | Antifraude |
| HomePhone | String | Telefone residencial do cliente | Antifraude |
| MobilePhone | String | Telefone celular do cliente | Antifraude |
| Name | String | Nome do cliente | Antifraude |
| PersonType | PersonTypeEnum | Tipo de pessoa (física ou jurídica) | Antifraude |
| TwitterId | String | Identificação do cliente no Twitter | Não |
| WorkPhone | String | Telefone comercial do cliente | Antifraude |
| BuyerCategory | BuyerCategoryEnum | Categoria do cliente na plataforma One | Não |
| BuyerKey | String | Identificação do cliente na plataforma One | Não |
| CreateDateInMerchant | DateTime | Data do cadastro do cliente na plataforma da loja | Antifraude |
| LastBuyerUpdateInMerchant | DateTime | Data da última atualização do cadastro do cliente na plataforma da loja | Antifraude |
| Campo | Tipo | Descrição | Obrigatório |
|---|
| AddressType | AddressTypeEnum | Tipo de endereço | Antifraude |
| City | string | Cidade | Antifraude |
| Complement | string | Complemento | Não |
| Country | CountryEnum | País | Antifraude |
| District | string | Bairro | Antifraude |
| Number | string | Número | Antifraude |
| State | string | Estado | Antifraude |
| ZipCode | string | CEP (Sem traço) | Antifraude |
| Campo | Tipo | Descrição | Obrigatório |
|---|
| AmountInCents | Integer | Valor da transação em centavos. R$ 1,00 = 100 | Sim |
| CreditCard | CreditCard | Objeto com os dados do cartão de crédito | Sim |
| InstallmentCount | Integer | Número de Parcelas | Não |
| CreditCardOperation | CreditCardOperationEnum | Tipo da transação a ser realizada. Ex:AuthOnly | Sim |
| Options | CreditCardTransactionOptions | Objeto com configurações opcionais da transação | Não |
| Recurrency | Recurrency | Objeto com as configurações de um pagamento recorrente | Não |
| TransactionDateInMerchant | String | Data da transação na plataforma da loja. Este campo deve obedecer a máscara -> “yyyy-mm-ddThh:mm:ss” | Não |
| TransactionReference | String | Identificador da transação na sua base | Não |
| Campo | Tipo | Descrição | Obrigatório |
|---|
| BillingAddress | BillingAddress | Objeto com o endereço de cobrança | Antifraude |
| CreditCardBrand | CreditCardBrandEnum | Bandeira do cartão do cliente | Sim |
| CreditCardNumber | String | Número do cartão do cliente | Sim |
| ExpMonth | Int | Mês de expiração do cartão | Sim |
| ExpYear | Int | Ano de expiração do cartão | Sim |
| HolderName | String | Nome do portador do cartão | Sim |
| InstantBuyKey | String | InstantBuyKey guardado para utilização na compra com um clique | InstantBuy |
| SecurityCode | String | Código de segurança do cartão | Sim |
| Campo | Tipo | Descrição | Obrigatório |
|---|
| City | String | Cidade | Antifraude |
| Complement | String | Complemento do endereço | Não |
| Country | CountryEnum | País | Antifraude |
| District | String | Bairro | Antifraude |
| Number | String | Número | Antifraude |
| State | String | Estado | Antifraude |
| Street | String | Rua | Antifraude |
| ZipCode | String | CEP | Antifraude |
| Campo | Tipo | Descrição | Obrigatório |
|---|
| CaptureDelayInMinutes | Int | Delay na Captura | Não |
| CurrencyIso | CurrencyIsoEnum | Moeda | Não |
| ExtendedLimitCode | String | Código do limite extendido | Não |
| ExtendedLimitEnabled | Boolean | Limite extendido habilitado | Não |
| IataAmountInCents | Int | | Não |
| InterestRate | Decimal | Taxa de juros | Não |
| MerchantCategoryCode | Long | Categoria da loja | Não |
| PaymentMethodCode | PaymentMethodCodeEnum | Meio de pagamento a ser utilizado | Sim |
| IsRecurringTransaction | Boolean | Indica se a transação é uma transação de recorrência. | Não |
| SoftDescriptorText | String | Texto da fatura do cartão | Não |
| Campo | Tipo | Descrição | Obrigatório |
|---|
| DateToStartBilling | DateTime | Data para início da recorrência | Recorrência |
| Frequency | FrequencyEnum | Frequência de cobrança | Recorrência |
| Interval | Int | Intervalo de cobranças | Recorrência |
| OneDollarAuth | Bolean | Transação de R$ 1,00 para validar o cartão | Recorrência |
| Recurrences | Int | Número de recorrências | Recorrência |
| Campo | Tipo | Descrição | Obrigatório |
|---|
| MerchantReference | String | Referência da loja | Não |
| Campo | Tipo | Descrição | Obrigatório |
|---|
| AntiFraudServiceCode | Int | Identifica o antifraude que deve ser usado para o pedido. | Não |
| CurrencyIso | String | Define a moeda.
Padrão:BRL | Não |
| IsAntiFraudEnabled | Boolean | Define se a transação deve passar ou não no antifraude. | Não |
| Retries | Int | Número de retentativas. O máximo são cinco. | Não |
| Campo | Tipo | Descrição | Obrigatório |
|---|
| OrderReference | String | Número do pedido | Não |
| Campo | Tipo | Descrição | Obrigatório |
|---|
| EcommerceCategory | String | Define se a transação é B2B ou B2C. | Não |
| IpAddress | String | IP do comprador. | Antifraude |
| Origin | String | Campo livre pra identificar a origem do pedido. | Não |
| SessionId | String | Identificador de sessão da loja. | Antifraude |
| Campo | Tipo | Descrição | Obrigatório |
|---|
| DeliveryAddress | DeliveryAddress | Objeto com o endereço de entrega do cliente | Só no uso do Antifraude. |
| DeliveryDeadline | DateTime | Prazo máximo para entrega dos produtos. Este campo deve obedecer a máscara -> “yyyy-mm-ddThh:mm:ss” | Não. |
| EstimatedDeliveryDate | DateTime | Prazo estimado para entrega dos produtos. Este campo deve obedecer a máscara -> “yyyy-mm-ddThh:mm:ss” | Não. |
| FreightCostInCents | Long | Valor do frete em centavos | Só no uso do Antifraude. |
| ShippingCompany | String | Nome da empresa responsável pela entrega do(s) produto(s) | Não. |
| ShoppingCartItemCollection | ShoppingCartItem | Coleção com os itens do carrinho | Só no uso do Antifraude. |
| Campo | Tipo | Descrição | Obrigatório |
|---|
| City | String | Cidade | Antifraude |
| Complement | String | Complemento do endereço | Não |
| Country | CountryEnum | País | Antifraude |
| District | String | Bairro | Antifraude |
| Number | String | Número | Antifraude |
| State | String | Estado | Antifraude |
| Street | String | Rua | Antifraude |
| ZipCode | String | CEP | Antifraude |
| Campo | Tipo | Descrição | Obrigatório |
|---|
| Description | String | Descrição do produto | Não |
| DiscountAmountInCents | Long | Desconto do produto em centavos | Não |
| ItemReference | String | Identificação do produto na plataforma da loja | Não |
| Name | String | Nome do produto | Não |
| Quantity | Int | Quantidade comprada pelo cliente | Não |
| TotalCostInCents | Long | Valor total do item no carrinho | Não |
| UnitCostInCents | Long | Valor unitário desse item no carrinho" para “Valor unitário do item no carrinho | Não |
Tabela de bancos aceitos para emissão de boletos
| BankNumber | Banco |
|---|
| 341 | Itaú |
| 033 | Santander |
| 237 | Bradesco |
| 001 | Banco do Brasil |
| 399 | HSBC |
| Valor | Descrição |
|---|
| 0 | Obedece a ordem de retentativas escolhida |
| 1 | Simulador MundiPagg |
| 3 | Redecard KOMERCI |
| 5 | Cielo 1.5 |
| 15 | Elavon TEF |
| 16 | Redecard TEF |
| 20 | Stone |
| 23 | Elavon WebService |
| 32 | E-Rede |
| 37 | GetNet WebService |
| 42 | Cielo 3.0 |