Consultar link

GET

/v1/links/{id}

curl --request GET \
  --url https://sandbox-api.eagleix-corban.com.br/v1/links/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

• Sandbox (só ambiente de teste)

Situação do link. Não devolve a URL (o token só sai na criação).

Autorizações

• canalOAuth

Parâmetros

Path Parameters

id

required

string format: uuid

Respostas

200

Link encontrado.

Tipo de mídiaapplication/json

object

id

required

string format: uuid

url

Só na criação. Envie ao cliente; não registre em log.

string

status

required

string

Allowed values: CRIADO ABERTO EM_ANDAMENTO CONCLUIDO CANCELADO EXPIRADO

ambiente

required

string

Allowed values: SANDBOX REAL

cpfMascarado

required

string

referenciaExterna

string

expiraEm

required

string format: date-time

criadoEm

required

string format: date-time

abertoEm

string format: date-time

proposta

Presente quando o cliente já enviou a proposta.

object

numero

integer

status

string

criadaEm

string format: date-time

Example

{
  "status": "CRIADO",
  "ambiente": "SANDBOX",
  "cpfMascarado": "***.982.247-**"
}

401

Token ausente, inválido ou expirado.

Tipo de mídiaapplication/json

object

code

required

Código estável, para tratamento programático.

string

message

required

Mensagem legível (pt-BR).

string

requestId

Id da requisição, igual ao header X-Request-Id.

string

Example

{
  "code": "unauthorized",
  "message": "token inválido ou expirado",
  "requestId": "8d1f0c2a9b7e4c3d2a1b0f9e"
}

Headers

WWW-Authenticate

string

Example

Bearer error="invalid_token"

404

Link não existe ou é de outro canal.

Tipo de mídiaapplication/json

object

code

required

Código estável, para tratamento programático.

string

message

required

Mensagem legível (pt-BR).

string

requestId

Id da requisição, igual ao header X-Request-Id.

string

Example

{
  "code": "unauthorized"
}