Pesquisar Links de Pagamento

Dados da API

API Gateway
Esta API é utilizada para operações do gateway de pagamento:

• Produção: https://api.sopague.com.br/gateway
• Homologação: https://api-hmg.sopague.com.br/gateway
• Arquitetura: Representational State Transfer (REST)

Pesquisa de Link de Pagamento

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

GET /v1/paymentlink/information?id=<guid>

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

Dicionário de dados - Parâmetros

PROPRIEDADE	DESCRIÇÃO	TIPO	LOCAL	OBRIGATÓRIO
id	Identificador do link de pagamento a ser pesquisado.	guid	Path	sim

🟢 200

Pagamento realizado com sucesso

{
  "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",
  "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 - Retorno

PROPRIEDADE	DESCRIÇÃO	TIPO	LOCAL	OBRIGATÓRIO
id	Identificador do link de pagamento	String	Body	sim
sellerDocumentNumber	Documento do vendedor	String	Body	sim
sellerName	Nome do vendedor	String	Body	sim
description	Descrição do link de pagamento	String	Body	sim
value	Valor do link de pagamento	Int	Body	sim
qttyInstallments	Quantidade de parcelas permitidas para pagamento. Presente apenas quando qttyInstallmentsCustom não está preenchido	Int	Body	condicional
qttyInstallmentsCustom	Array com quantidades de parcelas personalizadas. Presente apenas quando qttyInstallments não está preenchido	Array[Int]	Body	condicional
qttyInstallmentsIntFree	Quantidade de parcelas permitidas para pagamento sem juros	Int	Body	sim
installmentsFee	Taxa de juros aplicada em parcelas maiores que qttyInstallmentsIntFree (ex: 1.5 = 1.5%)	double	Body	sim
operationDate	Data da operação	Date	Body	sim
expirationDate	Data de expiração do link	Date	Body	sim
link	Link de pagamento	String	Body	sim
message	Mensagem do link de pagamento	String	Body	sim
status	Status do link de pagamento	Int	Body	sim
statusFormat	Mensagem do status do link de pagamento	String	Body	sim
paymentDate	Data em que o link foi pago	Date	Body	sim
paymentValue	Valor em que o link foi pago	Decimal	Body	sim
paymentQttyInstallments	Quantidade de parcelas pagas	Int	Body	sim
paymentAuthorizationCode	Código de autorização do pagamento	String	Body	sim
history	Histórico de alterações do link de pagamento	List	Body	sim

Status do link de pagamento:

• 1 = Em Aberto
• 2 = Pago
• 3 = Expirado
• 9 = Desativado
• 99 = Falha

🔴 400

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

Dicionário de dados - Retorno

PROPRIEDADE	DESCRIÇÃO	TIPO
tag	Tag do erro	string
description	Descrição do erro	string

🔴 500

Erro interno

[ 
    { 
        "tag": "", 
        "description": "Não foi possível executar comando. Erro desconhecido." 
    } 
]

Dicionário de dados - Retorno

PROPRIEDADE	DESCRIÇÃO	TIPO
tag	Tag do erro	string
description	Descrição do erro	string

Pesquisa de Lista de Links de Pagamento

É possível pesquisar e obter uma lista de todos os links de pagamento gerados pela sua conta, bastando fazer um GET conforme abaixo:

GET /v1/paymentlink/list?initialPaymentDate={initialPaymentDate}&finalPaymentDate={finalPaymentDate}&status={status}&pageNumber={pageNumber}&pageSize={pageSize}&columnOrder={columnOrder}&sortDirection={sortDirection}

Dicionário de dados - Query Parameters

PROPRIEDADE	DESCRIÇÃO	TIPO	OBRIGATÓRIO
initialPaymentDate	Intervalo de data de pagamento (início)	Date	sim
finalPaymentDate	Intervalo de data de pagamento (fim)	Date	sim
status	Status do link de pagamento	Int	sim
pageNumber	Número da página para paginação	Int	não
pageSize	Tamanho das páginas para paginação	Int	não
columnOrder	Coluna para ordenação	String	não
sortDirection	Direção da ordenação	String	não

🟢 200

Pagamento realizado com sucesso

{
  "paginacao": {
    "numeroPagina": 1,
    "qtdeItensPagina": 1,
    "tamanhoPagina": 10,
    "totalPaginas": 1,
    "qtdeItensTotal": 1
  },
  "itens": [
    {
      "id": "aed32670-c3e5-4192-8ab0-0e96f92e3408",
      "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,
      "status": 9,
      "statusFormat": "Desativado",
      "operationDate": "2024-09-02T11:55:58.7093323",
      "paymentDate": null,
      "payer": null
    }
  ]
}

Dicionário de dados - Retorno

PROPRIEDADE	DESCRIÇÃO	TIPO	LOCAL	OBRIGATÓRIO
paginacao.numeroPagina	Número da página atual	Int	Body	sim
paginacao.qtdeItensPagina	Quantidade de itens na página atual	Int	Body	sim
paginacao.tamanhoPagina	Tamanho da página	Int	Body	sim
paginacao.totalPaginas	Total de páginas	Int	Body	sim
paginacao.qtdeItensTotal	Quantidade total de itens	Int	Body	sim
itens.id	Identificador do link de pagamento	String	Body	sim
itens.description	Descrição do link de pagamento	String	Body	sim
itens.value	Valor do link de pagamento	Decimal	Body	sim
itens.qttyInstallments	Quantidade de parcelas. Presente apenas quando qttyInstallmentsCustom não está preenchido	Int	Body	condicional
itens.qttyInstallmentsCustom	Array com quantidades de parcelas personalizadas. Presente apenas quando qttyInstallments não está preenchido	Array[Int]	Body	condicional
itens.qttyInstallmentsIntFree	Quantidade de parcelas sem juros	Int	Body	sim
itens.installmentsFee	Taxa de juros aplicada em parcelas maiores que qttyInstallmentsIntFree (ex: 1.5 = 1.5%)	double	Body	sim
itens.status	Status do link de pagamento	Int	Body	sim
itens.statusFormat	Formato do status do link de pagamento	String	Body	sim
itens.operationDate	Data da operação	DateTime	Body	sim
itens.paymentDate	Data do pagamento	DateTime	Body	não
itens.payer	Pagador	String	Body	não

🔴 400

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

Dicionário de dados - Retorno

PROPRIEDADE	DESCRIÇÃO	TIPO
tag	Tag do erro	string
description	Descrição do erro	string

🔴 500

Erro interno

[ 
    { 
        "tag": "", 
        "description": "Não foi possível executar comando. Erro desconhecido." 
    } 
]

Dicionário de dados - Retorno

PROPRIEDADE	DESCRIÇÃO	TIPO
tag	Tag do erro	string
description	Descrição do erro	string