Tiendas en las que puedes emitir

GET/giftcards/catalogoProbar

ServidorURL base

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

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/catalogo

const url = 'http://localhost:3000/v1/giftcards/catalogo';
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/catalogo \
  --header 'x-api-key: <x-api-key>'

Scope giftcards:read. Las tiendas de tu programa con el valor mínimo y máximo de cada una, en centavos de USD, y tu margen (fee). Con una key sk_test_ es el catálogo de pruebas.

Authorizations

ApiKeyAuth

Responses

200

El catálogo

application/json

object

mode

string

Allowed values: test live

brands

Array<object>

object

string

name

string

tagline

string

nullable

logoUrl

Logo de la tienda

string

nullable

color

string

nullable

minAmount

Centavos de USD

integer

maxAmount

Centavos de USD

integer

asset

string

Allowed values: USD

fee

Tu margen, aparte del valor: bps en centésimas de 1 % (300 = 3 %, un ejemplo: depende de tu acuerdo comercial y de tu volumen) y fixed en centavos de USD

object

bps

integer

fixed

string

Example

{
  "mode": "test",
  "brands": [
    {
      "id": "farmatodo",
      "name": "Farmatodo",
      "color": "#0066B3",
      "minAmount": 100,
      "maxAmount": 50000
    }
  ],
  "asset": "USD",
  "fee": {
    "bps": 300,
    "fixed": "0"
  }
}

403

giftcards_program_suspended: tu programa está suspendido

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

503

giftcards_unavailable: problema nuestro, reintenta en unos minutos

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