find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/layup-technologies-settlementservice-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Layup endpoints AbsaDebiCheckService 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: SettlementService
paths:
  /v2/settlements:
    post:
      operationId: SettlementService_Create
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/modelSettlementResponse'
        '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: query
        required: false
        schema:
          type: string
      - name: taskToken
        in: query
        required: false
        schema:
          type: string
      tags:
      - SettlementService
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/modelSettlementRequest'
        required: true
  /v2/settlements-report:
    get:
      operationId: SettlementService_GetReport
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/modelSettlementReportResponse'
        '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: limit
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: skip
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: fromDate
        in: query
        required: false
        schema:
          type: string
      - name: toDate
        in: query
        required: false
        schema:
          type: string
      - name: search
        in: query
        required: false
        schema:
          type: string
      - name: sort
        in: query
        required: false
        schema:
          type: string
      tags:
      - SettlementService
  /v3/settlement-reports/{merchantId}/{settlementReferenceWithExtension}:
    get:
      summary: Redirect to pre-signed URL
      operationId: SettlementService_DownloadReport
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/modelSettlementDownloadResponse'
        '204':
          description: Successfully processed the request, no content.
        '302':
          description: Redirect to the pre-signed S3 URL
          headers:
            Location:
              description: The pre-signed S3 URL
              schema:
                type: string
                format: uri
          content:
            application/json:
              schema: {}
        '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: merchantId
        in: path
        required: true
        schema:
          type: string
      - name: settlementReferenceWithExtension
        description: reference.zip
        in: path
        required: true
        schema:
          type: string
      tags:
      - SettlementService
components:
  schemas:
    modelSettlementReport:
      type: object
      properties:
        id:
          type: string
        amount:
          type: number
          format: double
        batch:
          type: number
          format: double
        batchType:
          type: string
        merchantId:
          type: string
        status:
          type: string
        reference:
          type: string
        settledAt:
          type: string
        reconciled:
          type: boolean
    modelSettlementResponse:
      type: object
      properties:
        _id:
          type: string
        amount:
          type: number
          format: double
        fee:
          type: number
          format: double
        batch:
          type: string
        merchantId:
          type: string
        merchantAccountId:
          type: string
        reference:
          type: string
        dateSettled:
          type: string
        reconciled:
          type: boolean
        settled:
          type: boolean
        paymentIds:
          type: array
          items:
            type: string
        journalFees:
          type: array
          items:
            type: string
        batchType:
          type: string
        absaEftFile:
          type: string
        bankTransactionId:
          type: string
        createdAt:
          type: string
        updatedAt:
          type: string
        draft:
          type: boolean
    modelSettlementRequest:
      type: object
      properties:
        merchantId:
          type: string
        to:
          type: string
        from:
          type: string
        batchType:
          type: string
        automatic:
          type: boolean
        negative:
          type: boolean
        preview:
          type: boolean
    modelSettlementDownloadResponse:
      type: object
      properties:
        url:
          type: string
          title: The location that the user will be redirected to
    modelSettlementReportResponse:
      type: object
      properties:
        settlements:
          type: array
          items:
            type: object
            $ref: '#/components/schemas/modelSettlementReport'
  securitySchemes:
    apiKey:
      type: apiKey
      name: apikey
      in: header