Silverflow Merchant Acceptors API

openapi: 3.2.0
info:
  title: Silverflow Merchant Acceptors API
  version: 1.417.0
  contact:
    name: API Support
    email: support@silverflow.com
  license:
    name: Commercial
  description: 'Operations tagged Merchant Acceptors 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: Merchant Acceptors
  description: ' '
paths:
  /merchants/{merchantKey}/acceptors:
    post:
      operationId: createAcceptor
      summary: Create Merchant Acceptor
      description: 'This operation creates a new Acceptor for the specified Merchant.

        A newly created Acceptor always has `status` set to `active`.


        Requires `merchants:CreateAcceptor` permission.

        '
      tags:
      - Merchant Acceptors
      parameters:
      - $ref: '#/components/parameters/merchantKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AcceptorCreate'
      responses:
        '201':
          description: The created Acceptor
          headers:
            Location:
              description: The URL of the newly created Merchant Acceptor
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Acceptor'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '409':
          $ref: '#/components/responses/ConflictError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
    get:
      operationId: getMerchantAcceptors
      summary: List Merchant Acceptors by Merchant
      description: 'This operation returns a (paged) list of all (active) Merchant Acceptors for the specified Merchant.


        Requires `merchants:ListAcceptors` permission.

        '
      tags:
      - Merchant Acceptors
      parameters:
      - $ref: '#/components/parameters/sortOrder'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offsetToken'
      - $ref: '#/components/parameters/merchantKey'
      responses:
        '200':
          description: A (paged) list of Merchant Acceptors
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AcceptorsPage'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
    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
  /acceptors:
    get:
      operationId: getAcceptors
      summary: List Merchant Acceptors
      description: 'This operation returns a paged list of all Merchant Acceptors for the authenticated Agent.


        Requires `merchants:ListAcceptors` permission.

        '
      tags:
      - Merchant Acceptors
      parameters:
      - $ref: '#/components/parameters/sortOrder'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offsetToken'
      - $ref: '#/components/parameters/reference'
      responses:
        '200':
          description: A paged list of Merchant Acceptors
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AcceptorsPage'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
    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
  /acceptors/{acceptorKey}:
    get:
      operationId: getAcceptor
      summary: Get Merchant Acceptor
      description: 'This operation returns the active Merchant Acceptor.


        Requires `acceptors:Get` permission.

        '
      tags:
      - Merchant Acceptors
      parameters:
      - $ref: '#/components/parameters/acceptorKey'
      responses:
        '200':
          description: The active Acceptor version
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Acceptor'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '412':
          $ref: '#/components/responses/PreconditionFailedError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
    patch:
      operationId: updateAcceptor
      summary: Update Merchant Acceptor
      description: 'Update a Merchant Acceptor using JSON Merge Patch (RFC 7386).

        Set a field to `null` to remove it. Example:

        ```json

        { "webshopUrl": null }

        ```


        Requires `acceptors:Update` permission.

        '
      tags:
      - Merchant Acceptors
      parameters:
      - $ref: '#/components/parameters/acceptorKey'
      requestBody:
        description: 'Set the status of this Merchant Acceptor Version

          '
        required: true
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/AcceptorMergeUpdate'
      responses:
        '201':
          description: The updated Merchant Acceptor version
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Acceptor'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '409':
          $ref: '#/components/responses/ConflictError'
        '412':
          $ref: '#/components/responses/PreconditionFailedError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
    delete:
      operationId: deleteAcceptorVersion
      summary: Archive Merchant Acceptor
      description: "This operation archives the specified Merchant Acceptor. An archived Merchant Acceptor cannot be used to create \nnew charge requests. Charges can still be refunded and disputes can still occur.\n\nRequires `acceptors:Archive` permission.\n"
      tags:
      - Merchant Acceptors
      parameters:
      - $ref: '#/components/parameters/acceptorKey'
      responses:
        '204':
          description: Merchant Acceptor version deleted successfully
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '409':
          $ref: '#/components/responses/ConflictError'
        '412':
          $ref: '#/components/responses/PreconditionFailedError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
    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
  /acceptors/{acceptorKey}/versions/{acceptorVersion}:
    get:
      operationId: getAcceptorVersion
      summary: Get Merchant Acceptor Version
      description: 'This operation returns a particular Merchant Acceptor version.


        Requires `acceptors:Get` permission.

        '
      tags:
      - Merchant Acceptors
      parameters:
      - $ref: '#/components/parameters/acceptorKey'
      - $ref: '#/components/parameters/acceptorVersion'
      responses:
        '200':
          description: The referenced Merchant Acceptor version
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Acceptor'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
    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
  /acceptors/{acceptorKey}/versions/draft:
    patch:
      operationId: activateAcceptor
      summary: Activate Merchant Acceptor
      description: 'This operation activates the latest draft Merchant Acceptor.


        Requires `acceptors:Activate` permission.

        '
      tags:
      - Merchant Acceptors
      parameters:
      - $ref: '#/components/parameters/acceptorKey'
      requestBody:
        description: 'Set the status of this Merchant Acceptor version

          '
        required: true
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/AcceptorActivate'
      responses:
        '201':
          description: The referenced Merchant Acceptor version
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Acceptor'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '409':
          $ref: '#/components/responses/ConflictError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
    get:
      operationId: getDraftAcceptorVersion
      summary: Get Draft Merchant Acceptor Version
      description: 'This operation returns the draft Merchant Acceptor version.


        Requires `acceptors:Get` permission.

        '
      tags:
      - Merchant Acceptors
      parameters:
      - $ref: '#/components/parameters/acceptorKey'
      responses:
        '200':
          description: The referenced Merchant Acceptor version
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Acceptor'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
    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:
    Acceptor:
      type: object
      required:
      - key
      - status
      - mid
      - mcc
      - doingBusinessAsName
      - bin
      - merchant
      - created
      - version
      - description
      description: 'A Merchant Acceptor

        '
      properties:
        key:
          $ref: '#/components/schemas/acceptorKey'
        status:
          $ref: '#/components/schemas/acceptorStatus'
        description:
          $ref: '#/components/schemas/ExtendedFreeTextField'
        mid:
          $ref: '#/components/schemas/mid'
        mcc:
          $ref: '#/components/schemas/mcc'
        doingBusinessAsName:
          $ref: '#/components/schemas/doingBusinessAsName'
        webshopUrl:
          $ref: '#/components/schemas/webshopUrl'
        pointOfSaleAddress:
          $ref: '#/components/schemas/Address'
        bin:
          $ref: '#/components/schemas/Bin'
        merchant:
          $ref: '#/components/schemas/Merchant'
        networkAssignedId:
          $ref: '#/components/schemas/networkAssignedId'
        acquirerOrPayFacBusinessId:
          $ref: '#/components/schemas/acquirerOrPayFacBusinessId'
        subMerchantId:
          $ref: '#/components/schemas/subMerchantId'
        subMerchantAddress:
          $ref: '#/components/schemas/Address'
        isoId:
          $ref: '#/components/schemas/isoId'
        gatewayId:
          $ref: '#/components/schemas/gatewayId'
        restrictions:
          $ref: '#/components/schemas/AcceptorRestrictions'
        chargesBlocked:
          $ref: '#/components/schemas/chargesBlocked'
        foreignRetailer:
          $ref: '#/components/schemas/foreignRetailer'
        marketplaceId:
          $ref: '#/components/schemas/marketplaceId'
        rampProviderId:
          $ref: '#/components/schemas/rampProviderId'
        tags:
          $ref: '#/components/schemas/Tags'
        disputeHandling:
          $ref: '#/components/schemas/DisputeHandling'
        created:
          $ref: '#/components/schemas/created'
        lastModified:
          $ref: '#/components/schemas/lastModified'
        version:
          $ref: '#/components/schemas/version'
        reference:
          $ref: '#/components/schemas/reference'
        route:
          $ref: '#/components/schemas/acceptorRoute'
        merchantVolumeIndicator:
          $ref: '#/components/schemas/merchantVolumeIndicator'
        authorizationCurrency:
          $ref: '#/components/schemas/authorizationCurrencyForAmexDirectMerchant'
    gatewayId:
      type: string
      description: "Merchant Payment Gateway ID (MPG ID). MPG ID is assigned by Mastercard at the time of registration of the MPG as a Service Provider. \nThe value `999998` must be used for MGP ID field if the MPG is wholly owned by the Acquirer.\nThe value `999997` must be used in the MPG ID field if the Merchant uses no gateway and connects directly to the Acquirer. \nIn case no value is provided, `999998` is used by Silverflow where applicable. <span class=\"tag network-tag mastercard-tag\">MASTERCARD</span>\n"
      pattern: ^\d{1,11}$
    reference:
      type: string
      pattern: ^[a-zA-Z0-9()+,\-.:=@;$_!*\/?#|]+$
      minLength: 1
      maxLength: 120
      description: User-specified reference.
    marketplaceId:
      type: string
      description: Visa provided ID required for marketplaces. If provided, `rampProviderId` must not be provided. <span class="tag network-tag visa-tag">VISA</span>
      pattern: ^[a-zA-Z0-9]{1,11}$
    nullableTags:
      description: 'Optional tags provided by the agent to tag the object for maintainability. Tags can be used filtering and sorting on the list views of Disputes. A valid tag-key must:

        - contain only a-z, 0-9, "_" characters

        - first character should be a letter

        - be at least 1 character long

        - be no longer than 24 characters

        - not start with "sf_"

        '
      oneOf:
      - $ref: '#/components/schemas/Tags'
      - $ref: '#/components/schemas/null'
    PreconditionFailedProblemDetail:
      type: object
      required:
      - type
      - title
      - status
      - detail
      - instance
      properties:
        type:
          type: string
          enum:
          - /silverflow/problems/precondition-failed
        title:
          type: string
          enum:
          - Precondition Failed
        status:
          type: integer
          enum:
          - 412
        detail:
          type: string
          description: 'A human readable explanation specific to this occurrence of the

            problem.

            '
          example: Connection to database timed out
        instance:
          type: string
          description: 'An absolute URI that identifies the specific occurrence of the problem.

            It may or may not yield further information if dereferenced.

            '
      additionalProperties: false
    nullableMarketplaceId:
      type:
      - string
      - 'null'
      description: Visa provided ID required for marketplaces. If provided, `rampProviderId` must not be provided. <span class="tag network-tag visa-tag">VISA</span>
      pattern: ^[a-zA-Z0-9]{1,11}$
    amexAcquirerBin:
      anyOf:
      - $ref: '#/components/schemas/amexPayfacAcquirerBin'
      - $ref: '#/components/schemas/amexDirectMerchantAcquirerBin'
      - $ref: '#/components/schemas/amexPaymentDesignationAcquirerBin'
    version:
      type: integer
      description: The version of this object
      format: int64
    amexAcquirerIdCode:
      type: string
      description: Acquirer Institution ID code (Submitter ID). For PayFac model, this identifies the Payment Facilitator.
      pattern: ^[A-Z0-9]+$
      minLength: 6
      maxLength: 11
    nullableSubMerchantId:
      type:
      - string
      - 'null'
      pattern: ^[a-zA-Z0-9]+$
      minLength: 1
      maxLength: 15
      description: Unique ID assigned by the acquirer or Payment Facilitator to the subMerchant.
    CountryCodeCreate:
      oneOf:
      - $ref: '#/components/schemas/CountryCodeOnlyAlpha3'
      - $ref: '#/components/schemas/CountryCodeOnlyAlpha2'
      - $ref: '#/components/schemas/CountryCodeOnlyNumeric'
    VisaBin:
      allOf:
      - type: object
        required:
        - network
        - messageSystem
        - acquirerIdCode
        - acquirerBin
        - bid
        properties:
          network:
            type: string
            enum:
            - visa
          messageSystem:
            $ref: '#/components/schemas/messageSystem'
          acquirerIdCode:
            type: string
            description: Acquirer Institution ID code. This field corresponds to the CIB, which usually has the same value as the Bin.
            pattern: ^\d+$
            minLength: 6
            maxLength: 6
          acquirerBin:
            type: string
            description: Acquirer Bin. The Bin number as assigned by the card network.
            pattern: ^\d+$
            minLength: 6
            maxLength: 6
          bid:
            type: string
            description: Business Identification Number. The BID number as assigned by the card network.
            pattern: ^\d+$
            minLength: 8
            maxLength: 8
      - $ref: '#/components/schemas/BaseBin'
    status:
      type: string
      description: The status of the object
      enum:
      - active
      - archived
    DisputeHandling:
      type: object
      additionalProperties: false
      description: Dispute handling settings
      required:
      - autoDefense
      properties:
        autoDefense:
          type: boolean
          description: When autoDefense is set to true, disputes will be auto defended if there is a matching auto-defense rule present. <span class="tag network-tag visa-tag">VISA</span> <span class="tag network-tag mastercard-tag">MASTERCARD</span>
    ExtendedNameOfPeopleAndPlaces:
      type: string
      pattern: ^[\x20-\x7E\xA0-\xA3\xA5\xA7\xA9-\xB3\xB5-\xB7\xB9-\xBB\xBF-\xFF\u20AC\u0160\u0161\u017D\u017E\u0152\u0153\u0178]+$
      minLength: 1
      maxLength: 120
    nullableIsoId:
      type:
      - string
      - 'null'
      pattern: ^\d{1,11}$
      description: Unique ID assigned by the card network for the Independent Sales Organization. <span class="tag network-tag mastercard-tag">MASTERCARD</span>
    nullableNetworkAssignedId:
      type:
      - string
      - 'null'
      description: 'Unique ID assigned by the card network for the merchant. Used for example for Private Label transactions or large merchants.


        | Network | Length | Characters |

        | ------- | ------ | ---------- |

        | Mastercard | 6 | alpha numeric |

        | Visa | 10 | numeric |

        | Bancontact | 6 | numeric |

        '
    AcceptorCreate:
      type: object
      required:
      - mid
      - mcc
      - doingBusinessAsName
      - binKey
      - description
      additionalProperties: false
      properties:
        description:
          allOf:
          - $ref: '#/components/schemas/ExtendedFreeTextField'
          - example: ACME Corp. Visa Merchant Acceptor
        mid:
          $ref: '#/components/schemas/mid'
        mcc:
          $ref: '#/components/schemas/mcc'
        doingBusinessAsName:
          $ref: '#/components/schemas/doingBusinessAsName'
        webshopUrl:
          $ref: '#/components/schemas/webshopUrl'
        pointOfSaleAddress:
          allOf:
          - description: Required for Point of Sale (POS) Merchant Acceptors. For certain card network/country combinations the `stateOrProvince` value needs to be a recognised 2-letter uppercase state/province code. For `e-commerce` acceptors the `pointOfSaleAddress` can be omitted and the `registeredAddress` on the Merchant will be used instead.
          - $ref: '#/components/schemas/AddressCreate'
        networkAssignedId:
          $ref: '#/components/schemas/networkAssignedId'
        binKey:
          $ref: '#/components/schemas/binKeyRef'
        acquirerOrPayFacBusinessId:
          $ref: '#/components/schemas/acquirerOrPayFacBusinessId'
        subMerchantId:
          $ref: '#/components/schemas/subMerchantId'
        subMerchantAddress:
          $ref: '#/components/schemas/AddressCreate'
        isoId:
          $ref: '#/components/schemas/isoId'
        gatewayId:
          $ref: '#/components/schemas/gatewayId'
        restrictions:
          $ref: '#/components/schemas/AcceptorRestrictions'
        chargesBlocked:
          $ref: '#/components/schemas/chargesBlocked'
        foreignRetailer:
          $ref: '#/components/schemas/foreignRetailer'
        marketplaceId:
          $ref: '#/components/schemas/marketplaceId'
        rampProviderId:
          $ref: '#/components/schemas/rampProviderId'
        tags:
          $ref: '#/components/schemas/Tags'
        disputeHandling:
          $ref: '#/components/schemas/DisputeHandling'
        reference:
          $ref: '#/components/schemas/reference'
        route:
          $ref: '#/components/schemas/acceptorRoute'
        merchantVolumeIndicator:
          $ref: '#/components/schemas/merchantVolumeIndicator'
        authorizationCurrency:
          $ref: '#/components/schemas/authorizationCurrencyForAmexDirectMerchant'
    CountryCodeOnlyAlpha2:
      type: object
      required:
      - alpha2
      additionalProperties: false
      properties:
        alpha2:
          $ref: '#/components/schemas/countryCodeAlpha2'
    doingBusinessAsName:
      allOf:
      - $ref: '#/components/schemas/ExtendedNameOfPeopleAndPlaces'
      - description: Assumed, trade or fictitious name of the merchant. The name will be trimmed if greater than 25 (Visa) or 22 (Mastercard) characters by the card network. Clients not enrolled in the "extended character set beta" are still subject to the `^[\w,\*,\=,\.\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u00FF-/]+$` pattern for field input.
      - example: ACME Corp.
    discoverAcquirerIdCode:
      type: string
      description: Acquirer Institution ID code.
      pattern: ^\d+$
      minLength: 1
      maxLength: 11
    CountryCode:
      type: object
      required:
      - alpha3
      - alpha2
      - numeric
      properties:
        alpha3:
          $ref: '#/components/schemas/countryCodeAlpha3'
        alpha2:
          $ref: '#/components/schemas/countryCodeAlpha2'
        numeric:
          $ref: '#/components/schemas/countryCodeNumeric'
    mcc:
      type: string
      pattern: ^\d+$
      minLength: 4
      maxLength: 4
      description: The Merchant category.
      example: 742
    ProblemDetail:
      type: object
      description: 'The ''problem detail'' object relays detailed information about the error that occurred. It is defined

        by [RFC 7807 - Problem Details for HTTP APIs](https://tools.ietf.org/html/rfc7807).


        Note that additional properties may be used to relay error specific information.

        '
      properties:
        type:
          type: string
          description: 'An absolute URI that identifies the problem type.

            '
          default: about:blank
          example: https://api.silverflow.co/problem/constraint-violation
        title:
          type: string
          description: 'A short, summary of the problem type. Written in english and readable

            for engineers (usually not suited for non technical stakeholders and

            not localized);

            '
          example: Service Unavailable
        status:
          type: integer
          format: int32
          description: 'The HTTP status code generated by the origin server for this occurrence

            of the problem.

            '
          minimum: 100
          maximum: 599
          example: 503
        detail:
          type: string
          description: 'A human readable explanation specific to this occurrence of the

            problem.

            '
          example: Connection to database timed out
        instance:
          type: string
          description: 'An absolute URI that identifies the specific occurrence of the problem.

            It may or may not yield further information if dereferenced.

            '
      additionalProperties: true
    nullableAddress:
      description: 'A physical postal address

        '
      oneOf:
      - $ref: '#/components/schemas/AddressCreate'
      - $ref: '#/components/schemas/null'
    amexModel:
      type: string
      description: The AMEX business model. In the PayFac model, authorization is performed using the SE Number on the BIN. In the Direct Merchant or Payment Designation model, authorization is performed using the SE Number on the Acceptor. If `amexModel` is undefined, the AMEX Bin is treated as a PayFac Bin by default.
      default: payfac
      enum:
      - payfac
      - direct_merchant
      - payment_designation
    AcceptorRestrictions:
      type: array
      maxItems: 1
      description: This field is deprecated. The `chargesBlocked` property on the MerchantAcceptor serves as its replacement.
      deprecated: true
      items:
        $ref: '#/components/schemas/AcceptorRestriction'
    'null':
      type:
      - object
      - 'null'
      description: Set this field to null to remove it from the entity.
      additionalProperties: false
    acceptorStatus:
      type: string
      description: The status of the Acceptor (version)
      enum:
      - draft
      - active
      - archived
    isoId:
      type: string
      description: Unique ID assigned by the card network for the Independent Sales Organization. <span class="tag network-tag mastercard-tag">MASTERCARD</span>
      pattern: ^\d{1,11}$
    dxsCode:
      description: The dxsCode is provided to acquirers by Diners during onboarding. A unique dxsCode is provided for each IIC.
      type: string
      pattern: ^[a-zA-Z0-9]+$
      minLength: 3
      maxLength: 3
    ExtendedFreeTextField:
      type: string
      pattern: ^[\x20-\x7E\xA0-\xA3\xA5\xA7\xA9-\xB3\xB5-\xB7\xB9-\xBB\xBF-\xFF\u20AC\u0160\u0161\u017D\u017E\u0152\u0153\u0178]+$
      minLength: 1
      maxLength: 160
      description: Clients not enrolled in the "extended character set beta" are still subject to the `^[\w +=.,:;!?$@()-]+$` pattern for field input.
    webshopUrl:
      allOf:
      - $ref: '#/components/schemas/url'
      - example: https://acme.com
    url:
      type: string
      description: A valid URL
      pattern: ^http(s)?:\/\/[a-z0-9-_]+(\.[a-z0-9-_]+)+(\/.*)?$
      minLength: 8
      maxLength: 2048
    nullableDisputeHandling:
      description: Dispute handling settings
      oneOf:
      - $ref: '#/components/schemas/DisputeHandling'
      - $ref: '#/components/schemas/null'
    Bin:
      discriminator:
        propertyName: network
        mapping:
          visa: '#/components/schemas/VisaBin'
          mastercard: '#/components/schemas/MastercardBin'
          bancontact: '#/components/schemas/BancontactBin'
          american-express: '#/components/schemas/AmexBin'
          discover: '#/components/schemas/DiscoverBin'
          diners: '#/components/schemas/DinersBin'
      oneOf:
      - $ref: '#/components/schemas/VisaBin'
      - $ref: '#/components/schemas/MastercardBin'
      - $ref: '#/components/schemas/BancontactBin'
      - $ref: '#/components/schemas/AmexBin'
      - $ref: '#/components/schemas/DiscoverBin'
      - $ref: '#/components/schemas/DinersBin'
    DiscoverBin:
      allOf:
      - type: object
        required:
        - network
        - messageSystem
        - acquirerIdCode
        - acquirerBin
        properties:
          network:
            type: string
            enum:
            - discover
          messageSystem:
            type: string
            enum:
            - DMS
            description: Determines the message structure and Data Element definitions for card network.
          acquirerIdCode:
            $ref: '#/components/schemas/discoverAcquirerIdCode'
          acquirerBin:
            $ref: '#/components/schemas/discoverAcquirerBin'
          isoId:
            $ref: '#/components/schemas/discoverIsoId'
      - $ref: '#/components/schemas/BaseBin'
    CountryCodeOnlyAlpha3:
      type: object
      required:
      - alpha3
      additionalProperties: false
      properties:
        alpha3:
          $ref: '#/components/schemas/countryCodeAlpha3'
    moreItems:
      type: boolean
    merchantVolumeIndicator:
      type: string
      pattern: ^\d{2}
      minLength: 2
      maxLength: 2
      description: The Merchant Volume Indicator (MVI) is a Visa assigned field used to classify merchants based on their Visa transaction volume. This field is optional for Visa Merchant Acceptors in the US region. <span class="tag network-tag visa-tag">VISA</span>
    AddressCreate:
      type: object
      required:
      - countryCode
      - city
      - line1
      - postalCode
      additionalProperties: false
      description: 'A physical postal address

        '
      properties:
        countryCode:
          $ref: '#/components/schemas/CountryCodeCreate'
        stateOrProvince:
          $ref: '#/components/schemas/stateOrProvince'
        city:
          $ref: '#/components/schemas/city'
        line1:
          $ref: '#/components/schemas/line1'
        line2:
          $ref: '#/components/schemas/line2'
        postalCode:
          $ref: '#/components/schemas/postalCode'
    agentKey:
      description: Uniquely identifies an Agent
      type: string
      pattern: ^cgt-[a-zA-Z0-9]+|current$
      example: cgt-1UF2NafdfrdPMf2XrS2
    nullableWebshopUrl:
      type:
      - string
      

# --- truncated at 32 KB (117 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/silverflow/refs/heads/main/openapi/silverflow-merchant-acceptors-api-openapi.yml