Pin Payments · JSON-LD Context

Pin Payments Context

JSON-LD context defining the semantic vocabulary for Pin Payments from Pin Payments.

3 Classes 31 Properties 4 Namespaces
View Context View on GitHub

Namespaces

schema: https://schema.org/
xsd: http://www.w3.org/2001/XMLSchema#
dcterms: http://purl.org/dc/terms/
pin: https://pinpayments.com/schema#

Classes

CardCreate ChargeCreate CustomerCreate

Properties

Property Type Container
publishable_api_key string
number string
expiry_month string
expiry_year string
cvc string
name string
address_line1 string
address_line2 string
address_city string
address_postcode string
address_state string
address_country string
email string
description string
amount integer
ip_address string
currency string
capture boolean
reference string
card
card_token string
customer_token string
payment_source_token string
metadata
three_d_secure
platform_adjustment
first_name string
last_name string
phone_number string
company string
notes string

JSON-LD Document

Raw ↑
{
  "@context": {
    "@vocab": "https://pinpayments.com/schema#",
    "schema": "https://schema.org/",
    "xsd": "http://www.w3.org/2001/XMLSchema#",
    "dcterms": "http://purl.org/dc/terms/",
    "pin": "https://pinpayments.com/schema#",
    "CardCreate": "pin:CardCreate",
    "publishable_api_key": {
      "@id": "pin:publishable_api_key",
      "@type": "xsd:string"
    },
    "number": {
      "@id": "pin:number",
      "@type": "xsd:string"
    },
    "expiry_month": {
      "@id": "pin:expiry_month",
      "@type": "xsd:string"
    },
    "expiry_year": {
      "@id": "pin:expiry_year",
      "@type": "xsd:string"
    },
    "cvc": {
      "@id": "pin:cvc",
      "@type": "xsd:string"
    },
    "name": {
      "@id": "pin:name",
      "@type": "xsd:string"
    },
    "address_line1": {
      "@id": "pin:address_line1",
      "@type": "xsd:string"
    },
    "address_line2": {
      "@id": "pin:address_line2",
      "@type": "xsd:string"
    },
    "address_city": {
      "@id": "pin:address_city",
      "@type": "xsd:string"
    },
    "address_postcode": {
      "@id": "pin:address_postcode",
      "@type": "xsd:string"
    },
    "address_state": {
      "@id": "pin:address_state",
      "@type": "xsd:string"
    },
    "address_country": {
      "@id": "pin:address_country",
      "@type": "xsd:string"
    },
    "ChargeCreate": "pin:ChargeCreate",
    "email": {
      "@id": "pin:email",
      "@type": "xsd:string"
    },
    "description": {
      "@id": "pin:description",
      "@type": "xsd:string"
    },
    "amount": {
      "@id": "pin:amount",
      "@type": "xsd:integer"
    },
    "ip_address": {
      "@id": "pin:ip_address",
      "@type": "xsd:string"
    },
    "currency": {
      "@id": "pin:currency",
      "@type": "xsd:string"
    },
    "capture": {
      "@id": "pin:capture",
      "@type": "xsd:boolean"
    },
    "reference": {
      "@id": "pin:reference",
      "@type": "xsd:string"
    },
    "card": {
      "@id": "pin:card"
    },
    "card_token": {
      "@id": "pin:card_token",
      "@type": "xsd:string"
    },
    "customer_token": {
      "@id": "pin:customer_token",
      "@type": "xsd:string"
    },
    "payment_source_token": {
      "@id": "pin:payment_source_token",
      "@type": "xsd:string"
    },
    "metadata": {
      "@id": "pin:metadata"
    },
    "three_d_secure": {
      "@id": "pin:three_d_secure"
    },
    "platform_adjustment": {
      "@id": "pin:platform_adjustment"
    },
    "CustomerCreate": "pin:CustomerCreate",
    "first_name": {
      "@id": "pin:first_name",
      "@type": "xsd:string"
    },
    "last_name": {
      "@id": "pin:last_name",
      "@type": "xsd:string"
    },
    "phone_number": {
      "@id": "pin:phone_number",
      "@type": "xsd:string"
    },
    "company": {
      "@id": "pin:company",
      "@type": "xsd:string"
    },
    "notes": {
      "@id": "pin:notes",
      "@type": "xsd:string"
    }
  },
  "@type": "schema:Dataset",
  "schema:name": "Pin Payments API JSON-LD context",
  "schema:description": "A JSON-LD @context for the objects Pin Payments's own API contract declares: one class per component schema, one property per declared field, typed from the contract. Derived by script (derive-json-ld.py, 2026-10-21) from openapi/pin-payments-cards-api-openapi.yml, openapi/pin-payments-charges-api-openapi.yml, openapi/pin-payments-customers-api-openapi.yml.",
  "dcterms:created": "2026-10-21",
  "dcterms:source": [
    "openapi/pin-payments-cards-api-openapi.yml",
    "openapi/pin-payments-charges-api-openapi.yml",
    "openapi/pin-payments-customers-api-openapi.yml",
    "openapi/pin-payments-refunds-api-openapi.yml"
  ]
}