Simplifi/Simplifipay Funding Source API

openapi: 3.2.0
info:
  title: SimpliFi Cards Funding Source API
  version: 1.0.0
  description: 'SimpliFi Cards-as-a-Service API for issuing and managing virtual and physical cards across the GCC. Covers authentication (JWT), card programs, funding sources, cards, users, transactions, fees, rule groups, and webhook management. SimpliFi uses an asynchronous architecture: API calls return 2xx on receipt and final outcomes are delivered via webhooks.'
  contact:
    name: SimpliFi Support
    email: info@simplifipay.com
    url: https://apidoc.simplifipay.com/
servers:
- url: https://{env}-lb.simplifipay.com
  description: Load-balanced API host; {env} is the environment token issued during onboarding
  variables:
    env:
      default: uat
      description: Environment token issued by SimpliFi
security:
- bearerAuth: []
tags:
- name: Funding Source
paths:
  /v1/funding-source/{thirdPartyId}/rule-group:
    post:
      summary: Create Rule Group on Funding Account
      deprecated: false
      description: The 'Create Rule Group' endpoint creates new rule group on the Funding Account.
      tags:
      - Funding Source
      parameters:
      - name: thirdPartyId
        in: path
        description: This is a unique identifier for the Account ID of funding source (wallet)
        required: true
        example: ''
        schema:
          type: string
      - name: Authorization
        in: header
        description: This field contains the JWT token that is used to authenticate the user.
        required: true
        example: ''
        schema:
          type: string
          allowEmptyValue: false
      - name: requestUuid
        in: header
        description: 'A unique id is required to be passed as part of the header whenever a SimpliFi API is called from your

          system. This would help us in debugging in case of a discrepancy in the expected behavior of the API.'
        required: true
        example: ''
        schema:
          type: string
          allowEmptyValue: false
          minLength: 20
          maxLength: 40
          examples:
          - 00d366f2-a6e9-4714-b172-02c4e58c29d8
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RuleGroupModel'
      responses:
        '202':
          description: Successful operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuleGroupModel'
          headers: {}
        '400':
          description: Entity not found with the specified UUID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          headers: {}
        '401':
          description: Access token is missing or invalid
          content:
            application/json:
              schema:
                type: object
                properties: {}
          headers: {}
      security:
      - bearerAuth: []
      operationId: createRuleGroupOnFundingAccount
    put:
      summary: Update Rule Group on Funding Account
      deprecated: false
      description: The 'Update Rule Group' endpoint updates an existing group on the Funding Account.
      tags:
      - Funding Source
      parameters:
      - name: thirdPartyId
        in: path
        description: This is a unique identifier for the Account ID of funding source (wallet)
        required: true
        example: ''
        schema:
          type: string
      - name: requestUuid
        in: header
        description: 'A unique id is required to be passed as part of the header whenever a SimpliFi API is called from your

          system. This would help us in debugging in case of a discrepancy in the expected behavior of the API.'
        required: true
        example: ''
        schema:
          type: string
          allowEmptyValue: false
          minLength: 20
          maxLength: 40
          examples:
          - 00d366f2-a6e9-4714-b172-02c4e58c29d8
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RuleGroupModel'
      responses:
        '202':
          description: Successful operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuleGroupModel'
          headers: {}
        '400':
          description: Entity not found with the specified UUID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          headers: {}
        '401':
          description: Access token is missing or invalid
          content:
            application/json:
              schema:
                type: object
                properties: {}
          headers: {}
      security:
      - bearerAuth: []
      operationId: updateRuleGroupOnFundingAccount
    delete:
      summary: Delete Rule Group on Funding Account
      deprecated: false
      description: The 'Delete Rule Group' endpoint deletes an existing group on the Funding Account.
      tags:
      - Funding Source
      parameters:
      - name: thirdPartyId
        in: path
        description: This is a unique identifier for the Account ID of funding source (wallet)
        required: true
        example: ''
        schema:
          type: string
      - name: Authorization
        in: header
        description: This field contains the JWT token that is used to authenticate the user.
        required: true
        example: ''
        schema:
          type: string
          allowEmptyValue: false
      - name: requestUuid
        in: header
        description: 'A unique id is required to be passed as part of the header whenever a SimpliFi API is called from your

          system. This would help us in debugging in case of a discrepancy in the expected behavior of the API.'
        required: true
        example: ''
        schema:
          type: string
          allowEmptyValue: false
          minLength: 20
          maxLength: 40
          examples:
          - 00d366f2-a6e9-4714-b172-02c4e58c29d8
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RuleGroupModel'
      responses:
        '202':
          description: Successful operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuleGroupModel'
          headers: {}
        '400':
          description: Entity not found with the specified UUID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          headers: {}
        '401':
          description: Access token is missing or invalid
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x--orders: []
                x--ignore-properties: []
          headers: {}
      security:
      - bearerAuth: []
      operationId: deleteRuleGroupOnFundingAccount
    get:
      summary: Get Rule Groups on Funding Account
      deprecated: false
      description: The 'Get Rule Group' endpoint fetches all existing groups on the Funding Account.
      tags:
      - Funding Source
      parameters:
      - name: thirdPartyId
        in: path
        description: This is a unique identifier for the Account ID of funding source (wallet)
        required: true
        example: ''
        schema:
          type: string
      - name: Authorization
        in: header
        description: This field contains the JWT token that is used to authenticate the user.
        required: true
        example: ''
        schema:
          type: string
          allowEmptyValue: false
      - name: requestUuid
        in: header
        description: 'A unique id is required to be passed as part of the header whenever a SimpliFi API is called from your

          system. This would help us in debugging in case of a discrepancy in the expected behavior of the API.'
        required: true
        example: ''
        schema:
          type: string
          allowEmptyValue: false
          minLength: 20
          maxLength: 40
          examples:
          - 00d366f2-a6e9-4714-b172-02c4e58c29d8
      responses:
        '202':
          description: Successful operation.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RuleGroupResponseModel'
          headers: {}
        '400':
          description: Entity not found with the specified UUID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          headers: {}
        '401':
          description: Access token is missing or invalid
          content:
            application/json:
              schema:
                type: object
                properties: {}
          headers: {}
      security:
      - bearerAuth: []
      operationId: getRuleGroupsOnFundingAccount
  /v1/funding-source/{thirdPartyId}/rule-group/{ruleGroupUuid}:
    post:
      summary: Appply Rule Group on Funding Account
      deprecated: false
      description: The 'Apply Rule Group' endpoint applies an existing rule group on the Funding Account.
      tags:
      - Funding Source
      parameters:
      - name: thirdPartyId
        in: path
        description: This is a unique identifier for the Account ID of funding source (wallet)
        required: true
        example: ''
        schema:
          type: string
      - name: ruleGroupUuid
        in: path
        description: This is a unique identifier for the Rule Group
        required: true
        example: ''
        schema:
          type: string
      - name: Authorization
        in: header
        description: This field contains the JWT token that is used to authenticate the user.
        required: true
        example: ''
        schema:
          type: string
          allowEmptyValue: false
      - name: requestUuid
        in: header
        description: 'A unique id is required to be passed as part of the header whenever a SimpliFi API is called from your

          system. This would help us in debugging in case of a discrepancy in the expected behavior of the API.'
        required: true
        example: ''
        schema:
          type: string
          allowEmptyValue: false
          minLength: 20
          maxLength: 40
          examples:
          - 00d366f2-a6e9-4714-b172-02c4e58c29d8
      responses:
        '202':
          description: accepted.
          headers: {}
        '400':
          description: Entity not found with the specified UUID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          headers: {}
        '401':
          description: Access token is missing or invalid
          content:
            application/json:
              schema:
                type: object
                properties: {}
          headers: {}
      security:
      - bearerAuth: []
      operationId: appplyRuleGroupOnFundingAccount
    delete:
      summary: Remove Rule Group on Funding Account
      deprecated: false
      description: The 'Remove Rule Group' endpoint removes an existing rule group on the Funding Account.
      tags:
      - Funding Source
      parameters:
      - name: thirdPartyId
        in: path
        description: This is a unique identifier for the Account ID of funding source (wallet)
        required: true
        example: ''
        schema:
          type: string
      - name: ruleGroupUuid
        in: path
        description: This is a unique identifier for the Rule Group
        required: true
        example: ''
        schema:
          type: string
      - name: Authorization
        in: header
        description: This field contains the JWT token that is used to authenticate the user.
        required: true
        example: ''
        schema:
          type: string
          allowEmptyValue: false
      - name: requestUuid
        in: header
        description: 'A unique id is required to be passed as part of the header whenever a SimpliFi API is called from your

          system. This would help us in debugging in case of a discrepancy in the expected behavior of the API.'
        required: true
        example: ''
        schema:
          type: string
          allowEmptyValue: false
          minLength: 20
          maxLength: 40
          examples:
          - 00d366f2-a6e9-4714-b172-02c4e58c29d8
      responses:
        '202':
          description: accepted.
          headers: {}
        '400':
          description: Entity not found with the specified UUID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          headers: {}
        '401':
          description: Access token is missing or invalid
          content:
            application/json:
              schema:
                type: object
                properties: {}
          headers: {}
      security:
      - bearerAuth: []
      operationId: removeRuleGroupOnFundingAccount
components:
  schemas:
    RuleGroupModel:
      type: object
      properties:
        uuid:
          type: string
          description: 'This field contains the system generated unique identifier for the rule group

            that was created using the Rule Group API.'
          examples:
          - cceec464-eb26-4fbf-8e91-695f133ced0a
        name:
          type: string
          description: Name of the rule group
          examples:
          - Rule Group 1
        description:
          type: string
          description: Description of the rule group
          examples:
          - Rule Group 1 Description
        transactionRestrictions:
          $ref: '#/components/schemas/RuleGroupTransactionRestrictions'
        loadRestrictions:
          $ref: '#/components/schemas/RuleGroupLoadRestrictions'
        spendRestrictions:
          $ref: '#/components/schemas/RuleGroupSpendRestrictions'
      required:
      - name
    RuleGroupSpendRestrictions:
      type: object
      description: Details of card spend-related restrictions.
      properties:
        setLimitPerTxn:
          type: number
          format: decimal
          examples:
          - 123.45
        velocityDailyLimit:
          type: number
          format: decimal
          examples:
          - 3.45
        velocityWeeklyLimit:
          type: number
          format: decimal
          examples:
          - 23.45
        velocityMonthlyLimit:
          type: number
          format: decimal
          examples:
          - 123.45
        txnCountDaily:
          type: number
          format: int32
          examples:
          - 3
        txnCountWeekly:
          type: number
          format: int32
          examples:
          - 5
        txnCountMonthly:
          type: number
          format: int32
          examples:
          - 10
    RuleGroupLoadRestrictions:
      type: object
      description: Details of card load-related restrictions.
      properties:
        minimumLoad:
          type: number
          format: decimal
          examples:
          - 1.5
        maximumLoad:
          type: number
          format: decimal
          examples:
          - 123.45
        loadCountDailyLimit:
          type: number
          format: int32
          examples:
          - 3
        loadCountWeeklyLimit:
          type: number
          format: int32
          examples:
          - 5
        loadCountMonthlyLimit:
          type: number
          format: int32
          examples:
          - 10
        loadDailyLimit:
          type: number
          format: decimal
          examples:
          - 123.45
        loadWeeklyLimit:
          type: number
          format: decimal
          examples:
          - 523.45
        loadMonthlyLimit:
          type: number
          format: decimal
          examples:
          - 1023.45
    RuleGroupResponseModel:
      type: object
      properties:
        ruleGroup:
          $ref: '#/components/schemas/RuleGroupModel'
        enabled:
          type: boolean
          description: This field tells whether the `ruleGroup` is enabled or not
          examples:
          - 'true'
      required:
      - ruleGroup
      - enabled
    ErrorModel:
      type: object
      properties:
        errorCode:
          type: integer
          description: A 5-7 digit number defining the error
          examples:
          - '99997'
        message:
          type: string
          description: A brief message defining the error
          examples:
          - General Error
    RuleGroupTransactionRestrictions:
      type: object
      description: Details of transaction-related restrictions.
      properties:
        merchantRules:
          $ref: '#/components/schemas/RuleGroupMerchantRules'
      required:
      - merchantRules
    RuleGroupMerchantRules:
      type: object
      description: Allow or deny merchant category codes.
      properties:
        allow:
          type: boolean
          examples:
          - 'true'
        mcc:
          type: array
          items:
            type: string
        mccException:
          type: array
          items:
            type: string
      required:
      - allow
      - mcc
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'JWT access token from POST /v1/auth/login/{companyName}, sent as Authorization: Bearer <token>.'