EventCatalog

Properties

id* :

Unique identifier of the payment

cardId* :

Id of the Tokenized card used. Issued by the Payment Service Provider.

userId* :

The ID of the subscriber who has done the payment

pspUserId* :

Id of the user created on the Payment Service Provider.

paymentServiceProvider* :

Name of the Payment Service Provider used.

name* :

name of the customer in the card used by the user for the payment.

brand* :

brand of the card [VISA, MASTERCARD, etc..] added by the user.

expiryMonth* :

Expiry Month of the card added by the user.

expiryYear* :

Expiry Year of the card aedded by the user.

lastFour* :

Last four number of the card added by the user.

firstSix* :

First six number of the card added by the user.

cardType* :

Type of the card [DEBIT, CREDIT, etc..] added by the user.

metadata* :

Set of key-value pairs that can be set by initiator service/user. This can be useful for storing additional information about the object in a structured format.

default* :

A boolean that shows if the card has been set as default based on the consumer request.

createdAt* :

The date when the user created the checkout session.

flowchart LR l-Payment_Service[Payment Service]:::producer-->CardVerificationApproved[CardVerificationApproved]:::event classDef event stroke:#42014d,stroke-width: 4px; classDef producer stroke:#75d7b6,stroke-width: 2px; classDef consumer stroke:#818cf8,stroke-width: 2px; CardVerificationApproved[CardVerificationApproved]:::event-->r-API_Service[API Service]:::consumer click l-Payment_Service href "/services/Payment Service" "Go to Payment Service" _self click r-API_Service href "/services/API Service" "Go to API Service" _self click CardVerificationApproved href "/events/CardVerificationApproved" "Go to CardVerificationApproved" _self

CardVerificationApproved Schema (yml)

openapi: 3.0.0
info:
  version: "1.0.0"
  title: CardVerificationApproved
paths: {}
components:
  schemas:
    CardVerificationApproved:
      type: object
      required:
        - metadata
        - data
      properties:
        data:
          "$ref": "#/components/schemas/Data"
        metadata:
          "$ref": "#/components/schemas/Metadata"
    Data:
      type: object
      required:
        - id
        - cardId
        - userId
        - pspUserId
        - paymentServiceProvider
        - name
        - brand
        - expiryMonth
        - expiryYear
        - lastFour
        - firstSix
        - cardType
        - allowAutoCharge
        - defaultCard
        - createdAt
      properties:
        id:
          type: string
        cardId:
          type: string
        userId:
          type: string
        pspUserId:
          type: string
        name:
          type: string
        brand:
          type: string
        paymentServiceProvider:
          type: string
        expiryMonth:
          type: string
        expiryYear:
          type: string
        lastFour:
          type: string
        firstSix:
          type: string
        cardType:
          type: string
        allowAutoCharge:
          type: boolean
        defaultCard:
          type: boolean
        metadata:
          type: object
        createdAt:
          type: string
          format: date-time
    Metadata:
      type: object
      required:
        - serviceFunction
        - version
      properties:
        serviceFunction:
          type: string
        version:
          type: string

CardVerificationApprovedv1.0.0