RecurrenceFind recurrence

Find recurrence

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

Authentication: Bearer · API key

Use the v1/recurrency/:id route to look up a recurrence's data and status. The response is the same object the webhooks deliver.

Path parameters

idstringrequired
Identifier of the recurrence to look up.

This route takes no request body.

Responses

200Recurrence found, in the same format as the webhooks.

403The store does not have recurrence enabled.

messagestring
Error description message.

404Recurrence not found in this store.

Something wrong on this page? Talk to us

Request

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

const response = await fetch("https://api.securitypag.com/v1/recurrency/recr_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/recurrency/recr_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/recurrency/recr_01HXYZ123ABC456DEF789",
    headers={
        "Authorization": "Bearer " + os.environ["SUA_CHAVE_DE_API"],
        "Content-Type": "application/json",
    },
)

print(response.json())

Response

{
  "id": "recr_01HXYZ123ABC456DEF789",
  "amount": 9900,
  "currency": "BRL",
  "method": "PIXAUTOMATIC",
  "status": "ACTIVE",
  "description": "Assinatura mensal",
  "options": {
    "frequency": "MONTHLY",
    "freqInterval": 1,
    "maxPeriods": null
  },
  "customer": {
    "name": "John Doe",
    "taxId": "12345678900",
    "email": "john.doe@example.com",
    "phone": "11999990000"
  },
  "pix": {
    "emv": "00020101021226850014br.gov.bcb.pix2563api.gateway.test/pix/123e4567-e89b-12d3-a456-4266141740005204000053039865802BR6304ABCD",
    "retryPolicy": "THREE_RETRIES_7_DAYS"
  },
  "card": null,
  "invoice": null,
  "orderId": null,
  "externalRef": "order_123456",
  "notificationUrl": "https://example.com/webhook/recurrency",
  "metadata": null,
  "createdAt": "2026-01-05T10:12:33.120Z",
  "updatedAt": "2026-04-05T03:12:44.201Z",
  "cancelledAt": null
}

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

{
  "message": "Not found."
}