Stripe

Stripe Forwarding API

The Vault and Forward API allows you to tokenize and store card details in Stripes PCI-compliant vault and forward that data to supported third-party processors or endpoints.

GitHub OpenAPI

Operations 3

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/forwarding/requests List forwarded card requests · Stripe List Forwarding Requests #
Ask an LLM
“How do I see the requests where I've forwarded card details to another endpoint?”
“Can I page through my forwarding request history?”
Tell an agent
List my forwarding requests.
Show the latest {limit} forwarding requests.
POST /v1/forwarding/requests Forward saved card details to a destination URL · Stripe Create Forwarding Request #
Ask an LLM
“How do I send a stored card's details to another endpoint without touching raw card data?”
“Which card fields can be inserted into a forwarded request?”
Tell an agent
Forward payment method {payment_method} to {url} replacing {replacements}.
Send request {request} to {url} with {replacements} filled from payment method {payment_method}.
GET /v1/forwarding/requests/{id} Get a forwarding request · Stripe Retrieve Forwarding Request #
Ask an LLM
“How do I see what came back from a forwarded card request?”
“Can I look up one forwarding request by its ID?”
Tell an agent
Show forwarding request {id}.
Get the destination response for forwarding request {id}.

Documentation

📖
Documentation
https://docs.stripe.com/payments/vault-and-forward
📖
APIReference
https://docs.stripe.com/api/forwarding/request

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/stripe/refs/heads/main/openapi/stripe-forwarding-api-openapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/stripe/refs/heads/main/overlays/stripe-forwarding-overlay.yaml

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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/stripe-forwarding-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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

stripe-forwarding-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Stripe Accounts Account Forwarding API
  description: This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts.
  contact:
    email: dev-platform@stripe.com
    name: Stripe Dev Platform Team
    url: https://stripe.com
  termsOfService: https://stripe.com/us/terms/
  version: '2023-10-16'
  x-stripeSpecFilename: spec3
servers:
- url: https://api.stripe.com/
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: Forwarding
paths:
  /v1/forwarding/requests:
    get:
      summary: Stripe List Forwarding Requests
      description: Lists all ForwardingRequest objects.
      operationId: GetForwardingRequests
      parameters:
      - name: ending_before
        in: query
        required: false
        schema:
          type: string
          maxLength: 5000
      - name: limit
        in: query
        required: false
        schema:
          type: integer
      - name: starting_after
        in: query
        required: false
        schema:
          type: string
          maxLength: 5000
      - name: expand
        in: query
        required: false
        explode: true
        schema:
          type: array
          items:
            type: string
            maxLength: 5000
        style: deepObject
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    enum:
                    - list
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/forwarding.request'
                  has_more:
                    type: boolean
                  url:
                    type: string
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      tags:
      - Forwarding
    post:
      summary: Stripe Create Forwarding Request
      description: Creates a ForwardingRequest object.
      operationId: PostForwardingRequests
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - payment_method
              - url
              - replacements
              properties:
                payment_method:
                  type: string
                  description: The PaymentMethod to insert into the forwarded request.
                  maxLength: 5000
                url:
                  type: string
                  description: The destination URL for the forwarded request.
                replacements:
                  type: array
                  items:
                    type: string
                    enum:
                    - card_cvc
                    - card_expiry
                    - card_number
                    - cardholder_name
                request:
                  type: object
                  properties:
                    body:
                      type: string
                    headers:
                      type: array
                      items:
                        type: object
                        properties:
                          name:
                            type: string
                          value:
                            type: string
                metadata:
                  type: object
                  additionalProperties:
                    type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/forwarding.request'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      tags:
      - Forwarding
  /v1/forwarding/requests/{id}:
    get:
      summary: Stripe Retrieve Forwarding Request
      description: Retrieves a ForwardingRequest object.
      operationId: GetForwardingRequestsId
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          maxLength: 5000
      - name: expand
        in: query
        required: false
        explode: true
        schema:
          type: array
          items:
            type: string
            maxLength: 5000
        style: deepObject
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/forwarding.request'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      tags:
      - Forwarding
components:
  schemas:
    forwarding.request:
      type: object
      properties:
        id:
          type: string
          maxLength: 5000
        object:
          type: string
          enum:
          - forwarding.request
        created:
          type: integer
        livemode:
          type: boolean
        metadata:
          type:
          - object
          - 'null'
          additionalProperties:
            type: string
        payment_method:
          type: string
        replacements:
          type: array
          items:
            type: string
        request_context:
          type:
          - object
          - 'null'
        request_details:
          type:
          - object
          - 'null'
        response_details:
          type:
          - object
          - 'null'
        url:
          type:
          - string
          - 'null'
      required:
      - id
      - object
      - created
      - livemode
      - payment_method
      - replacements
    error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
            message:
              type: string
            code:
              type: string
            param:
              type: string