Search Payment

API data

API Gateway
This API is used for payment gateway operations:

• Production: https://api.sopague.com.br/gateway
• Sandbox: https://api-hmg.sopague.com.br/gateway
• Architecture: Representational State Transfer (REST)

Introduction

Payment lookup lets you check the status and other details of a specific transaction. To perform the operation, send a GET request to the endpoint below.

Perform payment lookup

GET /v1/payments/{paymentId}

Via REST request.

Data dictionary - Parameters

PROPERTY	DESCRIPTION	TYPE	LOCATION	REQUIRED	SIZE
PaymentId	Identifier of the payment to search.	string	path	yes	42

🟢 200

Search completed successfully

  {
    "paymentId": "020037308007081506570001580648030000000000", 
    "statusDescription": "Cancelada", 
    "transactionDate": "2024-07-08T12:06:57.07", 
    "authorizationCode": "078704", 
    "value": 15000
  }

Data dictionary - Response

PROPERTY	DESCRIPTION	TYPE
PaymentId	Payment identifier.	string
StatusDescription	Transaction status description.	string
transactionDate	Transaction date.	string
AuthorizationCode	Transaction authorization code.	string
Value	Transaction amount.	integer

🔴 400

Request error

[ 
    { 
        "tag": "__general__", 
        "description": "Transação não localizada, verifique os dados informados."
    } 
] 

Data dictionary - Response

PROPERTY	DESCRIPTION	TYPE
tag	Error tag	string
description	Error description	string

🔴 500

Internal error

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

Data dictionary - Response

PROPERTY	DESCRIPTION	TYPE
tag	Error tag	string
description	Error description	string