Obtener una tarjeta de regalo

GET

https://app.recurrente.com/api/gift_cards/:id

GET

/api/gift_cards/:id

curl https://app.recurrente.com/api/gift_cards/id \
     -H "X-SECRET-KEY: <apiKey>" \
     -H "Content-Type: application/json"

200Retrieved

{
  "id": "gc_9f8e7d6c",
  "account_id": "ac_987654321",
  "code": "GC-7HJK-9LMN",
  "status": "active",
  "currency": "GTQ",
  "initial_amount_in_cents": 50000,
  "balance_in_cents": 32000,
  "expires_on": "2025-12-31",
  "recipient": {
    "name": "Ana María López",
    "email": "ana.lopez@example.com",
    "phone": "+502 5555 1234"
  },
  "message": "Feliz cumpleaños, disfruta tu regalo!",
  "deliver_on": "2024-06-01",
  "delivered_at": "2024-06-01T10:15:00Z",
  "purchaser": {
    "name": "Carlos Méndez",
    "email": "carlos.mendez@example.com"
  },
  "checkout_id": "chk_4a5b6c7d",
  "public_url": "https://recurrente.com/gift_cards/gc_9f8e7d6c",
  "transactions": [
    {
      "id": "gct_1234abcd",
      "kind": "issue",
      "amount_in_cents": 50000,
      "balance_after_in_cents": 50000,
      "currency": "GTQ",
      "account_id": "ac_987654321",
      "checkout_id": "chk_4a5b6c7d",
      "note": "Tarjeta emitida tras pago exitoso",
      "created_at": "2024-05-15T14:00:00Z"
    },
    {
      "id": "gct_5678efgh",
      "kind": "redeem",
      "amount_in_cents": -18000,
      "balance_after_in_cents": 32000,
      "currency": "GTQ",
      "account_id": "ac_987654321",
      "checkout_id": null,
      "note": "Canje en tienda física",
      "created_at": "2024-05-20T16:45:00Z"
    }
  ],
  "created_at": "2024-05-15T14:00:00Z"
}

La tarjeta con su saldo y todos sus movimientos.

Authentication

X-SECRET-KEYstring

Tu clave secreta de API.

Una llave de cuenta (sk_live_..., sk_test_...) opera sobre su propia cuenta y, con X-ACCOUNT-ID, sobre sus cuentas conectadas.

La llave también fija el ambiente: una sk_test_ solo lista y resuelve objetos de prueba (live_mode: false) y una sk_live_ solo objetos reales. Un ID del otro ambiente responde 404 (401 en /customers).

Una llave de organización (sk_org_live_..., sk_org_test_...) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con X-ACCOUNT-ID; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde 403 con code: organization_key_unsupported.

Path parameters

idstringRequired

Response

La tarjeta

idstringOptional

account_idstringOptional

La cuenta que la vendió.

codestringOptional

El código que se canjea. Es un secreto al portador.

statusenumOptional

Allowed values:

currencystringOptional

initial_amount_in_centsintegerOptional

balance_in_centsintegerOptional

expires_ondate or nullOptional

recipientobjectOptional

messagestring or nullOptional

deliver_ondate or nullOptional

delivered_atdatetime or nullOptional

purchaserobjectOptional

checkout_idstring or nullOptional

El checkout que la vendió.

public_urlstringOptional

La página de saldo de la tarjeta, la que abre su QR.

transactionslist of objectsOptional

Sus movimientos, del más viejo al más nuevo.

created_atdatetimeOptional