Skip to navigation

Vender una tarjeta de regalo

Abre el checkout que vende una tarjeta, como “Vender” en el panel: cóbralo en mostrador o manda checkout_url al comprador. No mueve dinero por sí mismo; cuando el checkout se paga se emite la tarjeta, con su código, para recipient (o para quien pagó) y llega gift_card.issue. Con gift_card_id, el checkout recarga esa tarjeta en vez de emitir otra.

Requiere el interruptor de tarjetas de regalo de la cuenta (gift_cards_not_accepted). Usa un Idempotency-Key único por venta.

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.

Request

This endpoint expects an object.
amount_in_centsintegerRequired

El saldo de la tarjeta, en la moneda de la cuenta. Entre el cobro mínimo y el límite de precio de la cuenta.

recipient_namestringOptional
recipient_emailstringOptional
recipient_phonestringOptional
messagestringOptional<=300 characters
deliver_ondateOptional

El día en que llega a quien la recibe (9:00 en la zona del negocio). Por defecto, al pagarse.

gift_card_idstringOptional
Recarga esta tarjeta en vez de emitir otra.

Response

El checkout que la vende
checkout_idstringOptional
checkout_urlstringOptional
amount_in_centsintegerOptional
currencystringOptional
created_atdatetimeOptional

Errors

403
Forbidden Error
422
Unprocessable Entity Error