Endpoint utilizado para fazer login no portal da Aditum de forma transparente, sem que o usuário precise inserir login e senha. Essa funcionalidade pode ser utilizada por sistemas que queiram embutir o portal da Aditum.
\nBCrypt gerado a partir da concatenação do CNPJ da loja e o Merchant Token.
\n","type":"text"},{"key":"merchantCredential","value":"{{CNPJ}}","description":"CNPJ da loja.
\n","type":"text"}],"url":"{{GATEWAY_ENDPOINT}}/v2/merchant/auth","description":"Endpoint utilizado para autenticar no gateway, sistema responsável por lidar com os pagamentos.
\nCria novos checkouts ou links de pagamento com as configurações desejadas.
\nEndpoint utilizado para obter os dados detalhados de um checkout. Se aplicável, dados não sensíveis de cartão são retornados, indicando que o cliente já fez compras e salvou seu cartão na wallet da Aditum.
\nEsse endpoint é configurado para ser chamado uma vez a cada 5 segundos por um único cliente e irá retornar 429 caso seja chamado com mais frequência. O cliente deve possuir lógica de retentativa nesse caso.
\nEndpoint utilizado para fazer um pagamento de e-commerce.
\nAs propriedades opcionais devem ser enviadas apenas se diferentes da original.
\nEndpoints utilizados para gestão de cartões de crédito na wallet da Aditum.
\n","event":[{"listen":"prerequest","script":{"id":"341c991d-9a02-4879-9124-24d8df59dcfa","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"54c296c2-9cf7-4af0-b40a-6cfeb766b86e","type":"text/javascript","exec":[""]}}],"_postman_id":"309d9c0d-2b6a-4416-8e8e-415623228fcb"},{"name":"Carrinho","item":[{"name":"Cadastrar Produto","id":"f2dae8b4-694e-48cb-88cf-544a78ef809c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{PORTAL_JWT}}"},"isInherited":false},"method":"POST","header":[{"key":"MerchantId","value":"{{MERCHANT_ID}}","description":""},"isInherited":false},"method":"PUT","header":[{"key":"MerchantId","value":"{{MERCHANT_ID}}","description":"ID da loja
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 2099,\n \"name\": \"Coca cola 2\",\n \"Sku\": \"SKU_123\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PORTAL_ENDPOINT}}/v1/product/{{PRODUCT_ID}}","description":"Requisição
\n\n\n\n| Propriedade | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\n| productId | \nstring | \nSim | \nID do produto | \n
\n\n
\n
Resposta
\n\n\n\n| Propriedade | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\n| product | \nProductResult | \nSim | \nProduto atualizado | \n
\n\n| success | \nbool | \nSim | \nSe o endpoint processou a requisição com sucesso | \n
\n\n| errors | \nError[] | \nSim | \nSe success: false, esse array contem a descrição dos erros retornados | \n
\n\n| traceKey | \nstring | \nSim | \nIdentificador da operação | \n
\n\n
\n
ID da loja
\n","type":"text"}],"url":"{{PORTAL_ENDPOINT}}/v1/product/{{PRODUCT_ID}}","description":"Requisição
\n\n\n\n| Propriedade | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\n| productId | \nstring | \nSim | \nID do produto | \n
\n\n
\n
Resposta
\n\n\n\n| Propriedade | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\n| product | \nProductResult | \nSim | \nProduto atualizado | \n
\n\n| success | \nbool | \nSim | \nSe o endpoint processou a requisição com sucesso | \n
\n\n| errors | \nError[] | \nSim | \nSe success: false, esse array contem a descrição dos erros retornados | \n
\n\n| traceKey | \nstring | \nSim | \nIdentificador da operação | \n
\n\n
\n
Requisição
\n\n\n\n| Propriedade | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\n| email | \nstring | \nSim | \nE-mail para contingência de entrega do webhook | \n
\n\n| webhooks | \nWebhook[] | \nSim | \nWebhooks a serem cadastrados | \n
\n\n
\n
Resposta
\n\n\n\n| Propriedade | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\n| webhooks | \nWebhookResult[] | \nSim | \nWebhooks cadastrados | \n
\n\n| success | \nbool | \nSim | \nSe o endpoint processou a requisição com sucesso | \n
\n\n| errors | \nError[] | \nSim | \nSe success: false, esse array contem a descrição dos erros retornados | \n
\n\n| traceKey | \nstring | \nSim | \nIdentificador da operação | \n
\n\n
\n
Requisição
\n\n\n\n| Propriedade | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\n| pageSize | \nint | \nSim | \nNumero máximo de registros retornados na resposta | \n
\n\n| currentPage | \nint | \nSim | \nNumero da página atual | \n
\n\n
\n
Resposta
\n\n\n\n| Propriedade | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\n| webhooks | \nWebhookResult[] | \nSim | \nWebhooks vinculados ao lojista. Numero máximo de registros igual ou menor ao recebido na requisição, na propriedade pageSize | \n
\n\n| total | \nint | \nSim | \nTotal de webhooks vinculados ao lojista. Maior ou igual ao numero de itens contidos na lista webhooks | \n
\n\n| success | \nbool | \nSim | \nSe o endpoint processou a requisição com sucesso | \n
\n\n| errors | \nError[] | \nSim | \nSe success: false, esse array contem a descrição dos erros retornados | \n
\n\n| traceKey | \nstring | \nSim | \nIdentificador da operação | \n
\n\n
\n
Numero máximo de registros retornados na resposta
\n","type":"text/plain"},"key":"pageSize","value":"10"},{"description":{"content":"Numero da página atual
\n","type":"text/plain"},"key":"currentPage","value":"1"}],"variable":[]}},"response":[{"id":"b6863999-87a9-4c05-b05b-3e5cfc5bae1b","name":"Obter webhooks","originalRequest":{"method":"GET","header":[{"key":"MerchantId","value":"bc8a31a0-dd5f-43fc-90ee-c63be04c3f39","type":"text"}],"url":{"raw":"{{WEBHOOK_ENDPOINT}}/v1/webhook?pageSize=10¤tPage=1","host":["{{WEBHOOK_ENDPOINT}}"],"path":["v1","webhook"],"query":[{"key":"pageSize","value":"10"},{"key":"currentPage","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.17.8"},{"key":"Date","value":"Fri, 07 Aug 2020 19:11:33 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"api-supported-versions","value":"1.0"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"webhooks\": [\n {\n \"webhookId\": \"3edb269c-9ab2-4a28-9008-cca66790fe2c\",\n \"status\": \"Active\",\n \"targetUrl\": \"https://www.google.com/v1/2123\",\n \"eventType\": \"ChargeCreated\",\n \"creationDate\": \"07/08/2020 19:06:46\",\n \"email\": \"ceres.rohana@aditum.com.br\"\n }\n ],\n \"total\": 1,\n \"success\": true,\n \"errors\": [],\n \"traceKey\": \"72ba1c36-df6f-460c-961f-283f6b5889e0\"\n}"},{"id":"fa662a75-5306-457a-8a21-372eb14d7537","name":"Obter webhooks (nenhum cadastrado)","originalRequest":{"method":"GET","header":[{"key":"MerchantId","value":"bc8a31a0-dd5f-43fc-90ee-c63be04c3f39","type":"text"}],"url":{"raw":"{{WEBHOOK_ENDPOINT}}/v1/webhook?pageSize=10¤tPage=1","host":["{{WEBHOOK_ENDPOINT}}"],"path":["v1","webhook"],"query":[{"key":"pageSize","value":"10"},{"key":"currentPage","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.17.8"},{"key":"Date","value":"Fri, 07 Aug 2020 19:20:16 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"102"},{"key":"Connection","value":"keep-alive"},{"key":"api-supported-versions","value":"1.0"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"webhooks\": [],\n \"total\": 0,\n \"success\": true,\n \"errors\": [],\n \"traceKey\": \"7ba0c178-9494-42a7-90a4-260965974c21\"\n}"}],"_postman_id":"014266d7-486d-4f78-8a87-19fd48ecb7d4"},{"name":"Cancelar webhook","id":"d93f4f20-c367-4959-b72c-b148d75faeae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{PORTAL_JWT}}"},"isInherited":false},"method":"PUT","header":[{"key":"MerchantId","value":"{{MERCHANT_ID}}","description":"ID da loja
\n","type":"text"}],"url":"{{WEBHOOK_ENDPOINT}}/v1/webhook/cancel/{{WEBHOOK_ID}}","description":"Requisição
\n\n\n\n| Propriedade | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\n| pageSize | \nint | \nSim | \nNumero máximo de registros retornados na resposta | \n
\n\n| currentPage | \nint | \nSim | \nNumero da página atual | \n
\n\n
\n
Resposta
\n\n\n\n| Propriedade | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\n| webhooks | \nWebhookResult[] | \nSim | \nWebhooks vinculados ao lojista. Numero máximo de registros igual ou menor ao recebido na requisição, na propriedade pageSize | \n
\n\n| total | \nint | \nSim | \nTotal de webhooks vinculados ao lojista. Maior ou igual ao numero de itens contidos na lista webhooks | \n
\n\n| success | \nbool | \nSim | \nSe o endpoint processou a requisição com sucesso | \n
\n\n| errors | \nError[] | \nSim | \nSe success: false, esse array contem a descrição dos erros retornados | \n
\n\n| traceKey | \nstring | \nSim | \nIdentificador da operação | \n
\n\n
\n
Endpoints relacionados a configuração dos webhooks.
\nEntrega de webhooks
\nA entrega dos webhooks é feita via HTTP POST, utilizando o Merchant Token em base64 como autenticação. Ou seja, será enviado o parâmetro Authorization: base64(merchantToken). É importante que essa validação seja feita afim de evitar ataques de spoofing.
\nO body da requisição é descrito no objeto WebhookCall, na seção Objetos.
\n","event":[{"listen":"prerequest","script":{"id":"7db6f51e-7374-4494-91c1-71f11b18eb73","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c5fa2c8d-ce86-44f2-ad87-49aa5af6dc68","type":"text/javascript","exec":[""]}}],"_postman_id":"681674e8-5c7b-4d94-8eb0-387a07c37c69"},{"name":"Split","item":[{"name":"Criar Recebedor","id":"03d608dc-1f63-41bc-b069-04fd23c5ab0e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"receiver\": {\n \"name\": \"Heloisa Helena\",\n \"email\": \"helo.helena@gmail.com\",\n \"entityType\": \"IndividualMerchant\",\n \"documentType\": \"Cpf\",\n \"document\": \"75783987760\",\n \"transferEnabled\": false,\n \"address\": {\n \"street\": \"Travessa Eurico\",\n \"number\": \"407\",\n \"neighborhood\": \"Fonseca\",\n \"city\": \"Niterói\",\n \"state\": \"RJ\",\n \"country\": \"Brasil\",\n \"zipCode\": \"24130811\",\n \"complement\": \"CS 03\"\n },\n \"contacts\": {\n \"name\": \"Henrico Souza\",\n \"phone\": {\n \"countryCode\": \"55\",\n \"areaCode\": \"21\",\n \"number\": \"996325711\",\n \"type\": 5\n },\n \"email\": \"henrico@gmail.com\",\n \"type\": 1\n },\n \"bankAccounts\": [\n {\n \"bankCode\": 260,\n \"bankName\": \"NU PAGAMENTOS S.A (NUBANK)\",\n \"branch\": \"0001\",\n \"branchCheckDigit\": null,\n \"account\": \"9999999\",\n \"type\": \"CheckingAccount\",\n \"accountCheckDigit\": \"9\",\n \"isActive\": true\n }\n ],\n \"type\": \"Seller\",\n \"isActive\": true,\n \"mdrCommission\": 0,\n \"fixedAmountComission\": 0,\n \"mdrDiscount\": true,\n \"chargeRemainder\": true,\n \"percentageComission\": 0,\n \"minimumAmountAutomaticPayment\": 0,\n \"externalId\": \"REC-123\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://payment.aditum.com.br/v2/receiver","urlObject":{"protocol":"https","path":["v2","receiver"],"host":["payment","aditum","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"03d608dc-1f63-41bc-b069-04fd23c5ab0e"}],"id":"dec82914-09e5-485f-85be-b7b94cf3a3c4","_postman_id":"dec82914-09e5-485f-85be-b7b94cf3a3c4","description":""},{"name":"Assinatura / Recorrência","item":[{"name":"Obter assinatura","id":"7a0cf8fc-4eeb-44b9-a2af-0074b5a64990","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{PORTAL_JWT}}"},"isInherited":false},"method":"GET","header":[{"key":"MerchantId","value":"{{MERCHANT_ID}}","type":"text"}],"url":"{{PORTAL_ENDPOINT}}/v1/Subscription/8c142e72-b929-4296-971d-af2f9c663b6e","description":"Esse endpoint é responsável por retornar os detalhes de uma recorrência.
\nRequisição
\n\n\n\n| Propriedade | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\n| subscriptionId | \nstring | \nSim | \nGUID da subscription, obtido na criação da assinatura | \n
\n\n
\n
Resposta
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\n| name | \nstring | \nNome do comprador | \n
\n\n| email | \nstring | \nE-mail do comprador | \n
\n\n| startDate | \nDateTime | \nData de início da cobrança recorrente | \n
\n\n| endDate | \nDateTime | \nData de encerramento da cobrança recorrente | \n
\n\n| isActive | \nbool | \nSe a assinatura está ativa ou não | \n
\n\n| amount | \nint | \nValor de cada cobrança recorrente | \n
\n\n| card | \nObject | \nInformações reduzidas do cartão que será cobrado de forma recorrente | \n
\n\n| card.id | \nGUID | \nID do cartão retornado em sua criação | \n
\n\n| card.cardNumber | \nstring | \nNumeração do cartão truncado | \n
\n\n| card.brandName | \nstring | \nBandeira do cartão | \n
\n\n| card.cardholderName | \nstring | \nNome do comprador como escrito no cartão | \n
\n\n| card.expirationMonth | \nint | \nMês de expiração do cartão | \n
\n\n| card.expirationYear | \nint | \nAno de expiração do cartão em formato YYYY | \n
\n\n| frequency | \nFrequencyEnum | \nFrequência em que a cobrança recorrente será executada | \n
\n\n| charges | \nObject | \nCobranças recorrentes executadas na assinatura | \n
\n\n| charges.id | \nGUID | \nID da cobrança recorrente | \n
\n\n| charges.chargeStatus | \nChargeStatusEnum | \nStatus da cobrança recorrente | \n
\n\n| charges.chargeDate | \nDateTime | \nHorário em que a cobrança foi feita | \n
\n\n| charges.amount | \nint | \nValor da cobrança recorrente | \n
\n\n| planName | \nstring | \nNome do plano definido em sua criação | \n
\n\n| plan | \nObject | \nInformações sobre o plano | \n
\n\n| plan.id | \nGUID | \nID do plano definido em sua criação | \n
\n\n| plan.amount | \nint | \nValor do plano | \n
\n\n| plan.frequency | \nFrequencyEnum | \nFrequência em que a cobrança recorrente será executada | \n
\n\n| plan.cycles | \nint | \nQuantas vezes a recorrência será cobranda | \n
\n\n| plan.frequencyTranslated | \nstring | \nDescrição da frequência | \n
\n\n| plan.label | \nstring | \nNome do plano definido em sua criação | \n
\n\n| plan.isActive | \nbool | \nSe o plano está ativo | \n
\n\n| plan.merchantId | \nGUID | \nID da loja que criou o plano | \n
\n\n| plan.paymentType | \nPaymentType | \nForma de pagamento do plano | \n
\n\n| invoices | \nObject | \nFaturas cobradas na assinatura | \n
\n\n
\n
Uma assinatura é um pagamento cobrado de forma recorrente, utilizando cartões de crédito ou boleto bancário. Cada assinatura pode ser gerenciada individualmente através do portal ou via API.
\n","_postman_id":"fc0e5733-a062-49bb-a2cc-bfacaa9da3f9"},{"name":"Objetos","item":[],"id":"bfd7b1a0-0acb-4622-9d72-100d52252349","description":"Descreve os tipos de objetos utilizados nas mensagerias descritas nesta documentação.
\nCustomer
\n\n\n\n| Propriedade | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\n| name | \nstring | \nSim | \nNome completo do comprador | \n
\n\n| email | \nstring | \nSim | \nE-mail do comprador | \n
\n\n| entityType | \nEntityType | \nSim | \nSe é pessoa física ou jurídica | \n
\n\n| documentType | \nDocumentType | \nSim | \nTipo do documento do comprador (CPF, CNPJ) | \n
\n\n| document | \nstring | \nSim | \nDocumento do comprador | \n
\n\n| birthday | \ndate | \nNão | \nData de nascimento do comprador | \n
\n\n| gender | \nGenderCode | \nNão | \nGênero do comprador (F / M) | \n
\n\n| phone | \nobject | \nSim | \nTelefone do comprador | \n
\n\n| address | \nobject | \nSim | \nEndereço do comprador | \n
\n\n
\n
Phone
\n\n\n\n| Propriedade | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\n| countryCode | \nstring | \nSim | \nCódigo do país | \n
\n\n| areaCode | \nstring | \nSim | \nCódigo de área | \n
\n\n| number | \nstring | \nSim | \nNúmero do Telefone | \n
\n\n| type | \nPhoneType | \nSim | \nTipo do telefone | \n
\n\n
\n
Address
\n\n\n\n| Propriedade | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\n| street | \nstring | \nSim | \nRua | \n
\n\n| number | \nstring | \nSim | \nNúmero | \n
\n\n| neighborhood | \nstring | \nSim | \nBairro | \n
\n\n| city | \nstring | \nSim | \nCidade | \n
\n\n| state | \nstring | \nSim | \nEstado | \n
\n\n| country | \nstring | \nSim | \nPaís | \n
\n\n| zipCode | \nstring | \nSim | \nCEP | \n
\n\n| complement | \nstring | \nSim | \nComplemento | \n
\n\n
\n
NewProducts
\n\n\n\n| Propriedade | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\n| merchantId | \nstring | \nSim | \nID da loja dona dos produtos cadastrados | \n
\n\n| products | \nProduct[] | \nSim | \nInformação dos produtos cadastrados | \n
\n\n
\n
Product
\n\n\n\n| Propriedade | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\n| name | \nstring | \nSim | \nNome do produto, campo livre | \n
\n\n| description | \nstring | \nNão | \nDescrição do produto, campo livre | \n
\n\n| imagesRef | \nstring[] | \nNão | \nURLs de Imagens relacionados ao produto, string deve ser URL válida | \n
\n\n| amount | \nstring | \nSim | \nValor do produto em centavos | \n
\n\n| sku | \nstring | \nSim | \nIdentificador único do produto na loja. Não é permitido valor duplicado | \n
\n\n| isActive | \nbool | \nNão | \nSe o produto está disponível na loja. Default false | \n
\n\n
\n
ProductResult
\n\n\n\n| Propriedade | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\n| id | \nstring | \nSim | \nID do produto | \n
\n\n| name | \nstring | \nSim | \nNome do produto, campo livre | \n
\n\n| amount | \nstring | \nSim | \nValor do produto em centavos | \n
\n\n| sku | \nstring | \nSim | \nIdentificador único do produto na loja. Não é permitido valor duplicado | \n
\n\n| isActive | \nbool | \nNão | \nSe o produto está disponível na loja. Default false | \n
\n\n| merchantId | \nstring | \nSim | \nID do lojista dono do produto | \n
\n\n
\n
Transaction
\n\n\n\n| Propriedade | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\n| paymentType | \nPaymentType | \nSim | \nTipo do pagamento | \n
\n\n| amount | \nlong | \nSim | \nValor da transação em centavos | \n
\n\n| installmentType | \nInstallmentType | \nCondicional | \nTipo do parcelamento. Obrigatório se a transação for parcelada | \n
\n\n| installmentNumber | \nint | \nCondicional | \nNúmero de parcelas. Obrigatório se a transação for parcelada | \n
\n\n| card | \nCard | \nCondicional | \nDados do cartão de crédito. Obrigatório se walletCard não for preenchido | \n
\n\n| walletCard | \nWalletCard | \nCondicional | \nDados do cartão já salvo na wallet da Aditum | \n
\n\n
\n
Card
\n\n\n\n| Propriedade | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\n| expirationMonth | \nint | \nSim | \nMês de expiração do cartão | \n
\n\n| expirationYear | \nint | \nSim | \nAno de expiração do cartão | \n
\n\n| brand | \nCardBrand | \nSim | \nIdentificador da bandeira do cartão | \n
\n\n| cvv | \nstring | \nSim | \nCódigo de verificação do cartão. Suporta apenas valores numéricos de 3 à 4 dígitos | \n
\n\n| number | \nstring | \nSim | \nNumeração do cartão (PAN - Primary Account Number). Aviso: na criação do cartão, esse campo é chamado cardNumber | \n
\n\n| cardholderName | \nstring | \nSim | \nNome do portador como está escrito no cartão | \n
\n\n| cardholderDocument | \nstring | \nSim | \nDocumento do portador (CPF ou CNPJ) | \n
\n\n| billingAddress | \nAddress | \nEndereço de cobrança | \n | \n
\n\n
\n
CardResult
\n\n\n\n| Propriedade | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\n| id | \nstring | \nSim | \nID do cartão na wallet | \n
\n\n| customerId | \nstring | \nSim | \nID do comprador vinculado ao cartão | \n
\n\n| cardNumber | \nstring | \nSim | \nPAN truncado. Exemplo: 549362******9945 | \n
\n\n| brand | \nCardBrand | \nSim | \nBandeira do cartão | \n
\n\n| cardholderName | \nstring | \nSim | \nNome do portador como está escrito no cartão | \n
\n\n| cardholderDocument | \nstring | \nSim | \nDocumento do portador (CPF ou CNPJ) | \n
\n\n| billingAddress | \nAddress | \nSim | \nEndereço de cobrança | \n
\n\n| isPrivateLabel | \nbool | \nSim | \nSe o cartão é private label ou não | \n
\n\n| expirationMonth | \nint | \nSim | \nMês de expiração do cartão | \n
\n\n| expirationYear | \nint | \nSim | \nAno de expiração do cartão | \n
\n\n| brandName | \nstring | \nSim | \nLabel da bandeira do cartão | \n
\n\n
\n
WalletCard
\n\n\n\n| Propriedade | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\n| cardId | \nstring | \nSim | \nID do cartão cadastrado na wallet da Aditum | \n
\n\n| cvv | \nstring | \nSim | \nCódigo de verificação do cartão. Suporta apenas valores numéricos de 3 à 4 dígitos | \n
\n\n
\n
ShortCard
\n\n\n\n| Propriedade | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\n| id | \nstring | \nCondicional | \nID do cartão. Presente no objeto WebhookCall | \n
\n\n| number | \nstring | \nSim | \nPAN truncado. Exemplo: 549362******9945 | \n
\n\n| brand | \nCardBrand | \nSim | \nBandeira do cartão | \n
\n\n
\n
CardToUpdate
\n\n\n\n| Propriedade | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\n| id | \nstring | \nSim | \nID do cartão sendo atualizado | \n
\n\n| cardNumber | \nstring | \nNão | \nPAN do cartão | \n
\n\n| cvv | \nstring | \nCondicional | \nObrigatório se cardNumber atualizado | \n
\n\n| brand | \nCardBrand | \nNão | \nBandeira do cartão | \n
\n\n| cardholderName | \nstring | \nSim | \nNome do portador como está escrito no cartão | \n
\n\n| cardholderDocument | \nstring | \nSim | \nDocumento do portador (CPF ou CNPJ) | \n
\n\n| billingAddress | \nAddress | \nSim | \nEndereço de cobrança | \n
\n\n| isPrivateLabel | \nbool | \nSim | \nSe o cartão é private label ou não | \n
\n\n| expirationMonth | \nint | \nSim | \nMês de expiração do cartão | \n
\n\n| expirationYear | \nint | \nSim | \nAno de expiração do cartão | \n
\n\n| brandName | \nstring | \nSim | \nLabel da bandeira do cartão | \n
\n\n
\n
Error
\n\n\n\n| Propriedade | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\n| errorCode | \nErrorCode | \nSim | \nIdentificador de um erro retornado pela Aditum | \n
\n\n| message | \nstring | \nSim | \nMessagem com mais detalhes sobre o erro ocorrido | \n
\n\n| field | \nstring | \nNão | \nNome da propriedade em que o erro ocorreu | \n
\n\n
\n
ChargeResult
\n\n\n\n| Propriedade | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\n| id | \nstring | \nSim | \nID da cobrança | \n
\n\n| merchantChargeId | \nstring | \nNão | \nID da cobrança definido pelo lojista / integrador | \n
\n\n| nsu | \nstring | \nSim | \nNSU da cobrança definido pela Aditum. É um identificador único de 9 digitos, podendo ir de 0 à 999999999. Quando atinge seu valor máximo, o contador é reiniciado | \n
\n\n| customerId | \nstring | \nSim | \nID do comprador | \n
\n\n| chargeStatus | \nChargeStatus | \nSim | \nStatus da cobrança | \n
\n\n| transactions | \nTransactionResult[] | \nSim | \nTransações realizadas na cobrança | \n
\n\n
\n
TransactionResult
\n\n\n\n| Propriedade | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\n| isApproved | \nbool | \nSim | \nSe a transação foi aprovada ou pré-autorizada | \n
\n\n| card | \nShortCard | \nSim | \nDados resumidos do cartão utilizado na compra | \n
\n\n| paymentType | \nPaymentType | \nSim | \nTipo do pagamento | \n
\n\n| installmentType | \nInstallmentType | \nCondicional | \nTipo do parcelamento. Obrigatório se a transação for parcelada | \n
\n\n| installmentNumber | \nint | \nCondicional | \nNúmero de parcelas. Obrigatório se a transação for parcelada | \n
\n\n| softDescriptor | \nstring | \nCondicional | \nSe a transação for de crédito, descrição que aparece no extrato do comprador | \n
\n\n| amount | \nlong | \nSim | \nValor da transação em centavos | \n
\n\n| isCapture | \nbool | \nSim | \nSe a transação foi aprovada ou capturada | \n
\n\n| isRecurrency | \nbool | \nSim | \nSe a transação é parte de uma assinatura recorrente | \n
\n\n| isCanceled | \nbool | \nSim | \nSe a transação foi cancelada | \n
\n\n| transactionId | \nstring | \nSim | \nID da transação definido pela adquirente ou banco | \n
\n\n| transactionStatus | \nTransactionStatus | \nSim | \nStatus da transação | \n
\n\n| acquirer | \nAcquirerCode | \nCondicional | \nSe a transação for de crédito, o ID da adquirente que processou a transação | \n
\n\n| acquirerErrorCode | \nstring | \nCondicional | \nCódigo do erro retornado pela adquirente. Presente se a transação foi enviada à adquirente e ela retornou erro | \n
\n\n| acquirerErrorMessage | \nstring | \nCondicional | \nMensagem de erro retornada pela adquirente. Presente se a transação foi enviada à adquirente e ela retornou erro | \n
\n\n| bank | \nstring | \nCondicional | \nSe a transação for boleto, o ID do banco que emitiu o boleto definido pela FEBRABAN | \n
\n\n| creationDateTime | \ndate | \nSim | \nData da criação da transação | \n
\n\n
\n
Webhook
\n\n\n\n| Propriedade | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\n| targetUrl | \nstring | \nSim | \nURL a ser chamada quando o evento desejado acontecer | \n
\n\n| eventType | \nEventType | \nSim | \nTipo do evento que irá gerar notificações | \n
\n\n| customHeaders | \nCustomHeader | \nNão | \nHeaders para serem enviados na chamada da url de notificação. | \n
\n\n
\n
\n\n\n| Propriedade | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\n| param | \nstring | \nSim | \nNome do parâmetro para ser adicionado no header da requisição | \n
\n\n| value | \nstring | \nSim | \nValor do parâmetro, podendo ser enviado {{timestamp}} para ser preenchido com o valor do horário enviado. | \n
\n\n
\n
WebhookResult
\n\n\n\n| Propriedade | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\n| webhookId | \nstring | \nSim | \nID do webhook criado | \n
\n\n| status | \nWebhookStatus | \nSim | \nStatus do webhook | \n
\n\n| targetUrl | \nstring | \nSim | \nURL a ser chamada quando o evento desejado acontecer | \n
\n\n| eventType | \nEventType | \nSim | \nTipo do evento que irá gerar notificações | \n
\n\n| creationDate | \ndate | \nSim | \nData de criação do webhook | \n
\n\n| email | \nstring | \nSim | \nE-mail de contingência para entrega do webhook | \n
\n\n
\n
WebhookCall
\n\n\n\n| Propriedade | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\n| ChargeId | \nstring | \nSim | \nID da cobrança | \n
\n\n| MerchantId | \nstring | \nSim | \nID da loja | \n
\n\n| Nsu | \nstring | \nSim | \nCódigo da cobrança criado pela Aditum, não utilizado pelo e-commerce | \n
\n\n| CustomerId | \nstring | \nSim | \nID do comprador | \n
\n\n| ShippingAddress | \nAddress | \nCondicional | \nEndereço de entrega. Presente se houver entrega configurada no checkout / link de pagamento | \n
\n\n| Source | \nPaymentSource | \nSim | \nOrigem da cobrança | \n
\n\n| SmartCheckoutId | \nstring | \nSim | \nID do checkout / link de pagamentos | \n
\n\n| Transactions | \nWebhookTransaction | \nSim | \nInformações das transações na cobrança | \n
\n\n| ChargeStatus | \nChargeStatus | \nSim | \nStatus atualizado da cobrança | \n
\n\n
\n
WebhookTransaction
\n\n\n\n| Propriedade | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\n| Card | \nShortCard | \nCondicional | \nDados não sensíveis do cartão. Presente se a transação foi de cartão de crédito / débito | \n
\n\n| SoftDescriptor | \nstring | \nSim | \nDescrição no extrato bancário do comprador | \n
\n\n| TransactionStatus | \nTransactionStatus | \nSim | \nStatus atualizado da transação | \n
\n\n| IsApproved | \nbool | \nSim | \nSe a transação está aprovada | \n
\n\n| PaymentType | \nPaymentType | \nSim | \nTipo de pagamento da transação | \n
\n\n| InstallmentNumber | \nuint | \nCondicional | \nNumero de parcelas na transação. Presente se a transação foi parcelada | \n
\n\n| InstallmentType | \nInstallmentType | \nSim | \nTipo de parcelamento da transação | \n
\n\n| AcquirerCode | \nAcquirerCode | \nSim | \nAdquirente que autorizou a transação | \n
\n\n| Amount | \nlong | \nSim | \nValor da transação em centavos | \n
\n\n| IsCapture | \nbool | \nSim | \nSe a transação foi capturada | \n
\n\n| IsRecurrency | \nbool | \nSim | \nSe a transação é recorrente | \n
\n\n| IsCanceled | \nbool | \nSim | \nSe a transação foi cancelada | \n
\n\n| TransactionId | \nstring | \nSim | \nID da transação retornado pela adquirente | \n
\n\n| MerchantOrderId | \nstring | \nOpcional | \nID da cobrança definido pelo integrador. Se não utilizado, a Aditum atribui valor aleatório | \n
\n\n| CreationDateTime | \nstring | \nSim | \nData da criação da transação no formato DD/MM/AAAA HH:MM:SS | \n
\n\n| CaptureDateTime | \nstring | \nSim | \nData da captura da transação no formato DD/MM/AAAA HH:MM:SS | \n
\n\n| CancelStatus | \nCancelStatus | \nCondicional | \nStatus do cancelamento. Presente se a transação foi cancelada | \n
\n\n
\n
Descreve os enumeradores utilizados nas mensagerias descritas nesta documentação.
\nOs enumeradores podem ser utilizados tanto em sua representação inteira quanto em texto.
\nPhoneType
\n\n\n\n| Valor inteiro | \nValor string | \nDescrição | \n
\n\n\n\n| 1 | \nResidential | \nTelefone residencial | \n
\n\n| 2 | \nCommercial | \nTelefone comercial | \n
\n\n| 3 | \nVoicemail | \nCorreio de voz | \n
\n\n| 4 | \nTemporary | \nTelefone temporário | \n
\n\n| 5 | \nMobile | \nCelular | \n
\n\n
\n
SmartCheckoutType
\n\n\n\n| Valor inteiro | \nValor string | \nDescrição | \n
\n\n\n\n| 1 | \nPaymentLink | \nSmartCheckout do tipo Link de Pagamento, criado via endpoint v2/paymentlink. | \n
\n\n| 2 | \nCheckout | \nSmartCheckout do tipo Checkout, criado via endpoint v2/smartcheckout. | \n
\n\n
\n
PaymentSource
\n\n\n\n| Valor inteiro | \nValor string | \nDescrição | \n
\n\n\n\n| 5 | \nPaymentLink | \nO pagamento vem de um link de pagamento | \n
\n\n| 8 | \nThirdPartyEcommerce | \nPagamento avulso | \n
\n\n| 10 | \nCheckout | \nO pagamento vem de um checkout | \n
\n\n
\n
PaymentType
\n\n\n\n| Valor inteiro | \nValor string | \nDescrição | \n
\n\n\n\n| 2 | \nCredit | \nPagamento com cartão de crédito | \n
\n\n
\n
InstallmentType
\n\n\n\n| Valor inteiro | \nValor string | \nDescrição | \n
\n\n\n\n| 1 | \nMerchant | \nTransação parcelada pelo lojista, ou seja, sem juros | \n
\n\n| 2 | \nIssuer | \nTransação parcelada pelo emissor do cartão, ou seja, com juros | \n
\n\n
\n
CardBrand
\n\n\n\n| Valor inteiro | \nValor string | \n
\n\n\n\n| 1 | \nVisa | \n
\n\n| 2 | \nMasterCard | \n
\n\n| 3 | \nAmex | \n
\n\n| 4 | \nElo | \n
\n\n| 5 | \nAura | \n
\n\n| 6 | \nJcb | \n
\n\n| 7 | \nDiners | \n
\n\n| 8 | \nDiscover | \n
\n\n| 9 | \nHipercard | \n
\n\n| 11 | \nEnroute | \n
\n\n| 12 | \nTicket | \n
\n\n| 13 | \nSodexo | \n
\n\n| 14 | \nVr | \n
\n\n| 15 | \nAlelo | \n
\n\n| 16 | \nSetra | \n
\n\n| 18 | \nVero | \n
\n\n| 19 | \nSorocred | \n
\n\n| 20 | \nGreenCard | \n
\n\n| 21 | \nCabal | \n
\n\n| 22 | \nBanescard | \n
\n\n| 23 | \nVerdeCard | \n
\n\n| 24 | \nValeCard | \n
\n\n| 25 | \nUnionPay | \n
\n\n| 26 | \nUp | \n
\n\n| 27 | \nTricard | \n
\n\n| 28 | \nBigcard | \n
\n\n| 29 | \nBen | \n
\n\n| 30 | \nRedeCompras | \n
\n\n
\n
ChargeStatus
\n\n\n\n| Valor inteiro | \nValor string | \nDescrição | \n
\n\n\n\n| 1 | \nAuthorized | \nTodas as transações da cobrança foram aprovadas | \n
\n\n| 2 | \nPreAuthorized | \nTodas as transações da cobrança foram pré-autorizadas | \n
\n\n| 4 | \nCanceled | \nTodas as transações da cobrança foram canceladas | \n
\n\n| 5 | \nPartial | \nAs transações da cobrança diferem em status. Verificar o status de cada transação individualmente | \n
\n\n| 6 | \nNotAuthorized | \nTodas as transações da cobrança foram negadas | \n
\n\n| 7 | \nPendingCancel | \nTodas as transações da cobrança estão com cancelamento pendente | \n
\n\n
\n
TransactionStatus
\n\n\n\n| Valor inteiro | \nValor string | \nDescrição | \n
\n\n\n\n| 1 | \nPreAuthorized | \nTransação pré-autorizada | \n
\n\n| 2 | \nCaptured | \nTransação autorizada ou capturada posteriormente | \n
\n\n| 3 | \nDenied | \nTransação negada | \n
\n\n| 4 | \nPending | \nTransação pendente, a ser processada pela adquirente ou banco | \n
\n\n| 5 | \nCanceled | \nTransação cancelada | \n
\n\n| 6 | \nPendingCancel | \nTransação com cancelamento pendente pela adquirente ou banco | \n
\n\n| 7 | \nPendingPayment | \nTransação enviada a adquirente ou banco, aguardando retorno | \n
\n\n| 8 | \nPaid | \nBoleto pago | \n
\n\n| 9 | \nErrorCreation | \nErro ao criar boleto | \n
\n\n| 10 | \nExpired | \nBoleto expirado | \n
\n\n
\n
SmartCheckoutStatus
\n\n\n\n| Valor inteiro | \nValor string | \nDescrição | \n
\n\n\n\n| 1 | \nPending | \nPendente de pagamento, nenhuma cobrança foi feita ainda | \n
\n\n| 2 | \nActivated | \nAlguma cobrança foi feita, porém não atingiu ainda o limite ou expiração | \n
\n\n| 3 | \nCanceled | \nCancelado | \n
\n\n| 100 | \nExpiredByMaximumApprovals | \nExpirado, porque o numero de cobranças atingiu o máximo | \n
\n\n| 101 | \nExpiredByDate | \nExpirado, porque atingiu a data de expiração | \n
\n\n| 102 | \nExpiredByTooManyDenials | \nExpirado / bloqueado, devido a muitas tentativas não aprovadas | \n
\n\n
\n
AcquirerCode
\n\n\n\n| Valor inteiro | \nValor string | \n
\n\n\n\n| 1 | \nCielo | \n
\n\n| 2 | \nRede | \n
\n\n| 3 | \nStone | \n
\n\n| 4 | \nVBI | \n
\n\n| 5 | \nGranito | \n
\n\n| 6 | \nInfinitePay | \n
\n\n| 7 | \nSafrapay | \n
\n\n| 8 | \nAdiq (e-commerce) | \n
\n\n| 9 | \nPagSeguro | \n
\n\n| 10 | \nAdiq (TEF) | \n
\n\n| 999 | \nSimulador | \n
\n\n
\n
EventType
\n\n\n\n| Valor inteiro | \nValor string | \nDescrição | \n
\n\n\n\n| 1 | \nChargeCreated | \nEvento disparado quando uma cobrança é feita | \n
\n\n| 2 | \nChargeUpdated | \nEvento disparado quando uma atualização na cobrança é feita, ou seja, captura, cancelamento, etc | \n
\n\n
\n
WebhookStatus
\n\n\n\n| Valor inteiro | \nValor string | \nDescrição | \n
\n\n\n\n| 1 | \nPending | \nWebhook pendente, ou seja, eventos não serão enviados para ele nesse momento | \n
\n\n| 2 | \nActive | \nWebhook está ativo, ou seja, os eventos configurados serão entregues | \n
\n\n| 3 | \nFailed | \nFalha na validação do webhook. Webhook desativado, eventos não serão entregues | \n
\n\n| 4 | \nCanceled | \nWebhook cancelado pelo usuário | \n
\n\n
\n
EntityType
\n\n\n\n| Valor inteiro | \nValor string | \nDescrição | \n
\n\n\n\n| 1 | \nIndividualMerchant | \nPessoa Física | \n
\n\n| 2 | \nCompany | \nPessoa Jurídica | \n
\n\n
\n
DocumentType
\n\n\n\n| Valor inteiro | \nValor string | \nDescrição | \n
\n\n\n\n| 1 | \nCpf | \nCPF | \n
\n\n| 2 | \nCnpj | \nCNPJ | \n
\n\n
\n
GenderCode
\n\n\n\n| Valor inteiro | \nValor string | \nDescrição | \n
\n\n\n\n| 1 | \nFemale | \nMulher | \n
\n\n| 2 | \nMale | \nHomem | \n
\n\n| 3 | \nOther | \nOutro | \n
\n\n
\n
CancelStatus
\n\n\n\n| Valor inteiro | \nValor string | \nDescrição | \n
\n\n\n\n| 0 | \nPendingCancel | \nCancelamento pendente | \n
\n\n| 1 | \nCanceled | \nTransação cancelada | \n
\n\n| 2 | \nNotCanceled | \nTransação não cancelada ou cancelamento não aprovado | \n
\n\n
\n
ErrorCode
\n\n\n\n| Valor inteiro | \nDescrição | \n
\n\n\n\n| 1 | \nUma propriedade obrigatória ou condicional está vazia, apenas com espaços em branco, apenas com zeros ou nula | \n
\n\n| 2 | \nMerchant Token inválido | \n
\n\n| 3 | \nCartão não suportado | \n
\n\n| 4 | \nCartão não encontrado na wallet | \n
\n\n| 5 | \nMês de expiração do cartão inválido | \n
\n\n| 6 | \nAno de expiração do cartão inválido | \n
\n\n| 7 | \nCartão expirado | \n
\n\n| 8 | \nComprador não encontrado na Aditum | \n
\n\n| 9 | \nNúmero de parcelas inválido | \n
\n\n| 10 | \nErro de comunicação com a adquirente. Tentar mais tarde ou entrar em contato com a Aditum | \n
\n\n| 11 | \nAdquirente inválida | \n
\n\n| 12 | \nTipo de pagamento inválido | \n
\n\n| 13 | \nPrioridade do tipo de pagamento inválida | \n
\n\n| 14 | \nTaxa percentual inválida | \n
\n\n| 15 | \nValor inválido | \n
\n\n| 16 | \nCobrança cancelada | \n
\n\n| 17 | \nCobrança não encontrada na Aditum | \n
\n\n| 18 | \nData inválida | \n
\n\n| 19 | \nFrequência de recorrência inválida | \n
\n\n| 20 | \nPlano não encontrado na Aditum | \n
\n\n| 21 | \nIntervalo de datas inválido | \n
\n\n| 22 | \nID do cartão inválido | \n
\n\n| 23 | \nRecebedor não encontrado | \n
\n\n| 24 | \nOpção de enumerador inválida ou não suportada | \n
\n\n| 25 | \nBanco não suportado | \n
\n\n| 26 | \nComprador não pode fazer ou requisitar a operação | \n
\n\n| 27 | \nErro na cobrança recorrente | \n
\n\n| 28 | \nErro ao executar os comandos | \n
\n\n| 29 | \nUsuário não encontrado na Aditum | \n
\n\n| 31 | \nData de início é mais recente que a data final | \n
\n\n| 32 | \nCNPJ inválido | \n
\n\n| 33 | \nE-mail inválido | \n
\n\n| 34 | \nID da adquirente inválido | \n
\n\n| 35 | \nToken da loja pai inválido | \n
\n\n| 36 | \nOperação não permitida para a loja | \n
\n\n| 37 | \nOperação não permitida | \n
\n\n| 38 | \nID da loja inválido | \n
\n\n| 39 | \nPermissão não encontrada | \n
\n\n| 40 | \nPAN encriptado está ausente | \n
\n\n| 41 | \nPAN sequence number (5F34) inválido | \n
\n\n| 42 | \nTerminal não encontrado na Aditum | \n
\n\n| 43 | \nLoja não encontrada na Aditum | \n
\n\n| 44 | \nErro na senha | \n
\n\n| 45 | \nPropriedade inválida (genérico) | \n
\n\n| 46 | \nTamanho da página ausente | \n
\n\n| 47 | \nNumero da página atual ausente | \n
\n\n| 48 | \nData e hora inválidos | \n
\n\n| 49 | \nTransação não suportada | \n
\n\n| 50 | \nErro interno de atualização | \n
\n\n| 51 | \nNão foi possível se conectar ao gateway de pagamentos | \n
\n\n| 52 | \nA assinatura foi desativada | \n
\n\n| 53 | \nA assinatura foi desativada devido a quantidade excessiva de não autorização | \n
\n\n| 54 | \nValor excede o limite | \n
\n\n| 55 | \nAssinatura não encontrada | \n
\n\n| 56 | \nCartão inválido | \n
\n\n| 57 | \nHistórico de comunicação da loja não encontrado | \n
\n\n| 58 | \nOperação não suportada pela adquirente | \n
\n\n| 59 | \nID de conciliação já existe | \n
\n\n| 60 | \nID de conciliação não existe | \n
\n\n| 61 | \nData requisitava é mais recente que a data atual | \n
\n\n| 62 | \nErro de requisição no Safrapay | \n
\n\n| 63 | \nO cartão é diferente da transação original | \n
\n\n| 64 | \nTransação não pode ser cancelada | \n
\n\n| 65 | \nFalha no upload do arquivo .OFX | \n
\n\n| 66 | \nValor requisitado é maior que o saldo atual do recebedor | \n
\n\n| 67 | \nData requisitada é mais antiga que a data atual | \n
\n\n| 68 | \nValor de transferência inválido | \n
\n\n| 69 | \nData requisitava é mais recente que a data atual | \n
\n\n| 70 | \nData requisitada é mais antiga que a data atual | \n
\n\n| 71 | \nFormato do GUID inválido | \n
\n\n| 72 | \nStatus inválido para cancelamento de ordem de transferência. Tente novamente mais tarde | \n
\n\n| 73 | \nID da ordem de transferência não encontrado | \n
\n\n| 74 | \nNúmero de transferências por dia excedido | \n
\n\n| 75 | \nID da linha de extrato no arquivo .OFX é inválida | \n
\n\n| 76 | \nCliente já foi credenciado | \n
\n\n| 77 | \nID do cliente é inválido | \n
\n\n| 78 | \nID do cliente não existe | \n
\n\n| 79 | \nValor não aceito. O valor deve estar no intervalo especificado na mensagem de erro | \n
\n\n| 80 | \nRecebedor já possui conta vinculada | \n
\n\n| 81 | \nCheckout / link de pagamento expirado | \n
\n\n| 82 | \nErro ao salvar dados | \n
\n\n| 83 | \nCobrança não cancelada | \n
\n\n| 84 | \nCheckout / link de pagamento não encontrado | \n
\n\n| 85 | \nID da taxa não encontrado | \n
\n\n| 86 | \nOrdem de transferência está em processamento | \n
\n\n| 87 | \nNenhum plano de taxas cadastrado | \n
\n\n| 88 | \nConciliação não cadastrada | \n
\n\n| 89 | \nO documento do comprador é inválido para o e-mail requisitado. Isso pode ocorrer se o e-mail já foi cadastrado para um comprador, com outro CPF / CNPJ | \n
\n\n| 90 | \nStatus da transação conciliada é inválido | \n
\n\n| 91 | \nCódigo da bandeira do cartão é inválido | \n
\n\n| 92 | \nConta bancária não encontrada para a ordem de transferência | \n
\n\n| 93 | \nConta bancária inválida para a ordem de transferência | \n
\n\n| 94 | \nO valor solicitado é inferior ao saldo total disponível, descontando o valor total das ordens de transferência em progresso no momento | \n
\n\n| 95 | \nNenhum recebedor encontrado | \n
\n\n| 96 | \nCobrança não elegível para split | \n
\n\n| 97 | \nTipo de ajuste inválido | \n
\n\n| 98 | \nRazão do ajuste inválida | \n
\n\n| 99 | \nTamanho da lista é inválido. Verifique o tamanho suportado na mensagem de erro | \n
\n\n| 100 | \nCNPJ já cadastrado | \n
\n\n| 101 | \nCobrança já autorizada | \n
\n\n| 102 | \nValor inválido (genérico) | \n
\n\n| 103 | \nMovimentação de ajuste já processada | \n
\n\n| 104 | \nConfiguração de desconto do boleto está inválida | \n
\n\n| 105 | \nConfiguração de desconto do boleto está inválida | \n
\n\n| 106 | \nItem do plano com valor inválido | \n
\n\n| 107 | \nErro na configuração da fatura | \n
\n\n| 108 | \nErro ao requisitar parâmetros da adquirente | \n
\n\n| 109 | \nErro de ativação na adquirente | \n
\n\n| 110 | \nErro na mensageria ISO-8583 | \n
\n\n| 111 | \nErro ao fazer login no portal Aditum | \n
\n\n| 112 | \nTerminal não está ativado na adquirente | \n
\n\n| 113 | \nTransação por boleto não suportada | \n
\n\n| 114 | \nFatura não encontrada pelo ID | \n
\n\n| 115 | \nSaldo atual insuficiente, descontando a taxa de transferência eletrônica | \n
\n\n| 116 | \nCódigo do banco inválido | \n
\n\n| 117 | \nAgência inválida | \n
\n\n| 118 | \nTamanho da agência inválido | \n
\n\n| 119 | \nCódigo de verificação da agência inválido | \n
\n\n| 120 | \nConta bancária inválida | \n
\n\n| 121 | \nTamanho da conta bancária inválido | \n
\n\n| 122 | \nCódigo de verificação da conta bancária inválido | \n
\n\n| 123 | \nDados bancários em branco | \n
\n\n| 124 | \nTipo de conta bancária inválido | \n
\n\n| 125 | \nNão foi possível se comunicar com o banco | \n
\n\n| 126 | \nErro no desfazimento | \n
\n\n| 127 | \nE-mail já existe | \n
\n\n| 128 | \nComprador não encontrado pelo documento (CPF / CNPJ) | \n
\n\n| 129 | \nCPF inválido | \n
\n\n| 130 | \nCódigo de área do telefone é inválido | \n
\n\n| 131 | \nCódigo do país do telefone é inválido | \n
\n\n| 132 | \nTelefone é inválido | \n
\n\n| 133 | \nDocumento é inválido | \n
\n\n| 134 | \nA origem da requisição é inválida para a operação | \n
\n\n| 135 | \nInformação de parcelamento é inválida | \n
\n\n| 136 | \nBandeira do cartão não suportada pela adquirente | \n
\n\n| 137 | \nLançamento futuro não encontrada | \n
\n\n| 138 | \nLançamento futuro já existe | \n
\n\n| 139 | \nTipos de pagamento suportados não encontrados | \n
\n\n| 140 | \nWebhook já cadastrado | \n
\n\n| 141 | \nURL inválida | \n
\n\n| 142 | \nOrigem da requisição não suportada | \n
\n\n| 143 | \nModo de entrada do cartão não suportado | \n
\n\n| 144 | \nCódigo de transação não suportado, verifique os códigos de transação suportados | \n
\n\n| 145 | \nA loja não pode configurar antecipação | \n
\n\n| 146 | \nAcesso negado ao checkout de pagamentos | \n
\n\n| 147 | \nNão foi possível processar a transação. Tente novamente em alguns minutos ou entre em contato com a loja | \n
\n\n| 148 | \nCódigo de processamento não suportado, verifique os códigos de processamento suportados | \n
\n\n| 149 | \nO valor mínimo da parcela não pode ser maior que o valor do Link de Pagamento ou Checkout | \n
\n\n| 150 | \nO webhook informado não foi encontrado | \n
\n\n| 151 | \nNúmero de série do terminal é inválido | \n
\n\n| 152 | \nNSU inválido | \n
\n\n| 153 | \nLoja requer motor de antifraude cadastrado | \n
\n\n| 9999 | \nOutros | \n
\n\n
\n
O tratamento dos retornas das APIs deve ser feito utilizando os seguintes campos:
\n\n- HTTP status code
\n- IDs e descrição de erros
\n
\nHTTP status code
\n\n\n\n| Código | \nDescrição | \nComportamento esperado | \n
\n\n\n\n| 200 | \nSucesso | \nA requisição foi processada com sucesso | \n
\n\n| 400 | \nRequisição possui um ou mais campos em formato inválido ou inesperado | \nIdealmente esse retorno não será retornado aos clientes que estão em fase de produção. O corpo de resposta dessas mensagens possui ID e descrição do erro, como é especificado nos próximos itens desta documentação | \n
\n\n| 401 | \nNão autorizado | \nHouve um erro na autenticação da requisição. O cliente deve refazer a geração de tokens de autenticação. Caso o problema não seja resolvido, entrar em contato com a área de suporte da Aditum | \n
\n\n| 429 | \nExcesso de requisições | \nA aplicação deve inserir um temporizador e tentar novamente em alguns segundos | \n
\n\n| 500 | \nErro interno | \nUm erro inesperado ocorreu. Quando isso ocorre, alertas são disparados na Aditum e a nossa área de operação é acionada. Mais detalhes sobre o erro podem ser requisitados pela nossa equipe | \n
\n\n
\n
Erros
\nA Aditum retorna os erros no seguinte formato:
\n{\n \"success\": false,\n \"errors\": [\n {\n \"errorCode\": 129,\n \"message\": \"O CPF '94666176056' é inválido.\",\n \"field\": \"CPF\"\n }\n ],\n \"traceKey\": \"c8c3cb7b-6488-4036-94ad-f8f205eee686\"\n}\n
\n\n\n| Propriedade | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\n| success | \nbool | \nSim | \nIndica se a requisição foi processada com sucesso | \n
\n\n| errors | \nError | \nSim | \nInformações sobre o erro ocorrido | \n
\n\n| traceKey | \nstring | \nSim | \nIdentificador único da requisição | \n
\n\n
\n
Utilizando a SDK de Checkout Transparente
\nO script do checkout transparente deve ser inserido na sua página, apontando para o local em que está salvo o código. <script src=\"https://cdn-dev.aditum.com.br/adt-transparent-v1.0.0.js\"></script>. Após adicionar o script na página, está disponível um objeto chamado AditumTransparent e nele contém os métodos necessários para tokenizar o cartão.
\nPasso 1
\nA primeira coisa a se fazer é registrar as credenciais da loja em que vai ser criado o cartão tokenizado, chamando o método setCredentials da SDK. Nesse método é necessário passar a MerchantCredential(CNPJ) e o MerchantToken dessa forma aqui: AditumTransparent.setCredentials({merchantCredential: \"{{cnpj}}\", merchantToken: \"{{merchantToken}}\"}).
\nPasso 2
\nApós adicionar as credenciais deve chamar o método AditumTransparent.getCardBrand({bin: \"411111\", success, error}), onde o bin é os 6 primeiros dígitos do cartão usado para identificar a bandeira, sucess é o callback que vamos chamar retornando a resposta com a bandeira então deve passar uma função para fazer esse tratamento e o error é o callback quando acontecer algum erro no processamento da requisição.
\nObjeto de sucesso na response:
\n{\n \"brand\":\"Visa\"\n}\n
\nObjeto de erro na response:
\n{\n \"errors\": [\n {\n \"errorCode\": 1,\n \"message\": \"Propriedade 'CardBin' está ausente.\",\n \"field\": \"CardBin\"v\n }\n ]\n}\n
\nPasso 3
\nApós o retorno da bandeira de cartão, pode chamar o método AditumTransparent.createTemporaryCard({card, success, error}) que é responsável por criar o token do cartão, onde card é o objeto contendo informações do cartão, success é o callback onde será informado o token gerado e o error é o callback que será chamado quando estiver algum erro na requisição. Abaixo um exemplo do objeto card preenchido:
\n{\n \"brand\":\"Visa\",\n \"number\":\"4111111111111111\",\n \"holderName\":\"FULANO SILVA\",\n \"holderDocument\":\"65844359038\",\n \"expirationMonth\":\"02\",\n \"expirationYear\":\"2021\",\n \"cvv\":\"223\"\n}\n
\nObjeto de retorno de sucesso:
\n{\n \"temporaryToken\":\"card_t/AIChh82EgN440hTW8vQqHcPC82EwBW\"\n}\n
\nObjeto de retorno de erro:
\n{\n \"errors\":[\n {\n \"errorCode\":1,\n \"message\":\"Propriedade 'Cvv' está ausente.\",\n \"field\":\"Cvv\"\n }\n ]\n}\n
\nPara múltiplos cartões, basta chamar esse método novamente com os dados do novo cartão e utilizar nos objetos de transação abaixo.
\nPasso 4
\nApós gerar o token, esse token pode ser enviado para seu servidor e ser usado pra passar uma requisição no endpoint v2/charge/ecommerce. Para passar uma cobrança com múltiplos cartões, basta adicionar mais um objeto de transação, com o token gerado para este cartão. Abaixo um exemplo de requisição usando esse token temporário.
\n{\n \"source\":1,\n \"merchantChargeId\": 1,\n \"customer\":{\n \"name\":\"FULANO SILVA\",\n \"email\":\"fake@email\",\n \"document\":\"65844359038\",\n \"documentType\":1,\n \"phone\":{\n \"countryCode\":55,\n \"type\":5,\n \"areaCode\":\"41\",\n \"number\":\"444444444\"\n }\n },\n \"transactions\":[{\n \"paymentType\":2,\n \"amount\": 1000,\n \"installmentNumber\":1,\n \"temporaryCardToken\": \"card_vS7aIEd72Ei3rb2EZlioSaAWj8o66maM\"\n }]\n}\n
\n","event":[{"listen":"prerequest","script":{"id":"3d9eefa6-f5b0-4f41-bd49-bbc3825d2c4a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"462a318f-b3bf-427d-bb65-9dec42fb0881","type":"text/javascript","exec":[""]}}],"_postman_id":"109e0f5b-faf8-422e-8fb7-59c43e17eaa1"},{"name":"Checkout Lightbox","item":[],"id":"eaff45ae-cb4a-434b-97f4-2e63075bacae","description":"Utilizando a SDK de Checkout Lightbox
\nO script do checkout lightbox deve ser inserido na sua página, apontando para o local em que está salvo o código. <script src=\"https://cdn-dev.aditum.com.br/adt-checkout-v1.0.0.js\" type=\"text/javascript\"></script>. Esse script vai ser responsável por exibir o checkout com informações do cartão e preenchimento de informações do comprador.
\nApós inserir o script deve ser adicionado no botão de Pagar da sua aplicação os seguintes atributos: data-adt-smartcheckout e data-adt-callback-url. Onde o primeiro vai ser o ID do SmartCheckout que deve ser gerado no endpoint v2/smartcheckout e o segundo vai ser a URL chamada quando tiver sucesso na transação. Ex.:\n<button type=\"button\" data-adt-smartcheckout=\"{{SmartCheckoutId}}\" data-adt-callback-url=\"{{SuccessUrl}}\">Pagar</button>
\nQuando o botão for clicado com essas informações preenchidas, a tela vai abaixo vai ser exibida:
\n![\"Passo](\"https://cdn-dev.aditum.com.br/CHECKOUT_SAMPLES/ADDRESS_STEP.png\")
\nApós o cliente executar o pagamento nessa tela exibimos a seguinte tela para voltar ao fluxo da loja:
\n![\"Passo](\"https://cdn-dev.aditum.com.br/CHECKOUT_SAMPLES/SUCCESS.png\")
\n","event":[{"listen":"prerequest","script":{"id":"7fee4ba7-a04c-4232-b52f-e2504d3112ec","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d1fca9b6-4f12-43b6-b50c-f5ba7ff9a9c3","type":"text/javascript","exec":[""]}}],"_postman_id":"eaff45ae-cb4a-434b-97f4-2e63075bacae"}]}