List the partner's purchase codes

GET

/pcodes

const url = 'https://partner-pcode-dev.tsp.workers.dev/api/partner/v1/pcodes?status=sin_utilizar&page=1&limit=50';
const options = {method: 'GET', headers: {'x-gw': '<x-gw>'}};

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

curl --request GET \
  --url 'https://partner-pcode-dev.tsp.workers.dev/api/partner/v1/pcodes?status=sin_utilizar&page=1&limit=50' \
  --header 'x-gw: <x-gw>'

Authorizations

PartnerApiKey

Parameters

Query Parameters

status

string

Allowed values: sin_utilizar en_onboarding emitido bloqueado expirado

page

integer

default: 1

limit

integer

default: 50 <= 100

created_from

string

UTC date/time (YYYY-MM-DD or full timestamp).

created_to

string

UTC date/time. A bare date includes the whole day.

external_reference_id

string

batch_id

string

Responses

200

application/json

object

success

boolean

data

object

pcodes

Array<object>

object

pcode

string

partnerName

string

category

integer

status

Derived on every read, not a stored column. expirado: the 14-day window to start using it expired — unrelated to the validity of an already-issued certificate.

string

Allowed values: sin_utilizar en_onboarding emitido bloqueado expirado

processing

integer

batch_id

string

nullable

external_reference_id

string

nullable

expires_at

string format: date-time

nullable

created_at

string format: date-time

updated_at

string format: date-time

pagination

object

total

integer

page

integer

limit

integer

Example

{
  "success": true,
  "data": {
    "pcodes": [
      {
        "pcode": "MYPARTNER-26-FV01-A1B2C3D4",
        "category": 0,
        "status": "sin_utilizar"
      }
    ]
  }
}

401

Invalid API Key.