API de Tokenização

API de tokenização permite armazenar com segurança os dados dos cartões de crédito de seus clientes por meio da criação de um token. Este token permite fazer cobranças regulares ou implementar o recurso de pagamento em 1 clique, seguindo os padrões de segurança PCI DSS (Payment Card Industry Data Security Standard) para gerenciar dados de cartão de crédito.

O recurso de tokenização está disponível em acordos comerciais personalizados. Para obter mais informações, entre em contato com seu representante de vendas.

Para integrar com a API de tokenização, direcione sua solicitação para as seguintes URLs de acordo com seu ambiente.

URL

Teste: https://sandbox.api.payulatam.com/payments-api/4.0/service.cgi
Produção: https://api.payulatam.com/payments-api/4.0/service.cgi

Métodos disponíveis

A API de tokenização inclui métodos para registrar, remover e consultar tokens.

Registro de cartão de crédito individual
Registro de cartões de crédito em massa
Remoção de token individual
Remoção de tokens em massa
Consulta de token

Registro de cartão de crédito individual

Usando esse recurso, você pode registrar as informações do cartão de crédito de um cliente e obter um token.

Variáveis para pedido e resposta

Pedido

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 `CREATE_TOKEN`.	Sim
merchant			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
creditCardToken			Informações do cartão de crédito a ser tokenizado.	Sim
creditCardToken > payerId	Alfanumérico		Identificação interna do titular do cartão de crédito.	Sim
creditCardToken > name	Alfanumérico	Mín:1 Máx:255	Nome do titular exibido no cartão de crédito.	Sim
creditCardToken > identificationNumber	Alfanumérico	Máx:20	Número de identificação do titular do cartão de crédito.	Sim
creditCardToken > paymentMethod	Alfanumérico	32	Selecione um método de pagamento com cartão de crédito válido. Veja os métodos de pagamento disponíveis.	Sim
creditCardToken > number	Alfanumérico	Mín:13 Máx:20	Número do cartão de crédito.	Sim
creditCardToken > expirationDate	Alfanumérico	7	Data de validade do cartão de crédito. Formato `YYYY/MM`.	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`.
creditCardToken			Informações do cartão de crédito tokenizado.
creditCardToken > creditCardTokenId	Alfanumérico		Token gerado com as informações do cartão de crédito.
creditCardToken > name	Alfanumérico	Mín:1 Máx:255	Nome do titular exibido no cartão de crédito conforme enviado no pedido.
creditCardToken > payerId	Alfanumérico		Identificação interna do titular do cartão de crédito conforme enviado no pedido.
creditCardToken > identificationNumber	Alfanumérico	Máx:20	Número de identificação do titular do cartão de crédito conforme enviado no pedido.
creditCardToken > paymentMethod	Alfanumérico	32	Franquia do cartão de crédito tokenizado conforme enviado no pedido.
creditCardToken > maskedNumber	Alfanumérico	Mín:13 Máx:20	Número do cartão de crédito ocultado. Quando o cartão é ocultado, são exibidos os primeiros seis dígitos e os últimos quatro dígitos do cartão de crédito.

Chamada API

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

Exemplo pedido:

{
   "language": "es",
   "command": "CREATE_TOKEN",
   "merchant": {
      "apiLogin": "pRRXKOl8ikMmt9u",
      "apiKey": "4Vj8eK4rloUd272L48hsrarnUA"
   },
   "creditCardToken": {
      "payerId": "10",
      "name": "APPROVED",
      "identificationNumber": "32144457",
      "paymentMethod": "VISA",
      "number": "4037997623271984",
      "expirationDate": "2025/01"
   }
}

Exemplo resposta:

{
    "code": "SUCCESS",
    "error": null,
    "creditCardToken": {
        "creditCardTokenId": "05440005-9111-4d34-aa86-deeb91983d54",
        "name": "APPROVED",
        "payerId": "10",
        "identificationNumber": "32144457",
        "paymentMethod": "VISA",
        "number": null,
        "expirationDate": null,
        "creationDate": null,
        "maskedNumber": "403799******1984",
        "errorDescription": null
    }
}

Exemplo pedido:

<request>
   <language>es</language>
   <command>CREATE_TOKEN</command>
   <merchant>
      <apiLogin>pRRXKOl8ikMmt9u</apiLogin>
      <apiKey>4Vj8eK4rloUd272L48hsrarnUA</apiKey>
   </merchant>
   <creditCardToken>
      <payerId>10</payerId>
      <name>APPROVED</name>
      <identificationNumber>32144457</identificationNumber>
      <paymentMethod>VISA</paymentMethod>
      <number>4916332769997505</number>
      <expirationDate>2024/01</expirationDate>
   </creditCardToken>
</request>

Exemplo resposta:

<creditCardTokenResponse>
    <code>SUCCESS</code>
    <creditCardToken>
        <creditCardTokenId>46b7f03e-1b3b-4ce8-ad90-fe1a482f76c3</creditCardTokenId>
        <name>APPROVED</name>
        <payerId>10</payerId>
        <identificationNumber>32144457</identificationNumber>
        <paymentMethod>VISA</paymentMethod>
        <maskedNumber>491633******7505</maskedNumber>
    </creditCardToken>
</creditCardTokenResponse>

Registro de cartões de crédito em massa

Usando este recurso, você pode registrar as informações de vários cartões de crédito armazenados em um arquivo .csv e obtenha um token para cada cartão.

Observações

Cada registro do arquivo deve ter a seguinte estrutura e ordem separadas por vírgulas:
- ID de pagador
- Nome completo
- Número do cartão de crédito
- Data de validade
- Franquia
- Número de identificação
O arquivo não deve ter cabeçalho.
O arquivo deve ser codificado em UTF-8. Você precisa implementar uma funcionalidade para codificar o conteúdo e enviar a string codificada no parâmetro contentFile.
O arquivo não pode ter mais de 10.000 registros.

Variáveis para pedido e resposta

Pedido

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 `CREATE_BATCH_TOKENS`.	Sim
merchant			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
contentFile	Alfanumérico		String codificada em Base64 com as informações dos cartões de crédito, conforme explicado anteriormente.	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`.
id			Identificação do procedimento.

Chamada API

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

Exemplo pedido:

{
   "language": "es",
   "command": "CREATE_BATCH_TOKENS",
   "merchant": {
      "apiLogin": "pRRXKOl8ikMmt9u",
      "apiKey": "4Vj8eK4rloUd272L48hsrarnUA"
   },
   "contentFile": "MDAxLE1hcnkgS2VsbGVyLDQwMjQwMDcxMzU0MTI2ODAsMjAyNC8wMSxWSVNBLDEyMzQ1NgowMDIsTWFyayBCcm93biw1MTA0ODQyNTA1ODE2MTcwLDIwMjMvMDUsTUFTVEVSQ0FSRCw3ODkwMTI="
}

Exemplo resposta:

{
    "code": "SUCCESS",
    "error": null,
    "id": "b721abbc-a9cf-44c6-99ba-91393de2b5d6"
}

Exemplo pedido:

<request>
   <language>es</language>
   <command>CREATE_BATCH_TOKENS</command>
   <merchant>
      <apiLogin>pRRXKOl8ikMmt9u</apiLogin>
      <apiKey>4Vj8eK4rloUd272L48hsrarnUA</apiKey>
   </merchant>
   <contentFile>MDAxLE1hcnkgS2VsbGVyLDQwMjQwMDcxMzU0MTI2ODAsMjAyNC8wMSxWSVNBLDEyMzQ1NgowMDIsTWFyayBCcm93biw1MTA0ODQyNTA1ODE2MTcwLDIwMjMvMDUsTUFTVEVSQ0FSRCw3ODkwMTI=</contentFile>
</request>

Exemplo resposta:

<creditCardTokenBatchResponse>
   <code>SUCCESS</code>
   <id>b721abbc-a9cf-44c6-99ba-91393de2b5d6</id>
</creditCardTokenBatchResponse>

Remoção de token individual

Usando este recurso, você pode remover o token registrado anteriormente.

Variáveis para pedido e resposta

Pedido

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 `REMOVE_TOKEN`.	Sim
merchant			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
removeCreditCardToken			Informação do token a ser removido.	Sim
removeCreditCardToken > payerId	Alfanumérico		Identificação interna do titular do cartão de crédito.	Sim
removeCreditCardToken > creditCardTokenId	Alfanumérico		Token do cartão de crédito a ser removido.	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`.
creditCardToken			Informações do token removidas.
creditCardToken > creditCardTokenId	Alfanumérico		Token do cartão de crédito conforme enviado no pedido.
creditCardToken > name	Alfanumérico	Mín:1 Máx:255	Nome do titular exibido no cartão de crédito.
creditCardToken > payerId	Alfanumérico		Identificação interna do titular do cartão de crédito.
creditCardToken > identificationNumber	Alfanumérico	Máx:20	Número de identificação do titular do cartão de crédito.
creditCardToken > paymentMethod	Alfanumérico	32	Franquia do cartão de crédito tokenizado.
creditCardToken > maskedNumber	Alfanumérico	Mín:13 Máx:20	Número do cartão de crédito ocultado. Quando o cartão é ocultado, são exibidos os primeiros seis dígitos e os últimos quatro dígitos do cartão de crédito.

Chamada API

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

Exemplo pedido:

{
   "language": "es",
   "command": "REMOVE_TOKEN",
   "merchant": {
      "apiLogin": "pRRXKOl8ikMmt9u",
      "apiKey": "4Vj8eK4rloUd272L48hsrarnUA"
   },
   "removeCreditCardToken": {
      "payerId": "10",
      "creditCardTokenId": "46b7f03e-1b3b-4ce8-ad90-fe1a482f76c3"
   }
}

Exemplo resposta:

{
    "code": "SUCCESS",
    "error": null,
    "creditCardToken": {
        "creditCardTokenId": "46b7f03e-1b3b-4ce8-ad90-fe1a482f76c3",
        "name": "APPROVED",
        "payerId": "10",
        "identificationNumber": "32144457",
        "paymentMethod": "VISA",
        "number": null,
        "expirationDate": null,
        "creationDate": null,
        "maskedNumber": "491633******7505",
        "errorDescription": null
    }
}

Exemplo pedido:

<request>
   <language>es</language>
   <command>REMOVE_TOKEN</command>
   <merchant>
      <apiLogin>pRRXKOl8ikMmt9u</apiLogin>
      <apiKey>4Vj8eK4rloUd272L48hsrarnUA</apiKey>
   </merchant>
   <removeCreditCardToken>
      <payerId>10</payerId>
      <creditCardTokenId>46b7f03e-1b3b-4ce8-ad90-fe1a482f76c3</creditCardTokenId>4
   </removeCreditCardToken>
</request>

Exemplo resposta:

<creditCardTokenResponse>
    <code>SUCCESS</code>
    <creditCardToken>
        <creditCardTokenId>46b7f03e-1b3b-4ce8-ad90-fe1a482f76c3</creditCardTokenId>
        <name>APPROVED</name>
        <payerId>10</payerId>
        <identificationNumber>32144457</identificationNumber>
        <paymentMethod>VISA</paymentMethod>
        <maskedNumber>491633******7505</maskedNumber>
    </creditCardToken>
</creditCardTokenResponse>

Remoção de tokens em massa

Usando este recurso, você pode remover os tokens armazenados em um arquivo .csv.

Observações

Cada registro do arquivo deve ter a seguinte estrutura e ordem separadas por vírgulas:
- ID de pagador
- Token.
O arquivo não deve ter cabeçalho.
O arquivo deve ser codificado em UTF-8. Você precisa implementar uma funcionalidade para codificar o conteúdo e enviar a string codificada no parâmetro contentFile.
O arquivo não pode ter mais de 10.000 registros.

Variáveis para pedido e resposta

Pedido

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 `REMOVE_BATCH_TOKENS`.	Sim
merchant			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
contentFile	Alfanumérico		String codificada em Base64 com as informações dos tokens a serem removidos.	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`.
id			Identificação do procedimento.

Chamada API

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

Exemplo pedido:

{
   "language": "es",
   "command": "REMOVE_BATCH_TOKENS",
   "merchant": {
      "apiLogin": "pRRXKOl8ikMmt9u",
      "apiKey": "4Vj8eK4rloUd272L48hsrarnUA"
   },
   "contentFile": "UGF5ZXJJZDEsYWQ4NGQ2NzEtYjZiOC00YjEyLWFkNTktZmYxZDJhNjQ0M2NhDQpQYXllcklkMiw0ZGYxNjMwYy03MDkyLTRhNjgtODE3MC0yYzI2YzZjOTUyMDg="
}

Exemplo resposta:

{
    "code": "SUCCESS",
    "error": null,
    "id": "2562625d-9e4c-450a-b979-031feb033952"
}

Exemplo pedido:

<request>
   <language>es</language>
   <command>REMOVE_BATCH_TOKENS</command>
   <merchant>
      <apiLogin>pRRXKOl8ikMmt9u</apiLogin>
      <apiKey>4Vj8eK4rloUd272L48hsrarnUA</apiKey>
   </merchant>
   <contentFile>UGF5ZXJJZDEsYWQ4NGQ2NzEtYjZiOC00YjEyLWFkNTktZmYxZDJhNjQ0M2NhDQpQYXllcklkMiw0ZGYxNjMwYy03MDkyLTRhNjgtODE3MC0yYzI2YzZjOTUyMDg=</contentFile>
</request>

Exemplo resposta:

<creditCardTokenBatchResponse>
   <code>SUCCESS</code>
   <id>2562625d-9e4c-450a-b979-031feb033952</id>
</creditCardTokenBatchResponse>

Consulta de token

Usando este recurso, você pode obter as informações de cartões de crédito tokenizados e realizar a consulta pelo número do token ou por um intervalo de datas.

Variáveis para pedido e resposta

Pedido

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_TOKENS`.	Sim
merchant			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
creditCardTokenInformation			Parâmetros da consulta.	Sim
creditCardTokenInformation > creditCardTokenId	Alfanumérico		Token of the card to consult. Este parâmetro é obrigatório quando você deseja consultar por ID de Token.	Não
creditCardTokenInformation > startDate	Alfanumérico	23	Data de início da consulta, quando quiser consultar por intervalo de datas. Este parâmetro é obrigatório quando você deseja consultar por intervalo de datas. Formato `YYYY-MM-DDTHH:MM:SS`, por exemplo `2021-06-12T16:07:11`.	Não
creditCardTokenInformation > endDate	Alfanumérico	23	Data de término da consulta, quando quiser consultar por intervalo de datas. Este parâmetro é obrigatório quando você deseja consultar por intervalo de datas. Formato `YYYY-MM-DDTHH:MM:SS`, por exemplo `2021-06-12T16:07:11`.	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`.
creditCardTokenList			Informações dos cartões de crédito tokenizados.
creditCardTokenList > creditCardTokenId	Alfanumérico		Token gerado com as informações do cartão de crédito.
creditCardTokenList > name	Alfanumérico	Mín:1 Máx:255	Nome do titular exibido no cartão de crédito conforme enviado no pedido.
creditCardTokenList > payerId	Alfanumérico		Identificação interna do titular do cartão de crédito conforme enviado no pedido.
creditCardTokenList > identificationNumber	Alfanumérico	Máx:20	Número de identificação do titular do cartão de crédito conforme enviado no pedido.
creditCardTokenList > paymentMethod	Alfanumérico	32	Franquia do cartão de crédito tokenizado conforme enviado no pedido.
creditCardTokenList > creationDate	Alfanumérico	19	Data em que o cartão de crédito foi tokenizado.
creditCardTokenList > maskedNumber	Alfanumérico	Mín:13 Máx:20	Número do cartão de crédito ocultado. Quando o cartão é ocultado, são exibidos os primeiros seis dígitos e os últimos quatro dígitos do cartão de crédito.

Chamada API

A seguir estão os corpos do pedido e resposta deste método. O exemplo a seguir consulta os cartões tokenizados por intervalo de datas. Se você quiser consultar usando o ID do token, basta enviar o parâmetro creditCardTokenInformation.creditCardTokenId.

Exemplo pedido:

{
   "language": "es",
   "command": "GET_TOKENS",
   "merchant": {
      "apiLogin": "pRRXKOl8ikMmt9u",
      "apiKey": "4Vj8eK4rloUd272L48hsrarnUA"
   },
   "creditCardTokenInformation": {
      "startDate": "2021-06-23T12:00:00",
      "endDate": "2021-06-25T12:00:00"
   }
}

Exemplo resposta:

{
    "code": "SUCCESS",
    "error": null,
    "creditCardTokenList": [
        {
            "creditCardTokenId": "1adc6940-ee7e-48c2-bb96-7d784de74964",
            "name": "APPROVED",
            "payerId": "20263841",
            "identificationNumber": null,
            "paymentMethod": "AMEX",
            "number": null,
            "expirationDate": null,
            "creationDate": "2021-06-23T13:36:36",
            "maskedNumber": "377813*****0001",
            "errorDescription": null
        },
        {
            "creditCardTokenId": "3e5f0d77-0f93-421f-9432-99b6430e845e",
            "name": "Juan Perez",
            "payerId": "158301",
            "identificationNumber": null,
            "paymentMethod": "VISA",
            "number": null,
            "expirationDate": null,
            "creationDate": "2021-06-23T19:03:41",
            "maskedNumber": "424242******4242",
            "errorDescription": null
        },
        {
            "creditCardTokenId": "ead0a090-18dc-41ad-9431-ab342af854a2",
            "name": "LadyM",
            "payerId": "0sS01",
            "identificationNumber": "1234567890",
            "paymentMethod": "AMEX",
            "number": null,
            "expirationDate": null,
            "creationDate": "2021-06-24T11:48:21",
            "maskedNumber": "377813*****0001",
            "errorDescription": null
        }
    ]
}

Exemplo pedido:

<request>
   <language>es</language>
   <command>GET_TOKENS</command>
   <merchant>
      <apiLogin>pRRXKOl8ikMmt9u</apiLogin>
      <apiKey>4Vj8eK4rloUd272L48hsrarnUA</apiKey>
   </merchant>
   <creditCardTokenInformation>
      <startDate>2021-06-23T12:00:00</startDate>
      <endDate>2021-06-25T12:00:00</endDate>
   </creditCardTokenInformation>
</request>

Exemplo resposta:

<creditCardTokenListResponse>
    <code>SUCCESS</code>
    <creditCardTokenList>
        <creditCardToken>
            <creditCardTokenId>1adc6940-ee7e-48c2-bb96-7d784de74964</creditCardTokenId>
            <name>APPROVED</name>
            <payerId>20263841</payerId>
            <paymentMethod>AMEX</paymentMethod>
            <creationDate>2021-06-23T13:36:36</creationDate>
            <maskedNumber>377813*****0001</maskedNumber>
        </creditCardToken>
        <creditCardToken>
            <creditCardTokenId>3e5f0d77-0f93-421f-9432-99b6430e845e</creditCardTokenId>
            <name>Juan Perez</name>
            <payerId>158301</payerId>
            <paymentMethod>VISA</paymentMethod>
            <creationDate>2021-06-23T19:03:41</creationDate>
            <maskedNumber>424242******4242</maskedNumber>
        </creditCardToken>
        <creditCardToken>
            <creditCardTokenId>ead0a090-18dc-41ad-9431-ab342af854a2</creditCardTokenId>
            <name>LadyM</name>
            <payerId>0sS01</payerId>
            <identificationNumber>1234567890</identificationNumber>
            <paymentMethod>AMEX</paymentMethod>
            <creationDate>2021-06-24T11:48:21</creationDate>
            <maskedNumber>377813*****0001</maskedNumber>
        </creditCardToken>
    </creditCardTokenList>
</creditCardTokenListResponse>

Pagamentos usando tokenização

Para pagamentos com tokens de cartão de crédito, inclua o parâmetro transaction.creditCardTokenId substituindo as informações do cartão de crédito. O exemplo a seguir mostra o corpo da solicitação em um nível alto para um fluxo de uma etapa. Os detalhes da solicitação não são fornecidos.

Observação

Para processar sem CVV, é necessário enviar o parâmetro creditCard.processWithoutCvv2 como true na solicitação de pagamento e remover o parâmetro creditCard.securityCode.
Por padrão, o processamento de cartões de crédito sem código de segurança não está habilitado. Se você deseja habilitar este recurso, entre em contato com seu representante de vendas.

Exemplo pedido:

{
   "language": "es",
   "command": "SUBMIT_TRANSACTION",
   "merchant": {
      "apiKey": "4Vj8eK4rloUd272L48hsrarnUA",
      "apiLogin": "pRRXKOl8ikMmt9u"
   },
   "transaction": {
      "order": {
         "Informação do pedido":""
      },
      "payer": {
         "Informação do pagador":""
      },
      "creditCardTokenId": "46b7f03e-1b3b-4ce8-ad90-fe1a482f76c3",
      "creditCard": {
         "securityCode": "123"
      },
      "extraParameters": {
         "Parâmetros extras do pedido":""
      },
      "type": "AUTHORIZATION_AND_CAPTURE",
      "paymentMethod": "Card franchise", 
      "paymentCountry": "País de processamento",
      "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": true
}

Exemplo pedido:

<request>
   <language>es</language>
   <command>SUBMIT_TRANSACTION</command>
   <merchant>
      <apiKey>4Vj8eK4rloUd272L48hsrarnUA</apiKey>
      <apiLogin>pRRXKOl8ikMmt9u</apiLogin>
   </merchant>
   <transaction>
      <order>
         <!-- Informação do pedido -->
      </order>
      <payer>
         <!-- Informação do pagador -->
      </payer>
      <creditCardTokenId>46b7f03e-1b3b-4ce8-ad90-fe1a482f76c3</creditCardTokenId>
      <creditCard>
         <securityCode>321</securityCode>
      </creditCard>
      <extraParameters>
         <!-- Parâmetros extras do pedido -->
      </extraParameters>
      <type>AUTHORIZATION_AND_CAPTURE</type>
      <paymentMethod>{Card franchise}</paymentMethod>
      <paymentCountry>{País de processamento}</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>

Para obter informações específicas sobre como efetuar pagamentos, consulte o artigo respectivo ao país de processamento.

Argentina

Brasil

Chile

Colômbia

México

Panamá

Peru

Pagamentos múltiplos com tokenização

Usando este recurso, você pode realizar pagamentos usando vários tokens armazenados em um arquivo .csv e obter um token para cada cartão.

Observações

Cada registro do arquivo deve ter a seguinte estrutura e ordem separadas por vírgulas:
- ID da conta, identificador da sua conta PayU.
- Token de cartão de crédito
- Código de segurança do cartão de crédito
- Quantidade de parcelas
- Referência de venda
- Descrição de venda
- E-mail do comprador
- Código ISO da moeda. Veja as moedas aceitas
- Valor total incluindo impostos
- Valor base de reembolso
- Valor adicional
- Idioma usado nos e-mails enviados ao comprador e ao vendedor. Veja os idiomas disponíveis
O arquivo não deve ter cabeçalho.
O arquivo deve ser codificado em UTF-8. Você precisa implementar uma funcionalidade para codificar o conteúdo e enviar a string codificada no parâmetro contentFile.
O arquivo não pode ter mais de 10.000 registros.

Variáveis para pedido e resposta

Pedido

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 `PROCESS_BATCH_TRANSACTIONS_TOKEN`.	Sim
merchant			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
contentFile	Alfanumérico		String codificada em Base64 com as informações dos cartões de crédito, conforme explicado anteriormente.	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`.
id			Identificação do procedimento.

Chamada API

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

Exemplo pedido:

{
   "language": "es",
   "command": "PROCESS_BATCH_TRANSACTIONS_TOKEN",
   "merchant": {
      "apiLogin": "pRRXKOl8ikMmt9u",
      "apiKey": "4Vj8eK4rloUd272L48hsrarnUA"
   },
   "contentFile": "NTAwNTM4LGVhMDIwZTU5LWQ5NWEtNDk1ZC04OTAzLTM0ZTg0M2ZkN2ZlYywxMzIsMSxTYWxlLTA0LFN1YnNjcmlwdGlvbiBmZWUsdXNlcjFAbWFpbC5jb20sQ09QLDEwMDAwLDAsMCwwLGVzCjUwMDUzOCxlYWQwYTA5MC0xOGRjLTQxYWQtOTQzMS1hYjM0MmFmODU0YTIsMTM1LDEsU2FsZS0wNSxTdWJzY3JpcHRpb24gZmVlLHVzZXIyQG1haWwuY29tLENPUCwxMTAwMCwwLDAsMCxlcw=="
}

Exemplo resposta:

{
    "code": "SUCCESS",
    "error": null,
    "id": "51c72d88-f707-45ca-ad59-4508140833a7"
}

Exemplo pedido:

<request>
   <language>es</language>
   <command>PROCESS_BATCH_TRANSACTIONS_TOKEN</command>
   <merchant>
      <apiLogin>pRRXKOl8ikMmt9u</apiLogin>
      <apiKey>51c72d88-f707-45ca-ad59-4508140833a7</apiKey>
   </merchant>
   <contentFile>NTAwNTM4LGVhMDIwZTU5LWQ5NWEtNDk1ZC04OTAzLTM0ZTg0M2ZkN2ZlYywxMzIsMSxTYWxlLTA0LFN1YnNjcmlwdGlvbiBmZWUsdXNlcjFAbWFpbC5jb20sQ09QLDEwMDAwLDAsMCwwLGVzCjUwMDUzOCxlYWQwYTA5MC0xOGRjLTQxYWQtOTQzMS1hYjM0MmFmODU0YTIsMTM1LDEsU2FsZS0wNSxTdWJzY3JpcHRpb24gZmVlLHVzZXIyQG1haWwuY29tLENPUCwxMTAwMCwwLDAsMCxlcw=</contentFile>
</request>

Exemplo resposta:

<creditCardTokenBatchResponse>
   <code>SUCCESS</code>
   <id>b721abbc-a9cf-44c6-99ba-91393de2b5d6</id>
</creditCardTokenBatchResponse>

Última modificação 24 de junho de 2022: clon issue (d73e43fe5)