Nevermined Payment Methods API
The Payment Methods API from Nevermined — 2 operation(s) for payment methods.
The Payment Methods API from Nevermined — 2 operation(s) for payment methods.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/nevermined-app:nevermined-app-payment-methods-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a 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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: NVM BACKEND Payment Methods API
description: ''
version: 1.103.0
contact: {}
servers:
- url: https://api.live.nevermined.app
tags:
- name: Payment Methods
paths:
/api/v1/payment-methods:
get:
description: Returns the saved payment methods for the authenticated user. Requires a Nevermined API key.
operationId: PaymentMethodsController_listPaymentMethods
parameters:
- name: accessible
required: false
in: query
description: When "true", return only payment methods accessible to the requesting API key (filters by allowedApiKeyIds and Active status).
schema:
enum:
- 'true'
- 'false'
type: string
example: 'true'
- name: provider
required: false
in: query
description: When set, return only payment methods backed by this provider. Omit to return methods from every provider (default).
schema:
enum:
- stripe
- braintree
- erc4337
- visa
- vgs
type: string
example: stripe
responses:
'200':
description: List of saved payment methods
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PaymentMethodSummaryDto'
'400':
description: Bad Request - Unknown provider value
'401':
description: Unauthorized - Invalid or missing API key
security:
- Authorization: []
summary: List saved payment methods
tags:
- Payment Methods
/api/v1/payment-methods/{paymentMethodId}:
patch:
description: 'Updates a saved payment method, changing its friendly alias and/or the set of NVM API keys allowed to use it. Requires a Nevermined API key. A card enrolled with Nevermined can be listed twice, once per rail it is enrolled on (card-on-file under its card id `CRD…`, Visa agentic under its agentic token id): an update of either applies to both, so the card is never usable by a key one of its rails excludes.'
operationId: PaymentMethodsController_updatePaymentMethod
parameters:
- name: paymentMethodId
required: true
in: path
description: Identifier of the payment method to update
schema:
example: pm_1Abc2Def3Ghi4Jkl
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatePaymentMethodDto'
responses:
'200':
description: 'The updated payment method. It carries no `cardId`, `rails` or `needsReactivation`: read those from GET /payment-methods.'
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentMethodSummaryDto'
'401':
description: Unauthorized - Invalid or missing API key
'404':
description: Not Found - Payment method does not exist
'503':
description: BCK.CARD_PAYMENT.0023 - The rails of the card could not be read or updated; retry the same update
security:
- Authorization: []
summary: Update a payment method
tags:
- Payment Methods
delete:
description: 'Revokes (detaches) a saved payment method so it can no longer be used for delegated payments. Requires a Nevermined API key. A card enrolled with Nevermined can be listed twice, once per rail it is enrolled on: as card-on-file (provider `vgs`, listed under its card id `CRD…`) and as Visa agentic (provider `visa`, listed under its agentic token id). Revoking the card id revokes the whole card: both rails and every delegation on either. Revoking the Visa agentic token id turns off Visa agentic payments only: its delegations are revoked and the card keeps paying as card-on-file. A Visa agentic card enrolled on no other rail is revoked whole.'
operationId: PaymentMethodsController_revokePaymentMethod
parameters:
- name: paymentMethodId
required: true
in: path
description: Identifier of the payment method to revoke
schema:
example: pm_1Abc2Def3Ghi4Jkl
type: string
- name: confirm
required: false
in: query
description: '`true` revokes a card that pays for a subscription, an organization tier or automatic credit top-ups. Without it such a card is refused with BCK.CARD_PAYMENT.0010, which lists what it pays for.'
schema:
type: string
responses:
'200':
description: Payment method revoked
content:
application/json:
schema:
example:
success: true
'401':
description: Unauthorized - Invalid or missing API key
'404':
description: Not Found - Payment method does not exist
'409':
description: BCK.CARD_PAYMENT.0010 - The card pays for something; send confirm=true
'503':
description: BCK.CARD_PAYMENT.0009 - What the card pays for could not be read; retry. BCK.CARD_PAYMENT.0022 - The rails of the card could not be read or revoked; retry
security:
- Authorization: []
summary: Revoke a payment method
tags:
- Payment Methods
components:
schemas:
PaymentMethodSummaryDto:
type: object
properties:
id:
type: string
example: pm_1Abc2Def3Ghi4Jkl
type:
type: string
example: card
last4:
type: string
example: '4242'
brand:
type: string
example: visa
expMonth:
type:
- object
- 'null'
example: 12
expYear:
type:
- object
- 'null'
example: 2027
alias:
type:
- object
- 'null'
example: My Card
provider:
type: string
example: stripe
enum:
- stripe
- braintree
- erc4337
- visa
- vgs
status:
type: string
example: Active
enum:
- Active
- Revoked
allowedApiKeyIds:
type:
- object
- 'null'
example:
- sk-abc123
- sk-def456
description: NVM API Key IDs allowed to use this card. Null = any key can use it.
needsReactivation:
type: boolean
description: 'Present and true on an entry of an enrolled card whose card-on-file network token is no longer active: its holder can reactivate it in the Nevermined App. Absent too when that read fails, so its absence does not prove the token active. `rails`, not this flag, tells whether the card can pay now and through which rail.'
cardId:
type: string
example: CRDs4FYUfwueGDryKrPDjd3JR
description: 'The card’s CRD… card id, on an entry of a card enrolled with Nevermined (provider vgs or visa) whose card is known, and on an entry flagged needsReactivation. A card enrolled for card-on-file and Visa agentic payments is listed once per rail (or more), each entry with the same cardId: group entries by `cardId`, falling back to `id`. Absent on other entries. When the cards cannot be read it is absent too (a vgs entry without cardId is the sign; a retry can fix it), except on an entry flagged needsReactivation, which keeps it without `rails`. POST /delegation/create takes it as `providerPaymentMethodId` for a provider its `rails` lists. Only GET /payment-methods sets it: the PATCH /payment-methods/{paymentMethodId} response carries neither it nor `rails`.'
rails:
type: array
example:
- vgs
- visa
description: 'Listed with cardId on an entry of a card enrolled with Nevermined: the delegation providers a new delegation naming the card by its cardId can pay through now — vgs (card on file; listed only while the card-on-file network token is active) and visa (Visa agentic). `rails`, not needsReactivation, tells whether the card can pay now. It describes the card, so the entry for a rail that was turned off still lists the card’s other rails. Empty when the card can pay through neither. Absent when the cards cannot be read, so on an entry with cardId a missing `rails` means unknown (retry) and `[]` means none. A vgs entry’s own `id` is the card’s CRD…, so naming it is the same request: refused BCK.DELEGATION.0005 while the card cannot pay card on file. A Revoked vgs or visa entry is refused. An Active visa entry’s own `id` (its agentic token) is accepted even when the entry carries no `rails` (its token is linked to no card, or the cards could not be read).'
items:
type: string
enum:
- vgs
- visa
orgId:
type:
- object
- 'null'
description: Organization this card belongs to (null = personal).
required:
- id
- type
- last4
- brand
- expMonth
- expYear
- alias
- provider
- status
UpdatePaymentMethodDto:
type: object
properties:
alias:
type: string
description: Optional friendly name for the card
example: My Production Card
allowedApiKeyIds:
description: Array of NVM API Key skId values allowed to use this card. Null or empty = any key can use it.
example:
- sk-abc123
- sk-def456
type:
- array
- 'null'
items:
type: string
orgId:
type:
- object
- 'null'
description: Move the card to an org (a valid orgId) or to personal (null). Omit to leave unchanged.
securitySchemes:
Authorization:
scheme: bearer
bearerFormat: JWT
type: http