Super Payments Payment Methods API
The Payment Methods API from Super Payments — 4 operation(s) for payment methods.
Work with this as data
Every API 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 apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.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 API
curl "https://apis.io/api/v1/apis/super-payments-payment-methods-api"
All apis
curl "https://apis.io/api/v1/apis?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.
OpenAPI Specification
openapi: 3.2.0
info:
title: Super Payments Payment Methods API
description: Super Payments is empowering businesses with free payments, allowing them to offer customers a % Cash Reward, which is automatically deducted from their next purchase when they pay with Super.
version: '2026-04-01'
contact:
url: https://docs.superpayments.com
license:
name: Super Payments
identifier: https://www.superpayments.com/terms-and-conditions
servers:
- url: https://api.superpayments.com/2026-04-01
description: Live Environment
- url: https://api.test.superpayments.com/2026-04-01
description: Sandbox Environment
tags:
- name: Payment Methods
paths:
/payment-methods:
post:
operationId: create-payment-method
summary: Create Payment Method
description: This endpoint creates a new payment method that will be associated with a particular customer. This payment method, once set up, can be used to create off-session payments against a given customer.
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePaymentMethodRequestDto'
responses:
'201':
description: The newly created payment method
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentMethodResponseDto'
security:
- api_key: []
tags:
- Payment Methods
get:
operationId: list-payment-methods
summary: List Payment Methods
description: This endpoint lists your previously created payment methods in a paged list. Additional filters and sorting criteria may be provided as query parameters.
parameters:
- name: brandId
in: query
required: false
schema:
type:
- string
- 'null'
format: uuid
- name: customerId
in: query
required: false
schema:
type:
- string
- 'null'
- name: type
in: query
required: false
schema:
type:
- string
- 'null'
const: CARD
x-enumNames:
- CARD
- name: usage
in: query
required: false
schema:
type:
- string
- 'null'
const: OFF_SESSION
x-enumNames:
- OFF_SESSION
- name: status
in: query
required: false
schema:
type:
- string
- 'null'
enum:
- DISABLED
- ENABLED
- REQUIRES_ACTION
x-enumNames:
- DISABLED
- ENABLED
- REQUIRES_ACTION
- name: direction
in: query
required: false
schema:
type: string
default: DESC
enum:
- ASC
- DESC
- name: by
in: query
required: false
schema:
type: string
default: createdAt
enum:
- createdAt
- updatedAt
- name: pageNumber
in: query
required: false
schema:
type: number
default: 1
minimum: 1
- name: pageSize
in: query
required: false
schema:
type: number
default: 100
maximum: 1000
minimum: 1
responses:
'200':
description: Paginated list of payment methods
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedPaymentMethodListOutput'
security:
- api_key: []
tags:
- Payment Methods
/payment-methods/{id}/setup-intents:
post:
operationId: create-setup-intent
summary: Create Setup Intent
description: This endpoint creates a setup intent against a previously created payment method. The setup intent is used to orchestrate the process that allows a customer to set up their payment method (e.g. debit card) for future usage in off-session payments. It returns a session token that may be passed to the Web Component to begin the setup process.
parameters:
- name: id
in: path
required: true
schema:
$ref: '#/components/schemas/PaymentMethodIdParam'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SetupIntentSessionInputDto'
responses:
'201':
description: The newly created setup intent & next action options
content:
application/json:
schema:
$ref: '#/components/schemas/SetupIntentSessionOutputDto'
security:
- api_key: []
tags:
- Payment Methods
/payment-methods/{id}:
get:
operationId: get-payment-method
summary: Get Payment Method
description: This endpoint returns a previously created payment method, including its current status. It requires the Super payment method ID that was provided upon successful creation of the payment method.
parameters:
- name: id
in: path
required: true
schema:
$ref: '#/components/schemas/PaymentMethodIdParam'
responses:
'200':
description: Existing payment method
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentMethodResponseDto'
security:
- api_key: []
tags:
- Payment Methods
/payment-methods/setup-intents:
get:
operationId: list-setup-intents
summary: List Setup Intents
description: This endpoint lists all existing setup intents.
parameters: []
responses:
'200':
description: List all setup intent sessions
content:
application/json:
schema:
$ref: '#/components/schemas/SetupIntentSessionListOutputDto'
security:
- api_key: []
tags:
- Payment Methods
components:
schemas:
PaymentMethodResponseDto:
type: object
properties:
id: {}
customerId: {}
type:
type: string
const: CARD
x-enumNames:
- CARD
usage:
type: string
const: OFF_SESSION
x-enumNames:
- OFF_SESSION
status:
type: string
enum:
- DISABLED
- ENABLED
- REQUIRES_ACTION
x-enumNames:
- DISABLED
- ENABLED
- REQUIRES_ACTION
metadata:
type:
- object
- 'null'
additionalProperties:
type: string
pattern: ^[^\r\n\t\b\f\v]+$
maxLength: 200
createdAt: {}
updatedAt: {}
required:
- id
- customerId
- type
- usage
- status
- metadata
- createdAt
- updatedAt
PaginatedPaymentMethodListOutput:
type: object
properties:
pageInfo:
type: object
properties:
hasNextPage:
type: boolean
currentPage:
type: number
lastPage:
type: number
pageSize:
type: number
required:
- hasNextPage
- currentPage
- lastPage
- pageSize
totalCount:
type: number
items:
type: array
items:
type: object
properties:
id: {}
customerId: {}
type:
type: string
const: CARD
x-enumNames:
- CARD
usage:
type: string
const: OFF_SESSION
x-enumNames:
- OFF_SESSION
status:
type: string
enum:
- DISABLED
- ENABLED
- REQUIRES_ACTION
x-enumNames:
- DISABLED
- ENABLED
- REQUIRES_ACTION
metadata:
type:
- object
- 'null'
additionalProperties:
type: string
pattern: ^[^\r\n\t\b\f\v]+$
maxLength: 200
createdAt: {}
updatedAt: {}
required:
- id
- customerId
- type
- usage
- status
- metadata
- createdAt
- updatedAt
required:
- pageInfo
- totalCount
- items
PaymentMethodIdParam:
type: string
CreatePaymentMethodRequestDto:
type: object
properties:
customerId:
type: string
type:
type: string
const: CARD
x-enumNames:
- CARD
usage:
type: string
const: OFF_SESSION
x-enumNames:
- OFF_SESSION
metadata:
type:
- object
- 'null'
additionalProperties:
type: string
pattern: ^[^\r\n\t\b\f\v]+$
maxLength: 200
required:
- customerId
- type
- usage
SetupIntentSessionInputDto:
type: object
properties:
redirectUrl:
type: string
format: uri
SetupIntentSessionListOutputDto:
type: object
properties:
items:
type: array
items:
type: object
properties:
id:
type: string
status:
type: string
enum:
- FAILED
- PROCESSING
- SUCCESS
createdAt: {}
updatedAt: {}
paymentMethodId:
type: string
customerId:
type: string
brandId:
type: string
providerData:
type:
- object
- 'null'
properties:
provider:
type: string
const: STRIPE
providerPaymentMethodId:
type: string
required:
- provider
- providerPaymentMethodId
required:
- id
- status
- createdAt
- updatedAt
- paymentMethodId
- customerId
- brandId
required:
- items
SetupIntentSessionOutputDto:
type: object
properties:
id:
type: string
sessionToken:
type: string
redirectUrl:
type: string
format: uri
required:
- id
- sessionToken
securitySchemes:
api_key:
type: apiKey
in: header
name: Authorization
description: Merchant API key
HMAC:
type: apiKey
in: header
name: super-signature
description: Header used to validate the webhook request