Ver una gift card

GET/giftcards/{id}Probar

URL base

API key x-api-keyRecordar la clave en este navegador (localStorage, no sale de aquí)

Parámetros de ruta

idstringobligatorio

Parámetros de consulta

includeLink1 | true

Enviar peticiónCopiar como curl

La llamada la hace tu navegador, contra el servidor que elijas arriba. Si la documentación no está servida desde el mismo origen que la API, el navegador puede bloquear la respuesta por CORS: en ese caso abre estas páginas desde la propia API (/docs) o usa el curl de arriba.

GET

/giftcards/{id}

curl --request GET \
  --url 'http://localhost:3000/v1/giftcards/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0?includeLink=1' \
  --header 'x-api-key: <x-api-key>'

• Pruebas (sandbox)
• Producción

Scope giftcards:read. Sin includeLink, url viene en null. Con includeLink=1 trae el enlace con la clave de gasto: trátalo como dinero.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

id

required

string format: uuid

Query Parameters

includeLink

string

Allowed values: 1 true

Responses

200

La gift card

Media typeapplication/json

object

giftcard

object

id

string format: uuid

externalId

string

mode

string

Allowed values: test live

brandId

string

amount

object

asset

string

Allowed values: USD

amount

Centavos de USD

string

fee

object

asset

string

Allowed values: USD

amount

Centavos de USD

string

balance

Lo que queda por gastar

object

asset

string

Allowed values: USD

amount

Centavos de USD

string

status

pendiente → activa → usada (saldo en cero) o expirada. fallida es una emisión que no salió: su dinero ya volvió a tu saldo.

string

Allowed values: pendiente activa usada expirada fallida

opened

Si quien la recibió ya abrió el regalo

boolean

expiresAt

string format: date-time

nullable

createdAt

string format: date-time

error

Sólo si está fallida

object

code

string

message

string

url

Sólo con includeLink

string

nullable

Example

{
  "giftcard": {
    "externalId": "cacao-order-88213",
    "mode": "test",
    "brandId": "farmatodo",
    "amount": {
      "asset": "USD",
      "amount": "2000"
    },
    "fee": {
      "asset": "USD",
      "amount": "2000"
    },
    "balance": {
      "asset": "USD",
      "amount": "2000"
    },
    "status": "pendiente",
    "error": {
      "code": "giftcards_unavailable"
    }
  }
}

404

giftcard_not_found

Media typeapplication/json

object

error

object

meta

Contexto estructurado del error cuando lo hay: qué límite se superó y de cuánto, qué campo es inválido, cuánto saldo había. No aparece en errores internos.

object

key

additional properties

any

type

string

Allowed values: invalid_request_error authentication_error rate_limit_error upstream_error api_error

code

Código ESTABLE. Programa contra esto.

string

message

string

request_id

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "insufficient_balance",
    "request_id": "req_8a0312ba896772bc441134cd"
  }
}

503

giftcards_unavailable (sólo con includeLink)

Media typeapplication/json

object

error

object

meta

Contexto estructurado del error cuando lo hay: qué límite se superó y de cuánto, qué campo es inválido, cuánto saldo había. No aparece en errores internos.

object

key

additional properties

any

type

string

Allowed values: invalid_request_error authentication_error rate_limit_error upstream_error api_error

code

Código ESTABLE. Programa contra esto.

string

message

string

request_id

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "insufficient_balance",
    "request_id": "req_8a0312ba896772bc441134cd"
  }
}