RecorrênciaBuscar recorrência

Buscar recorrência

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

Autenticação: Bearer · chave de API

Use a rota v1/recurrency/:id para consultar os dados e o status de uma recorrência. A resposta é o mesmo objeto que os webhooks entregam.

Parâmetros de caminho

idstringobrigatório
Identificador da recorrência a consultar.

Esta rota não recebe corpo na requisição.

Respostas

200Recorrência encontrada, no mesmo formato dos webhooks.

403A loja não tem recorrência liberada.

messagestring
Mensagem descritiva do erro.

404Recorrência não encontrada nesta loja.

Algo errado nesta página? Fale com o time

Requisição

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())

Resposta

{
  "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."
}