Criar Pagamento

Neste endpoint nosso protocolo espera que você retorne quais as formas de parcelamento para uma forma de pagamento.

/# Request Bod

{
  "id": "8b5bf004-cb12-419a-a551-22b1cbab5078",
  "nsu": 1,
  "amount": 100,
  "payment_method": "Visa",
  "card": {
    "brand": "Visa",
    "number": "4551870000000183",
    "exp_month": "10",
    "exp_year": "2019",
    "holder_name": "TESTE CIELO",
    "security_code": "123"
  },
  "installments": 1,
  "request": {
    "ip_address": "127.0.0.1",
    "session_id": "wim2gfti63d4e9dcgvdnqdb7mwytahkf",
    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/68.0.3",
    "device_finger_print": "a5eb67bc403ed1021b91c20f1cb4c6a0"
  },
  "buyer": {
    "id": "bcb5d867-3a11-4ea2-b79e-0193e9152b2e",
    "name": "Comprador Teste",
    "document_number": "04136081820",
    "document_type": "CPF",
    "email": "[email protected]",
    "phone": "1140107676",
    "billing_address": {
      "city": "RIBEIRÃO PRETO",
      "state": "SP",
      "street": "R BERNARDINO DE CAMPOS",
      "number": "1001",
      "neighborhood": "HIGIENOPOLIS",
      "country": "BRA",
      "zipcode": "14015130"
    }
  },
  "cart": {
    "delivery_address":{
      "city": "RIBEIRÃO PRETO",
      "state": "SP",
      "street": "R BERNARDINO DE CAMPOS",
      "number": "1001",
      "neighborhood": "HIGIENOPOLIS",
      "country": "BRA",
      "zipcode": "14015130"
    },
    "items": [
      {
        "id", 1, 
        "ean_13": "1234567890123", 
        "reference_code": 1, 
        "name": "Produto de Teste",
        "quantity": 1,
        "unit": 100,
        "total": 100,
        "discount": 0
      }
    ],
    "shipping_total": 0
  }
}

Request Body - Descrição dos Campos

ParameterTypeDescription
iduuidID da transação na Convertize
nsuintegerNúmero sequencial único da transação
amountintegerValor total do pagamento em centavos
payment_methodstringNome da forma de pagamento, Veja a lista
cardobjectDados do cartão
=> brandstringBandeira do Cartão
=> numberstringNúmero do Cartão
=> exp_monthstringMes de Validade do Cartão
=> exp_yearstringAno de Validade do Cartão
=> holder_namestringNome do Cartão
=> security_codestringCódigo de segurança do Cartão
installmentsintegerNúmero de parcelas
requestobjectDados do request do usuário
=> ip_addressstringEndereço de IP do comprador
=> session_idstringId da sessão do comprador
=> user_agentstringUser Agent do comprador
=> device_finger_printstringFingerprint representa caracteristicas do dispositivo usado para fazer o pedido
buyerobjectDados do comprador
=> iduuidID do comprador na Convertize
=> namestringNome do comprador
=> document_numberstringNúmero do documento do comprador
=> document_typestringTipo do documento do comprador
=> emailstringE-mail do comprador
=> phonestringTelefone do comprador
=> billing_addressobjectDados do endereço de entrega
=>=> citystringCidade do endereço de pagamento
=>=> statestringEstado do endereço de pagamento
=>=> streetstringRua do endereço de pagamento
=>=> numberstringNúmero do endereço de pagamento
=>=> neighborhoodstringBairro do endereço de pagamento
=>=> countrystringPais do endereço de pagamento
=>=> zipcodestringZipcode (CEP) do endereço de pagamento
cartobjectDados do carrinho
=> delivery_addressobjectDados do endereço de entrega
=>=> citystringCidade do endereço de entrega
=>=> statestringEstado do endereço de entrega
=>=> streetstringRua do endereço de entrega
=>=> numberstringNúmero do endereço de entrega
=>=> neighborhoodstringBairro do endereço de entrega
=>=> countrystringPais do endereço de entrega
=>=> zipcodestringZipcode (CEP) do endereço de entrega
=>itemsarray of objectLista de objetos com dados dos items
=>=>idintegerID do item na Convertize
=>=>ean_13stringEAN 13 do item na Convertize
=>=>reference_codestringCódigo de Referência do item na Convertize
=>=>namestringNome do item
=>=>quantityintegerQuantidade deste item no carrinho
=>=>unitintegerPreço Unitário do item em centavos
=>=>totalintegerPreço Unitário do item em centavos
=>=>discountintegerDesconto total do item em centavos
=>shipping_totalintegerValor total do frete em centavos
notification_urlstringUrl para notificação com o status das transações
return_urlstringUrl de retorno (usada somente no fluxo com redirect)

Response Body

ParameterTypeDescription
iduuidID da transação na Convertize
statusstringStatus da transação (APPROVED, DENIED, AUTHENTICATING ou APPROVED_PENDING_CAPTURE)
payment_idstringID de do pagamento gerado pela sua WebAPI
nsustringNúmero sequencial unico
tidstringID da transação
redirect_url(optional)stringURL de authenticação usando em pagamentos com redirecionamentos
boleto_url(optional)stringURL do boleto usado somente em pagamentos com Boleto
barcode(optional)stringBarcode do Boleto, usado somente em pagamentos com Boleto
billet_html(optional)stringURL do boleto em formato HTML, usado somente em pagamentos com Boleto
billet_pdf(optional)stringURL do boleto em formato PDF, usado somente em pagamentos com Boleto
code(optional)stringCódigo de erro
message(optional)stringMensagem de erro
token(optional)stringToken referente ao cartão ou forma de pagamento
qrcode(optional)stringCódigo do QRCODE, usado somente para pagamentos via QRCODE
qrcode_image(optional)stringImage do QRCODE em base64, usado somente para pagamentos via QRCODE
Language
Click Try It! to start a request and see the response here!