AMCS Group Mobills IVR API

openapi: 3.2.0
info:
  title: Core AccessGroup Mobills IVR API
  version: core
servers:
- url: https://rstapi-sbx-svc-core.amcsplatform.com/erp/api/integrator/erp
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Mobills IVR
paths:
  /Mobills/Ivr/Pay/GetCustomerInvoiceDetails:
    post:
      tags:
      - Mobills IVR
      summary: Get Customer Invoice Details
      description: "This endpoint creates a record in payment transaction table.\n\n## Request\n\n| Property                  | Description  |\n| ------------------------- | ------------------------------------------------------------------------|\n| CustomerARCode                      | The account code used for Accounts Receivable.        (AMCS will provide the account ARCode)                             |\n| Channel               | Channel can be only MOBILL OR IVR                         | \n\n ## Response\n\n| Property                  | Description  |\n| ------------------------- | ------------------------------------------------------------------------|\n| CustomerGuid                 | The GUID associated to the customer.        |\n| CustomerName               |The customer's name.        |\n| CustomerBalance               |The amount associated to the payment.        |\n| CustomerCurrency               | Customer Currency associated with the Customer account.        |\n| InvoiceDetails               |It will show all the invoices associated with the account               |\n| InvoiceNumber                   |The invoice number associated to the invoice. Filterable.        |\n| InvoiceGUID                     |The GUID associated to the invoice.        |\n| InvoiceDate                     |The invoiceDate associated to the invoice in ISO format (YYYY-MM-DD).        |\n| ZipCode                         |Zip code is associated with the account               |\n| InvoiceDueDate                  |The dueDate associated to the invoice in ISO format (YYYY-MM-DD).        |\n| UnallocatedAmount               |The Unallocated Amount on the customers account.        |\n| InvoiceCurrency                 |Invoice Currency asscoaited with the customer account             |\n| TransactionReference            |Transaction Reference associated with account                 |\n| ZipCode                         |ZipCode associated with the account address                                |\n| InvoiceDate                     |The invoiceDate associated to the invoice in ISO format (YYYY-MM-DD).        |\n| LastPaymentDate                 |When the last payment was made                     |\n| MakePaymentLink                 |It shows the payment link (if any invoice available)                     |\n| IsActive                 |Whether the customer is active              |\n| MobillsEnrollment               |Whether the mobills enrollment is active.              |\n| GUID         |Guid associated with the account"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AMCSPayMobillsIvrRequest'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AMCSPayMobillsIvrResponse'
        '204':
          description: No Content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AMCSPayErrorContentResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AMCSPayErrorResponse'
  /payACIInteractiveVoiceResponse:
    post:
      tags:
      - Mobills IVR
      summary: Post Back IVR Response
      description: "This endpoint updates an existing record in the payment transaction table and creates a record in the Amcs-Pay Database.\n\n## Request\n\n| Property                  | Description  |\n| ------------------------- | ------------------------------------------------------------------------|\n| TransactionReference                      | The Transaction Reference can get from the GetCustomerInvoce API.                           |\n| PaymentAmount               | The payment amount associated to the payment request.  |\n| Currency               | Currency associated with the Customer account.|\n| Timestamp                     | The time stamp associated to the response payload. |\n| TransactionPaymentType                     | Transaction payment type can be any of \"CARD\", \"ACH\".  |\n| IsIVR                     |IsIVR is a flag and should be set to true..  |\n| Code                     |The codes for successfully processed transactions.  |\n| Description                     |Description associated with the Code.  |\n| Bin                     |The first six digits of the card.number. |\n| Last4Digits                     |Last 4 digits of the \"Credit\", \"Debit\" Card.  |\n| PaymentType                     |Payment Type DB, Debit: Debits the account of the end customer and credits the merchant account. |\n| Holder                     |Holder of the credit card account. |\n| ExpiryMonth                    | The expiry month of the card. |\n| ExpiryYear                     |The expiry year of the card. |\n| ConfirmationNumber                     |The Confirmation Number (payment reference) data sent by the provider associated to the original payment response.| \n\n ## Response\n\n| Property                  | Description  |\n| ------------------------- | ------------------------------------------------------------------------|\n|  |\n| Response                     |It returns the success response."
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AMCSPayPostBackIvrRequest'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AMCSPayIvrResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AMCSPayErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AMCSPayErrorResponse'
  /ivr/pay/getCustomerAccountDetail:
    post:
      tags:
      - Mobills IVR
      summary: Get Customer Account Detail
      description: "If the credit balance flag is false, then this endpoint initiates a payment for the IVR and returns the customer's details. If it's true, then it returns the customer's name along with the available credit balance in the account.\n\n## Request\n\n| Property                  | Description  |\n| ------------------------- | ------------------------------------------------------------------------|\n| CustomerARCode                      | The account code used for Accounts Receivable.        (AMCS will provide the account ARCode)                             |\n| Channel               | Channel can be only MOBILL OR IVR.   |\n| Amount               | Amount that customer wants to make a payment. |\n| CreditBalance               | The credit balance flag can be true or false.                       | \n\n ## Response\n\n| Property                  | Description  |\n| ------------------------- | ------------------------------------------------------------------------|\n| CustomerId                      | The account code used for Accounts Receivable.        (AMCS will provide the account ARCode) |\n|CustomerGuid                 | The GUID associated to the customer.        |\n| CustomerName               |The customer's name.   |\n| CustomerBalance               |The amount associated to the payment.|\n| CustomerCurrency               | Customer Currency associated with the Customer account.|\n| CreditBalance               |The Credit Balance available balance.|\n| ZipCode                         |ZipCode associated with the account address                            |\n| LastPaymentAmount                 |what was the last payment amount.    |\n| LastPaymentDate                 |When the last payment was made. |\n| TransactionReference            |Transaction Reference associated with account."
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AMCSPayAccountDetailIvrRequest'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AMCSPayAccountDetailIvrResponse'
        '204':
          description: No Content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AMCSPayErrorContentResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AMCSPayErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AMCSPayErrorResponse'
components:
  schemas:
    AMCSPayErrorResponse:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
          example: error message
          description: The exception message.
        type:
          type:
          - string
          - 'null'
          example: error message
          description: The type of exception thrown.
        stackTrace:
          type:
          - string
          - 'null'
          example: error message
          description: The stack trace of the error encountered.
    AMCSPayAccountDetailIvrRequest:
      type: object
      required:
      - customerARCode
      - channel
      - amount
      properties:
        customerARCode:
          type: string
          example: ACC1007
        channel:
          type: string
          example: MOBILL / IVR
        amount:
          type:
          - integer
          - 'null'
          example: 10
        creditBalance:
          type:
          - boolean
          - 'null'
          example: true
      additionalProperties: false
    AMCSPayInvoiceDetails:
      type: object
      properties:
        invoiceNumber:
          type: string
          example: INV001
        invoiceGUID:
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
          type: string
        invoiceDate:
          type: string
          example: YYYY-MM-DD
        zipCode:
          type:
          - string
          - 'null'
          example: '00501'
        invoiceDueDate:
          type: string
          example: YYYY-MM-DD
        unallocatedAmount:
          type:
          - integer
          - 'null'
          example: '120.95'
        invoiceCurrency:
          type: string
          example: EUR
      additionalProperties: false
    AMCSPayAccountDetailIvrResponseCreditBalanceResponse:
      type: object
      properties:
        customerid:
          format: string
          type: string
          example: ACC1001
        customerName:
          type: string
          example: Mark Smith
        creditBalance:
          type:
          - integer
          - 'null'
          example: '200.00'
    AMCSPayAccountDetailIvrResponseCreditBalanceAsFalse:
      type: object
      properties:
        customerid:
          format: uuid
          type: string
          example: ACC1001
        customerGuid:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        customerName:
          type: string
          example: Mark Smith
        customerBalance:
          type:
          - integer
          - 'null'
          example: '120.95'
        customerCurrency:
          type: string
          example: EUR
        creditBalance:
          type:
          - integer
          - 'null'
          example: '200.00'
        zipCode:
          type:
          - string
          - 'null'
          example: '00501'
        lastPaymentAmount:
          type:
          - string
          - 'null'
          example: '155.50'
        lastPaymentDate:
          type:
          - string
          - 'null'
          example: YYYY-MM-DD
        transactionReference:
          type:
          - string
          - 'null'
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
    AMCSPayMobillsIvrResponse:
      type: object
      properties:
        customerGuid:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        customerName:
          type: string
          example: Mark Smith
        customerBalance:
          type:
          - integer
          - 'null'
          example: '120.95'
        customerCurrency:
          type: string
          example: EUR
        invoiceDetails:
          type: object
          $ref: '#/components/schemas/AMCSPayInvoiceDetails'
        transactionReference:
          type:
          - string
          - 'null'
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        zipCode:
          type:
          - string
          - 'null'
          example: '00501'
        dueDate:
          type:
          - string
          - 'null'
          example: YYYY-MM-DD
        invoiceDate:
          type:
          - string
          - 'null'
          example: YYYY-MM-DD
        lastPaymentDate:
          type:
          - string
          - 'null'
          example: YYYY-MM-DD
        lastPaymentAmount:
          type:
          - string
          - 'null'
          example: '155.50'
        makePaymentLink:
          format: url
          type:
          - string
          - 'null'
          example: https://localhost/paybylink?key=092159d8-9e57-41a5-af6c-745bd45ff2f7
        isActive:
          type: boolean
          example: 'true'
        mobillsEnrollment:
          type: boolean
          example: 'true'
        guid:
          format: uuid
          type:
          - string
          - 'null'
          example: 00000000-0000-0000-0000-000000000000
    AMCSPayMobillsIvrRequest:
      type: object
      required:
      - customerARCode
      - channel
      - amount
      properties:
        customerARCode:
          type: string
          example: ACC1007
        channel:
          type: string
          example: MOBILL / IVR
      additionalProperties: false
    AMCSPayAccountDetailIvrResponse:
      type: object
      properties:
        creditBalanceAsTrue:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AMCSPayAccountDetailIvrResponseCreditBalanceResponse'
        creditBalanceAsFalse:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AMCSPayAccountDetailIvrResponseCreditBalanceAsFalse'
    AMCSPayErrorContentResponse:
      type:
      - string
      - 'null'
    AMCSPayIvrResponse:
      type: object
      example: Success
    AMCSPayPostBackIvrRequest:
      type: object
      required:
      - transactionReference
      - paymentAmount
      - currency
      - timestamp
      - transactionPaymentType
      - isIVR
      - code
      - description
      - bin
      - last4Digits
      - paymentType
      - holder
      - expiryMonth
      - expiryYear
      - confirmationNumber
      properties:
        transactionReference:
          type: string
          format: uuid
          example: c4521490-c0dd-40e5-94c6-afe90073aa1b
        paymentAmount:
          type: integer
          example: 10.2
        currency:
          type: string
          example: EUR
        timestamp:
          type: string
          format: datetime
          example: 2021-10-21-17:20:30
        transactionPaymentType:
          type: string
          example: Credit Card
        isIVR:
          type: boolean
          example: 'true'
        code:
          type: string
          example: 000.100.112
        description:
          type: string
          example: Request successfully processed in 'Merchant In Connect
        bin:
          type: string
          example: '545454'
        last4Digits:
          type: string
          example: '5454'
        paymentType:
          type: string
          example: DB
        holder:
          type: string
          example: SK_Test
        expiryMonth:
          type: string
          example: '06'
        expiryYear:
          type: string
          example: '2034'
        confirmationNumber:
          type: string
          format: uuid
          example: c4521490-c0dd-40e5-94c6-afe90073aa1b
      additionalProperties: false