Pular para o conteúdo principal
GET
/
v1
/
payments
/
{id}
Obter detalhes do pagamento
curl --request GET \
  --url https://api.paybridge.dev/v1/payments/{id} \
  --header 'X-API-Key: <api-key>'
{
  "id": "<string>",
  "amount": 123,
  "currency": "<string>",
  "status": "<string>",
  "provider": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "externalId": "<string>",
  "pixCopyPaste": "<string>",
  "pixQrCodeBase64": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "confirmedAt": "2023-11-07T05:31:56Z",
  "payerName": "<string>",
  "payerDocument": "<string>",
  "payerEmail": "<string>",
  "isTest": true,
  "metadata": {
    "orderId": "123",
    "source": "mobile"
  }
}

Autorizações

X-API-Key
string
header
obrigatório

API Key para autenticação (pk_live_* ou pk_test_*)

Parâmetros de caminho

id
string
obrigatório

ID do pagamento (UUID)

Exemplo:

"550e8400-e29b-41d4-a716-446655440000"

Resposta

Detalhes do pagamento recuperados com sucesso

id
string
obrigatório

ID único do pagamento

amount
number
obrigatório

Valor do pagamento

currency
string
obrigatório

Moeda (BRL)

status
string
obrigatório

Status do pagamento

provider
string
obrigatório

Provedor de pagamento

createdAt
string<date-time>
obrigatório

Data de criação

description
string

Descrição do pagamento

externalId
string

ID de referência externa

pixCopyPaste
string

Código PIX copia e cola

pixQrCodeBase64
string

QR Code em Base64

expiresAt
string<date-time>

Data de expiração

confirmedAt
string<date-time>

Data de confirmação do pagamento

payerName
string

Nome do pagador

payerDocument
string

Documento do pagador

payerEmail
string

E-mail do pagador

isTest
boolean

Se é um pagamento de teste/sandbox

metadata
object

Metadados customizados

Exemplo:
{ "orderId": "123", "source": "mobile" }