> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.recurrente.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.recurrente.com/_mcp/server. # Listar tarjetas de regalo GET https://app.recurrente.com/api/gift_cards Las tarjetas que la cuenta puede tomar (las suyas y las de su organización), de la más nueva a la más vieja, cada una con su saldo y sus movimientos. `q` busca por código (en cualquier forma: "gc 2bcd-fg3h" o "2BCDFG3H") o, desde 3 caracteres, por nombre o correo de quien la recibió. Reference: https://docs.recurrente.com/referencia-api/api-reference/gift-cards/list-gift-cards ## Authentication - `X-SECRET-KEY` header (required) — 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`. ## Request ### Query parameters - `status` (enum, optional) - Allowed values: `active`, `depleted`, `expired`, `voided` - `q` (string, optional) — Código, o parte del nombre o correo de quien la recibió. - `page` (integer, optional, default: 1) ## Response ### 200 Las tarjetas - `list of GiftCard` ## Errors ### 403 Forbidden Error La cuenta es personal, sin tarjetas de regalo (`gift_cards_not_enabled`) - `message` (string, optional) — Mensaje de error - `code` (string, optional) — Código estable legible por máquinas, cuando aplica - `refund_id` (string, optional) — ID del reembolso relacionado cuando aplica - `endpoint` (string, optional) — Acción de API rechazada, cuando aplica - `errors` (ErrorErrors, optional) — Detalles de errores por campo ## Types ### GiftCard Una tarjeta de regalo digital con su saldo y sus movimientos. - `id` (string, optional) - `account_id` (string, optional) — La cuenta que la vendió. - `code` (string, optional) — El código que se canjea. Es un secreto al portador. - `status` (enum, optional) - Allowed values: `active`, `depleted`, `expired`, `voided` - `currency` (string, optional) - `initial_amount_in_cents` (integer, optional) - `balance_in_cents` (integer, optional) - `expires_on` (date, optional, nullable) - `recipient` (GiftCardRecipient, optional) - `message` (string, optional, nullable) - `deliver_on` (date, optional, nullable) - `delivered_at` (datetime, optional, nullable) - `purchaser` (GiftCardPurchaser, optional) - `checkout_id` (string, optional, nullable) — El checkout que la vendió. - `public_url` (string, optional) — La página de saldo de la tarjeta, la que abre su QR. - `transactions` (list of GiftCardTransaction, optional) — Sus movimientos, del más viejo al más nuevo. - `created_at` (datetime, optional) ### ErrorErrors Detalles de errores por campo ### GiftCardRecipient - `name` (string, optional, nullable) - `email` (string, optional, nullable) - `phone` (string, optional, nullable) ### GiftCardPurchaser - `name` (string, optional, nullable) - `email` (string, optional, nullable) ### GiftCardTransaction Un movimiento del saldo de una tarjeta. `amount_in_cents` lleva signo (un canje es negativo). - `id` (string, optional) - `kind` (enum, optional) - Allowed values: `issue`, `redeem`, `release`, `reload`, `refund_back`, `adjust`, `expire`, `void`, `refund_void` - `amount_in_cents` (integer, optional) - `balance_after_in_cents` (integer, optional) - `currency` (string, optional) - `account_id` (string, optional) — La cuenta (sucursal) donde ocurrió. - `checkout_id` (string, optional, nullable) - `note` (string, optional, nullable) - `created_at` (datetime, optional) ## Examples **Request** ```json {} ``` **Response** ```json [ { "id": "gc_9f8e7d6c", "account_id": "ac_987654", "code": "GC-2BCD-FG3H", "status": "active", "currency": "GTQ", "initial_amount_in_cents": 25000, "balance_in_cents": 15000, "expires_on": "2024-12-31", "recipient": { "name": "María López", "email": "maria.lopez@example.com", "phone": "+502 5555 1234" }, "message": "Feliz cumpleaños, disfruta tu regalo!", "deliver_on": "2024-01-10", "delivered_at": "2024-01-10T14:45:00Z", "purchaser": { "name": "Carlos Méndez", "email": "carlos.mendez@empresa.com" }, "checkout_id": "chk_4567abcd", "public_url": "https://recurrente.com/gift_cards/gc_9f8e7d6c", "transactions": [ { "id": "gct_1a2b3c4d", "kind": "issue", "amount_in_cents": 25000, "balance_after_in_cents": 25000, "currency": "GTQ", "account_id": "ac_987654", "checkout_id": "chk_4567abcd", "note": "Emisión inicial de la tarjeta", "created_at": "2024-01-10T14:45:00Z" }, { "id": "gct_5e6f7g8h", "kind": "redeem", "amount_in_cents": -10000, "balance_after_in_cents": 15000, "currency": "GTQ", "account_id": "ac_987654", "checkout_id": "chk_7890efgh", "note": "Canje en tienda física", "created_at": "2024-02-05T11:20:00Z" } ], "created_at": "2024-01-10T14:45:00Z" } ] ``` **SDK Code** ```python import requests url = "https://app.recurrente.com/api/gift_cards" payload = {} headers = { "X-SECRET-KEY": "", "Content-Type": "application/json" } response = requests.get(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://app.recurrente.com/api/gift_cards'; const options = { method: 'GET', headers: {'X-SECRET-KEY': '', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://app.recurrente.com/api/gift_cards" payload := strings.NewReader("{}") req, _ := http.NewRequest("GET", url, payload) req.Header.Add("X-SECRET-KEY", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://app.recurrente.com/api/gift_cards") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["X-SECRET-KEY"] = '' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://app.recurrente.com/api/gift_cards") .header("X-SECRET-KEY", "") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('GET', 'https://app.recurrente.com/api/gift_cards', [ 'body' => '{}', 'headers' => [ 'Content-Type' => 'application/json', 'X-SECRET-KEY' => '', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://app.recurrente.com/api/gift_cards"); var request = new RestRequest(Method.GET); request.AddHeader("X-SECRET-KEY", ""); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "X-SECRET-KEY": "", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://app.recurrente.com/api/gift_cards")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```