Silverflow Processor Tokens Events API

openapi: 3.2.0
info:
  title: Silverflow Processor Tokens Events API
  version: 1.417.0
  contact:
    name: API Support
    email: support@silverflow.com
  license:
    name: Commercial
  description: 'Operations tagged Processor Tokens Events across 2 of this provider''s published API definitions: silverflow-openapi.yml, silverflow-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://eu-west-1.api.silverflow.com/v1
  description: Production URL for Europe - Equivalent to https://api.silverflow.co/v1
- url: https://us-east-2.api.silverflow.com/v1
  description: Production URL for North America
- url: https://eu-west-1.api-sbx.silverflow.com/v1
  description: Sandbox URL - Equivalent to https://api-sbx.silverflow.co/v1
security:
- ApiKey: []
- BearerToken: []
tags:
- name: Processor Tokens Events
  description: ' '
paths: {}
webhooks:
  events.processorTokens.created:
    post:
      summary: Processor Token Created
      security: []
      operationId: processorTokenCreated
      tags:
      - Processor Tokens Events
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProcessorTokenEventNotification1_1Created'
            examples:
              created:
                $ref: '#/components/examples/created'
      responses:
        default:
          description: Event Notification sent when a Processor Token is created.
    servers:
    - url: https://eu-west-1.api.silverflow.com/v1
      description: Production URL for Europe - Equivalent to https://api.silverflow.co/v1
    - url: https://us-east-2.api.silverflow.com/v1
      description: Production URL for North America
    - url: https://eu-west-1.api-sbx.silverflow.com/v1
      description: Sandbox URL - Equivalent to https://api-sbx.silverflow.co/v1
  events.processorTokens.archived:
    post:
      summary: Processor Token Archived
      security: []
      operationId: processorTokenArchived
      tags:
      - Processor Tokens Events
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProcessorTokenEventNotification1_1Archived'
            examples:
              archived:
                $ref: '#/components/examples/archived'
      responses:
        default:
          description: Event Notification sent when a Processor Token is archived.
    servers:
    - url: https://eu-west-1.api.silverflow.com/v1
      description: Production URL for Europe - Equivalent to https://api.silverflow.co/v1
    - url: https://us-east-2.api.silverflow.com/v1
      description: Production URL for North America
    - url: https://eu-west-1.api-sbx.silverflow.com/v1
      description: Sandbox URL - Equivalent to https://api-sbx.silverflow.co/v1
  events.processorTokens.cvcDeleted:
    post:
      summary: Processor Token CVC Deleted
      security: []
      operationId: processorTokenCvcDeleted
      tags:
      - Processor Tokens Events
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProcessorTokenEventNotification1_1CvcDeleted'
            examples:
              cvcDeleted:
                $ref: '#/components/examples/cvc-deleted'
      responses:
        default:
          description: Event Notification sent when CVC data is deleted from a Processor Token.
    servers:
    - url: https://eu-west-1.api.silverflow.com/v1
      description: Production URL for Europe - Equivalent to https://api.silverflow.co/v1
    - url: https://us-east-2.api.silverflow.com/v1
      description: Production URL for North America
    - url: https://eu-west-1.api-sbx.silverflow.com/v1
      description: Sandbox URL - Equivalent to https://api-sbx.silverflow.co/v1
components:
  schemas:
    source:
      type: string
      description: Source system of the event.
      pattern: ^https://silverflow.com/[a-zA-Z]+$
    ProcessorTokenEventNotification1_1CvcDeleted:
      type: object
      allOf:
      - $ref: '#/components/schemas/PublicCloudEvent'
      required:
      - data
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/processorTokenEventType'
          - enum:
            - com.silverflow.processorTokens.cvcDeleted
          - example: com.silverflow.processorTokens.cvcDeleted
        data:
          $ref: '#/components/schemas/ProcessorTokenEventDataVersion1_1CvcDeleted'
        source:
          allOf:
          - $ref: '#/components/schemas/source'
          - enum:
            - https://silverflow.com/processorTokens
        specversion:
          allOf:
          - $ref: '#/components/schemas/openapi_components-schemas-version-3'
          - enum:
            - '1.0'
        subject:
          allOf:
          - description: The subject of the notification, which is the processor token key.
          - $ref: '#/components/schemas/openapi_components-schemas-processorTokenKey'
        dataschema:
          allOf:
          - $ref: '#/components/schemas/dataschema'
          - example: https://silverflow.com/schemas/events/processorTokens/1.1
          - enum:
            - https://silverflow.com/schemas/events/processorTokens/1.1
    time:
      type: string
      format: date-time
      description: Date and time when the event was sent.
    PublicCloudEvent:
      type: object
      required:
      - id
      - source
      - specversion
      - type
      - datacontenttype
      - dataschema
      - subject
      - time
      - agent
      - data
      properties:
        id:
          $ref: '#/components/schemas/eventId'
        specversion:
          allOf:
          - description: The version of the current spec.
          - enum:
            - '1.0'
          - $ref: '#/components/schemas/openapi_components-schemas-version-3'
        datacontenttype:
          $ref: '#/components/schemas/dataContentType'
        dataschema:
          $ref: '#/components/schemas/dataschema'
        time:
          $ref: '#/components/schemas/time'
        agent:
          $ref: '#/components/schemas/common_agentKey'
    processorTokenReference:
      type: string
      description: Optional reference assigned by the agent to the processor token.
      minLength: 5
      maxLength: 120
      example: VEQNS4L35E6IU1TN
    ProcessorTokenEventDataVersion1_1Archived:
      type: object
      description: The event data for processor token archived notifications.
      required:
      - key
      - status
      - created
      - version
      properties:
        key:
          $ref: '#/components/schemas/openapi_components-schemas-processorTokenKey'
        status:
          type: string
          description: The current status of a Processor Token.
          enum:
          - archived
          example: archived
        reference:
          $ref: '#/components/schemas/processorTokenReference'
        created:
          $ref: '#/components/schemas/openapi_components-schemas-created-4'
        lastModified:
          $ref: '#/components/schemas/openapi_components-schemas-lastModified-3'
        version:
          $ref: '#/components/schemas/common_version'
    common_agentKey:
      description: Uniquely identifies an Agent.
      type: string
      pattern: ^cgt-[a-zA-Z0-9]+$
      readOnly: true
      example: cgt-EFG67b4yPre23ZDrLX
      title: agentKey
    dataschema:
      type: string
      description: The event schema with the data version of the event.
    openapi_components-schemas-version-3:
      type: string
      description: The version of the spec.
      pattern: ^[1-9]+.[0-9]+$
      example: '1.0'
    openapi_components-schemas-processorTokenKey:
      description: Uniquely identifies a Processor Token.
      type: string
      pattern: ^ptk-[a-zA-Z0-9]+$
      minLength: 5
      maxLength: 120
      example: ptk-1e1dA2fgs1YTUhlhyPOp
    common_version:
      type: integer
      description: The version of this object.
      format: int64
      minimum: 1
      maximum: 1000
      example: 1
      readOnly: false
    ProcessorTokenEventDataVersion1_1Created:
      type: object
      description: The event data for processor token created notifications.
      required:
      - key
      - status
      - created
      - version
      properties:
        key:
          $ref: '#/components/schemas/openapi_components-schemas-processorTokenKey'
        status:
          type: string
          description: The current status of a Processor Token.
          enum:
          - active
          example: active
        reference:
          $ref: '#/components/schemas/processorTokenReference'
        created:
          $ref: '#/components/schemas/openapi_components-schemas-created-4'
        lastModified:
          $ref: '#/components/schemas/openapi_components-schemas-lastModified-3'
        version:
          $ref: '#/components/schemas/common_version'
    ProcessorTokenEventNotification1_1Archived:
      type: object
      allOf:
      - $ref: '#/components/schemas/PublicCloudEvent'
      required:
      - data
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/processorTokenEventType'
          - enum:
            - com.silverflow.processorTokens.archived
          - example: com.silverflow.processorTokens.archived
        data:
          $ref: '#/components/schemas/ProcessorTokenEventDataVersion1_1Archived'
        source:
          allOf:
          - $ref: '#/components/schemas/source'
          - enum:
            - https://silverflow.com/processorTokens
        specversion:
          allOf:
          - $ref: '#/components/schemas/openapi_components-schemas-version-3'
          - enum:
            - '1.0'
        subject:
          allOf:
          - description: The subject of the notification, which is the processor token key.
          - $ref: '#/components/schemas/openapi_components-schemas-processorTokenKey'
        dataschema:
          allOf:
          - $ref: '#/components/schemas/dataschema'
          - example: https://silverflow.com/schemas/events/processorTokens/1.1
          - enum:
            - https://silverflow.com/schemas/events/processorTokens/1.1
    openapi_components-schemas-created-4:
      type: string
      description: The date and time this object was created.
      format: date-time
      readOnly: false
    openapi_components-schemas-lastModified-3:
      type: string
      description: The date and time this object was last modified.
      format: date-time
      readOnly: false
    ProcessorTokenEventDataVersion1_1CvcDeleted:
      type: object
      description: The event data for processor token CVC deleted notifications.
      required:
      - key
      - status
      - created
      - version
      properties:
        key:
          $ref: '#/components/schemas/openapi_components-schemas-processorTokenKey'
        status:
          type: string
          description: The current status of a Processor Token.
          enum:
          - active
          - archived
          example: active
        reference:
          $ref: '#/components/schemas/processorTokenReference'
        created:
          $ref: '#/components/schemas/openapi_components-schemas-created-4'
        lastModified:
          $ref: '#/components/schemas/openapi_components-schemas-lastModified-3'
        version:
          $ref: '#/components/schemas/common_version'
    processorTokenEventType:
      type: string
      description: The event type.
      pattern: ^com.silverflow.processorTokens.[a-zA-Z]+$
      example: com.silverflow.processorTokens.created
    eventId:
      type: string
      description: Uniquely identifies an event.
      pattern: ^evt-[a-zA-Z0-9]+$
      minLength: 5
      maxLength: 120
      example: evt-1e1dAHhgstYTUhlphPzZ
    ProcessorTokenEventNotification1_1Created:
      type: object
      allOf:
      - $ref: '#/components/schemas/PublicCloudEvent'
      required:
      - data
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/processorTokenEventType'
          - enum:
            - com.silverflow.processorTokens.created
          - example: com.silverflow.processorTokens.created
        data:
          $ref: '#/components/schemas/ProcessorTokenEventDataVersion1_1Created'
        source:
          allOf:
          - $ref: '#/components/schemas/source'
          - enum:
            - https://silverflow.com/processorTokens
        specversion:
          allOf:
          - $ref: '#/components/schemas/openapi_components-schemas-version-3'
          - enum:
            - '1.0'
        subject:
          allOf:
          - description: The subject of the notification, which is the processor token key.
          - $ref: '#/components/schemas/openapi_components-schemas-processorTokenKey'
        dataschema:
          allOf:
          - $ref: '#/components/schemas/dataschema'
          - example: https://silverflow.com/schemas/events/processorTokens/1.1
          - enum:
            - https://silverflow.com/schemas/events/processorTokens/1.1
    dataContentType:
      type: string
      description: The content type of the event.
      enum:
      - application/json
  examples:
    cvc-deleted:
      summary: CVC was deleted from Processor Token
      value:
        type: com.silverflow.processorTokens.cvcDeleted
        data:
          key: ptk-1e1dA2fgs1YTUhlhyPOp
          status: active
          reference: VEQNS4L35E6IU1TN
          created: '2024-01-31T09:55:00.999Z'
          lastModified: '2024-02-01T08:15:30.456Z'
          version: 2
        source: https://silverflow.com/processorTokens
        specversion: '1.0'
        subject: ptk-1e1dA2fgs1YTUhlhyPOp
        dataschema: https://silverflow.com/schemas/events/processorTokens/1.1
        id: evt-5RqTbZ9VfhjLYxvmpSqD
        datacontenttype: application/json
        time: '2024-02-01T08:15:30.456Z'
        agent: cgt-1UF2NafdfrdPMf2XrS2
    archived:
      summary: Processor Token was archived
      value:
        type: com.silverflow.processorTokens.archived
        data:
          key: ptk-1e1dA2fgs1YTUhlhyPOp
          status: archived
          reference: VEQNS4L35E6IU1TN
          created: '2024-01-31T09:55:00.999Z'
          lastModified: '2024-02-15T14:30:45.123Z'
          version: 2
        source: https://silverflow.com/processorTokens
        specversion: '1.0'
        subject: ptk-1e1dA2fgs1YTUhlhyPOp
        dataschema: https://silverflow.com/schemas/events/processorTokens/1.1
        id: evt-2KmNpW8QcfgYXwujnRpA
        datacontenttype: application/json
        time: '2024-02-15T14:30:45.123Z'
        agent: cgt-1UF2NafdfrdPMf2XrS2
    created:
      summary: Processor Token was created
      value:
        type: com.silverflow.processorTokens.created
        data:
          key: ptk-1e1dA2fgs1YTUhlhyPOp
          status: active
          reference: VEQNS4L35E6IU1TN
          created: '2024-01-31T09:55:00.999Z'
          version: 1
        source: https://silverflow.com/processorTokens
        specversion: '1.0'
        subject: ptk-1e1dA2fgs1YTUhlhyPOp
        dataschema: https://silverflow.com/schemas/events/processorTokens/1.1
        id: evt-3IgSdT7DbeXNVftim0oY
        datacontenttype: application/json
        time: '2024-01-31T10:03:19.951Z'
        agent: cgt-1UF2NafdfrdPMf2XrS2
  securitySchemes:
    ApiKey:
      description: "The primary method of authenticating to the Silverflow API is through API keys.\n\nAPI keys can be created by calling the [createApiKey](#operation/createApiKey) endpoint. You can create up to 40 API keys and also update and delete them, allowing for _credential rotation_.\n\nThe _Agent Activation_ process will generate an initial API Key for you. See [Activate Agent](#section/Getting-Started).\n\nA call to the [createApiKey](#operation/createApiKey) endpoint will return the following structure:\n\n```json\n{\n    \"key\": \"apk-1wtRxni5IsPsSpBLWpwr\",\n    \"status\": \"active\",\n    \"agentKey\": \"cgt-1wtRvFLIjDOyyUR5Q2LB\",\n    \"description\": \"Data lake API key\",\n    \"permissions\": [\n        \"charges:List\",\n        \"reports:All\"\n    ],\n    \"created\": \"2021-06-22T11:21:45.115Z\",\n    \"secret\": \"FWtnOOHAjbD6rNxWWEeVOCj7JXSEPGJQ\",\n    \"version\": 1\n}\n```\n\n> **Important:** The `secret` is only returned once in the response to the `createApiKey` call.\n\nOnce created, the `key` and `secret` fields from the API key must be used in the HTTP `Authorization` header using the `Basic` scheme.\nThe Basic scheme requires a **username** and **password** to be specified, separated by a `:` (colon) and Base64 encoded.\n\nUse the following values from the API key to construct a Basic authentication header:\n\n| Basic field | API key field | Example |\n| ----------- | ------------- | ------- |\n| username | `key` | `apk-1wtRxni5IsPsSpBLWpwr` |\n| password | `secret` | `FWtnOOHAjbD6rNxWWEeVOCj7JXSEPGJQ` |\n\nIn pseudo-code a valid HTTP Basic Authentication header would be constructed as follows:\n\n```ts\nconst apiKeyId = \"apk-1wtRxni5IsPsSpBLWpwr\";\nconst apiKeySecret = \"FWtnOOHAjbD6rNxWWEeVOCj7JXSEPGJQ\";\nconst authnValue = \"Basic \" + base64Encode(apiKeyId + \":\" + apiKeySecret);\nrequest.setHeader(\"Authorization\", authnValue);\n```\n\nUsing the values from the example a valid HTTP request would look like the following:\n\n```http\nGET /v1/agents/current HTTP/1.1\nAccept: application/json\nAuthorization: Basic YXBrLTF3dFJ4bmk1SXNQc1NwQkxXcHdyOkZXdG5PT0hBamJENnJOeFdXRWVWT0NqN0pYU0VQR0pR\n```\n\nMore information on the Basic scheme can be found in [RFC-7617 - The 'Basic' HTTP Authentication Scheme](https://datatracker.ietf.org/doc/html/rfc7617)."
      type: http
      scheme: basic
    BearerToken:
      description: 'Bearer tokens are temporary security credentials that can be used to authorize ''third parties'' (bearers) access to the Silverflow API on behalf of the agent.


        These tokens are created by calling the [createAgentBearerToken](#operation/createAgentBearerToken) endpoint.


        Once created the `token` field must be used in the HTTP `Authorization` header using the `Bearer` scheme.

        Here''s an example of an HTTP request with a bearer token:


        ```http

        GET /v1/merchants/mct-1hPdFhmgaBzMS191nIbJ HTTP/1.1

        Accept: application/json

        Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...40EFOgxf_3I6mPZ16bXqHd5tUyApgl0mNOAXPm5AhnA


        ```


        More information on the Bearer scheme can be found in [RFC-6750 - The OAuth 2.0 Authorization Framework: Bearer Token Usage](https://datatracker.ietf.org/doc/html/rfc6750).'
      type: http
      scheme: bearer
      bearerFormat: JWT
    MutualTLS:
      type: apiKey
      in: header
      name: '-'
      description: 'The client must set up mTLS connection with a valid X.509 client certificate signed by a customer-provided CA (certificate authority) that is registered to a specific agent. The customer-provided CA certificate must be shared and added to Silverflow''s trust store prior to calling endpoints.


        Certificate validation happens at the transport layer during TLS handshake. Tenant verification is performed by matching the agent key embedded in the client certificate against the agent key embedded in the trusted CA.

        '
x-refined-from:
- silverflow-openapi.yml
- silverflow-openapi.yml
x-tagGroups:
- name: ''
  tags:
  - Introduction
  - Release Notes
- name: Accounts
  tags:
  - Agents
  - API Keys
  - Bins
  - Merchants
  - Merchant Acceptors
  - Enrollments
  - Screenings
- name: Event Notifications
  tags:
  - Event Subscriptions
  - Charges Events
  - Disputes Events
  - Fraud Notification Events
  - Processor Tokens Events
  - Network Tokens Events
  - Report Events
  - Distribution Events
  - AMMF Submission Events
  - Reconciliation Events
  - Clearing Events
- name: 3DS Authentication
  tags:
  - 3DS Authentication
- name: BEP Authentication
  tags:
  - BEP Authentication
- name: Tokenization
  tags:
  - Processor Tokenization
  - Network Tokenization
- name: Charges
  tags:
  - Create Charges
  - Create Recurring
  - Retrieve Charges
  - Charge Actions
- name: Terminal-To-Cloud
  tags:
  - Create POS Charges
  - Retrieve POS Charges
  - POS Charge Actions
- name: Card Management
  tags:
  - Card Management
- name: Disputes
  tags:
  - Disputes
  - Documents
- name: Fraud Notifications
  tags:
  - Fraud Notifications
- name: Card Info
  tags:
  - Card Info
- name: Currency Conversion Rates
  tags:
  - Currency Conversion Rates
- name: Fees
  tags:
  - Fees
- name: Reconciliation
  tags:
  - Reconciliation Details
  - Network Funds Transfers
- name: Reports
  tags:
  - Reconciliation Reports
  - Settlement Reports
  - Card Network Reports
  - Dispute Reports
  - Fraud Notifications Reports
  - Charges Reports
  - Scheme Fee Reports
  - Retrieve Reports
  - Report Scheduling
  - Distributions
- name: Transaction Risk Assessment
  tags:
  - Transaction Risk Assessment
- name: File Subscriptions
  tags:
  - File Subscriptions