Skip to main content
GET
/
transaction
/
{financialTransactionId}
Buscar transação
curl --request GET \
  --url https://api.bestfy.io/transaction/{financialTransactionId} \
  --header 'x-api-key: <api-key>'
{
  "transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "AUTHORIZED",
  "product": "<string>",
  "productType": "<string>",
  "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "value": 123,
  "customer": "<string>",
  "customerEmail": "jsmith@example.com",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customerPhone": "<string>",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "paymentMetadata": {
    "paymentMetadataId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "value": 123,
    "method": "CREDIT_CARD",
    "installments": 6,
    "cardBrand": "VISA",
    "cardLastDigits": "<string>"
  },
  "paymentConfirmedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "refundedAt": "2023-11-07T05:31:56Z",
  "deliveryStatus": "PENDING",
  "acquirer": "IUGU",
  "pixEndToEndId": "<string>"
}
Use este endpoint para localizar uma transação específica usando transactionId ou pixEndToEndId. Caso ambos sejam enviados, a busca prioriza o ID da transação.

​
Estratégia de busca

  • Informe o transactionId único da transação. Lembre-se: você precisa ter permissão de acesso à empresa vinculada a este registro.

​
Exemplo de requisição

curl --request GET 'https://api.bestfy.io/transaction/{financialTransactionId}' \
  --header 'x-api-key: <SUA_CHAVE_AQUI>'

​
Erros comuns

CódigoMotivo
400Requisição sem transactionId e pixEndToEndId
404Transação não encontrada para os filtros enviados
500Erro interno

Authorizations

​
x-api-key
string
header
required

Key pública disponibilizada no dashboard Bestfy.

Path Parameters

​
financialTransactionId
string<uuid>
required

Identificador único da transação.

Response

Transação encontrada.

​
transactionId
string<uuid>
required
​
status
enum<string>
required
Available options:
AUTHORIZED,
CANCELED,
CHARGEBACK,
EXPIRED,
UNDER_REVIEW,
IN_DISPUTE,
PAID,
PROCESSING,
REFUNDED,
REJECTED,
UNKNOWN,
PENDING,
PRE_CHARGEBACK,
MED
​
product
string
required
​
value
integer
required

Valor configurado da transação em centavos.

​
paymentMetadata
object
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
productType
string
​
productId
string<uuid>
​
customer
string
​
customerEmail
string<email>
​
customerId
string<uuid>
​
customerPhone
string
​
companyId
string<uuid>
​
paymentConfirmedAt
string<date-time>
​
refundedAt
string<date-time> | null
​
deliveryStatus
enum<string>
Available options:
PENDING,
IN_TRANSIT,
DELIVERED
​
acquirer
enum<string>
Available options:
IUGU
​
pixEndToEndId
string