Disputa de Parceiros

A API Disputa de Parceiros tem a finalidade de fornecer uma possibilidade de melhoria de eficiência operacional nos gerenciamentos dos processos de Disputas.

Feito para:  CredenciadoresSubcredenciadoresEmissores

A Elo disponibilizou a possibilidade de melhoria do processo manual de documentação e relatório em um formato sistêmico, agilizando e melhorando a operacionalização nos gerenciamentos dos processos de disputas.

A API de Disputas estará disponível para os parceiros que desejarem realizar a integração, porém, a sua utilização não será mandatória.

Em todas as chamadas descritas é necessário informar o client_id e o access_token no header da requisição.

Para obter o access_token é necessário antes que você cadastre um usuário e faça login, onde será retornado o access_token que será utilizado nas chamadas desta API para se identificar.

Mais detalhes podem ser vistos na seção cadastro do portador.

Esta API segue a arquitetura REST e, no final desta documentação, há a seção de Referências com o Swagger desta API. Os possíveis base paths são:

Homologação:

https://dev-api.elo.com.br/dispute/v1/

Utilizando este recurso é possível realização do download da documentação de apoio, incluída nos processos em que o parceiro está envolvido.

Para realizar o download de evidência utilize o recurso GET /partners/me/disputes/{referenceNumber}/cycles/{cycle}/evidences.

Através da URL da requisição será necessário enviar os seguintes parâmetros:

  • referenceNumber (Parâmetro obrigatório): é o número da disputa a qual o parceiro faz parte.

  • cycle - (Parâmetro obrigatório): é o ciclo a qual se deseja obter a última evidencia anexada, podendo conter os seguintes valores: “CHARGEBACK”, “REPRESENTMENT”, “PREARBITRATION” e ou “ARBITRATION”.

Exemplo da chamada:

curl -X GET --header 'Accept: application/octet-stream'
--header 'client_id:'000c0000-000b-0000-ba0c-fb0d0000b000'
--header 'access_token:'111c1111-111b-1111-ba1c-fb1d1111b111'
https://dev-api.elo.com.br/dispute/v1/partners/me/disputes/00000000000000000000000/cycles/CHARGEBACK/evidences'

Exemplo do conteúdo dos cabeçalhos da requisição:

Accept: application/octet-stream'
client_id: 'string'
access_token: 'string'

Exemplo de resposta do cabeçalho:

  "accept-ranges": "bytes",
  "content-disposition": "attachment; filename=\"IMG_DISPUTA.png\"",
  "content-length": "275760",
  "content-type": "application/octet-stream",
  "date": "Wed, 23 Jun 2021 22:50:49 GMT"

Este serviço permite a realização de upload e/ou substituição de documentação de apoio nos processos enviados pelo parceiro.

É permitido apenas a inclusão de um documento por ciclo. O documento tem limite de tamanho máximo de 10MB e as extensões possíveis de inclusão são TIFF, PDF, PNG, TIF, JPEG, JPG.

Para realizar a inclusão de uma evidência, é preciso efetuar uma requisição POST ao recurso /partners/me/evidences?partnerEmail=email-parceiro.

Através da URL da requisição será necessário enviar os seguintes parâmetros:

  • file: Tipo “formData” Arquivo que será incluído no ciclo vigente e parcela principal. Exemplo: “NUMERO_REFERENCIA.pdf”. (referenceNumber)

  • partnerEmail: Tipo “String” e-mail referente ao parceiro que irá incluir a evidência, este e-mail será usado para ser referenciado ao evento de inclusão.

Exemplo da chamada:

curl --location --request POST 'https://dev-api.elo.com.br/dispute/v1/partners/me/evidences?partnerEmail=elo@elo.com' \
--header 'client_id: 00000000-0000-0000-0000-000000000000' \
--header 'access_token: 00000000-0000-0000-0000-000000000000' \
--form 'file=@"/home/elo/Downloads/00000000000000000000000.PNG"'

Este serviço permite o download de um relatório analítico em formato .xlsx com as informações das transações buscadas, de acordo com os filtros definidos, limitado a 10 mil linhas.

É possível a geração de um arquivo Excel contendo todas as disputas do parceiro conforme os parâmetros opcionais informados.

Para realizar a extração de uma evidência é necessário enviar através da URL da requisição os seguintes parâmetros:

  • referenceNumber (Campo opcional): Número da disputa a qual o parceiro faz parte.

  • cardNumber (Campo opcional): Número do cartão do cliente a qual pertence a uma ou a várias disputas.

  • acquirerCode (Campo opcional caso o issuerCode seja informado): Código do credenciador cujo valor poderá ser informado caso o participante seja um emissor.

  • issuerCode (Campo opcional caso o acquirerCode_ seja informado): Código do emissor cujo valor poderá ser informado caso o participante seja um credenciador.

  • cycle (Campo opcional): Ciclo a qual a disputa se encontra, podendo conter os seguintes valores: “CHARGEBACK”, “REPRESENTMENT”, “PREARBITRATION” e ou “ARBITRATION”.

  • startDate (Campo opcional): Início do intervalo ao qual a disputa faz parte.

  • endDate (Campo opcional): Fim do intervalo ao qual a disputa faz parte.

Exemplo da chamada:

curl --location --request GET 'https://dev-api.elo.com.br/dispute/v1?referenceNumber=00000000000000000000000&cardNumber=000000******0000&acquirerCode=000' \
--header 'client_id: 00000000-0000-0000-0000-000000000000' \
--header 'access_token:00000000-0000-0000-0000-000000000000' \
--form 'file=@"/home/elo/Downloads/00000000000000000000000.PNG"'

Abaixo, você verá uma lista de possíveis erros e o que eles podem significar.

  • 400 Bad Request

  • 500 Internal error

  • 500 Download failed

  • 406 Business error