LayUp Technologies PaymentProviderSettlementService API

openapi: 3.2.0
info:
  title: Layup endpoints AbsaDebiCheckService Payment Provider Settlement Service API
  version: 1.4.16
  description: 'Welcome to The Layup Swagger page. This page allows developers to interactively explore the API. For more detailed documentation see [The Layup documentation page](https://documentation.layup.co.za/).


    # Introduction


    ## What is LayUp


    LayUp is a lay-by payment solution. LayUp Schedules payments and ensures that your clients pay securely, effectively and on time. Depending on your parameters LayUp schedules a payment plan for your clients. Once a payment plan has been completed we notify you. There are 3 stories that are of importance to a merchant:


    1. Order Creation

    2. Deposit Received (and holding Stock for your client)

    3. Order Completion.


    LayUp allows you to take full control over the entire payment process if you wish to do so. We also provide a convenient front-end for users to use. The front-end should significantly reduce the time to integrate and get you started using LayUp as soon as possible.


    Once an order is completed a notification will be sent to the merchant so that you can provide the client with their product.


    ## How to use LayUp


    As a merchant who wants to place an order through LayUp, you want to send the relevant information to the LayUp API to create the order. The API will return an order ID. Unless your integration is using a custom user interface, you want to send the user to the LayUp customer payment widget. The URL for this widget is <u>https://shopper.layup.co.za/order/{orderId}</u> for production and <u>https://sandbox.layup.co.za/order/{orderId}</u> for sandbox.

    '
servers:
- url: http://localhost:3000
- url: https://localhost:3000
- url: wss://localhost:3000
security:
- apiKey:
  - read
  - write
tags:
- name: PaymentProviderSettlementService
paths:
  /v1/paymentProviderSettlements:
    post:
      operationId: PaymentProviderSettlementService_create
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/modelPaymentProviderSettlementsResponse'
        '204':
          description: Successfully processed the request, no content.
        '403':
          description: Returned when the user does not have permission to access the resource.
        '404':
          description: Returned when the resource does not exist.
      tags:
      - PaymentProviderSettlementService
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/modelPaymentProviderSettlementsRequest'
        required: true
  /v1/paymentProviderSettlements/link-batch:
    put:
      operationId: PaymentProviderSettlementService_linkBatch
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '204':
          description: Successfully processed the request, no content.
        '403':
          description: Returned when the user does not have permission to access the resource.
        '404':
          description: Returned when the resource does not exist.
      parameters:
      - name: ids
        in: query
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: bankTransactionBatchId
        in: query
        required: true
        schema:
          type: string
      tags:
      - PaymentProviderSettlementService
  /v1/paymentProviderSettlements/{id}/linkPayment/{paymentId}:
    put:
      operationId: PaymentProviderSettlementService_linkPayment
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/modelPaymentProviderSettlementResponse'
        '204':
          description: Successfully processed the request, no content.
        '403':
          description: Returned when the user does not have permission to access the resource.
        '404':
          description: Returned when the resource does not exist.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: paymentId
        in: path
        required: true
        schema:
          type: string
      tags:
      - PaymentProviderSettlementService
components:
  schemas:
    modelPaymentProviderSettlementsRequest:
      type: object
      properties:
        paymentProviderSettlements:
          type: array
          items:
            type: object
            $ref: '#/components/schemas/modelPaymentProviderSettlement'
    modelPaymentProviderSettlementResponse:
      type: object
      properties:
        amountInCents:
          type: integer
          format: int32
        reference:
          type: string
        paymentProvider:
          type: string
        paymentProviderPaymentId:
          type: string
        transactionDate:
          type: string
        paymentReference:
          type: string
        fileStorageReference:
          type: string
        paymentMethod:
          type: string
        feeInCents:
          type: integer
          format: int32
        _id:
          type: string
    modelPaymentProviderSettlement:
      type: object
      properties:
        amountInCents:
          type: integer
          format: int32
        reference:
          type: string
        paymentProvider:
          type: string
        paymentProviderPaymentId:
          type: string
        transactionDate:
          type: string
        paymentReference:
          type: string
        fileStorageReference:
          type: string
        paymentMethod:
          type: string
        feeInCents:
          type: integer
          format: int32
    modelPaymentProviderSettlementsResponse:
      type: object
      properties:
        settlements:
          type: array
          items:
            type: object
            $ref: '#/components/schemas/modelPaymentProviderSettlementResponse'
  securitySchemes:
    apiKey:
      type: apiKey
      name: apikey
      in: header