PaymentsFind Payment

Find Payment

GET/v1/payment/:idhttps://api.securitypag.com

Authentication: Bearer · API key

Use the route v1/payment/:id to retrieve the complete details of a specific payment using its unique identifier.

Path parameters

idstringrequired
Unique identifier of the payment to be queried.

This route takes no request body.

Responses

200Payment object successfully returned when querying a payment by its identifier.

404Payment not found.

messagestring
Descriptive error message.

400Request error.

Something wrong on this page? Talk to us

Request

curl --request GET \
  --url https://api.securitypag.com/v1/payment/pay_01HXYZ123ABC456DEF789 \
  --header 'Authorization: Bearer SUA_CHAVE_DE_API' \
  --header 'Content-Type: application/json'

const response = await fetch("https://api.securitypag.com/v1/payment/pay_01HXYZ123ABC456DEF789", {
  method: "GET",
  headers: {
    Authorization: "Bearer " + process.env.SUA_CHAVE_DE_API,
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

<?php
$ch = curl_init("https://api.securitypag.com/v1/payment/pay_01HXYZ123ABC456DEF789");
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer " . getenv("SUA_CHAVE_DE_API"),
    "Content-Type: application/json",
  ],
]);

$data = json_decode(curl_exec($ch), true);
print_r($data);

import os
import requests

response = requests.request(
    "GET",
    "https://api.securitypag.com/v1/payment/pay_01HXYZ123ABC456DEF789",
    headers={
        "Authorization": "Bearer " + os.environ["SUA_CHAVE_DE_API"],
        "Content-Type": "application/json",
    },
)

print(response.json())

Response

{
  "id": "z8k3f1x9a2m4q7w6t5r0",
  "currency": "BRL",
  "status": "PAID",
  "amount": 15990,
  "installments": 1,
  "method": "PIX",
  "orderId": "ord_7h3d92ksl1p0x",
  "description": "Compra de produto digital",
  "payer": {
    "name": "Maria Silva Santos",
    "email": "maria.silva@email.com",
    "phone": "11988887777",
    "taxId": "32165498700"
  },
  "metadata": {
    "customerId": "cus_00192",
    "source": "checkout_v2"
  },
  "utms": {
    "utmSource": "google",
    "utmMedium": "cpc",
    "utmCampaign": "black-friday-2026",
    "utmContent": "banner-topo",
    "utmTerm": "tenis-de-corrida",
    "src": "blog-artigo-1",
    "sck": "lista-quente"
  },
  "feeAmount": 799,
  "feeFixed": 299,
  "feePercent": 3,
  "chkFeeAmount": 0,
  "config": null,
  "data": {
    "id": "pix_txn_4k2m9z1a0",
    "method": "PIX",
    "message": null,
    "e2e": "E1823610928374650918273645091827",
    "copypaste": "00020101021226850014br.gov.bcb.pix2563api.gateway.test/pix/8a7b6c5d-1234-5678-9abc-abcdef1234565204000053039865802BR5921GATEWAY DEMO6009SaoPaulo62070503***6304A1B2",
    "barcode": null,
    "digitableLine": null,
    "createdAt": "2026-02-10T14:21:33.102Z",
    "updatedAt": "2026-02-10T14:21:40.551Z"
  },
  "splits": [
    {
      "amount": 15191,
      "currency": "BRL",
      "percent": 9500,
      "storeId": "store_main_001",
      "splitId": "split_a1b2c3"
    },
    {
      "amount": 799,
      "currency": "BRL",
      "percent": 500,
      "storeId": "z8k334535a2m4q7w6t5r0",
      "splitId": "ksh39d993939jfkfh"
    }
  ],
  "items": [
    {
      "quantity": 1,
      "name": "Product",
      "price": 15990,
      "type": "DIGITAL"
    }
  ],
  "paidAt": "2026-02-10T14:21:40.551Z",
  "refundedAt": null,
  "createdAt": "2026-02-10T14:21:33.102Z",
  "updatedAt": "2026-02-10T14:21:40.551Z"
}

{
  "message": "The user does not have permission for this operation."
}

{
  "message": "Store not found."
}