Super Payments · Schema
LinkInputDto
CompanyPaymentsOpen BankingCash RewardsCheckoutFintechUnited KingdomPay by Bank
Properties
| Name | Type | Description |
|---|---|---|
| brandId | string | |
| externalReference | stringnull | |
| amountInMinorUnits | number | |
| purpose | string | |
| expiresAt | stringnull | |
| successUrl | stringnull | |
| failureUrl | stringnull | |
| cancelUrl | stringnull | |
| metadata | objectnull | |
| billingAddress | object | |
| shippingAddress | object | |
| lineItems | arraynull |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/super-payments/main/json-schema/super-payments-link-input-dto-schema.json",
"title": "LinkInputDto",
"x-generated": "2026-10-12",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/super-payments-payment-links-api-openapi.yml#/components/schemas/LinkInputDto",
"type": "object",
"properties": {
"brandId": {
"type": "string",
"format": "uuid"
},
"externalReference": {
"type": [
"string",
"null"
]
},
"amountInMinorUnits": {
"type": "number"
},
"purpose": {
"type": "string",
"default": "PURCHASE",
"enum": [
"MERCHANT_TOPUP",
"PURCHASE"
]
},
"expiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"successUrl": {
"type": [
"string",
"null"
],
"format": "uri"
},
"failureUrl": {
"type": [
"string",
"null"
],
"format": "uri"
},
"cancelUrl": {
"type": [
"string",
"null"
],
"format": "uri"
},
"metadata": {
"type": [
"object",
"null"
],
"additionalProperties": {
"type": "string",
"pattern": "^[^\\r\\n\\t\\b\\f\\v]+$",
"maxLength": 200
}
},
"billingAddress": {
"allOf": [
{
"$ref": "#/$defs/PaymentLinkAddressDto"
}
]
},
"shippingAddress": {
"allOf": [
{
"$ref": "#/$defs/PaymentLinkAddressDto"
}
]
},
"lineItems": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/PaymentLinkLineItemDto"
}
}
},
"required": [
"brandId",
"amountInMinorUnits"
],
"$defs": {
"PaymentLinkAddressDto": {
"type": "object",
"properties": {
"addressLine1": {
"type": [
"string",
"null"
]
},
"addressLine2": {
"type": [
"string",
"null"
]
},
"addressLine3": {
"type": [
"string",
"null"
]
},
"city": {
"type": [
"string",
"null"
]
},
"country": {
"type": [
"string",
"null"
]
},
"postCode": {
"type": [
"string",
"null"
]
},
"firstName": {
"type": [
"string",
"null"
]
},
"lastName": {
"type": [
"string",
"null"
]
},
"phone": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
}
}
},
"PaymentLinkLineItemDto": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "AIRLINE"
},
"data": {
"type": "object",
"properties": {
"flightNumber": {
"type": "string"
},
"flightDate": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "string",
"format": "date-time"
}
]
},
"travellers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
]
}
},
"totalPrice": {
"type": "number"
},
"currency": {
"type": "string",
"const": "GBP"
}
}
}
},
"required": [
"type",
"data"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "CAR_RENTAL"
},
"data": {
"type": "object",
"properties": {
"travellers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
]
}
},
"checkInDate": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "string",
"format": "date-time"
}
]
},
"checkOutDate": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "string",
"format": "date-time"
}
]
},
"totalPrice": {
"type": "number"
},
"currency": {
"type": "string",
"const": "GBP"
}
}
}
},
"required": [
"type",
"data"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "LODGING"
},
"data": {
"type": "object",
"properties": {
"travellers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
]
}
},
"checkInDate": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "string",
"format": "date-time"
}
]
},
"checkOutDate": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "string",
"format": "date-time"
}
]
},
"totalPrice": {
"type": "number"
},
"currency": {
"type": "string",
"const": "GBP"
}
}
}
},
"required": [
"type",
"data"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "PRODUCT"
},
"data": {
"type": "object",
"properties": {
"productDescription": {
"type": "string"
},
"sku": {
"type": "string"
},
"quantity": {
"type": "number"
},
"unitPrice": {
"type": "number"
},
"currency": {
"type": "string",
"const": "GBP"
},
"expectedDeliveryDate": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
}
}
}
},
"required": [
"type",
"data"
]
}
]
}
}
}Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/super-payments-link-input-dto"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.