Pesquisar Link

GET/v1/paymentlink/information?id={id}

Você pode obter detalhes de um link de pagamento através do seu ID, fazendo um GET no endpoint a seguir:

Via request Representational State Transfer (REST) com o body:

Dicionário de dados - Parâmetros

Exemplo de requisição

curl --request GET \
  --url 'https://api.enoqpay.com.br/gateway/v1/paymentlink/information?id=aed32670-c3e5-4192-8ab0-0e96f92e3408' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json'

Retorno (200)

Exemplo de resposta

{
  "id": "aed32670-c3e5-4192-8ab0-0e96f92e3408",
  "sellerDocumentNumber": "28249206000179",
  "sellerName": "SO PAGUE ",
  "description": "Teste",
  "value": 10.50,
  // Apenas um dos campos abaixo vai estar preenchido: qttyInstallments ou qttyInstallmentsCustom
  "qttyInstallments": 12,
  "qttyInstallmentsCustom": [3, 6, 9, 12],
  "qttyInstallmentsIntFree": 6,
  "installmentsFee": 1.5,
  "operationDate": "<datetime>",
  "expirationDate": "<datetime>",
  "link": ".../teste/aed32670-c3e5-4192-8ab0-0e96f92e3408",
  "message": "Olá! Estou enviando um link para você fazer o pagamento para NOME COBRADOR (01234567890123).\r\n\r\nDescrição: Teste\r\nValor: R$ 10,50\r\nVocê pode pagar em até 12x!\r\n\r\nLink: .../teste/aed32670-c3e5-4192-8ab0-0e96f92e3408\r\n\r\nInstruções: Basta clicar no link, preencher os dados solicitados, escolher a opção de pagamento que melhor atende suas necessidades e clicar em Pagar. Você pode pagar de onde quiser! :)",
  "status": 9,
  "statusFormat": "Desativado",
  "paymentDate": "<datetime>",
  "paymentValue": null,
  "paymentQttyInstallments": 6,
  "paymentAuthorizationCode": "149674",
  "paymentResultId": "020080286103040952150000006201850000000000",
  "history": [
    {
      "id": "05874f86-9167-4f02-8af5-4132d4541a4b",
      "idPaymentLink": "aed32670-c3e5-4192-8ab0-0e96f92e3408",
      "reason": null,
      "historyDate": "<datetime>",
      "status": 1,
      "statusFormat": "Em Aberto"
    },
    {
      "id": "d12192a0-1670-4d0a-a57d-5208d8d1652c",
      "idPaymentLink": "aed32670-c3e5-4192-8ab0-0e96f92e3408",
      "reason": null,
      "historyDate": "<datetime>",
      "status": 9,
      "statusFormat": "Desativado"
    }
  ]
}

Dicionário de dados

Status do link de pagamento

Código	Descrição
1	Em Aberto
2	Pago
3	Expirado
9	Desativado
99	Falha

Erros

As respostas de erro conhecidas estão abaixo. Os retornos observados em homologação estão identificados separadamente dos exemplos documentados; as respostas podem variar conforme o ambiente e a configuração.

Exemplo documentado

{
  "error": "Link de pagamento não encontrado"
}

Observado em homologação

Requisição com corpo JSON vazio ou identificador sintético. O retorno abaixo mostra a validação realizada em homologação.

[
  {
    "tag": "",
    "description": "Nenhum link de pagamento encontrado"
  }
]

Campos da resposta de erro

A tabela reúne os campos presentes nos exemplos acima. Uma resposta HTTP sem corpo não inclui esses campos.