Qualpay Integrator API

openapi: 3.2.0
info:
  title: APIs Integrator API
  description: This document describes the Platform and PG API.
  contact:
    name: Qualpay
  license:
    name: Apache
    url: http://apache.org
  version: 2.1.3
servers:
- url: https://api-test.qualpay.com
  description: Sandbox Platform API
- url: https://api.qualpay.com
  description: Production Platform API
tags:
- name: Integrator
paths:
  /platform/vendor/settings/account/add:
    post:
      tags:
      - Integrator
      summary: Generate Test Account
      description: 'Creates a new test merchant account.


        Note: This API resource is intended for a very specific use case for a third-party integration. To use this resource, please contact Qualpay Customer Support to configure your account for it.'
      operationId: createTestAccount
      requestBody:
        description: NewAccount
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewAccountRequest'
            example:
              dba_name: My Test Account
              user_login: testusername
              user_first_name: Joe
              user_last_name: Smith
              user_email: joesmith@mycompany.com
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MerchantSettingsResponse'
        '400':
          description: Request Validation Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QPApiResponse'
        '500':
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QPApiResponse'
      security:
      - basicAuth: []
      x-codegen-request-body-name: body
  /platform/vendor/settings/key/{mid}:
    post:
      tags:
      - Integrator
      summary: Generate Security Key
      description: 'Creates a new API security key for a specified merchant account.


        Note: This API resource is intended for a very specific use case for a third-party integration. To use this resource, please contact Qualpay Customer Support to configure your account for it.'
      operationId: rotateApiKey
      parameters:
      - name: mid
        in: path
        description: The merchant ID for whom you are generating the security key.
        example: '210000000289'
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Data
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RotateKeyRequest'
            example:
              minutes: '2880'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RotateKeyResponse'
        '400':
          description: Request Validation Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QPApiResponse'
        '500':
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QPApiResponse'
      security:
      - basicAuth: []
      x-codegen-request-body-name: body
  /platform/vendor/settings/{mid}:
    get:
      tags:
      - Integrator
      summary: Merchant Settings
      description: 'Gets the payment card types and currencies supported by a specified merchant account.


        Note: This API resource is intended for a very specific use case for a third-party integration. To use this resource, please contact Qualpay Customer Support to configure your account for it.'
      operationId: getMerchantSettings
      parameters:
      - name: mid
        in: path
        description: The merchant ID whose settings you are requesting.
        example: '210000000289'
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MerchantSettingsResponse'
        '400':
          description: Request Validation Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QPApiResponse'
        '500':
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QPApiResponse'
      security:
      - basicAuth: []
components:
  schemas:
    Settings:
      type: object
      properties:
        app_id:
          type: integer
          description: The application ID for this merchant account.  Only returned if an application exists.
          format: int64
          example: 501722
        merchant_id:
          type: integer
          description: The merchant ID for this merchant account.
          format: int64
          example: 212000010001
        dba_name:
          type: string
          description: The 'Doing Business As' (DBA) name for this merchant account.
          example: My Test Account
        payments_accepted:
          type: array
          description: An array of the card types and currencies accepted by this merchant account.
          items:
            $ref: '#/components/schemas/Payment'
        payment_profiles:
          type: array
          description: An array of payment profiles available for this merchant account.
          items:
            $ref: '#/components/schemas/PaymentProfile'
        user_login:
          type: string
          description: The user login created for the merchant account.  Only returned if a new user was requested during account creation.
          example: testuser
        reset_url:
          type: string
          description: The URL to establish a new password for the created user.  Only returned if a new user was requested during account creation.
          example: https://app-test.qualpay.com/login/recover/b8b1e2cf5f7811e8bf8bacde48001122
    PaymentProfile:
      type: object
      properties:
        profile_id:
          type: string
          description: The ID of the payment profile.
          example: '21200001000100000840'
        label:
          type: string
          description: The payment profile's label.
          example: YOUR PROFILE - USD
        currency:
          type: string
          description: The currency code of the payment profile.
          example: '840'
        auto_close_time:
          type: integer
          description: The auto-close time for the batch in PST (U.S.).
          format: int32
          example: 2100
    QPApiResponse:
      type: object
      properties:
        code:
          type: integer
          description: '<strong>Format: </strong>Fixed length, 1 N<br><strong>Description: </strong>Response code from the API. `0` indicates success. Refer to <a href="/docs/api-conventions#platform-api-response-codes" target="_blank">Platform API Response Codes</a> for the entire list of return codes.'
          format: int32
          readOnly: true
          example: 0
        message:
          type: string
          description: '<strong>Format: </strong>Variable length AN<br><strong>Description: </strong>A short description of the API response code.'
          readOnly: true
          example: Success
        data:
          $ref: '#/components/schemas/QPApiData'
    Payment:
      type: object
      properties:
        card_type:
          type: string
          description: The two-character abbreviation for the card type.
          example: VS
        currency:
          type: array
          description: An array of currency codes allowed for the specified card type.
          example: '[840,124]'
          items:
            type: string
    RotateKeyResponse:
      type: object
      properties:
        code:
          type: integer
          description: '<strong>Format: </strong>Fixed length, 1 N<br><strong>Description: </strong>Response code from the API. `0` indicates success. Refer to <a href="/docs/api-conventions#platform-api-response-codes" target="_blank">Platform API Response Codes</a> for the entire list of return codes.'
          format: int32
          readOnly: true
          example: 0
        message:
          type: string
          description: '<strong>Format: </strong>Variable length AN<br><strong>Description: </strong>A short description of the API response code.'
          readOnly: true
          example: Success
        data:
          $ref: '#/components/schemas/ApiKey'
    ApiKey:
      type: object
      properties:
        security_key:
          type: string
          description: The new security key for the merchant account.
          example: 3888ab7bba98452987cdf69ae917561a
    NewAccountRequest:
      type: object
      properties:
        dba_name:
          type: string
          description: The 'Doing Business As' name for the new test account.
          example: My Test Account
        user_login:
          type: string
          description: The user login for the user assigned to the new test account.
          example: testusername
        user_first_name:
          type: string
          description: The first name of the user assigned to the new test account.
          example: Joe
        user_last_name:
          type: string
          description: The last name of the user assigned to the new test account.
          example: Smith
        user_email:
          type: string
          description: The email address for the user assigned to the new test account.
          example: joesmith@mycompany.com
    RotateKeyRequest:
      type: object
      properties:
        minutes:
          type: integer
          description: The number of minutes the old key will remain valid.
          format: int32
          example: 2880
    MerchantSettingsResponse:
      type: object
      properties:
        code:
          type: integer
          description: '<strong>Format: </strong>Fixed length, 1 N<br><strong>Description: </strong>Response code from the API. `0` indicates success. Refer to <a href="/docs/api-conventions#platform-api-response-codes" target="_blank">Platform API Response Codes</a> for the entire list of return codes.'
          format: int32
          readOnly: true
          example: 0
        message:
          type: string
          description: '<strong>Format: </strong>Variable length AN<br><strong>Description: </strong>A short description of the API response code.'
          readOnly: true
          example: Success
        data:
          $ref: '#/components/schemas/Settings'
    QPApiData:
      type: object
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
x-provenance:
  method: searched
  source: https://developer.qualpay.com/reference
  harvested: '2026-10-26'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developer.qualpay.com/reference/acceptdispute.md
  - https://developer.qualpay.com/reference/addapp.md
  - https://developer.qualpay.com/reference/addausjsonrequest.md
  - https://developer.qualpay.com/reference/addbillingcard.md
  - https://developer.qualpay.com/reference/addcheckout.md
  - https://developer.qualpay.com/reference/addcustomer.md
  - https://developer.qualpay.com/reference/addevent.md
  - https://developer.qualpay.com/reference/addinvoicepayment.md
  - https://developer.qualpay.com/reference/addpayee.md
  - https://developer.qualpay.com/reference/addplan.md
  - https://developer.qualpay.com/reference/addshippingaddress.md
  - https://developer.qualpay.com/reference/addsubscription.md
  - https://developer.qualpay.com/reference/addwebhook.md
  - https://developer.qualpay.com/reference/archiveplan.md
  - https://developer.qualpay.com/reference/authorization.md
  - https://developer.qualpay.com/reference/batch-close.md
  - https://developer.qualpay.com/reference/browseapps.md
  - https://developer.qualpay.com/reference/browseausrequestsdetail.md
  - https://developer.qualpay.com/reference/browseausrequestssummary.md
  - https://developer.qualpay.com/reference/browsebatches.md
  - https://developer.qualpay.com/reference/browsebouncedinvoices.md
  - https://developer.qualpay.com/reference/browsecustomers.md
  - https://developer.qualpay.com/reference/browsedeposits.md
  - https://developer.qualpay.com/reference/browsedisputes.md
  - https://developer.qualpay.com/reference/browseinvoicepayments.md
  - https://developer.qualpay.com/reference/browseinvoicepaymentsbyid.md
  - https://developer.qualpay.com/reference/browseinvoices.md
  - https://developer.qualpay.com/reference/browsepayees.md
  - https://developer.qualpay.com/reference/browseplans.md
  - https://developer.qualpay.com/reference/browsesalesreps.md
  - https://developer.qualpay.com/reference/browsestatementdisputeadjustmentdata.md
  - https://developer.qualpay.com/reference/browsestatementfeedata.md
  - https://developer.qualpay.com/reference/browsestatementplandata.md
  - https://developer.qualpay.com/reference/browsestatementreservedata.md
  - https://developer.qualpay.com/reference/browsestatementsettlementdata.md
  - https://developer.qualpay.com/reference/browsestatementsummarydata.md
  - https://developer.qualpay.com/reference/browsesubscriptions.md
  - https://developer.qualpay.com/reference/browsetrans.md
  - https://developer.qualpay.com/reference/browsewebhook.md
  - https://developer.qualpay.com/reference/cancelausrequest.md
  - https://developer.qualpay.com/reference/cancelcheckout.md
  - https://developer.qualpay.com/reference/cancelinvoice.md
  - https://developer.qualpay.com/reference/cancelsubscription.md
  - https://developer.qualpay.com/reference/capture.md
  - https://developer.qualpay.com/reference/copyinvoice.md
  - https://developer.qualpay.com/reference/createausrequest.md
  - https://developer.qualpay.com/reference/createdispute.md
  - https://developer.qualpay.com/reference/createinvoice.md
  - https://developer.qualpay.com/reference/createtestaccount.md
  - https://developer.qualpay.com/reference/credit.md
  - https://developer.qualpay.com/reference/deletebillingcard.md
  - https://developer.qualpay.com/reference/deletecustomer.md
  - https://developer.qualpay.com/reference/deletedisputefile.md
  - https://developer.qualpay.com/reference/deletepayee.md
  - https://developer.qualpay.com/reference/deleteplan.md
  - https://developer.qualpay.com/reference/deleteshippingaddress.md
  - https://developer.qualpay.com/reference/disablewebhook.md
  - https://developer.qualpay.com/reference/editwebhook.md
  - https://developer.qualpay.com/reference/emailapp.md
  - https://developer.qualpay.com/reference/enablewebhook.md
  - https://developer.qualpay.com/reference/expire.md
  - https://developer.qualpay.com/reference/force.md
  - https://developer.qualpay.com/reference/generatependingtoken.md
  - https://developer.qualpay.com/reference/get-card-type-information.md
  - https://developer.qualpay.com/reference/getallsubscriptiontransactions.md
  - https://developer.qualpay.com/reference/getapp.md
  - https://developer.qualpay.com/reference/getausdetail.md
  - https://developer.qualpay.com/reference/getausresponse.md
  - https://developer.qualpay.com/reference/getaussummary.md
  - https://developer.qualpay.com/reference/getbillingcards.md
  - https://developer.qualpay.com/reference/getcreditedtran.md
  - https://developer.qualpay.com/reference/getcustomer.md
  - https://developer.qualpay.com/reference/getcustomerbycardid.md
  - https://developer.qualpay.com/reference/getdetails.md
  - https://developer.qualpay.com/reference/getdispute.md
  - https://developer.qualpay.com/reference/getdisputefiles.md
  - https://developer.qualpay.com/reference/getdisputeresponse.md
  - https://developer.qualpay.com/reference/getdisputes.md
  - https://developer.qualpay.com/reference/getembeddedtransientkey.md
  - https://developer.qualpay.com/reference/getevents.md
  - https://developer.qualpay.com/reference/getinvoice.md
  - https://developer.qualpay.com/reference/getmerchantsettings.md
  - https://developer.qualpay.com/reference/getnondisputedtran.md
  - https://developer.qualpay.com/reference/getpayee.md
  - https://developer.qualpay.com/reference/getplan.md
  - https://developer.qualpay.com/reference/getremedyundisputedtran.md
  - https://developer.qualpay.com/reference/getshippingaddresses.md
  - https://developer.qualpay.com/reference/getsubscription.md
  - https://developer.qualpay.com/reference/getsubscriptiontransactions.md
  - https://developer.qualpay.com/reference/gettransactionbypgid.md
  - https://developer.qualpay.com/reference/gettransactionrequests.md
  - https://developer.qualpay.com/reference/getwebhook.md
  - https://developer.qualpay.com/reference/initiate-payment.md
  - https://developer.qualpay.com/reference/pausesubscription.md
  - https://developer.qualpay.com/reference/putonaushold.md
  - https://developer.qualpay.com/reference/recharge.md
  - https://developer.qualpay.com/reference/refund.md
  - https://developer.qualpay.com/reference/refundnonpg.md
  - https://developer.qualpay.com/reference/releasefromaushold.md
  - https://developer.qualpay.com/reference/removeevent.md
  - https://developer.qualpay.com/reference/removeinvoicepayment.md
  - https://developer.qualpay.com/reference/request-balance.md
  - https://developer.qualpay.com/reference/resendinvoice.md
  - https://developer.qualpay.com/reference/resetdispute.md
  - https://developer.qualpay.com/reference/resumesubscription.md
  - https://developer.qualpay.com/reference/rotateapikey.md
  - https://developer.qualpay.com/reference/sale.md
  - https://developer.qualpay.com/reference/savedata.md
  - https://developer.qualpay.com/reference/send-receipt.md
  - https://developer.qualpay.com/reference/sendinvoice.md
  - https://developer.qualpay.com/reference/setprimarybillingcard.md
  - https://developer.qualpay.com/reference/setprimaryshippingaddress.md
  - https://developer.qualpay.com/reference/submitdisputeaction.md
  - https://developer.qualpay.com/reference/submitdisputesresponse.md
  - https://developer.qualpay.com/reference/subscriptionlabelsadd.md
  - https://developer.qualpay.com/reference/subscriptionlabelsbrowse.md
  - https://developer.qualpay.com/reference/subscriptionlabelsdelete.md
  - https://developer.qualpay.com/reference/subscriptionlabelsedit.md
  - https://developer.qualpay.com/reference/tokenize.md
  - https://developer.qualpay.com/reference/tokenstatus.md
  - https://developer.qualpay.com/reference/unblocktoken.md
  - https://developer.qualpay.com/reference/updatebillingcard.md
  - https://developer.qualpay.com/reference/updatecustomer.md
  - https://developer.qualpay.com/reference/updatedraftinvoice.md
  - https://developer.qualpay.com/reference/updateinvoicepayment.md
  - https://developer.qualpay.com/reference/updateoutstandinginvoice.md
  - https://developer.qualpay.com/reference/updatepayee.md
  - https://developer.qualpay.com/reference/updatepayeeaccount.md
  - https://developer.qualpay.com/reference/updateplan.md
  - https://developer.qualpay.com/reference/updateshippingaddress.md
  - https://developer.qualpay.com/reference/updatesubscription.md
  - https://developer.qualpay.com/reference/uploaddisputefile.md
  - https://developer.qualpay.com/reference/uploadfile.md
  - https://developer.qualpay.com/reference/validateapp.md
  - https://developer.qualpay.com/reference/verify.md
  - https://developer.qualpay.com/reference/void.md
  merge:
    pages: 136
    deduped: 681
    conflicts_kept_first: 0