LianLian Global Operations API

swagger: '2.0'
info:
  title: Distribution Account Operations API
  version: '1.0'
host: global-api-sandbox.lianlianpay-inc.com
basePath: /b2b-import/v1
schemes:
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: Operations
paths:
  /file/{id}:
    parameters:
    - schema:
        type: string
      name: id
      in: path
      required: true
      description: File ID
    get:
      summary: Download File
      tags:
      - Operations
      responses:
        '200':
          description: OK
          content:
            application/octet-stream:
              schema:
                type: string
                description: File data streaming.
              examples: {}
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
        ? ''
        : description: ''
          headers: {}
          content:
            application/octet-stream:
              schema:
                type: string
                description: File data streaming.
      operationId: download-File
      description: Download File by `id`.
  /ew-files:
    parameters: []
    get:
      summary: Get list of Files
      operationId: get-files
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: string
                    description: Total data number.
                  page_list:
                    type: array
                    items:
                      $ref: '#/components/schemas/File'
      parameters: []
      tags:
      - Operations
      description: Get list of Files.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: File ID.
                name:
                  type: string
                  description: A file name in the server, require exact match.
                title:
                  type: string
                  description: User naming the file when uploading, require exact match
                page_number:
                  type: integer
                  description: The query page number.
                page_size:
                  description: The default value is 20. A maximum of 100 data items can be displayed on a page.
                  type: integer
                start_time:
                  description: File object creation period start time.
                  type: integer
                end_time:
                  description: File object creation period end time.
                  type: integer
        description: ''
  /file/upload:
    parameters: []
    post:
      summary: Upload File
      operationId: upload-file
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      description: 'Upload a file to LianLian Global''s server. The max size of an upload file is up to 10MB.

        When you upload a file, the API responds with a `id`.

        This `id` will be referenced as required as part of the `File Folder` object.


        Allowed file types:

        `application/x-rar-compressed` `application/zip` `application/pdf` `image/jpeg` `image/png`


        '
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
          application/json:
            schema:
              $ref: '#/components/schemas/File'
          application/xml:
            schema:
              type: object
              properties: {}
          text/html:
            schema:
              type: object
              properties:
                file:
                  type: object
                size:
                  type: string
          text/plain:
            schema:
              type: object
              properties: {}
          application/EDI-X12:
            schema:
              type: object
              properties: {}
          application/EDIFACT:
            schema:
              type: object
              properties: {}
          application/atom+xml:
            schema:
              type: object
              properties: {}
        description: 'file : File stream, A maximum of 10 MB files are supported. Empty files are not allowed.<br>

          extension_info : json object structure is {"notes":"notes descn","title":"1fzip"}.

          <br><br>

          notes : The notes of the file, max length is 128 characters. <br>

          title : User naming the file when uploading.'
      x-internal: false
      tags:
      - Operations
      parameters:
      - schema:
          type: string
        in: query
        name: file
        description: File stream, A maximum of 10 MB files are supported. Empty files are not allowed.
        required: true
      - schema:
          type: string
        in: query
        name: notes
        description: The notes of the file, max length is 128 characters.
      - schema:
          type: string
        in: query
        name: title
        description: User naming the file when uploading.
  /ew-balances:
    parameters: []
    get:
      summary: Get list of Balances
      tags:
      - Operations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Balance'
              examples: {}
        '400':
          description: Bad Request
        ? ''
        : content:
            application/json:
              schema:
                $ref: '#/components/schemas/Balance'
      operationId: get-balance
      description: "#### Demo for java SDK\n```java\n//create an API service as native Object\nBalanceReadService service = GatewayProxyFactory.getInstance().create(BalanceReadService.class, config);\n//init your API call parameter\nBaseOpenApiReq req = new BaseOpenApiReq();\n//invoke api as native call and get the deserialized result Object\nRichOpenRes<List<BalanceDetailRes>> res = service.list(req);\n//if invoke succeed do your business\nif (res.isSuccess()) {\n    //do your business here\n    System.out.println(res);\n    System.out.println(JSONObject.toJSON(res));\n    if (res.getModel() != null) {\n        System.out.println(\"return balance list:\");\n        res.getModel().forEach(e -> {\n            System.out.println(\"accountId:\" + e.getAccountId() + \"\\t\\t\" + \"accountId:\" + e.getAccountId() + \"\\t\\t\" + \"availableAmount:\" + e.getAvailableAmount());\n        });\n    }\n} else {//if invoked error check the return error message and do your error handler\n    //error handler\n    System.out.println(\"there is a error for API invoke, the detail message is:\");\n    System.out.println(\"error:\" + res.getError());\n    System.out.println(\"message:\" + res.getMessage());\n    System.out.println(\"success:\" + res.isSuccess());\n    System.out.println(\"code:\" + res.getCode());\n}\n```"
      parameters: []
      x-internal: false
  /ew-balances-with-settings:
    parameters: []
    get:
      summary: Get List of Balances With Settings
      tags:
      - Operations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BalanceWithSetting'
      operationId: get-ew-balances-with-settings
      description: Get list of balances and with the account settings.
  /ew-conversions:
    parameters: []
    post:
      summary: Create a Conversion
      operationId: post-conversion
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Conversion'
        '400':
          description: Bad Request
      tags:
      - Operations
      requestBody:
        content:
          application/json:
            schema:
              $ref: ./CommonModel.json#/components/schemas/ConversionRequest
      description: 'Create a new `Conversion` to be executed. To associate a conversion with a `Payout`, use the Payout API.

        Note: On a conversion, both `buy_currency` and `sell_currency` will be populated, but define only one of either `buy_amount` or `sell_amount`. '
  /ew-conversions/{request_id}:
    parameters:
    - schema:
        type: string
      name: request_id
      in: path
      required: true
    get:
      summary: Get Conversion by Request_ID
      tags:
      - Operations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Conversion'
        '400':
          description: Bad Request
      operationId: get-conversion-conversion_id
      parameters: []
      description: Get detail of a `Conversion` transaction.
  /ew-agreements/signing:
    parameters: []
    post:
      summary: Start a New Agreement Signing
      operationId: post-ew-payees-registrationation
      tags:
      - Operations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                x-examples:
                  example-1:
                    id: string
                    merchant_client_id: string
                    status: need_info
                    registration_url: string
                    shop_url: string
                    note: string
                    registration_complete: true
                properties:
                  id:
                    type: string
                    description: 'LianLian `Network Contact` Object ID. Merchant shall use this ID to contact LianLian for any payment issues.


                      Non-existant if `signing_complete` is false.'
                  merchant_client_id:
                    type: string
                    description: Client's ID for this Merchant.
                  merchant_client_name:
                    type: string
                    description: Merchant name as known by the client platform.
                  signing_url:
                    type: string
                    description: 'URL to redirect merchant to in order to start agreement signing on LianLian platform.


                      Non-existent if `signing_complete` is true.'
                  additional_info:
                    type: array
                    description: Additional info to be used by customer support if needed.
                    items:
                      $ref: ./Items.json#/components/schemas/Item
                  signing_complete:
                    type: boolean
                    description: State of merchant signing process.
                  agreement_no:
                    type: string
                    description: Unique identifier for the `Agreement` created by the LianLian Global.
        ? ''
        : description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: 'LianLian `Network Contact` Object ID. Merchant shall use this ID to contact LianLian for any payment issues.


                      Non-existant if `signing_complete` is false.'
                  merchant_client_id:
                    type: string
                    description: Client's ID for this Merchant.
                  signing_url:
                    type: string
                    description: 'URL to redirect merchant to in order to start agreement signing on LianLian platform.


                      Non-existent if `signing_complete` is true.'
                  additional_info:
                    type: array
                    description: Additional info to be used by customer support if needed.
                    items:
                      $ref: ./Items.json#/components/schemas/Item
                  signing_complete:
                    type: boolean
                    description: State of merchant registration process.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              x-examples:
                example-1:
                  store_name: string
                  redirect_url: string
                  shop_url: string
                  merchant_client_id: string
                  note: string
              properties:
                merchant_client_id:
                  type: string
                  description: Merchant ID as known by the client platform.
                merchant_client_name:
                  type: string
                  description: Merchant name as known by the client platform.
                country_code:
                  type: string
                  description: Two-letter [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) country code of counterparty.
                  enum:
                  - US
                  - VN
                  - SG
                  - ID
                  - PH
                  - KH
                  - MY
                  - KR
                  - AU
                  - AE
                  - DE
                  - FR
                  - IT
                  - NL
                  - BE
                  - LU
                  - IE
                  - ES
                  - PT
                  - AT
                  - FI
                  - LT
                  - LV
                  - EE
                  - SK
                  - SI
                  - GR
                  - MT
                  - CY
                  - PL
                  - TH
                  - GB
                  - CN
                  - HK
                agreement_type:
                  type: string
                  description: Signing agreement type.
                  enum:
                  - ECOMMERCE-SEND-PAYMENT
                  - BILL-DIRECT-DEBIT
                redirect_url:
                  type: string
                  description: URL Lianlian will redirect to at the end of a successful signing process.
                additional_info:
                  type: array
                  description: 'Additional info to be used by customer support if needed.<br>

                    When `agreement_type` is `ECOMMERCE-SEND-PAYMENT`, 3 name keys are established.<br>

                    1. cert_no:The Cert number of counterparty on client side. <br>

                    2. store_name:Store name as known by the calling platform. <br>

                    3. shop_url:URL of merchant store if URL can’t be algorithmically produced from merchant_id.'
                  items:
                    $ref: '#/components/schemas/SigningInfo'
              required:
              - merchant_client_id
              - country_code
              - agreement_type
              - redirect_url
        description: ''
  /ew-agreements/merchant-client-id:
    parameters: []
    get:
      summary: Get Agreement By Merchant Client ID
      tags:
      - Operations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SigningInfo'
            application/xml:
              schema:
                $ref: '#/components/schemas/SigningInfo'
            multipart/form-data:
              schema:
                type: object
                properties:
                  ? ''
                  : $ref: '#/components/schemas/SigningInfo'
                  app_auth_info:
                    $ref: '#/components/schemas/AppAuthInfo'
      operationId: get-ew-contracts-merchant_client_id
      parameters:
      - schema:
          type: string
        in: query
        name: merchant_client_id
        description: Merchant ID as known by the client platform.
        required: true
      - schema:
          type: string
          enum:
          - ECOMMERCE-SEND-PAYMENT
          - BILL-DIRECT-DEBIT
        in: query
        name: agreement_type
        description: Signing agreement type.
        required: true
      description: Get `Agreement` by merchant_client_id
  /ew-folders/{id}:
    parameters:
    - schema:
        type: string
      name: id
      in: path
      required: true
      description: File Floder ID
    get:
      summary: Get File Folder Info by ID
      tags:
      - Operations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileFolder'
              examples: {}
        '400':
          description: Bad Request
      operationId: get-file
      description: Get File Floder Info by ID.
      parameters: []
    delete:
      summary: Delete File Folder Info by ID
      operationId: delete-Folder-id
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
      description: Delete `File Folder` Info by ID. This method only delete File Floder object, not the files associated with it.
      tags:
      - Operations
  /ew-folders:
    parameters: []
    post:
      summary: Create File Folder Info
      operationId: create-file
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileFolder'
        '400':
          description: Bad Request
      description: create a new `File Floder` with multiple `File` refrence.
      requestBody:
        content:
          application/json:
            schema:
              $ref: ./CommonModel.json#/components/schemas/FileRequest
          application/xml:
            schema:
              $ref: '#/components/schemas/File'
        description: ''
      tags:
      - Operations
  /ew-conversions/lockfx:
    parameters: []
    post:
      summary: Create a LockFX Quote
      operationId: post-lockfx
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExchangeRate'
              examples:
                example:
                  value:
                    rate_id: string
                    rate: string
                    base_currency: string
                    sell_currency: string
                    buy_currency: string
                    validity: T_0
                    valid_strarting_after: string
                    valid_ending_before: string
      tags:
      - Operations
      requestBody:
        content:
          application/json:
            schema:
              $ref: ./CommonModel.json#/components/schemas/LockFXRequest
            examples: {}
          application/xml:
            schema:
              type: object
              properties: {}
          multipart/form-data:
            schema:
              type: object
              properties: {}
          text/html:
            schema:
              type: object
              properties: {}
          text/plain:
            schema:
              type: object
              properties: {}
        description: ''
      parameters: []
      description: Lock quote.
  /ew-contacts/bank/{id}:
    parameters:
    - schema:
        type: string
      name: id
      in: path
      required: true
    get:
      summary: Get a Bank Account Contact
      tags:
      - Operations
      operationId: get-beneficiary-info
      description: Get a specific bank account contact by the `contact _id`.
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Payee'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankAccountContact'
              examples:
                BankAccount Payee:
                  value:
                    address:
                      country_code: NL
                      city: gerg
                      postcode: '32432'
                      state: e
                      line2: asda
                      line1: add
                    entity_type: CORPORATE
                    type: BANK_ACCOUNT
                    bank_info:
                      account_number: DE75512108001245126199
                      account_currency: EUR
                      bank_country_code: NL
                      swift_code: '45346364363'
                      routing_info:
                      - {}
                      iban: DE75512108001245126199
                      bank_address: NL
                      holder_type: CORPORATE
                      holder_name: dsdfgdfg
                    user_id: '2022042512674869'
                    base_info:
                      country_code: NL
                      corporate_name: dsgdgdsgf
                      email: idra@foxmail.com
                    id: '910036527140438742016'
                    status: ACCEPTED
                Network Payee:
                  value:
                    type: NETWORK
                    entity_type: INDIVIDUAL
                    user_id: '2022042512674869'
                    base_info:
                      country_code: US
                      last_name: Last
                      middle_name: Middle
                      first_name: First
                    id: '910037275098575475712'
                    status: ACCEPTED
        '400':
          description: Bad Request
    delete:
      summary: Delete a Bank Account Contact
      operationId: delete-payees-payee_id
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
        '500':
          description: Internal Server Error
      description: Delete a specific bank account contact by the `contact_id`.
      tags:
      - Operations
      parameters: []
  /ew-contacts/bank:
    parameters: []
    post:
      summary: Create a New Bank Account Contact
      operationId: post-payee
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Payee'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankAccountContact'
              examples:
                example-1:
                  value:
                    address:
                      country_code: NL
                      city: gerg
                      postcode: '32432'
                      state: e
                      line2: asda
                      line1: add
                    entity_type: CORPORATE
                    bank_info:
                      account_number: DE75512108001245126199
                      account_currency: EUR
                      bank_country_code: NL
                      swift_code: '45346364363'
                      routing_info:
                      - {}
                      iban: DE75512108001245126199
                      bank_address: NL
                      holder_type: CORPORATE
                      holder_name: dsdfgdfg
                    user_id: '2022042512674869'
                    base_info:
                      country_code: NL
                      corporate_name: dsgdgdsgf
                      email: idra@foxmail.com
                    id: '910036527140438742016'
                    status: ACCEPTED
        '400':
          description: Missing Required Information
          schema:
            type: 'null'
        ? ''
        : schema:
            $ref: '#/definitions/Payee'
      description: 'Create a new bank account `Contact` which will be audited by LianLian Global before that can be used in payout transaction.

        A notification of the audit result will be sent by Webhook after subscribing the payee related event `Contact`.'
      parameters:
      - in: body
        name: body
        schema:
          '0':
            allOf: []
            type: string
          description: ''
          type: object
          x-examples:
            example-1:
              payee_id: string
              payee_type: CORPORATE
              payee_info:
                corporate_name: string
                corporate_registration_number: string
                corporate_contact_number: string
                individual_first_name: string
                individual_last_name: string
                individual_id_number: string
                date_of_birth: string
                email_address: string
              address:
                country_code: string
                city: string
                state: string
                street_address: string
                post_code: string
              bank_account_info:
                account_currency: string
                account_name: string
                account_number: string
                bank_country_code: string
                bank_name: string
                bank_branch_name: string
                bank_address: string
                swift_code: string
                bank_routing_type: SORT
                bank_routing_number: string
              payout_method: LOCAL
              file_id: string
              status: REJECTED
          properties:
            payee_id:
              type: string
              description: Unique identifier for the payee
            payee_type:
              type: string
              description: Payee type, one of `INDIVIDUAL` and `CORPORATE`
              enum:
              - CORPORATE
              - INDIVIDUAL
            payee_info:
              type: object
              description: Payee type, one of INDIVIDUAL and
              properties:
                corporate_name:
                  type: string
                  description: Corporate name, mandatory if `payee_type` = `CORPORATE`
                corporate_registration_number:
                  type: string
                  description: Corporate registratioin number
                corporate_contact_number:
                  type: string
                  description: Contact number for corporate
                individual_first_name:
                  type: string
                  description: Individual first name, mandatory if `payee_type` = `INDIVIDUAL`
                individual_last_name:
                  type: string
                  description: Individual last name, mandatory if `payee_type` = `INDIVIDUAL`
                individual_id_number:
                  type: string
                  description: Personal ID number of Payee
                date_of_birth:
                  type: string
                  description: Payee's date of birth
                email_address:
                  type: string
                  description: Payee email
            address:
              type: object
              description: Payee's address detail
              properties:
                country_code:
                  type: string
                  description: Payee's country code, two-letter [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) country code.
                city:
                  type: string
                  description: Payee's city
                state:
                  type: string
                  description: Payee's state
                street_address:
                  type: string
                  description: Payee's street address
                post_code:
                  type: string
                  description: Payee's post code
            bank_account_info:
              type: object
              properties:
                account_currency:
                  type: string
                  description: Account currency(in three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format)
                account_name:
                  type: string
                  description: Account name
                account_number:
                  type: string
                  description: Account number
                bank_country_code:
                  type: string
                  description: Bank country code, two-letter [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) country code.
                bank_name:
                  type: string
                  description: Bank name
                bank_branch_name:
                  type: string
                  description: Bank branch name
                bank_address:
                  type: string
                  description: Bank detail address
                swift_code:
                  type: string
                  description: Bank SWIFT code
                bank_routing_type:
                  type: string
                  description: Routing number type
                  enum:
                  - SORT
                  - ABA
                  - ZENGIN
                  - BSB
                bank_routing_number:
                  type: string
                  description: Routing code
                iban:
                  type: string
                  description: International bank account number
              required:
              - account_currency
              - account_name
              - bank_country_code
              - bank_name
            payout_method:
              type: string
              minLength: 1
            file_id:
              type: string
              minLength: 1
          required:
          - payee_id
          - payee_type
        description: ''
        x-examples: {}
      tags:
      - Operations
      requestBody:
        content:
          application/json:
            schema:
              $ref: ./CommonModel.json#/components/schemas/PayeeRequest
            examples:
              example-1:
                value:
                  id: string
                  type: CORPORATE
                  base_info:
                    corporate_name: string
                    corporate_registration_number: string
                    corporate_contact_number: string
                    first_name: string
                    last_name: string
                    id_number: string
                    date_of_birth: string
                    email: string
                  address:
                    country_code: st
                    city: string
                    state: string
                    line1: string
                    line2: string
                    postcode: string
                    street_address: string
                  bank_info:
                    id: string
                    holder_name: string
                    holder_type: string
                    account_currency: string
                    account_number: string
                    bank_name: string
                    bank_address: string
                    bank_country_code: string
                    branch_name: string
                    bank_phone: string
                    swift_code: string
                    iban: string
                    routing_info:
                    - bank_routing_type: ABA
                      bank_routing_number: string
                  payout_method: LOCAL
                  file_id:
                  - string
                  status: REJECTED
          application/xml:
            schema:
              $ref: '#/components/schemas/PayeeRequest'
        description: ''
  /ew-contacts/bank/merchant-client-id/{merchant_client_id}:
    parameters:
    - schema:
        type: string
      name: merchant_client_id
      in: path
      required: true
    get:
      summary: Get a Bank Account Contact by Merchant Client Id
      tags:
      - Operations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/

# --- truncated at 32 KB (470 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lianlian-global/refs/heads/main/openapi/lianlian-global-operations-api-openapi.yml