API de Pagamentos - Chile

A API de Pagamentos para o Chile permite que você integre de forma eficiente as capacidades de processamento de pagamentos da PayU na sua plataforma de compras online. Por meio dessa API, as lojas podem oferecer aos seus clientes uma ampla variedade de métodos de pagamento, incluindo dinheiro, cartões de crédito, débito ou pré-pagos, e cartões de débito ou pré-pagos através do WebPay Plus.

Este guia mostra como aproveitar esses serviços para melhorar a experiência de pagamento dos seus clientes, oferecendo opções de pagamento flexíveis e seguras adaptadas ao mercado local.

Métodos Disponíveis

A API de Pagamentos inclui os seguintes métodos:

Enviar Transações Usando Cartões de Crédito, Débito ou Pré-Pago

Este método permite processar os pagamentos efetuados pelos seus clientes com cartões de crédito, débito ou pré-pago. Para o Chile, você pode executar os fluxos de duas etapas, você pode executar os fluxos de duas etapas (Autorização, Captura) e fluxos de uma etapa (Cobrança). Para obter mais informações, consulte Fluxos de pagamento.

Parâmetros para Solicitação e Resposta

Solicitação
Nome do Campo Formato Tamanho Descrição Obrigatório
language Alfanumérico 2 Idioma usado no pedido, usado para exibir as mensagens de erro geradas. Veja os idiomas disponíveis. Sim
command Alfanumérico Máx:32 Definir SUBMIT_TRANSACTION. Sim
test (JSON)
isTest (XML)		 Boolean Definir true se o pedido estiver em modo de teste. Caso contrário, definir false. Sim
merchant Objeto Este objeto contém os dados de autenticação. Sim
merchant > apiLogin Alfanumérico Mín:12 Máx:32 Usuário ou login fornecido pelo PayU. Como faço para obter minha API Login Sim
merchant > apiKey Alfanumérico Mín:6 Máx:32 Senha fornecida pelo PayU. Como faço para obter minha API key Sim
transaction Objeto Este objeto contém os dados da transação. Sim
transaction > order Objeto Este objeto contém os dados da ordem. Sim
transaction > order > accountId Número Identificador da sua conta. Sim
transaction > order > referenceCode Alfanumérico Mín:1 Máx:255 Representa o identificador da ordem em seu sistema. Sim
transaction > order > description Alfanumérico Mín:1 Máx:255 Descrição da ordem. Sim
transaction > order > language Alfanumérico 2 Idioma usado nos e-mails enviados ao comprador e ao vendedor. Sim
transaction > order > notifyUrl Alfanumérico Máx:2048 URL de confirmação da ordem. Não
transaction > order > partnerId Alfanumérico Máx:255 ID de parceiro no PayU. Não
transaction > order > signature Alfanumérico Máx:255 A assinatura associada ao formulário. Para obter mais informações, consulte Assinatura de autenticação. Sim
transaction > order > shippingAddress Objeto Endereço para envio. Não
transaction > order > shippingAddress > street1 Alfanumérico Máx:100 Endereço: Linha 1. Não
transaction > order > shippingAddress > street2 Alfanumérico Máx:100 Endereço: Linha 2. Não
transaction > order > shippingAddress > city Alfanumérico Máx:50 Endereço: cidade. Não
transaction > order > shippingAddress > state Alfanumérico Máx:40 Endereço: estado. Não
transaction > order > shippingAddress > country Alfanumérico 2 Endereço: país. Não
transaction > order > shippingAddress > postalCode Alfanumérico Máx:8 Endereço: Código postal. Não
transaction > order > shippingAddress > phone Alfanumérico Máx:11 Número de telefone associado ao endereço. Não
transaction > order > buyer Objeto Informações do comprador. Sim
transaction > order > buyer > merchantBuyerId Alfanumérico Máx:100 ID do comprador em seu sistema. Não
transaction > order > buyer > fullName Alfanumérico Máx:150 Nome completo do comprador. Sim
transaction > order > buyer > emailAddress Alfanumérico Máx:255 E-mail do comprador. Sim
transaction > order > buyer > contactPhone Alfanumérico Máx:20 Número de telefone do comprador. Sim
transaction > order > buyer > dniNumber Alfanumérico Máx:20 Número de identificação do comprador. Sim
transaction > order > buyer > shippingAddress Alfanumérico Endereço de envio do comprador. Sim
transaction > order > buyer > shippingAddress > street1 Alfanumérico Máx:150 Linha 1 do endereço de entrega do comprador. Sim
transaction > order > buyer > shippingAddress > city Alfanumérico Máx:50 Cidade do endereço de entrega do comprador. Sim
transaction > order > buyer > shippingAddress > state Alfanumérico Máx:40 Estado do endereço de entrega do comprador. Sim
transaction > order > buyer > shippingAddress > country Alfanumérico 2 País do endereço do comprador no formato ISO 3166 alpha-2. Sim
transaction > order > buyer > shippingAddress > postalCode Número Máx:20 Código postal do endereço do comprador. Sim
transaction > order > buyer > shippingAddress > phone Número Máx:20 Número de telefone do endereço do comprador. Sim
transaction > order > additionalValues > Objeto 64 Valor da ordem ou seus valores associados. Sim
transaction > order > additionalValues > TX_VALUE Alfanumérico 64 Valor da transação. Sim
transaction > order > additionalValues > TX_VALUE > value Número 12, 2 Especifica o valor da transação. Este valor não pode incluir decimais. Sim
transaction > order > additionalValues > TX_VALUE > currency Alfanumérico 3 Código ISO da moeda. Veja as moedas aceitas. Sim
transaction > order > additionalValues > TX_TAX Alfanumérico 64 Total do Imposto sobre Valor Agregado (IVA). Sim
transaction > order > additionalValues > TX_TAX > value Número 12, 2 Especifica o valor do IVA. Não
transaction > order > additionalValues > TX_TAX > currency Alfanumérico 3 Código ISO da moeda. Veja as moedas aceitas. Não
transaction > order > additionalValues > TX_TAX_RETURN_BASE Alfanumérico 64 Valor base para cálculo do VAT.
Se o valor não tiver IVA, envie 0.
Este valor pode ter duas casas decimais.		 Não
transaction > order > additionalValues > TX_TAX_RETURN_BASE > value Número 12, 2 Especifica o valor base da transação. Não
transaction > order > additionalValues > TX_TAX_RETURN_BASE > currency Alfanumérico 3 Código ISO da moeda. Veja as moedas aceitas. Não
transaction > creditCardTokenId Alfanumérico Incluir este parâmetro quando a transação for feita com um cartão tokenizado, no lugar das informações do cartão de crédito. Para obter mais informações, consulte API de tokenização Não
transaction > creditCard Objeto Informações do cartão de crédito. Este objeto e seus parâmetros são obrigatórios quando o pagamento é realizado com cartão de crédito não tokenizado. Não
transaction > creditCard > number Alfanumérico Mín:13 Máx:20 Número do cartão de crédito. Não
transaction > creditCard > securityCode Alfanumérico Mín:1 Máx:4 Código de segurança do cartão de crédito (CVC2, CVV2, CID). Não
transaction > creditCard > expirationDate Alfanumérico 7 Data de validade do cartão de crédito. Formato YYYY/MM. Não
transaction > creditCard > name Alfanumérico Mín:1 Máx:255 Nome do titular exibido no cartão de crédito. Não
transaction > creditCard > processWithoutCvv2 Boolean Máx:255 Permite processar transações sem incluir o código de segurança do cartão de crédito. Sua loja precisa da autorização do PayU antes de usar este recurso. Não
transaction > debitCard Objeto Informações do cartão de débito. Este objeto e seus parâmetros são obrigatórios quando o pagamento é realizado com cartão de débito. Não
transaction > debitCard > number Alfanumérico Mín:13 Máx:20 Número do cartão de débito. Não
transaction > debitCard > securityCode Alfanumérico Mín:1 Máx:4 Código de segurança do cartão de débito (CVC2, CVV2, CID). Não
transaction > debitCard > expirationDate Alfanumérico 7 Data de validade do cartão de débito. Formato YYYY/MM. Não
transaction > debitCard > name Alfanumérico Mín:1 Máx:255 Nome do titular exibido no cartão de débito. Não
transaction > payer Objeto Informações do pagador. Sim
transaction > payer > emailAddress Alfanumérico Máx:255 Endereço de e-mail do pagador. Sim
transaction > payer > merchantPayerId Alfanumérico Máx:100 Identificador do pagador em seu sistema. Não
transaction > payer > fullName Alfanumérico Máx:150 Nome do pagador, que deve corresponder ao nome enviado no parâmetro transaction.creditCard.name para pagamentos com cartão de crédito. Sim
transaction > payer > billingAddress Objeto Endereço de cobrança. Sim
transaction > payer > billingAddress > street1 Alfanumérico Máx:100 Endereço de cobrança linha 1. Sim
transaction > payer > billingAddress > street2 Alfanumérico Máx:100 Endereço de cobrança linha 2. Não
transaction > payer > billingAddress > city Alfanumérico Máx:50 Cidade do endereço de cobrança. Sim
transaction > payer > billingAddress > state Alfanumérico Máx:40 Estado do endereço de cobrança. Não
transaction > payer > billingAddress > country Alfanumérico 2 País do endereço de cobrança no formato ISO 3166 Alpha-2. Sim
transaction > payer > billingAddress > postalCode Alfanumérico Máx:20 Código postal do endereço de cobrança. Não
transaction > payer > billingAddress > phone Alfanumérico Máx:20 Número de telefone do endereço de cobrança. Não
transaction > payer > birthdate Alfanumérico Máx:10 Data de nascimento do pagador. Não
transaction > payer > contactPhone Alfanumérico Máx:20 Número de telefone do pagador. Sim
transaction > payer > dniNumber Alfanumérico Máx:20 Número de identificação do pagador. Sim
transaction > payer > dniType Alfanumérico 2 Tipo de identificação do pagador. Veja os tipos de documentos. Não
transaction > type Alfanumérico 32 Definir este valor de acordo com a transação que você quer:
  • AUTHORIZATION
  • CAPTURE
  • AUTHORIZATION_AND_CAPTURE para fluxos de uma etapa.
 Sim
transaction > paymentMethod Alfanumérico 32 Selecione um método de pagamento com cartão de crédito ou débito válido. Veja os métodos de pagamento disponíveis o Chile. Sim
transaction > paymentCountry Alfanumérico 2 Definir CL o Chile. Sim
transaction > deviceSessionId Alfanumérico Máx:255 Identificador da sessão do dispositivo onde o cliente faz a transação. Para obter mais informações, consulte este tópico. Sim
transaction > ipAddress Alfanumérico Máx:39 Endereço IP do dispositivo onde o cliente faz a transação. Sim
transaction > cookie Alfanumérico Máx:255 Cookie armazenado pelo dispositivo onde o cliente faz a transação. Sim
transaction > userAgent Alfanumérico Máx:1024 O agente do usuário do navegador onde o cliente faz a transação. Sim
transaction > extraParameters Objeto Parâmetros ou dados adicionais associados a pedido. O tamanho máximo de cada nome extraParameters é de 64 caracteres.
Em JSON, o parâmetro extraParameters segue esta estrutura:
"extraParameters": {
 "INSTALLMENTS_NUMBER": 1
}

Em XML, o parâmetro extraParameters segue esta estrutura:
<extraParameters>
 <entry>
  <string>INSTALLMENTS_NUMBER</string>
  <string>1</string>
 </entry>
</extraParameters>		 Não
Resposta
Nome do Campo Formato Tamanho Descrição
code Alfanumérico O código de resposta da transação. Os valores possíveis são ERROR e SUCCESS.
error Alfanumérico Máx:2048 A mensagem de erro associada quando o código de resposta é ERROR.
transactionResponse Objeto Os dados de resposta.
transactionResponse > orderId Número O ID de ordem gerado ou existente no PayU.
transactionResponse > transactionId Alfanumérico 36 O identificador da transação no PayU.
transactionResponse > state Alfanumérico Máx:32 O status da transação.
transactionResponse > responseCode Alfanumérico Máx:64 O código de resposta associado ao status.
transactionResponse > paymentNetworkResponseCode Alfanumérico Máx:255 O código de resposta fornecido pela rede financeira.
transactionResponse > paymentNetworkResponseErrorMessage Alfanumérico Máx:255 A mensagem de erro fornecida pela rede financeira.
transactionResponse > trazabilityCode Alfanumérico Máx:32 O código de rastreamento fornecido pela rede financeira.
transactionResponse > authorizationCode Alfanumérico Máx:12 O código de autorização fornecido pela rede financeira.
transactionResponse > responseMessage Alfanumérico Máx:2048 Mensagem associada ao código de resposta.
transactionResponse > operationDate Date Data de criação da resposta no sistema PayU.
transactionResponse > extraParameters Objeto Parâmetros ou dados adicionais associados à resposta.
Em JSON, o parâmetro extraParameters segue esta estrutura:
"extraParameters": {
 "BANK_REFERENCED_CODE": "CREDIT"
}

Em XML, o parâmetro extraParameters segue esta estrutura:
<extraParameters>
 <entry>
  <string>BANK_REFERENCED_CODE</string>
  <string>CREDIT</string>
 </entry>
</extraParameters>

Considerações

  • Tokens de Cartão de Crédito: Ao utilizar tokens de cartão de crédito para pagamentos, inclua os seguintes parâmetros:
    • transaction.creditCardTokenId: Identifica o token do cartão de crédito armazenado.
    • transaction.creditCard.securityCode (Opcional): O código de segurança do cartão (CVV) se necessário para o seu processamento. Para mais informações sobre como criar e usar tokens, consulte a API de Tokenização.
  • Moeda: As transações devem ser enviadas em Pesos Chilenos (CLP) com números inteiros apenas. Decimais não são permitidos.
  • Fluxos de Duas Etapas (Autorização e Captura):
    • Disponível atualmente apenas para pagamentos à vista. A integração rejeitará automaticamente transações parceladas.
    • A funcionalidade do fluxo de duas etapas requer ativação prévia. Entre em contato com o seu representante de vendas da PayU para mais informações e ativação.
  • Código de Segurança (CVV):
    • Por padrão, o processamento de cartões de crédito sem o código de segurança (CVV) não está habilitado.
    • Para habilitar o processamento sem CVV, entre em contato com o seu representante de vendas da PayU. Uma vez habilitado, inclua o parâmetro creditCard.processWithoutCvv2 definido como true em sua solicitação e omita o parâmetro creditCard.securityCode.

Autorização

Use este método para executar a etapa Autorização de um fluxo de duas etapas. Nesta etapa, você autoriza o pagamento, mas o valor não é debitado até você capturar os fundos.
A seguir estão os corpos de pedido e resposta para este tipo de transação.


Exemplo de uma Solicitação:

{
   "language": "es",
   "command": "SUBMIT_TRANSACTION",
   "merchant": {
      "apiKey": "4Vj8eK4rloUd272L48hsrarnUA",
      "apiLogin": "pRRXKOl8ikMmt9u"
   },
   "transaction": {
      "order": {
         "accountId": "512325",
         "referenceCode": "PRODUCT_TEST_2021-06-25T16:33:48.512Z",
         "description": "Payment test description",
         "language": "es",
         "signature": "77d72fb91eb43f9b15fb300d5f173da3",
         "notifyUrl": "http://www.payu.com/notify",
         "additionalValues": {
            "TX_VALUE": {
               "value": 10000,
               "currency": "CLP"
         }
         },
         "buyer": {
            "merchantBuyerId": "1",
            "fullName": "First name and second buyer name",
            "emailAddress": "buyer_test@test.com",
            "contactPhone": "7563126",
            "dniNumber": "123456789",
            "shippingAddress": {
               "street1": "Autopista Del Sol, 0 - Km.43 Costado Sur",
               "street2": "5555487",
               "city": "RM",
               "state": "Talagante",
               "country": "CL",
               "postalCode": "000000",
               "phone": "7563126"
            }
         },
         "shippingAddress": {
            "street1": "Autopista Del Sol, 0 - Km.43 Costado Sur",
            "street2": "5555487",
            "city": "RM",
            "state": "Talagante",
            "country": "CL",
            "postalCode": "0000000",
            "phone": "7563126"
         }
      },
      "payer": {
         "merchantPayerId": "1",
         "fullName": "First name and second payer name",
         "emailAddress": "payer_test@test.com",
         "contactPhone": "7563126",
         "dniNumber": "5415668464654",
         "billingAddress": {
            "street1": "Autopista Del Sol, 0 - Km.43 Costado Sur",
            "street2": "125544",
            "city": "RM",
            "state": "Talagante",
            "country": "CL",
            "postalCode": "000000",
            "phone": "7563126"
         }
      },
      "creditCard": {
         "number": "4097440000000004",
         "securityCode": "777",
         "expirationDate": "2022/12",
         "name": "APPROVED"
      },
      "extraParameters": {
         "INSTALLMENTS_NUMBER": 1
      },
      "type": "AUTHORIZATION",
      "paymentMethod": "VISA",
      "paymentCountry": "CL",
      "deviceSessionId": "vghs6tvkcle931686k1900o6e1",
      "ipAddress": "127.0.0.1",
      "cookie": "pt1t38347bs6jc9ruv2ecpv7o2",
      "userAgent": "Mozilla/5.0 (Windows NT 5.1; rv:18.0) Gecko/20100101 Firefox/18.0"
   },
   "test": false
}

Exemplo de uma Resposta:

{
    "code": "SUCCESS",
    "error": null,
    "transactionResponse": {
        "orderId": 1400455722,
        "transactionId": "49cb24d9-eda6-43de-aad9-a17ffa9e5fb8",
        "state": "APPROVED",
        "paymentNetworkResponseCode": "195569",
        "paymentNetworkResponseErrorMessage": null,
        "trazabilityCode": "49cb24d9-eda6-43de-aad9-a17ffa9e5fb8",
        "authorizationCode": "195569",
        "pendingReason": null,
        "responseCode": "APPROVED",
        "errorCode": null,
        "responseMessage": "Approved transaction",
        "transactionDate": null,
        "transactionTime": null,
        "operationDate": 1624616739664,
        "referenceQuestionnaire": null,
        "extraParameters": {
            "BANK_REFERENCED_CODE": "CREDIT",
            "TRANSBANK_DIRECT_TOKEN": "01ab3984007f3010d2adb6c02d104f85b8268ccf4b95da4b56f3abdb339e1c52"
        },
        "additionalInfo": null
    }
}

Exemplo de uma Solicitação:

<request>
   <language>es</language>
   <command>SUBMIT_TRANSACTION</command>
   <merchant>
      <apiKey>4Vj8eK4rloUd272L48hsrarnUA</apiKey>
      <apiLogin>pRRXKOl8ikMmt9u</apiLogin>
   </merchant>
   <transaction>
      <order>
         <accountId>512325</accountId>
         <referenceCode>PRODUCT_TEST_2021-06-25T16:33:48.512ZZ</referenceCode>
         <description>Payment test description</description>
         <language>es</language>
         <signature>77d72fb91eb43f9b15fb300d5f173da3</signature>
         <notifyUrl>http://www.payu.com/notify</notifyUrl>
         <additionalValues>
            <entry>
               <string>TX_VALUE</string>
               <additionalValue>
                  <value>10000</value>
                  <currency>CLP</currency>
               </additionalValue>
            </entry>
         </additionalValues>
         <buyer>
            <merchantBuyerId>1</merchantBuyerId>
            <fullName>First name and second buyer name</fullName>
            <emailAddress>buyer_test@test.com</emailAddress>
            <contactPhone>7563126</contactPhone>
            <dniNumber>123456789</dniNumber>
            <shippingAddress>
               <street1>Autopista Del Sol, 0 - Km.43 Costado Sur</street1>
               <street2>5555487</street2>
               <city>RM</city>
               <state>Talagante</state>
               <country>CL</country>
               <postalCode>000000</postalCode>
               <phone>7563126</phone>
            </shippingAddress>
         </buyer>
         <shippingAddress>
            <street1>Autopista Del Sol, 0 - Km.43 Costado Sur</street1>
            <street2>5555487</street2>
            <city>RM</city>
            <state>Talagante</state>
            <country>CL</country>
            <postalCode>0000000</postalCode>
            <phone>7563126</phone>
         </shippingAddress>
      </order>
      <payer>
         <merchantPayerId>1</merchantPayerId>
         <fullName>First name and second payer name</fullName>
         <emailAddress>payer_test@test.com</emailAddress>
         <contactPhone>7563126</contactPhone>
         <dniNumber>5415668464654</dniNumber>
         <billingAddress>
            <street1>Autopista Del Sol, 0 - Km.43 Costado Sur</street1>
            <street2>5555487</street2>
            <city>RM</city>
            <state>Talagante</state>
            <country>CL</country>
            <postalCode>000000</postalCode>
            <phone>7563126</phone>
         </billingAddress>
      </payer>
      <creditCard>
         <number>4097440000000004</number>
         <securityCode>777</securityCode>
         <expirationDate>2022/12</expirationDate>
         <name>APPROVED</name>
      </creditCard>
      <extraParameters>
         <entry>
            <string>INSTALLMENTS_NUMBER</string>
            <string>1</string>
         </entry>
      </extraParameters>
      <type>AUTHORIZATION</type>
      <paymentMethod>VISA</paymentMethod>
      <paymentCountry>CL</paymentCountry>
      <deviceSessionId>vghs6tvkcle931686k1900o6e1</deviceSessionId>
      <ipAddress>127.0.0.1</ipAddress>
      <cookie>pt1t38347bs6jc9ruv2ecpv7o2</cookie>
      <userAgent>Mozilla/5.0 (Windows NT 5.1; rv:18.0) Gecko/20100101 Firefox/18.0</userAgent>
   </transaction>
   <isTest>false</isTest>
</request>

Exemplo de uma Resposta:

<paymentResponse>
    <code>SUCCESS</code>
    <transactionResponse>
        <orderId>1400455931</orderId>
        <transactionId>56f77e02-447a-4c98-a04b-9a8f3f92f3e7</transactionId>
        <state>APPROVED</state>
        <paymentNetworkResponseCode>363838</paymentNetworkResponseCode>
        <trazabilityCode>56f77e02-447a-4c98-a04b-9a8f3f92f3e7</trazabilityCode>
        <authorizationCode>363838</authorizationCode>
        <responseCode>APPROVED</responseCode>
        <responseMessage>Approved transaction</responseMessage>
        <operationDate>2021-06-25T06:33:55</operationDate>
        <extraParameters>
            <entry>
                <string>BANK_REFERENCED_CODE</string>
                <string>CREDIT</string>
            </entry>
            <entry>
                <string>TRANSBANK_DIRECT_TOKEN</string>
                <string>01ab79a6030063a6b4039a64a8cf7de471d7ad02390c118fbd7d66cfd1af9864</string>
            </entry>
        </extraParameters>
    </transactionResponse>
</paymentResponse>

Captura

Use este método para executar a etapa Captura de um fluxo de duas etapas. Nesta etapa, você captura os fundos Autorizados anteriormente para transferi-los para sua conta PayU.

Observações

Leve em conta as seguintes informações para captura:

  • O tempo máximo para capturar uma transação aprovada é de sete (7) dias. Após este período, a transação é cancelada automaticamente (auto-void).
  • Apenas os parâmetros exibidos no corpo da solicitação são obrigatórios para invocar uma transação de Captura. Lembre-se de que os IDs da ordem e da transação devem corresponder a uma transação atualmente autorizada.
  • Não é permitida a captura de valor superior ao previamente autorizado.
  • As capturas são permitidas apenas para transações em uma parcela.

A seguir estão os corpos de pedido e resposta para este tipo de transação.


Exemplo de uma Solicitação:

{
   "language": "es",
   "command": "SUBMIT_TRANSACTION",
   "merchant": {
      "apiLogin": "pRRXKOl8ikMmt9u",
      "apiKey": "4Vj8eK4rloUd272L48hsrarnUA"
   },
   "transaction": {
      "order": {
         "id": "1400421560"
      },
      "type": "CAPTURE",
      "parentTransactionId": "db9d9d7f-b62c-4ed2-a3b9-d146d33bdaf5"
   },
   "test": false
}

Exemplo de uma Resposta:

{
    "code": "SUCCESS",
    "error": null,
    "transactionResponse": {
        "orderId": 1400455931,
        "transactionId": "da91c0ec-632b-44e3-883d-b85821390519",
        "state": "APPROVED",
        "paymentNetworkResponseCode": "0",
        "paymentNetworkResponseErrorMessage": null,
        "trazabilityCode": "da91c0ec-632b-44e3-883d-b85821390519",
        "authorizationCode": "169018",
        "pendingReason": null,
        "responseCode": "APPROVED",
        "errorCode": null,
        "responseMessage": "Approved transaction",
        "transactionDate": null,
        "transactionTime": null,
        "operationDate": 1624629865424,
        "referenceQuestionnaire": null,
        "extraParameters": {
            "TRANSBANK_DIRECT_TOKEN": "01ab5a10f3c1bdd401ac86d7c21e4347a7b848171fad7830157abcaac0373c7e"
        },
        "additionalInfo": null
    }
}

Exemplo de uma Solicitação:

<request>
   <language>es</language>
   <command>SUBMIT_TRANSACTION</command>
   <merchant>
      <apiKey>4Vj8eK4rloUd272L48hsrarnUA</apiKey>
      <apiLogin>pRRXKOl8ikMmt9u</apiLogin>
   </merchant>
   <transaction>
      <order>
         <id>1400456250</id>
      </order>
      <type>CAPTURE</type>
      <parentTransactionId>ead41073-a03a-45aa-9e83-23d4b03197f0</parentTransactionId>
   </transaction>
   <isTest>false</isTest>
</request>

Exemplo de uma Resposta:

<paymentResponse>
    <code>SUCCESS</code>
    <transactionResponse>
        <orderId>1400456250</orderId>
        <transactionId>9c4d12c4-277d-4936-9d15-735e21dd5a19</transactionId>
        <state>APPROVED</state>
        <paymentNetworkResponseCode>0</paymentNetworkResponseCode>
        <trazabilityCode>9c4d12c4-277d-4936-9d15-735e21dd5a19</trazabilityCode>
        <authorizationCode>698999</authorizationCode>
        <responseCode>APPROVED</responseCode>
        <responseMessage>Approved transaction</responseMessage>
        <operationDate>2021-06-25T09:08:16</operationDate>
        <extraParameters>
            <entry>
                <string>TRANSBANK_DIRECT_TOKEN</string>
                <string>01ab6ddef1f9350f7b970d33b9766db9b0d52c6b9cb353618ddc8cd58d076b59</string>
            </entry>
        </extraParameters>
    </transactionResponse>
</paymentResponse>

Captura Parcial

Uma captura parcial é uma operação que permite solicitar o desembolso de um valor menor do que o previamente autorizado em uma transação.

Isso significa que, se sua integração inicialmente autorizou um pagamento de $100, você pode realizar uma captura parcial de $60 e liberar os $40 restantes, que a integração não poderá capturar posteriormente.

Considerações

  • O valor total capturado não pode exceder o valor originalmente autorizado.
  • Cada processador de pagamento e cada país podem ter regras ou restrições em relação ao valor que você pode capturar parcialmente.
  • Você deve especificar o valor que deseja capturar parcialmente no campo value, dentro do parâmetro TX_VALUE, como mostrado no exemplo abaixo.
  • O valor mínimo para uma captura parcial é de 50 CLP.

A seguir estão exemplos dos corpos de solicitação e resposta para este tipo de transação.


Exemplo de uma Solicitação:

{
    "language": "es",
    "command": "SUBMIT_TRANSACTION",
    "merchant": {
        "apiLogin": "pRRXKOl8ikMmt9u",
        "apiKey": "4Vj8eK4rloUd272L48hsrarnUA"
    },
    "transaction": {
        "order": {
            "id": "2152525133"
        },
        "additionalValues": {
            "TX_VALUE": {
                "value": 50,
                "currency": "CLP"
            }
        },
        "type": "CAPTURE",
        "parentTransactionId": "4b6adba7-e43b-45f8-88a6-d290755d6c04"
    },
    "test": false
}

Exemplo de uma Resposta:

{
    "code": "SUCCESS",
    "error": null,
    "transactionResponse": {
        "orderId": 2152543423,
        "transactionId": "6f523681-1587-4a2d-8a15-605d27f89c26",
        "state": "APPROVED",
        "paymentNetworkResponseCode": "0",
        "paymentNetworkResponseErrorMessage": null,
        "trazabilityCode": "6f523681-1587-4a2d-8a15-605d27f89c26",
        "authorizationCode": "NPS-011111",
        "pendingReason": null,
        "responseCode": "APPROVED",
        "errorCode": null,
        "responseMessage": "APROBADA - Autorizada",
        "transactionDate": null,
        "transactionTime": null,
        "operationDate": 1723724052207,
        "referenceQuestionnaire": null,
        "extraParameters": null,
        "additionalInfo": {
            "paymentNetwork": "NPS_AR",
            "rejectionType": "NONE",
            "responseNetworkMessage": null,
            "travelAgencyAuthorizationCode": null,
            "cardType": null,
            "transactionType": "CAPTURE"
        }
    }
}

Exemplo de uma Solicitação:

<request>
  <language>es</language>
  <command>SUBMIT_TRANSACTION</command>
  <merchant>
    <apiLogin>pRRXKOl8ikMmt9u</apiLogin>
    <apiKey>4Vj8eK4rloUd272L48hsrarnUA</apiKey>
  </merchant>
  <transaction>
    <order>
      <id>2152525133</id>
    </order>
    <additionalValues>
      <TX_VALUE>
        <value>50</value>
        <currency>CLP</currency>
      </TX_VALUE>
    </additionalValues>
    <type>CAPTURE</type>
    <parentTransactionId>4b6adba7-e43b-45f8-88a6-d290755d6c04</parentTransactionId>
  </transaction>
  <test>false</test>
</request>

Exemplo de uma Resposta:

<response>
  <code>SUCCESS</code>
  <error />
  <transactionResponse>
    <orderId>2152543423</orderId>
    <transactionId>6f523681-1587-4a2d-8a15-605d27f89c26</transactionId>
    <state>APPROVED</state>
    <paymentNetworkResponseCode>0</paymentNetworkResponseCode>
    <paymentNetworkResponseErrorMessage />
    <trazabilityCode>6f523681-1587-4a2d-8a15-605d27f89c26</trazabilityCode>
    <authorizationCode>NPS-011111</authorizationCode>
    <pendingReason />
    <responseCode>APPROVED</responseCode>
    <errorCode />
    <responseMessage>APROBADA - Autorizada</responseMessage>
    <transactionDate />
    <transactionTime />
    <operationDate>1723724052207</operationDate>
    <referenceQuestionnaire />
    <extraParameters />
    <additionalInfo>
      <paymentNetwork>NPS_AR</paymentNetwork>
      <rejectionType>NONE</rejectionType>
      <responseNetworkMessage />
      <travelAgencyAuthorizationCode />
      <cardType />
      <transactionType>CAPTURE</transactionType>
    </additionalInfo>
  </transactionResponse>
</response>

Cobrança

Use este método para executar um fluxo de uma etapa, ou seja, uma cobrança. Neste momento, as duas etapas do fluxo são combinadas em uma só transação, e os fundos são transferidos da conta do cliente para sua conta PayU, uma vez que tenham sido aprovados:

A seguir estão os corpos de pedido e resposta para este tipo de transação.


Exemplo de uma Solicitação:

{
   "language": "es",
   "command": "SUBMIT_TRANSACTION",
   "merchant": {
      "apiKey": "4Vj8eK4rloUd272L48hsrarnUA",
      "apiLogin": "pRRXKOl8ikMmt9u"
   },
   "transaction": {
      "order": {
         "accountId": "512325",
         "referenceCode": "PRODUCT_TEST_2021-06-15T20:35:48.975Z",
         "description": "Payment test description",
         "language": "es",
         "signature": "75ae7a887dfd759894c57eb1bc5a4288",
         "notifyUrl": "http://www.payu.com/notify",
         "additionalValues": {
            "TX_VALUE": {
               "value": 10000,
               "currency": "CLP"
         }
         },
         "buyer": {
            "merchantBuyerId": "1",
            "fullName": "First name and second buyer name",
            "emailAddress": "buyer_test@test.com",
            "contactPhone": "7563126",
            "dniNumber": "123456789",
            "shippingAddress": {
               "street1": "Autopista Del Sol, 0 - Km.43 Costado Sur",
               "street2": "5555487",
               "city": "RM",
               "state": "Talagante",
               "country": "CL",
               "postalCode": "000000",
               "phone": "7563126"
            }
         },
         "shippingAddress": {
            "street1": "Autopista Del Sol, 0 - Km.43 Costado Sur",
            "street2": "5555487",
            "city": "RM",
            "state": "Talagante",
            "country": "CL",
            "postalCode": "0000000",
            "phone": "7563126"
         }
      },
      "payer": {
         "merchantPayerId": "1",
         "fullName": "First name and second payer name",
         "emailAddress": "payer_test@test.com",
         "contactPhone": "7563126",
         "dniNumber": "5415668464654",
         "billingAddress": {
            "street1": "Autopista Del Sol, 0 - Km.43 Costado Sur",
            "street2": "125544",
            "city": "RM",
            "state": "Talagante",
            "country": "CL",
            "postalCode": "000000",
            "phone": "7563126"
         }
      },
      "creditCard": {
         "number": "4037997623271984",
         "securityCode": "321",
         "expirationDate": "2030/12",
         "name": "APPROVED"
      },
      "extraParameters": {
         "INSTALLMENTS_NUMBER": 1
      },
      "type": "AUTHORIZATION_AND_CAPTURE",
      "paymentMethod": "VISA",
      "paymentCountry": "CL",
      "deviceSessionId": "vghs6tvkcle931686k1900o6e1",
      "ipAddress": "127.0.0.1",
      "cookie": "pt1t38347bs6jc9ruv2ecpv7o2",
      "userAgent": "Mozilla/5.0 (Windows NT 5.1; rv:18.0) Gecko/20100101 Firefox/18.0"
   },
   "test": false
}

Exemplo de uma Resposta:

{
    "code": "SUCCESS",
    "error": null,
    "transactionResponse": {
        "orderId": 1400431556,
        "transactionId": "14aed0cc-95cb-4b04-b4dd-0c7f8c3296e8",
        "state": "APPROVED",
        "paymentNetworkResponseCode": "456505",
        "paymentNetworkResponseErrorMessage": null,
        "trazabilityCode": "14aed0cc-95cb-4b04-b4dd-0c7f8c3296e8",
        "authorizationCode": "456505",
        "pendingReason": null,
        "responseCode": "APPROVED",
        "errorCode": null,
        "responseMessage": "Approved transaction",
        "transactionDate": null,
        "transactionTime": null,
        "operationDate": 1623834912248,
        "referenceQuestionnaire": null,
        "extraParameters": {
            "BANK_REFERENCED_CODE": "CREDIT",
            "TRANSBANK_DIRECT_TOKEN": "01ab306b62cd0ce17d462501b121ed6cac3794375054b80a51c01bad4ec51550"
        },
        "additionalInfo": null
    }
}

Exemplo de uma Solicitação:

<request>
   <language>es</language>
   <command>SUBMIT_TRANSACTION</command>
   <merchant>
      <apiKey>4Vj8eK4rloUd272L48hsrarnUA</apiKey>
      <apiLogin>pRRXKOl8ikMmt9u</apiLogin>
   </merchant>
   <transaction>
      <order>
         <accountId>512325</accountId>
         <referenceCode>PRODUCT_TEST_2021-06-15T20:35:48.975Z</referenceCode>
         <description>Payment test description</description>
         <language>es</language>
         <signature>75ae7a887dfd759894c57eb1bc5a4288</signature>
         <notifyUrl>http://www.payu.com/notify</notifyUrl>
         <additionalValues>
            <entry>
               <string>TX_VALUE</string>
               <additionalValue>
                  <value>10000</value>
                  <currency>CLP</currency>
               </additionalValue>
            </entry>
         </additionalValues>
         <buyer>
            <merchantBuyerId>1</merchantBuyerId>
            <fullName>First name and second buyer name</fullName>
            <emailAddress>buyer_test@test.com</emailAddress>
            <contactPhone>7563126</contactPhone>
            <dniNumber>123456789</dniNumber>
            <shippingAddress>
               <street1>Autopista Del Sol, 0 - Km.43 Costado Sur</street1>
               <street2>5555487</street2>
               <city>RM</city>
               <state>Talagante</state>
               <country>CL</country>
               <postalCode>000000</postalCode>
               <phone>7563126</phone>
            </shippingAddress>
         </buyer>
         <shippingAddress>
            <street1>Autopista Del Sol, 0 - Km.43 Costado Sur</street1>
            <street2>5555487</street2>
            <city>RM</city>
            <state>Talagante</state>
            <country>CL</country>
            <postalCode>0000000</postalCode>
            <phone>7563126</phone>
         </shippingAddress>
      </order>
      <payer>
         <merchantPayerId>1</merchantPayerId>
         <fullName>First name and second payer name</fullName>
         <emailAddress>payer_test@test.com</emailAddress>
         <contactPhone>7563126</contactPhone>
         <dniNumber>5415668464654</dniNumber>
         <billingAddress>
            <street1>Autopista Del Sol, 0 - Km.43 Costado Sur</street1>
            <street2>5555487</street2>
            <city>RM</city>
            <state>Talagante</state>
            <country>CL</country>
            <postalCode>000000</postalCode>
            <phone>7563126</phone>
         </billingAddress>
      </payer>
      <creditCard>
         <number>4037997623271984</number>
         <securityCode>321</securityCode>
         <expirationDate>2030/12</expirationDate>
         <name>APPROVED</name>
      </creditCard>
      <extraParameters>
         <entry>
            <string>INSTALLMENTS_NUMBER</string>
            <string>1</string>
         </entry>
      </extraParameters>
      <type>AUTHORIZATION_AND_CAPTURE</type>
      <paymentMethod>VISA</paymentMethod>
      <paymentCountry>CL</paymentCountry>
      <deviceSessionId>vghs6tvkcle931686k1900o6e1</deviceSessionId>
      <ipAddress>127.0.0.1</ipAddress>
      <cookie>pt1t38347bs6jc9ruv2ecpv7o2</cookie>
      <userAgent>Mozilla/5.0 (Windows NT 5.1; rv:18.0) Gecko/20100101 Firefox/18.0</userAgent>
   </transaction>
   <isTest>false</isTest>
</request>

Exemplo de uma Resposta:

<paymentResponse>
    <code>SUCCESS</code>
    <transactionResponse>
        <orderId>1400431549</orderId>
        <transactionId>937ed9fe-72d3-44e2-b1b8-e38e9f8e08a4</transactionId>
        <state>APPROVED</state>
        <paymentNetworkResponseCode>185495</paymentNetworkResponseCode>
        <trazabilityCode>937ed9fe-72d3-44e2-b1b8-e38e9f8e08a4</trazabilityCode>
        <authorizationCode>185495</authorizationCode>
        <responseCode>APPROVED</responseCode>
        <responseMessage>Approved transaction</responseMessage>
        <operationDate>2021-06-16T04:13:51</operationDate>
        <extraParameters>
            <entry>
                <string>BANK_REFERENCED_CODE</string>
                <string>CREDIT</string>
            </entry>
            <entry>
                <string>TRANSBANK_DIRECT_TOKEN</string>
                <string>01abc29e7b32bbf011cdd2a1e9961c5d6bd068220f4b506b06c66e15de1acfd2</string>
            </entry>
        </extraParameters>
    </transactionResponse>
</paymentResponse>

Enviar Transações Usando Cartões de Débito e Pré-Pagos Através do WebPay Plus

Esse método permite que você processe os pagamentos com cartão pré-pago e de débito de seus clientes. Para se integrar a essas transações, você deve redirecionar o cliente para a URL encontrada na resposta do método.

PrintScreen

Parâmetros para Solicitação e Resposta

Solicitação
Nome do Campo Formato Tamanho Descrição Obrigatório
language Alfanumérico 2 Idioma usado no pedido, usado para exibir as mensagens de erro geradas. Veja os idiomas disponíveis. Sim
command Alfanumérico Máx:32 Definir SUBMIT_TRANSACTION. Sim
test (JSON)
isTest (XML)		 Boolean Definir true se o pedido estiver em modo de teste. Caso contrário, definir false. Sim
merchant Objeto Este objeto contém os dados de autenticação. Sim
merchant > apiLogin Alfanumérico Mín:12 Máx:32 Usuário ou login fornecido pelo PayU. Como faço para obter minha API Login Sim
merchant > apiKey Alfanumérico Mín:6 Máx:32 Senha fornecida pelo PayU. Como faço para obter minha API key Sim
transaction Objeto Este objeto contém os dados da transação. Sim
transaction > order Objeto Este objeto contém os dados da ordem. Sim
transaction > order > accountId Número Identificador da sua conta. Sim
transaction > order > referenceCode Alfanumérico Mín:1 Máx:255 Representa o identificador da ordem em seu sistema. Sim
transaction > order > description Alfanumérico Mín:1 Máx:255 Descrição da ordem. Sim
transaction > order > language Alfanumérico 2 Idioma usado nos e-mails enviados ao comprador e ao vendedor. Sim
transaction > order > notifyUrl Alfanumérico Máx:2048 URL de confirmação da ordem. Não
transaction > order > partnerId Alfanumérico Máx:255 ID de parceiro no PayU. Não
transaction > order > signature Alfanumérico Máx:255 A assinatura associada ao formulário. Para obter mais informações, consulte Assinatura de autenticação. Sim
transaction > order > shippingAddress Objeto Endereço para envio. Não
transaction > order > shippingAddress > street1 Alfanumérico Máx:100 Endereço: Linha 1. Não
transaction > order > shippingAddress > street2 Alfanumérico Máx:100 Endereço: Linha 2. Não
transaction > order > shippingAddress > city Alfanumérico Máx:50 Endereço: cidade. Não
transaction > order > shippingAddress > state Alfanumérico Máx:40 Endereço: estado. Não
transaction > order > shippingAddress > country Alfanumérico 2 Endereço: país. Não
transaction > order > shippingAddress > postalCode Alfanumérico Máx:8 Endereço: Código postal. Não
transaction > order > shippingAddress > phone Alfanumérico Máx:11 Número de telefone associado ao endereço. Não
transaction > order > buyer Objeto Informações do comprador. Sim
transaction > order > buyer > merchantBuyerId Alfanumérico Máx:100 ID do comprador em seu sistema. Não
transaction > order > buyer > fullName Alfanumérico Máx:150 Nome completo do comprador. Sim
transaction > order > buyer > emailAddress Alfanumérico Máx:255 E-mail do comprador. Sim
transaction > order > buyer > contactPhone Alfanumérico Máx:20 Número de telefone do comprador. Sim
transaction > order > buyer > dniNumber Alfanumérico Máx:20 Número de identificação do comprador. Sim
transaction > order > buyer > shippingAddress Alfanumérico Endereço de envio do comprador. Sim
transaction > order > buyer > shippingAddress > street1 Alfanumérico Máx:150 Linha 1 do endereço de entrega do comprador. Sim
transaction > order > buyer > shippingAddress > city Alfanumérico Máx:50 Cidade do endereço de entrega do comprador. Sim
transaction > order > buyer > shippingAddress > state Alfanumérico Máx:40 Estado do endereço de entrega do comprador. Sim
transaction > order > buyer > shippingAddress > country Alfanumérico 2 País do endereço do comprador no formato ISO 3166 alpha-2. Sim
transaction > order > buyer > shippingAddress > postalCode Número Máx:20 Código postal do endereço do comprador. Sim
transaction > order > buyer > shippingAddress > phone Número Máx:20 Número de telefone do endereço do comprador. Sim
transaction > order > additionalValues > Objeto 64 Valor da ordem ou seus valores associados. Sim
transaction > order > additionalValues > TX_VALUE Alfanumérico 64 Valor da transação. Sim
transaction > order > additionalValues > TX_VALUE > value Número 12, 2 Especifica o valor da transação. Este valor não pode incluir decimais. Sim
transaction > order > additionalValues > TX_VALUE > currency Alfanumérico 3 Código ISO da moeda. Veja as moedas aceitas. Sim
transaction > order > additionalValues > TX_TAX Alfanumérico 64 Total do Imposto sobre Valor Agregado (IVA). Sim
transaction > order > additionalValues > TX_TAX > value Número 12, 2 Especifica o valor do IVA. Não
transaction > order > additionalValues > TX_TAX > currency Alfanumérico 3 Código ISO da moeda. Veja as moedas aceitas. Não
transaction > order > additionalValues > TX_TAX_RETURN_BASE Alfanumérico 64 Valor base para cálculo do VAT.
Se o valor não tiver IVA, envie 0.
Este valor pode ter duas casas decimais.		 Não
transaction > order > additionalValues > TX_TAX_RETURN_BASE > value Número 12, 2 Especifica o valor base da transação. Não
transaction > order > additionalValues > TX_TAX_RETURN_BASE > currency Alfanumérico 3 Código ISO da moeda. Veja as moedas aceitas. Não
transaction > payer Objeto Informações do pagador. Sim
transaction > payer > emailAddress Alfanumérico Máx:255 Endereço de e-mail do pagador. Sim
transaction > payer > merchantPayerId Alfanumérico Máx:100 Identificador do pagador em seu sistema. Não
transaction > payer > fullName Alfanumérico Máx:150 Nome of the payer. Sim
transaction > payer > billingAddress Objeto Endereço de cobrança. Sim
transaction > payer > billingAddress > street1 Alfanumérico Máx:100 Endereço de cobrança linha 1. Sim
transaction > payer > billingAddress > street2 Alfanumérico Máx:100 Endereço de cobrança linha 2. Não
transaction > payer > billingAddress > city Alfanumérico Máx:50 Cidade do endereço de cobrança. Sim
transaction > payer > billingAddress > state Alfanumérico Máx:40 Estado do endereço de cobrança. Não
transaction > payer > billingAddress > country Alfanumérico 2 País do endereço de cobrança no formato ISO 3166 Alpha-2. Sim
transaction > payer > billingAddress > postalCode Alfanumérico Máx:20 Código postal do endereço de cobrança. Não
transaction > payer > billingAddress > phone Alfanumérico Máx:20 Número de telefone do endereço de cobrança. Não
transaction > payer > birthdate Alfanumérico Máx:10 Data de nascimento do pagador. Não
transaction > payer > contactPhone Alfanumérico Máx:20 Número de telefone do pagador. Sim
transaction > payer > dniNumber Alfanumérico Máx:20 Número de identificação do pagador. Sim
transaction > payer > dniType Alfanumérico 2 Tipo de identificação do pagador. Veja os tipos de documentos. Não
transaction > type Alfanumérico 32 Como os pagamentos são feitos na página WebPay plus, o único tipo de transação disponível é AUTHORIZATION_AND_CAPTURE Sim
transaction > paymentMethod Alfanumérico 32 Selecione um método de pagamento válido para cartões de débito e pré-pagos. Veja os métodos de pagamento disponíveis o Chile. Sim
transaction > paymentCountry Alfanumérico 2 Definir CL o Chile. Sim
transaction > deviceSessionId Alfanumérico Máx:255 Identificador da sessão do dispositivo onde o cliente faz a transação. Para obter mais informações, consulte este tópico. Sim
transaction > ipAddress Alfanumérico Máx:39 Endereço IP do dispositivo onde o cliente faz a transação. Sim
transaction > cookie Alfanumérico Máx:255 Cookie armazenado pelo dispositivo onde o cliente faz a transação. Sim
transaction > userAgent Alfanumérico Máx:1024 O agente do usuário do navegador onde o cliente faz a transação. Sim
transaction > extraParameters Objeto Parâmetros ou dados adicionais associados a pedido. Para pagamentos através do WebPay plus, esta é a página de resposta da sua loja.
Em JSON, o parâmetro extraParameters é definido como:
"extraParameters": {
 "RESPONSE_URL": "http://www.test.com/response"
}

Em XML, o parâmetro extraParameters é definido como:
<extraParameters>
 <entry>
  <string>RESPONSE_URL</string>
  http://www.test.com/response
 </entry>
</extraParameters>		 Não
Resposta
Nome do Campo Formato Tamanho Descrição
code Alfanumérico O código de resposta da transação. Os valores possíveis são ERROR e SUCCESS.
error Alfanumérico Máx:2048 A mensagem de erro associada quando o código de resposta é ERROR.
transactionResponse Objeto Os dados de resposta.
transactionResponse > orderId Número O ID de ordem gerado ou existente no PayU.
transactionResponse > transactionId Alfanumérico 36 O identificador da transação no PayU.
transactionResponse > state Alfanumérico Máx:32 O status da transação. As the payment is performed by the user in a physical office, the state for a successful transaction is PENDING
transactionResponse > paymentNetworkResponseCode Alfanumérico Máx:255 O código de resposta fornecido pela rede financeira.
transactionResponse > paymentNetworkResponseErrorMessage Alfanumérico Máx:255 A mensagem de erro fornecida pela rede financeira.
transactionResponse > trazabilityCode Alfanumérico Máx:32 O código de rastreamento fornecido pela rede financeira.
transactionResponse > authorizationCode Alfanumérico Máx:12 O código de autorização fornecido pela rede financeira.
transactionResponse > pendingReason Alfanumérico Máx:21 O código de resposta associado ao status, conforme mencionado em transactionResponse > state, a transação está aguardando o pagamento.
transactionResponse > responseCode Alfanumérico Máx:64 O código de resposta associado ao status. Neste caso, para transações bem-sucedidas é PENDING_PAYMENT_IN_ENTITY.
transactionResponse > responseMessage Alfanumérico Máx:2048 Mensagem associada ao código de resposta.
transactionResponse > operationDate Data Data de criação da resposta no sistema PayU.
transactionResponse > extraParameters Objeto Parâmetros ou dados adicionais associados à resposta.
Em JSON, o parâmetro extraParameters segue esta estrutura:
"extraParameters": {
 "URL_PAYMENT_REDIRECT": "xxxx"
}

Em XML, o parâmetro extraParameters segue esta estrutura:
<extraParameters>
 <entry>
  <string>URL_PAYMENT_REDIRECT</string>
  <string>xxxx</string>
 </entry>
</extraParameters>

Observações

  • Se você não enviar o parâmetro RESPONSE_URL em transaction.extraParameters, API extrairá o valor da variável URL de resposta em seu Módulo PayU (Configuração > Configuração técnica).
  • Ao processar os pagamentos através do WebPay plus, você deve redirecionar o cliente para a URL encontrada no parâmetro extra URL_PAYMENT_REDIRECT concatenado com o parâmetro extra TRANSBANK_DIRECT_TOKEN da seguinte forma:
    URL_PAYMENT_REDIRECT?token_ws=TRANSBANK_DIRECT_TOKEN.
  • Se a solicitação de pagamento for bem-sucedida, a transação tem estado PENDING e responseCode PENDING_PAYMENT_IN_ENTITY; Isso ocorre porque o pagador é redirecionado ao banco selecionado para concluir o pagamento.
  • The response page must have the following variables:
Variável Descrição
transactionState Estado da transação.
reference_pol Código de referência para identificar uma transação no PayU.
TX_VALUE Valor da transação.
authorizationCode Código de autorização da transação.
processingDate Data da transação.
cc_number Número visível do cartão utilizado na transação.

Os parâmetros acima são enviadas via GET.

Chamada de API

A seguir estão o corpo do pedido e da resposta deste meio de pagamento.


Exemplo de uma Solicitação:

{
   "language": "es",
   "command": "SUBMIT_TRANSACTION",
   "merchant": {
      "apiKey": "4Vj8eK4rloUd272L48hsrarnUA",
      "apiLogin": "pRRXKOl8ikMmt9u"
   },
   "transaction": {
      "order": {
         "accountId": "512325",
         "referenceCode": "PRODUCT_TEST_2021-06-15T20:35:48.975Z",
         "description": "Payment test description",
         "language": "es",
         "signature": "75ae7a887dfd759894c57eb1bc5a4288",
         "notifyUrl": "http://www.payu.com/notify",
         "additionalValues": {
            "TX_VALUE": {
               "value": 10000,
               "currency": "CLP"
         }
         },
         "buyer": {
            "merchantBuyerId": "1",
            "fullName": "First name and second buyer  name",
            "emailAddress": "buyer_test@test.com",
            "contactPhone": "7563126",
            "dniNumber": "5415668464654",
            "shippingAddress": {
               "street1": "Autopista Del Sol, 0 - Km.43 Costado Sur",
               "street2": "5555487",
               "city": "RM",
               "state": "Talagante",
               "country": "CL",
               "postalCode": "000000",
               "phone": "7563126"
            }
         },
         "shippingAddress": {
            "street1": "Autopista Del Sol, 0 - Km.43 Costado Sur",
            "street2": "5555487",
            "city": "RM",
            "state": "Talagante",
            "country": "CL",
            "postalCode": "000000",
            "phone": "7563126"
         }
      },
      "payer": {
         "merchantPayerId": "1",
         "fullName": "First name and second payer name",
         "emailAddress": "payer_test@test.com",
         "contactPhone": "7563126",
         "dniNumber": "5415668464654",
         "billingAddress": {
            "street1": "Autopista Del Sol, 0 - Km.43 Costado Sur",
               "street2": "5555487",
               "city": "RM",
               "state": "Talagante",
               "country": "CL",
               "postalCode": "000000",
               "phone": "7563126"
         }
      },
      "extraParameters": {
         "RESPONSE_URL": "http://www.test.com/response"
      },
      "type": "AUTHORIZATION_AND_CAPTURE",
      "paymentMethod": "TRANSBANK_DEBIT",
      "paymentCountry": "CL",
      "deviceSessionId": "vghs6tvkcle931686k1900o6e1",
      "ipAddress": "127.0.0.1",
      "cookie": "pt1t38347bs6jc9ruv2ecpv7o2",
      "userAgent": "Mozilla/5.0 (Windows NT 5.1; rv:18.0) Gecko/20100101 Firefox/18.0"
   },
   "test": false
}

Exemplo de uma Resposta:

{
    "code": "SUCCESS",
    "error": null,
    "transactionResponse": {
        "orderId": 1400432466,
        "transactionId": "e2609a58-97d6-4a65-8638-1b03da03cc7a",
        "state": "PENDING",
        "paymentNetworkResponseCode": null,
        "paymentNetworkResponseErrorMessage": null,
        "trazabilityCode": "5f0cac61-c023-4fa3-bf27-ff888fa36c3c",
        "authorizationCode": null,
        "pendingReason": "AWAITING_PAYMENT_IN_ENTITY",
        "responseCode": "PENDING_PAYMENT_IN_ENTITY",
        "errorCode": null,
        "responseMessage": null,
        "transactionDate": null,
        "transactionTime": null,
        "operationDate": 1623856942412,
        "referenceQuestionnaire": null,
        "extraParameters": {
            "EXPIRATION_DATE": 1623875847781,
            "URL_PAYMENT_REDIRECT": "https://webpay3gint.transbank.cl/webpayserver/initTransaction",
            "TRANSBANK_DIRECT_TOKEN": "01ab155164939156988ee462d09ed5613b7efd297fe97b099c684ec8599c5cc5"
        },
        "additionalInfo": null
    }
}

Exemplo de uma Solicitação:

<request>
   <language>es</language>
   <command>SUBMIT_TRANSACTION</command>
   <merchant>
      <apiKey>4Vj8eK4rloUd272L48hsrarnUA</apiKey>
      <apiLogin>pRRXKOl8ikMmt9u</apiLogin>
   </merchant>
   <transaction>
      <order>
         <accountId>512325</accountId>
         <referenceCode>PRODUCT_TEST_2021-06-15T20:35:48.975Z</referenceCode>
         <description>Payment test description</description>
         <language>es</language>
         <signature>75ae7a887dfd759894c57eb1bc5a4288</signature>
         <notifyUrl>http://www.payu.com/notify</notifyUrl>
         <additionalValues>
            <entry>
               <string>TX_VALUE</string>
               <additionalValue>
                  <value>10000</value>
                  <currency>CLP</currency>
               </additionalValue>
            </entry>
         </additionalValues>
         <buyer>
            <merchantBuyerId>1</merchantBuyerId>
            <fullName>First name and second buyer name</fullName>
            <emailAddress>buyer_test@test.com</emailAddress>
            <contactPhone>7563126</contactPhone>
            <dniNumber>5415668464654</dniNumber>
            <shippingAddress>
               <street1>Autopista Del Sol, 0 - Km.43 Costado Sur</street1>
               <street2>5555487</street2>
               <city>RM</city>
               <state>Talagante</state>
               <country>CL</country>
               <postalCode>000000</postalCode>
               <phone>7563126</phone>
            </shippingAddress>
         </buyer>
         <shippingAddress>
            <street1>Autopista Del Sol, 0 - Km.43 Costado Sur</street1>
            <street2>5555487</street2>
            <city>RM</city>
            <state>Talagante</state>
            <country>CL</country>
            <postalCode>0000000</postalCode>
            <phone>7563126</phone>
         </shippingAddress>
      </order>
      <payer>
         <merchantPayerId>1</merchantPayerId>
         <fullName>First name and second payer name</fullName>
         <emailAddress>payer_test@test.com</emailAddress>
         <contactPhone>7563126</contactPhone>
         <dniNumber>5415668464654</dniNumber>
         <billingAddress>
            <street1>Autopista Del Sol, 0 - Km.43 Costado Sur</street1>
            <street2>5555487</street2>
            <city>RM</city>
            <state>Talagante</state>
            <country>CL</country>
            <postalCode>000000</postalCode>
            <phone>7563126</phone>
         </billingAddress>
      </payer>
      <extraParameters>
         <entry>
            <string>RESPONSE_URL</string>
            <string>http://www.test.com/response</string>
         </entry>
      </extraParameters>
      <type>AUTHORIZATION_AND_CAPTURE</type>
      <paymentMethod>TRANSBANK_DEBIT</paymentMethod>
      <paymentCountry>CL</paymentCountry>
      <deviceSessionId>vghs6tvkcle931686k1900o6e1</deviceSessionId>
      <ipAddress>127.0.0.1</ipAddress>
      <cookie>pt1t38347bs6jc9ruv2ecpv7o2</cookie>
      <userAgent>Mozilla/5.0 (Windows NT 5.1; rv:18.0) Gecko/20100101 Firefox/18.0</userAgent>
   </transaction>
   <isTest>false</isTest>
</request>

Exemplo de uma Resposta:

<paymentResponse>
    <code>SUCCESS</code>
    <transactionResponse>
        <orderId>1400432986</orderId>
        <transactionId>71a72319-f143-4359-8cb9-bc44a21d2b25</transactionId>
        <state>PENDING</state>
        <trazabilityCode>a0d9d7d6-000a-4777-af78-e33917a30fd8</trazabilityCode>
        <pendingReason>AWAITING_PAYMENT_IN_ENTITY</pendingReason>
        <responseCode>PENDING_PAYMENT_IN_ENTITY</responseCode>
        <operationDate>2021-06-16T12:22:28</operationDate>
        <extraParameters>
            <entry>
                <string>EXPIRATION_DATE</string>
                <date>2021-06-16T17:42:53</date>
            </entry>
            <entry>
                <string>URL_PAYMENT_REDIRECT</string>
                <string>https://webpay3gint.transbank.cl/webpayserver/initTransaction</string>
            </entry>
            <entry>
                <string>TRANSBANK_DIRECT_TOKEN</string>
                <string>01abbca6da54f4e4ef9eb37fb9cacf72fdcc52797f6a9ca20377bc59eb0d2706</string>
            </entry>
        </extraParameters>
    </transactionResponse>
</paymentResponse>

Consulta de Métodos de Pagamento Disponíveis

Este método gera uma lista dos métodos de pagamento disponíveis em todos os países.

Parâmetros para Solicitação e Resposta

Solicitação
Nome do Campo Formato Tamanho Descrição Obrigatório
language Alfanumérico 2 Idioma usado no pedido, usado para exibir as mensagens de erro geradas. Veja os idiomas disponíveis. Sim
command Alfanumérico Máx:32 Definir GET_PAYMENT_METHODS. Sim
test (JSON)
isTest (XML)		 Boolean Definir true se o pedido estiver em modo de teste. Caso contrário, definir false. Sim
merchant Objeto Este objeto contém os dados de autenticação. Sim
merchant > apiLogin Alfanumérico Mín:12 Máx:32 Usuário ou login fornecido pelo PayU. Como faço para obter minha API Login Sim
merchant > apiKey Alfanumérico Mín:6 Máx:32 Senha fornecida pelo PayU. Como faço para obter minha API key Sim
Resposta
Nome do Campo Formato Tamanho Descrição
code Alfanumérico O código de resposta da transação. Os valores possíveis são ERROR e SUCCESS.
error Alfanumérico Máx:2048 A mensagem de erro associada quando o código de resposta é ERROR.
paymentMethods Objeto Lista dos métodos de pagamento.
paymentMethods > paymentMethodComplete Objeto Este objeto contém as informações de um método de pagamento.
paymentMethods > paymentMethodComplete > id Numérico Identificador do método de pagamento.
paymentMethods > paymentMethodComplete > description Alfanumérico Máx:32 Nome do método de pagamento.
paymentMethods > paymentMethodComplete > country Alfanumérico 2 Código ISO do país do método de pagamento.

Chamada de API

A seguir estão os corpos do pedido e resposta deste método. Para fins de exemplo, a solicitação e a resposta aqui mostram dois métodos de pagamento.


Exemplo de uma Solicitação:

{
   "test": false,
   "language": "en",
   "command": "GET_PAYMENT_METHODS",
   "merchant": {
      "apiLogin": "pRRXKOl8ikMmt9u",
      "apiKey": "4Vj8eK4rloUd272L48hsrarnUA"
   }
}

Exemplo de uma Resposta:

{
    "code": "SUCCESS",
    "error": null,
    "paymentMethods": [
        {
            "id": "716",
            "description": "VISA",
            "country": "CL",
            "enabled": true,
            "reason": null
        },
        {
            "id": "712",
            "description": "DINERS",
            "country": "CL",
            "enabled": true,
            "reason": null
        }
    ]
}

Exemplo de uma Solicitação:

<request>
   <language>en</language>
   <command>GET_PAYMENT_METHODS</command>
   <merchant>
      <apiLogin>pRRXKOl8ikMmt9u</apiLogin>
      <apiKey>4Vj8eK4rloUd272L48hsrarnUA</apiKey>
   </merchant>
   <isTest>false</isTest>
</request>

Exemplo de uma Resposta:

<paymentMethodsResponse>
    <code>SUCCESS</code>
    <paymentMethods>
        <paymentMethodComplete>
            <id>716</id>
            <description>VISA</description>
            <country>CL</country>
            <enabled>true</enabled>
        </paymentMethodComplete>
        <paymentMethodComplete>
            <id>712</id>
            <description>DINERS</description>
            <country>CL</country>
            <enabled>true</enabled>
        </paymentMethodComplete>
    </paymentMethods>
</paymentMethodsResponse>

Ping

O método PING permite que você confirme a conexão com a nossa plataforma.

Parâmetros para Solicitação e Resposta

Solicitação
Nome do Campo Formato Tamanho Descrição Obrigatório
language Alfanumérico 2 Idioma usado no pedido, usado para exibir as mensagens de erro geradas. Veja os idiomas disponíveis. Sim
command Alfanumérico Máx:32 Definir PING. Sim
test (JSON)
isTest (XML)		 Boolean Definir true se o pedido estiver em modo de teste. Caso contrário, definir false. Sim
merchant Objeto Este objeto contém os dados de autenticação. Sim
merchant > apiLogin Alfanumérico Mín:12 Máx:32 Usuário ou login fornecido pelo PayU. Como faço para obter minha API Login Sim
merchant > apiKey Alfanumérico Mín:6 Máx:32 Senha fornecida pelo PayU. Como faço para obter minha API key Sim
Resposta
Nome do Campo Formato Tamanho Descrição Obrigatório
code Alfanumérico O código de resposta da transação. Sim
error Alfanumérico Máx:2048 A mensagem de erro associada, caso tenha ocorrido um erro. Sim
transactionResponse Objeto Máx:2048 A resposta do método PING caso tenha ocorrido um erro. Sim

Chamada de API

A seguir estão os corpos do pedido e resposta deste método.


Exemplo de uma Solicitação:

{
   "test": false,
   "language": "en",
   "command": "PING",
   "merchant": {
      "apiLogin": "pRRXKOl8ikMmt9u",
      "apiKey": "4Vj8eK4rloUd272L48hsrarnUA"
   }
}

Exemplo de uma Resposta:

{
    "code": "SUCCESS",
    "error": null,
    "transactionResponse": null
}

Exemplo de uma Solicitação:

<request>
   <language>en</language>
   <command>PING</command>
   <merchant>
      <apiLogin>pRRXKOl8ikMmt9u</apiLogin>
      <apiKey>4Vj8eK4rloUd272L48hsrarnUA</apiKey>
   </merchant>
   <isTest>false</isTest>
</request>

Exemplo de uma Resposta:

<paymentResponse>
    <code>SUCCESS</code>
</paymentResponse>
Última modificação 28 de março de 2025: Documentation updates (6385d288b)