Mastercard
Mastercard Subscriptions API

The Subscriptions API from Mastercard — 4 operation(s) for subscriptions.
Documentation GitHub OpenAPI
OpenAPI Specification

swagger: '2.0'
info:
  title: Mastercard Bill Payment Validator Account Opening Subscriptions API
  description: This service is provided on behalf of the Mastercard Remote Payment and Presentment (RPPS) Bill Payment Processing Network, which supports consumer to business "push" bill payments (i.e. those which are not funded by debit/credit card transactions) in the U.S.
  version: '1.0'
  x-artifactId: billpay-api
  contact:
    name: Bill Pay Development Support
    email: Bill_Pay_Development_Support@mastercard.com
host: sandbox.api.mastercard.com
basePath: /billpayAPI/v1
schemes:
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: Subscriptions
paths:
  /subscriptions:
    post:
      summary: Creating subscriptions
      description: Create a subscription that will cause notifications to be generated for the specified events.
      tags:
      - Subscriptions
      operationId: createSubscription
      requestBody:
        $ref: '#/components/requestBodies/CreateSubscription'
      responses:
        '201':
          $ref: '#/components/responses/CreatedSubscription'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
      callbacks:
        pushNotificationsMessage:
          to registered notification url:
            post:
              requestBody:
                description: Push Notifications message for subscribed events
                content:
                  application/json:
                    schema:
                      type: array
                      items:
                        $ref: '#/components/schemas/notification'
              responses:
                '200':
                  description: 'Your server implementation should return this HTTP status code

                    if the data was received successfully

                    '
    get:
      summary: Retrieving subscriptions
      description: Retrieve the subscriptions defined for this client.
      tags:
      - Subscriptions
      operationId: getAllSubscriptions
      parameters:
      - $ref: '#/components/parameters/subscriptionsOffsetParam'
      - $ref: '#/components/parameters/subscriptionsLimitParam'
      - $ref: '#/components/parameters/sortParam'
      responses:
        '200':
          $ref: '#/components/responses/GetSubscription'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
  /subscriptions/{id}:
    get:
      summary: Retrieving subscription by id
      description: Retrieve the details of a subscription.
      tags:
      - Subscriptions
      operationId: getSubscription
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParam'
      responses:
        '200':
          $ref: '#/components/responses/GetSubscriptionsById'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    put:
      summary: Updating subscription
      description: Update an existing subscription.
      tags:
      - Subscriptions
      operationId: updateSubscription
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParam'
      requestBody:
        $ref: '#/components/requestBodies/UpdateSubscription'
      responses:
        '200':
          $ref: '#/components/responses/UpdatedSubscription'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      summary: Deleting subscription
      description: Deletes a subscription, with the effect that no further notifications will be generated for that subscription.
      tags:
      - Subscriptions
      operationId: deleteSubscription
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParam'
      responses:
        '204':
          description: No content, indicates that the subscription has been deleted successfully
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /subscription-inquiries:
    post:
      summary: Mastercard Inquire on a Subscription to Determine if an Account Is Already Being Watched or Not.
      tags:
      - Subscriptions
      description: An inquiry request is used to check if an account is already being watched or not. Based on the response back, the ABU Integrator can choose to take action if necessary; to subscribe to watch an account or unsubscribe, to stop watching an account.
      operationId: subscriptionInquiry
      requestBody:
        $ref: '#/components/requestBodies/SubscriptionInquiryRequest'
      responses:
        '200':
          $ref: '#/components/responses/SubscriptionInquiryResponse'
        '400':
          $ref: '#/components/responses/BadRequestErrorResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /subscription-deletions:
    post:
      summary: Mastercard Unsubscribe From an Account to Stop Receiving Updates for Account Information in the Future.
      tags:
      - Subscriptions
      description: ABU Integrators can unsubscribe from an account to stop automatically receiving notifications with account information when updates occur.
      operationId: accountSubscriptionDeletion
      requestBody:
        $ref: '#/components/requestBodies/SubscriptionDeletionRequest'
      responses:
        '202':
          $ref: '#/components/responses/SubscriptionDeletionResponse'
        '400':
          $ref: '#/components/responses/BadRequestErrorResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  examples:
    BPSPaymentUpdateUpdatedSubscriptionResponse:
      value:
        id: 0CNSee76a6d031ba2166fe83ed7203f74b52134758270d1339c995b3be6c68a918211718964283
        name: TestSubscription_PaymentUpdateUpdated
        subjectType: PAYMENT_UPDATE
        subscriberId: C94BC2953D52DCE1E05368459E0ADF8E
        active: true
        specifications: []
    CreateICMPLifecycleSubscription:
      value:
        name: TestSubscription_ICMPTokenLifeCycle
        subjectType: TOKEN_LIFECYCLE_EVENT
        active: true
        specifications:
        - type: FIELD
          operator: WHERE
          children: []
          fieldMappingName: purchaseRequest.rcnAlias
          fieldOperator: EQUALS
          expectedContent:
            value: TEXT
            contentType: TEXT
    ICCPAuthorizationSubscriptionResponse:
      value:
        id: 0CNSf829c8c968765f86f51418c28d6b0430daa657174c3920a474890e540be5495d1718867617
        name: TestSubscription_ICCPAuth
        subjectType: PAYMENT_AUTHORIZATION
        subscriberId: A49875790BBF5F19E0535B449E0A5014
        active: true
        specifications:
        - id: 0CNSa6d4b038aa40e844f3e521e8062c242de051c72be96cbc206666ea467069e9401718867617
          type: FIELD
          operator: WHERE
          children: []
          fieldMapping:
            id: 0CNSa6d4a329d377bb296957df43e9f2f1ab5b35c997f88bcbc34939bc1525990be51556724071
            name: virtualpaymentcard.number
            displayName: VirtualPaymentCard Number
            subjectType: PAYMENT_AUTHORIZATION
            contentType: TEXT
          fieldOperator: EQUALS
          expectedContent:
            value: '1234567890123456'
            contentType: TEXT
    CreateBPSPaymentUpdateSubscription:
      value:
        name: TestSubscription_ICCPPaymentUpdate
        subjectType: PAYMENT_UPDATE
        active: true
        specifications: []
    UpdateICMPProvisioningSubscription:
      value:
        name: TestSubscription_ICMPTokenProvisioningUpdated
        subjectType: TOKEN_PROVISIONING_EVENT
        active: true
        specifications:
        - type: FIELD
          operator: WHERE
          children: []
          fieldMappingName: purchaseRequest.rcnAlias
          fieldOperator: EQUALS
          expectedContent:
            value: TEXT
            contentType: TEXT
    UpdateICCPAuthorizationSubscription:
      value:
        name: TestSubscription_ICCPPaymentAuthorization_Updated
        subjectType: PAYMENT_AUTHORIZATION
        active: true
        specifications:
        - type: FIELD
          operator: WHERE
          children:
          - type: FIELD
            operator: AND
            fieldMappingName: purchaseRequest.rcnAlias
            fieldOperator: EQUALS
            expectedContent:
              value: Travel Expense RCN
              contentType: TEXT
            children: []
          fieldMappingName: purchaseRequest.rcnAlias
          fieldOperator: EQUALS
          expectedContent:
            value: BOC
            contentType: TEXT
    ICMPLifecycleUpdatedSubscriptionResponse:
      value:
        id: 0CNSa56c4e01133b472a532678ab1e02b394de1886b3692eb42c99287ef10cffa59c1720083461
        name: TestSubscription_ICMPTokenProvisioningUpdated
        subjectType: TOKEN_LIFECYCLE_EVENT
        subscriberId: A49875790BBF5F19E0535B449E0A5014
        active: true
        specifications:
        - id: 0CNS63299c1c2fcd133327b88e12457b67333543ba4be3c1f77880b3fb99e25e31421720087279
          type: FIELD
          operator: WHERE
          children: []
          fieldMapping:
            id: 1AD42C3FCAF12726E06368459E0A9487
            name: purchaseRequest.rcnAlias
            displayName: Purchase Request RCN Alias
            subjectType: TOKEN_LIFECYCLE_EVENT
            contentType: TEXT
          fieldOperator: EQUALS
          expectedContent:
            value: TEXT
            contentType: TEXT
    CreateBPCAuthorizationSubscription:
      value:
        name: TestSubscription_BPCPaymentAuthorization
        subjectType: BPC_PAYMENT_AUTHORIZATION
        active: true
        specifications:
        - type: FIELD
          operator: WHERE
          children: []
          fieldMappingName: virtualPaymentCard.number
          fieldOperator: EQUALS
          expectedContent:
            value: '1234567890123456'
            contentType: TEXT
    CreateICCPAuthorizationSubscription:
      value:
        name: TestSubscription_ICCPPaymentAuthorization
        subjectType: PAYMENT_AUTHORIZATION
        active: true
        specifications:
        - type: FIELD
          operator: WHERE
          children:
          - type: FIELD
            operator: AND
            fieldMappingName: virtualPaymentCard.number
            fieldOperator: EQUALS
            expectedContent:
              value: '1234567890123456'
              contentType: TEXT
            children: []
          fieldMappingName: purchaseRequest.rcnAlias
          fieldOperator: EQUALS
          expectedContent:
            value: BOC
            contentType: TEXT
    ICCPAuthorizationUpdatedSubscriptionResponse:
      value:
        id: 0CNSf829c8c968765f86f51418c28d6b0430daa657174c3920a474890e540be5495d1718867617
        name: TestSubscription_ICCPAuthUpdated
        subjectType: PAYMENT_AUTHORIZATION
        subscriberId: A49875790BBF5F19E0535B449E0A5014
        active: true
        specifications:
        - id: 0CNS9e4f526d9641a7e65247f832e6f98505330cfcdd2e1955fabaa711ad052160971718952594
          type: FIELD
          operator: WHERE
          children: []
          fieldMapping:
            id: 0CNSa6d4a329d377bb296957df43e9f2f1ab5b35c997f88bcbc34939bc1525990be51556724071
            name: messageTypeIndicator
            displayName: Message type indicator
            subjectType: PAYMENT_AUTHORIZATION
            contentType: TEXT
          fieldOperator: EQUALS
          expectedContent:
            value: '12312'
            contentType: TEXT
    GetSubscriptionICCPResponse:
      value:
      - id: CNSa91bf379b48a593fd17f07f431bad8fb296796498f4e9982ea134394c1fa4f071556724070
        name: TestSubscription_PaymentAuthorization
        subjectType: PAYMENT_AUTHORIZATION
        subscriberId: CNSa91bf379b48a593fd17f07f431bad8fb296796498f4e9982ea134394c1fa4f071556724071
        active: true
        specifications:
        - id: CNSa91bf379b48a593fd17f07f431bad8fb296796498f4e9982ea134394c1fa4f071556724072
          type: FIELD
          operator: WHERE
          fieldMapping:
            id: CNSa91bf379b48a593fd17f07f431bad8fb296796498f4e9982ea134394c1fa4f071556724073
            name: purchaseRequest.rcnAlias
            displayName: Purchase request RCN alias
            subjectType: PAYMENT_AUTHORIZATION
            contentType: TEXT
          fieldOperator: EQUALS
          expectedContent:
            contentType: TEXT
            value: Travel Expense RCN
            anotherValue: {}
          children:
          - string
      - id: ABSa91bf379b48a593fd17f07f431bad8fb296796498f4e9982ea134394c1fa4f071556724070
        name: TestSubscription_PaymentUpdate
        subjectType: PAYMENT_UPDATE
        subscriberId: CNSa91bf379b48a593fd17f07f431bad8fb296796498f4e9982ea134394c1fa4f071556724071
        active: true
        specifications: []
      - id: 0CNS00773977af91478d9a21643947955dbbb7038e4958bda83e308689725096c4ac1712210079
        name: TestSubscription_Clearing
        subjectType: CLEARING
        subscriberId: A49875790BBF5F19E0535B449E0A5014
        active: true
        specifications:
        - id: 0CNS9cc3a869f3010b380f72ebd92001cad9c0c7446609895f30b020f8e7e6aae7cc1712210079
          type: FIELD
          operator: WHERE
          children: []
          fieldMapping:
            id: 135E59332C54BF9AE06368459E0ACEF0
            name: purchaseRequest.rcnAlias
            displayName: purchaseRequest rcnAlias
            subjectType: CLEARING
            contentType: TEXT
          fieldOperator: EQUALS
          expectedContent:
            value: RcnAliasText
            contentType: TEXT
    GetSubscriptionBPCResponse:
      value:
      - id: 0CNS2f3a8d6bbda7dcc282e0946a9b886231c99fd2e53ab8d3ca9c35144412c590121712030697
        name: TestSubscription_BPC
        subjectType: BPC_PAYMENT_AUTHORIZATION
        subscriberId: 0CED10E7921EFFF6E06368459E0AD156
        active: true
        specifications:
        - id: 0CNS9f5a947e901b39a123ed6a9cf2cbedcf019d5880f6d65321c78e89a546043f6f1712030697
          type: FIELD
          operator: WHERE
          children: []
          fieldMapping:
            id: 141747A087B5DC9DE06368459E0AC116
            name: corpGuid
            displayName: CorpGuid
            subjectType: BPC_PAYMENT_AUTHORIZATION
            contentType: TEXT
          fieldOperator: EQUALS
          expectedContent:
            value: SENTTYA75A95EEE00B3DC279FCBF82AC3CD834F9C6DDCEFA44B22CEBF842EF4E9750921701908872
            contentType: TEXT
    GetSubscriptionBPSResponse:
      value:
      - id: ABSa91bf379b48a593fd17f07f431bad8fb296796498f4e9982ea134394c1fa4f071556724070
        name: TestSubscription_PaymentUpdate
        subjectType: PAYMENT_UPDATE
        subscriberId: CNSa91bf379b48a593fd17f07f431bad8fb296796498f4e9982ea134394c1fa4f071556724071
        active: true
        specifications: []
    UpdateICMPLifecycleSubscription:
      value:
        name: TestSubscription_ICMPTokenProvisioningUpdated
        subjectType: TOKEN_LIFECYCLE_EVENT
        active: true
        specifications:
        - type: FIELD
          operator: WHERE
          children: []
          fieldMappingName: purchaseRequest.rcnAlias
          fieldOperator: EQUALS
          expectedContent:
            value: TEXT
            contentType: TEXT
    UpdateBPSPaymentUpdateSubscription:
      value:
        name: TestSubscription_ICCPPaymentUpdate_Updated
        subjectType: PAYMENT_UPDATE
        active: true
        specifications: []
    BPCAuthorizationSubscriptionResponse:
      value:
        id: 0CNS5f3aee95730c70a70ca85cb66f13ac40eeb79c6bc508cbe58e1c74ae97f18bb01718868027
        name: TestSubscription_BPCAuth
        subjectType: BPC_PAYMENT_AUTHORIZATION
        subscriberId: A49875790BBF5F19E0535B449E0A5014
        active: true
        specifications:
        - id: 0CNSa14d1f4baaadae35a8a83f65bb74914b002fbab44b4abf47039b687d5149fc3b1718868027
          type: FIELD
          operator: WHERE
          children: []
          fieldMapping:
            id: 1360ACE9C4D4CBFEE06368459E0ADD50
            name: virtualPaymentCard.number
            displayName: VirtualPaymentCard Number
            subjectType: BPC_PAYMENT_AUTHORIZATION
            contentType: TEXT
          fieldOperator: EQUALS
          expectedContent:
            value: '1234567890123456'
            contentType: TEXT
    UpdateBPCAuthorizationSubscription:
      value:
        name: TestSubscription_BPCPaymentAuthorization_Updated
        subjectType: BPC_PAYMENT_AUTHORIZATION
        active: true
        specifications:
        - type: FIELD
          operator: WHERE
          children: []
          fieldMappingName: messageTypeIndicator
          fieldOperator: EQUALS
          expectedContent:
            value: '12312'
            contentType: TEXT
    GetSubscriptionICMPResponse:
      value:
        id: 0CNS8d3bb4d6a02504515a15c631eb60d03de5b9cf760348439320b4fdc135ef1e111719205036
        name: TestICMPProvisioningSubscription
        subjectType: TOKEN_PROVISIONING_EVENT
        subscriberId: A49875790BBF5F19E0535B449E0A5014
        active: true
        specifications:
        - id: 0CNSfb3b539f47e9b95a267237c801e8818fd44b5b3c6aa957275bfd4d6dc9e9b2901719205036
          type: FIELD
          operator: WHERE
          children: []
          fieldMapping:
            id: 1AD42C3FCAF22726E06368459E0A9487
            name: purchaseRequest.companyId
            displayName: Purchase Request Company Id
            subjectType: TOKEN_PROVISIONING_EVENT
            contentType: INTEGER
          fieldOperator: EQUALS
          expectedContent:
            value: 248947
            contentType: INTEGER
        - id: 0CNSfe566e15084e64a9c2baa0183aaa8b901ac6defebf5f413365ecad64ab604ec11721373472
          name: OpenAPITest_SUBSC_NAME_DONT_DELETE1790226083
          subjectType: TOKEN_LIFECYCLE_EVENT
          subscriberId: A49875790BBF5F19E0535B449E0A5014
          active: true
          specifications:
          - id: 0CNS658f593db73c43ff9a1cc28a9053007ffdba8894649ce9d34f9cdedf430939eb1721373472
            type: FIELD
            operator: WHERE
            children: []
            fieldMapping:
              id: 1B9E8BCF021563E6E06368459E0AB38F
              name: purchaseRequest.rcnAlias
              displayName: Purchase Request RCN Alias
              subjectType: TOKEN_LIFECYCLE_EVENT
              contentType: TEXT
            fieldOperator: EQUALS
            expectedContent:
              value: RcnAliasText
              contentType: TEXT
    BPCAuthorizationUpdatedSubscriptionResponse:
      value:
        id: 0CNS5f3aee95730c70a70ca85cb66f13ac40eeb79c6bc508cbe58e1c74ae97f18bb01718868027
        name: TestSubscription_BPCAuthUpdated
        subjectType: BPC_PAYMENT_AUTHORIZATION
        subscriberId: A49875790BBF5F19E0535B449E0A5014
        active: true
        specifications:
        - id: 0CNS12fe24ddd5529bbfb317894e15b946ed3e5878b2382163ae9534b1cf38a3875a1718952480
          type: FIELD
          operator: WHERE
          children: []
          fieldMapping:
            id: 1360ACE9C4D4CBFEE06368459E0ADD50
            name: messageTypeIndicator
            displayName: MessageTypeIndicator
            subjectType: BPC_PAYMENT_AUTHORIZATION
            contentType: TEXT
          fieldOperator: EQUALS
          expectedContent:
            value: '12312'
            contentType: TEXT
    ICMPProvisioningSubscriptionResponse:
      value:
        id: 0CNSa56c4e01133b472a532678ab1e02b394de1886b3692eb42c99287ef10cffa59c1720083461
        name: TestSubscription_ICMPTokenProvisioning
        subjectType: TOKEN_PROVISIONING_EVENT
        subscriberId: A49875790BBF5F19E0535B449E0A5014
        active: true
        specifications:
        - id: 0CNSb12ce4d40ae45a3ff9cb9928f66ded61345e1cd45fc8d4991a0ce200d2b11ee11720083461
          type: FIELD
          operator: WHERE
          children: []
          fieldMapping:
            id: 1AD42C3FCAF12726E06368459E0A9487
            name: purchaseRequest.rcnAlias
            displayName: Purchase Request RCN Alias
            subjectType: TOKEN_PROVISIONING_EVENT
            contentType: TEXT
          fieldOperator: EQUALS
          expectedContent:
            value: TEXT
            contentType: TEXT
    BPSPaymentUpdateSubscriptionResponse:
      value:
        id: 0CNSee76a6d031ba2166fe83ed7203f74b52134758270d1339c995b3be6c68a918211718964283
        name: TestSubscription_ICCPPaymentUpdate
        subjectType: PAYMENT_UPDATE
        subscriberId: C94BC2953D52DCE1E05368459E0ADF8E
        active: true
        specifications: []
    ICMPProvisioningUpdatedSubscriptionResponse:
      value:
        id: 0CNSa56c4e01133b472a532678ab1e02b394de1886b3692eb42c99287ef10cffa59c1720083461
        name: TestSubscription_ICMPTokenProvisioningUpdated
        subjectType: TOKEN_PROVISIONING_EVENT
        subscriberId: A49875790BBF5F19E0535B449E0A5014
        active: true
        specifications:
        - id: 0CNS63299c1c2fcd133327b88e12457b67333543ba4be3c1f77880b3fb99e25e31421720087279
          type: FIELD
          operator: WHERE
          children: []
          fieldMapping:
            id: 1AD42C3FCAF12726E06368459E0A9487
            name: purchaseRequest.rcnAlias
            displayName: Purchase Request RCN Alias
            subjectType: TOKEN_PROVISIONING_EVENT
            contentType: TEXT
          fieldOperator: EQUALS
          expectedContent:
            value: TEXT
            contentType: TEXT
    UpdateICCPClearingSubscription:
      value:
        name: TestSubscription_ICCPClearing_Updated
        subjectType: CLEARING
        active: true
        specifications:
        - type: FIELD
          operator: WHERE
          children: []
          fieldMappingName: purchaseRequest.rcnAlias
          fieldOperator: EQUALS
          expectedContent:
            value: test rcn alias
            contentType: TEXT
    ICCPClearingUpdatedSubscriptionResponse:
      value:
        id: 0CNS0aa3f4e102b6f00976f9556d9af9951951ca3218f5d64d80c91b9057cdcff0a21718868785
        name: TestSubscription_ICCPClearingUpdated
        subjectType: CLEARING
        subscriberId: A49875790BBF5F19E0535B449E0A5014
        active: true
        specifications:
        - id: 0CNS91d2a2d3c9a517aee50830da16e83ed675262ca013fb9f82119867ccf4c5c1231718952258
          type: FIELD
          operator: WHERE
          children: []
          fieldMapping:
            id: 135E59332C54BF9AE06368459E0ACEF0
            name: purchaseRequest.rcnAlias
            displayName: purchaseRequest rcnAlias
            subjectType: CLEARING
            contentType: TEXT
          fieldOperator: EQUALS
          expectedContent:
            value: test rcn alias
            contentType: TEXT
    CreateICMPProvisioningSubscription:
      value:
        name: TestSubscription_ICMPTokenProvisioning
        subjectType: TOKEN_PROVISIONING_EVENT
        active: true
        specifications:
        - type: FIELD
          operator: WHERE
          children: []
          fieldMappingName: purchaseRequest.rcnAlias
          fieldOperator: EQUALS
          expectedContent:
            value: TEXT
            contentType: TEXT
    ICMPLifecycleSubscriptionResponse:
      value:
        id: 0CNSa56c4e01133b472a532678ab1e02b394de1886b3692eb42c99287ef10cffa59c1720083461
        name: TestSubscription_ICMPTokenLifecycle
        subjectType: TOKEN_LIFECYCLE_EVENT
        subscriberId: A49875790BBF5F19E0535B449E0A5014
        active: true
        specifications:
        - id: 0CNSb12ce4d40ae45a3ff9cb9928f66ded61345e1cd45fc8d4991a0ce200d2b11ee11720083461
          type: FIELD
          operator: WHERE
          children: []
          fieldMapping:
            id: 1AD42C3FCAF12726E06368459E0A9487
            name: purchaseRequest.rcnAlias
            displayName: Purchase Request RCN Alias
            subjectType: TOKEN_LIFECYCLE_EVENT
            contentType: TEXT
          fieldOperator: EQUALS
          expectedContent:
            value: TEXT
            contentType: TEXT
    CreateICCPClearingSubscription:
      value:
        name: TestSubscription_ICCPClearing
        subjectType: CLEARING
        active: true
        specifications:
        - type: FIELD
          operator: WHERE
          children: []
          fieldMappingName: purchaseRequest.rcnAlias
          fieldOperator: EQUALS
          expectedContent:
            value: test rcn alias
            contentType: TEXT
    ICCPClearingSubscriptionResponse:
      value:
        id: 0CNS0aa3f4e102b6f00976f9556d9af9951951ca3218f5d64d80c91b9057cdcff0a21718868785
        name: TestSubscription_ICCPClearing
        subjectType: CLEARING
        subscriberId: A49875790BBF5F19E0535B449E0A5014
        active: true
        specifications:
        - id: 0CNS4ab8577afb3a04ffa75e1ae75beb4509ac850d259b322b3b8dc3c721ec56777d1718868785
          type: FIELD
          operator: WHERE
          children: []
          fieldMapping:
            id: 135E59332C54BF9AE06368459E0ACEF0
            name: purchaseRequest.rcnAlias
            displayName: purchaseRequest rcnAlias
            subjectType: CLEARING
            contentType: TEXT
          fieldOperator: EQUALS
          expectedContent:
            value: test rcn alias
            contentType: TEXT
    UnauthorizedExample:
      value:
        Errors:
          Error:
          - Source: Security.Credential
            ReasonCode: AUTHENTICATION_FAILED
            Description: Unauthorized Access to Web Service.
            Recoverable: false
            Details: No ICA configured for clientID
    BadRequestExample:
      value:
        Errors:
          Error:
          - Source: Validation
            ReasonCode: ICA_VALUE_REQUIRED
            Description: ICA required for ABU client eligibility validation.
            Recoverable: false
            Details: ICA is mandatory.
    SubscriptionAccountInquirySubscribed:
      value:
        subscribed: true
    AccountInquiryAccountUpdate:
      value:
        responseIndicator: ACCOUNT_UPDATE
        account:
          number: '5573491171029999'
          expiry: '1221'
    AccountInquiryExpiry:
      value:
        responseIndicator: EXPIRY
        account:
          number: '5573491171027315'
          expiry: '1221'
    AccountInquiryUnknown:
      value:
        responseIndicator: UNKNOWN
    AccountInquiryNonParticipating:
      value:
        responseIndicator: NON_PARTICIPATING
    SubscriptionAccountInquiryNotSubscribed:
      value:
        subscribed: false
    AccountInquiryValid:
      value:
        responseIndicator: VALID
    AccountInquiryContact:
      value:
        responseIndicator: CONTACT
  responses:
    CreatedSubscription:
      description: CREATED
      headers:
        Location:
          description: URI with the ID that identifies the newly created subscription
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SubscriptionDetails'
          examples:
            BPC PAYMENT AUTHORIZATION:
              $ref: '#/components/examples/BPCAuthorizationSubscriptionResponse'
            ICCP CLEARING:
              $ref: '#/components/examples/ICCPClearingSubscriptionResponse'
            ICCP PAYMENT AUTHORIZATION:
              $ref: '#/components/examples/ICCPAuthorizationSubscriptionResponse'
            BPS PAYMENT UPDATE:
              $ref: '#/components/examples/BPSPaymentUpdateSubscriptionResponse'
            ICMP TOKEN LIFECYCLE:
              $ref: '#/components/examples/ICMPLifecycleSubscriptionResponse'
            ICMP TOKEN PROVISIONING:
              $ref: '#/components/examples/ICMPProvisioningSubscriptionResponse'
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error-403'
    UpdatedSubscription:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SubscriptionDetails'
          examples:
            BPC PAYMENT AUTHORIZATION:
              $ref: '#/components/examples/BPCAuthorizationUpdatedSubscriptionResponse'
            ICCP CLEARING:
              $ref: '#/components/examples/ICCPClearingUpdatedSubscriptionResponse'
            ICCP PAYMENT AUTHORIZATION:
              $ref: '#/components/examples/ICCPAuthorizationUpdatedSubscriptionResponse'
            BPS PAYMENT UPDATE:
              $ref: '#/components/examples/BPSPaymentUpdateUpdatedSubscriptionResponse'
            ICMP TOKEN LIFECYCLE:
              $ref: '#/components/examples/ICMPLifecycleUpdatedSubscriptionResponse'
            ICMP TOKEN PROVISIONING:
              $ref: '#/components/examples/ICMPProvisioningUpdatedSubscriptionResponse'
    GetSubscription:
      description: OK
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: '#/components/schemas/SubscriptionDetails'
          examples:
            Business Payments Control:
              $ref: '#/components/examples/GetSubscriptionBPCResponse'
            In Control for Commercial Payments(ICCP):
              $ref: '#/components/examples/GetSubscriptionICCPResponse'
            In Control for Mobile Payments(ICMP):
              $ref: '#/components/examples/GetSubscriptionICMPResponse'
            Business Payment Service(STP):
              $ref: '#/components/examples/GetSubscriptionBPSResponse'
    NotFound:
      description: Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error-404'
    GetSubscriptionsById:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SubscriptionDetails'
          examples:
            BPC PAYMENT AUTHORIZATION:
              $ref: '#/components/examples/BPCAuthorizationSubscriptionResponse'
            ICCP CLEARING:
              $ref: '#/components/examples/ICCPClearingSubscriptionResponse'
            ICCP PAYMENT AUTHORIZATION:
              $ref: '#/components/examples/ICCPAuthorizationSubscriptionResponse'
            BPS PAYMENT UPDATE:
              $ref: '#/components/examples/BPSPaymentUpdateSubscriptionResponse'
            ICMP TOKEN LIFECYCLE:
              $ref: '#/components/examples/ICMPLifecycleSubscriptionResponse'
            ICMP TOKEN PROVISIONING:
              $ref: '#/components/examples/ICMPProvisioningSubscriptionResponse'
    BadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error-400'
    UnauthorizedErrorResponse:
      description: Authentication information was missing or invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorWrapper'
          examples:
            UnauthorizedExample:
              $ref: '#/components/examples/UnauthorizedExample'
    SubscriptionInquiryResponse:
      description: The status of a subscription inquiry.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OutSubscriptionInquiry'
          examples:
            Subscribed:
              $ref: '#/components/examples/SubscriptionAccountInquirySubscribed'
            Not Subscribed:
              $ref: '#/components/examples/SubscriptionAccountInquiryNotSubscribed'
    BadRequestErrorResponse:
      description: Something was wrong with the request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorWrapper'
          examples:
            BadRequestExample:
              $ref: '#/components/examples/BadRequestExample'
    SubscriptionDeletionResponse:
      description: Successfully unsubscribed customer from account number for a given merchant.
    SubscriptionResponse:
      description: Customer account inquiry response, account will only be populated if response indicator is of type `EXPIRY` or `ACCOUNT_UPDATE`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OutSubscription'
          examples:
            Valid:
              $ref: '#/components/examples/AccountInquiryValid'
            Unknown:
    

# --- truncated at 32 KB (143 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mastercard/refs/heads/main/openapi/mastercard-subscriptions-api-openapi.yml
Mastercard Subscriptions API

Documentation

Specifications

Code Examples

Other Resources

OpenAPI Specification
