API Reference
API Reference

Como mandar uma requisição completa!

CreateSaleRequest

CampoTipoDescriçãoObrigatório
BoletoTransactionCollectionColeção de BoletoTransactionColeção de transações de boletoNão
BuyerBuyerObjeto com os dados do compradorAntifraude
CreditCardTransactionCollectionColeção de CreditCardTransactionColeção de transações de cartão de créditoNão
MerchantMerchantIdentificação da loja. Este campo deve ser utilizado por plataformas de e-commerce que desejam identificar a loja que esta realizando a transaçãoNão
OptionsCreateSaleOptionsObjeto com as configurações opcionais da transaçãoNão
OrderOrderObjeto com os dados do pedidoNão
RequestData[RequestData] (referências#section-requestdata)Objeto com os dados adicionais da requisição.Não
ShoppingCartCollectionColeção de ShoppingCartColeção de carrinhos de compraAntifraude

BoletoTransaction

CampoTipoDescriçãoObrigatório
AmountInCentsIntegerValor do boleto em centavos. R$ 1,00 = 100Sim
BankNumberStringNúmero do banco. Consulte a tabela de BankNumber para saber quais bancos são aceitosNão
BillingAddressBillingAddressEndereço de cobrança do clienteNão
DocumentNumberstringNúmero do documento no boleto. O conteúdo desse campo é utilizado somente para impressão no boletoNão
InstructionsstringInstruçõ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
OptionsBoletoTransactionOptionsConfigurações opcionais do boletoNão
TransactionDateInMerchantstringData da transação na plataforma da loja. Este campo deve obedecer a máscara -> “yyyy-mm-ddThh:mm:ss”Não
TransactionReferencestringIdentificador da transação na sua baseNão

BoletoTransactionOptions

CampoTipoDescriçãoObrigatório
CurrencyIsoCurrencyIsoEnumMoedaNão
DaysToAddInBoletoExpirationDateIntegerDias para o vencimentoNão

Buyer

CampoTipoDescriçãoObrigatório
AdressCollectionColeção de AdressCollectionColeção de BuyerAddress com os dados do compradorAntifraude
BirthdateDateTimeData de nascimento do clienteNão
DocumentNumberstringNúmero do documento (CPF/CNPJ)Sim
DocumentTypeDocumentTypeEnumTipo do documento informadoSim
EmailStringEmail do clienteAntifraude
EmailTypeEmailTypeEnumTipo do emailAntifraude
FacebookIdStringIdentificação do cliente no FacebookNão
GenderGenderEnumGênero do clienteAntifraude
HomePhoneStringTelefone residencial do clienteAntifraude
MobilePhoneStringTelefone celular do clienteAntifraude
NameStringNome do clienteAntifraude
PersonTypePersonTypeEnumTipo de pessoa (física ou jurídica)Antifraude
TwitterIdStringIdentificação do cliente no TwitterNão
WorkPhoneStringTelefone comercial do clienteAntifraude
BuyerCategoryBuyerCategoryEnumCategoria do cliente na plataforma OneNão
BuyerKeyStringIdentificação do cliente na plataforma OneNão
CreateDateInMerchantDateTimeData do cadastro do cliente na plataforma da lojaAntifraude
LastBuyerUpdateInMerchantDateTimeData da última atualização do cadastro do cliente na plataforma da lojaAntifraude

BuyerAddressCollection

CampoTipoDescriçãoObrigatório
AddressTypeAddressTypeEnumTipo de endereçoAntifraude
CitystringCidadeAntifraude
ComplementstringComplementoNão
CountryCountryEnumPaísAntifraude
DistrictstringBairroAntifraude
NumberstringNúmeroAntifraude
StatestringEstadoAntifraude
ZipCodestringCEP (Sem traço)Antifraude

CreditCardTransaction

CampoTipoDescriçãoObrigatório
AmountInCentsIntegerValor da transação em centavos. R$ 1,00 = 100Sim
CreditCardCreditCardObjeto com os dados do cartão de créditoSim
InstallmentCountIntegerNúmero de ParcelasNão
CreditCardOperationCreditCardOperationEnumTipo da transação a ser realizada. Ex:AuthOnlySim
OptionsCreditCardTransactionOptionsObjeto com configurações opcionais da transaçãoNão
RecurrencyRecurrencyObjeto com as configurações de um pagamento recorrenteNão
TransactionDateInMerchantStringData da transação na plataforma da loja. Este campo deve obedecer a máscara -> “yyyy-mm-ddThh:mm:ss”Não
TransactionReferenceStringIdentificador da transação na sua baseNão

CreditCard

CampoTipoDescriçãoObrigatório
BillingAddressBillingAddressObjeto com o endereço de cobrançaAntifraude
CreditCardBrandCreditCardBrandEnumBandeira do cartão do clienteSim
CreditCardNumberStringNúmero do cartão do clienteSim
ExpMonthIntMês de expiração do cartãoSim
ExpYearIntAno de expiração do cartãoSim
HolderNameStringNome do portador do cartãoSim
InstantBuyKeyStringInstantBuyKey guardado para utilização na compra com um cliqueInstantBuy
SecurityCodeStringCódigo de segurança do cartãoSim

BillingAddress

CampoTipoDescriçãoObrigatório
CityStringCidadeAntifraude
ComplementStringComplemento do endereçoNão
CountryCountryEnumPaísAntifraude
DistrictStringBairroAntifraude
NumberStringNúmeroAntifraude
StateStringEstadoAntifraude
StreetStringRuaAntifraude
ZipCodeStringCEPAntifraude

CreditCardTransactionOptions

CampoTipoDescriçãoObrigatório
CaptureDelayInMinutesIntDelay na CapturaNão
CurrencyIsoCurrencyIsoEnumMoedaNão
ExtendedLimitCodeStringCódigo do limite extendidoNão
ExtendedLimitEnabledBooleanLimite extendido habilitadoNão
IataAmountInCentsIntNão
InterestRateDecimalTaxa de jurosNão
MerchantCategoryCodeLongCategoria da lojaNão
PaymentMethodCodePaymentMethodCodeEnumMeio de pagamento a ser utilizadoSim
IsRecurringTransactionBooleanIndica se a transação é uma transação de recorrência.Não
SoftDescriptorTextStringTexto da fatura do cartãoNão

Recurrency

CampoTipoDescriçãoObrigatório
DateToStartBillingDateTimeData para início da recorrênciaRecorrência
FrequencyFrequencyEnumFrequência de cobrançaRecorrência
IntervalIntIntervalo de cobrançasRecorrência
OneDollarAuthBoleanTransação de R$ 1,00 para validar o cartãoRecorrência
RecurrencesIntNúmero de recorrênciasRecorrência

Merchant

CampoTipoDescriçãoObrigatório
MerchantReferenceStringReferência da lojaNão

Options

CampoTipoDescriçãoObrigatório
AntiFraudServiceCodeIntIdentifica o antifraude que deve ser usado para o pedido.Não
CurrencyIsoStringDefine a moeda.
Padrão:BRL
Não
IsAntiFraudEnabledBooleanDefine se a transação deve passar ou não no antifraude.Não
RetriesIntNúmero de retentativas. O máximo são cinco.Não

Order

CampoTipoDescriçãoObrigatório
OrderReferenceStringNúmero do pedidoNão

RequestData

CampoTipoDescriçãoObrigatório
EcommerceCategoryStringDefine se a transação é B2B ou B2C.Não
IpAddressStringIP do comprador.Antifraude
OriginStringCampo livre pra identificar a origem do pedido.Não
SessionIdStringIdentificador de sessão da loja.Antifraude

ShoppingCart

CampoTipoDescriçãoObrigatório
DeliveryAddressDeliveryAddressObjeto com o endereço de entrega do clienteSó no uso do Antifraude.
DeliveryDeadlineDateTimePrazo máximo para entrega dos produtos. Este campo deve obedecer a máscara -> “yyyy-mm-ddThh:mm:ss”Não.
EstimatedDeliveryDateDateTimePrazo estimado para entrega dos produtos. Este campo deve obedecer a máscara -> “yyyy-mm-ddThh:mm:ss”Não.
FreightCostInCentsLongValor do frete em centavosSó no uso do Antifraude.
ShippingCompanyStringNome da empresa responsável pela entrega do(s) produto(s)Não.
ShoppingCartItemCollectionShoppingCartItemColeção com os itens do carrinhoSó no uso do Antifraude.

DeliveryAddress

CampoTipoDescriçãoObrigatório
CityStringCidadeAntifraude
ComplementStringComplemento do endereçoNão
CountryCountryEnumPaísAntifraude
DistrictStringBairroAntifraude
NumberStringNúmeroAntifraude
StateStringEstadoAntifraude
StreetStringRuaAntifraude
ZipCodeStringCEPAntifraude

ShoppingCartItem

CampoTipoDescriçãoObrigatório
DescriptionStringDescrição do produtoNão
DiscountAmountInCentsLongDesconto do produto em centavosNão
ItemReferenceStringIdentificação do produto na plataforma da lojaNão
NameStringNome do produtoNão
QuantityIntQuantidade comprada pelo clienteNão
TotalCostInCentsLongValor total do item no carrinhoNão
UnitCostInCentsLongValor unitário desse item no carrinho" para “Valor unitário do item no carrinhoNão

BankNumber

Tabela de bancos aceitos para emissão de boletos

BankNumberBanco
341Itaú
033Santander
237Bradesco
001Banco do Brasil
399HSBC

PaymentMethodCode

ValorDescrição
0Obedece a ordem de retentativas escolhida
1Simulador MundiPagg
3Redecard KOMERCI
5Cielo 1.5
15Elavon TEF
16Redecard TEF
20Stone
23Elavon WebService
32E-Rede
37GetNet WebService
42Cielo 3.0
Website Localization**/