Listar tus gift cards

GET/giftcardsProbar

ServidorURL base

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

Parámetros de consultaexternalIdstringstatuslimitintegerbeforestring

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

const url = 'http://localhost:3000/v1/giftcards?status=pendiente&limit=50';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'http://localhost:3000/v1/giftcards?status=pendiente&limit=50' \
  --header 'x-api-key: <x-api-key>'

Scope giftcards:read. Las más recientes primero. Para paginar, pasa en before el createdAt de la última que recibiste. Nunca trae el url.

Authorizations

ApiKeyAuth

Parameters

Query Parameters

externalId

string

/^[A-Za-z0-9_.:-]{1,64}$/

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

limit

integer

default: 50 >= 1 <= 200

before

string format: date-time

Responses

200

Tus gift cards del modo de la key

application/json

object

data

Array<object>

object

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

Example

{
  "data": [
    {
      "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"
      }
    }
  ]
}

400

Error con código estable

application/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"
  }
}