Skip to main content
GET
/
user
/
payments
/
{id}
Buscar pagamento por ID
curl --request GET \
  --url https://dev.plugtopay.com/api/v1/user/payments/{id} \
  --header 'Authorization: Bearer <token>'
{
  "status": "approved",
  "transaction_id": "019ddb56-fbe3-72e1-9f3c-8d0b2faf8f73",
  "amount": 15000,
  "message": "Payment approved",
  "attempts": 2,
  "payment_method": "card",
  "vault_token": "tok_a1b2c3d4e5f6",
  "request_time": "2.10s",
  "created_at": "2026-04-30T01:23:45+00:00",
  "updated_at": "2026-04-30T01:23:47+00:00",
  "transactions": [
    {
      "attempt": 1,
      "gateway": "safe2pay",
      "status": "failed",
      "holder_name": "JOAO SILVA",
      "brand": "visa",
      "last_4_digits": "1111",
      "installments": 1,
      "response_code": "51",
      "gateway_message": "Saldo insuficiente",
      "soft_descriptor": null,
      "request_time": "0.88s"
    },
    {
      "attempt": 2,
      "gateway": "pagarme",
      "status": "approved",
      "holder_name": "JOAO SILVA",
      "brand": "visa",
      "last_4_digits": "1111",
      "installments": 1,
      "response_code": "00",
      "gateway_message": "Transação aprovada",
      "soft_descriptor": null,
      "request_time": "1.22s"
    }
  ],
  "card": {
    "brand": "visa",
    "last_4_digits": "1111",
    "authorization_nsu": "123456",
    "authorization_code": "654321",
    "soft_descriptor": null,
    "response_code": "00",
    "gateway_message": "Transação aprovada"
  },
  "webhooks": []
}

Authorizations

Authorization
string
header
required

JWT emitido pelo fluxo de login. Usado nas rotas do painel administrativo.

Path Parameters

id
string<uuid>
required

ID (UUID) da transação.

Example:

"019ddb56-fbe3-72e1-9f3c-8d0b2faf8f73"

Response

Detalhe do pagamento.

Recurso de pagamento. O status raiz reflete o resultado final após todas as tentativas. Cada tentativa de fallback fica registrada em transactions[].

status
enum<string>
required

Estado do pagamento na resposta HTTP. processing é transitório, retornado apenas no 202 enquanto a resolução assíncrona está em andamento.

Available options:
pending,
approved,
failed,
refunded,
processing
Example:

"approved"

transaction_id
string<uuid> | null
required
Example:

"019ddb56-fbe3-72e1-9f3c-8d0b2faf8f73"

amount
integer | null
required

Valor, em centavos.

Example:

15000

message
string
required
Example:

"Payment approved"

attempts
integer
required
Example:

1

payment_method
enum<string> | null
required

Método de pagamento.

Available options:
pix,
card,
billet
Example:

"card"

transactions
object[]
required
webhooks
object[]
required

Tentativas de entrega de webhook associadas à transação.

vault_token
string | null

Token do cartão vaultado, quando save_card: true.

Example:

"tok_a1b2c3d4e5f6"

request_time
string | null
Example:

"1.23s"

created_at
string<date-time> | null
Example:

"2026-04-30T01:23:45+00:00"

updated_at
string<date-time> | null
Example:

"2026-04-30T01:23:46+00:00"

card
object

Resumo do cartão na resposta de pagamento.

pix
object

Dados do QR PIX. Contém tudo que é necessário para renderizar o QR ao cliente.