LianLian Global Operations API
The Operations API from LianLian Global — 117 operation(s) for operations.
GET
/file/{id}
Download File
#
GET
/ew-files
Get list of Files
#
POST
/file/upload
Upload File
#
GET
/ew-balances
Get list of Balances
#
GET
/ew-balances-with-settings
Get List of Balances With Settings
#
POST
/ew-conversions
Create a Conversion
#
GET
/ew-conversions/{request_id}
Get Conversion by Request_ID
#
POST
/ew-agreements/signing
Start a New Agreement Signing
#
GET
/ew-agreements/merchant-client-id
Get Agreement By Merchant Client ID
#
GET
/ew-folders/{id}
Get File Folder Info by ID
#
DELETE
/ew-folders/{id}
Delete File Folder Info by ID
#
POST
/ew-folders
Create File Folder Info
#
POST
/ew-conversions/lockfx
Create a LockFX Quote
#
GET
/ew-contacts/bank/{id}
Get a Bank Account Contact
#
DELETE
/ew-contacts/bank/{id}
Delete a Bank Account Contact
#
POST
/ew-contacts/bank
Create a New Bank Account Contact
#
GET
/ew-contacts/bank/merchant-client-id/{merchant_client_id}
Get a Bank Account Contact by Merchant Client Id
#
DELETE
/ew-contacts/bank/merchant-client-id/{merchant_client_id}
Delete a Bank Account Contact by Merchant Client Id
#
GET
/ew-contacts/clearing-rules
Clearing Rules
#
GET
/ew-contacts/network/{id}
Get a Network Contact
#
DELETE
/ew-contacts/network/{id}
Delete a Network Contact
#
POST
/ew-contacts/network
Create a New Network Contact
#
GET
/ew-contacts/network/merchant-client-id/{merchant_client_id}
Get a Network Contact by Merchant Client Id
#
DELETE
/ew-contacts/network/merchant-client-id/{merchant_client_id}
Delete a Network Contact by Merchant Client Id
#
GET
/ew-payouts/{request_id}
Get Payout by Request ID
#
POST
/ew-payouts
Create a Payout
#
POST
/ew-payouts-to-app
Create a payout to APP
#
GET
/ew-request-payments/{request_id}
Get Request Payment by Request ID
#
POST
/ew-request-payments
Create a New Request Payment
#
POST
/ew-request-payments/url
Request Payment Url
#
POST
/global/common/v1/account
Query Currency Account Available Balance
#
POST
/global/common/v1/account/list
Retrieve all balances
#
POST
/documents
Upload Document
#
GET
/documents/{documentId}
Download Document
#
GET
/events
Get Event List
#
GET
/events/{eventId}
Get Event
#
GET
/exchange/{exchangeId}
Get Exchange Info
POST
/exchange
Create a Currency Exchange
GET
/funding
Get List of Fundings
GET
/funding/{fundingId}
Get Funding by ID
#
PUT
/funding/{fundingId}
Return funding
#
GET
/marketrate
Get indicative market rate
#
GET
/lockrate
Create LockFX Rate
#
POST
/transaction
Create a transaction
#
GET
/transaction/{transactionId}
Get Transaction Info
#
POST
/payee
Create Payee
#
GET
/payee/{payeeId}
Get Payee Info
#
PUT
/payee/{payeeId}
Update the Payee Info
#
POST
/receipt
Create Receipt
GET
/receipt/{transactionId}
Get Receipt Info
POST
/tradefile
Create Trade File
#
GET
/tradefile/{tradeFileId}
Get Trade File Info
#
POST
/underlytradefile
Create Underlying Trade File
GET
/underlytradefile/{underlyTradeFileId}
Get Underlying Trade File
POST
/directransaction
Create a transation for the provided payee info
#
GET
/directransaction/{transactionId}
Get Direc Transaction Info
#
POST
/tradeFile
Create Trade File
#
GET
/tradeFile/{tradeFileId}
Get Trade File by trade file ID
#
POST
/vcc/apply
Apply VCC
GET
/vcc/{cardId}
Get VCC Info by Card ID
DELETE
/vcc/{cardId}
Block VCC
GET
/vcc/authTransaction
Get List of VCC Authorization Transacions
GET
/vcc/authTransaction/{transactionId}
Get VCC Authorization Transaction
GET
/vcc/settleTransaction
Get List of VCC Settlement Transactions
GET
/vcc/otp/{otpId}
Get VCC 3DS otp
#
POST
/webhooks
Register Webhook
#
GET
/webhooks
Get Webhook Registration List
#
GET
/webhooks/{webhookId}
Get Webhook Registration
#
DELETE
/webhooks/{webhookId}
Delete Webhook Registration
#
POST
/va/apply
Apply Virtual Account
POST
/va/supplement
Supplement Virtual Account
GET
/va/{accountId}
Get Virtual Account Info by ID
GET
/va/transaction
Get List of Virtual Account Debit Records
GET
/va/transaction/{transactionId}
Get Virtual Account Debit Record
GET
/va/verify/{transactionId}
Get Virtual Account Verify
GET
/virtualCard/{virtualAcctId}
Get Virtual Account Information
#
POST
/virtualCard/add
Create a Virtual Account
GET
/balance
Get Client Balance
#
POST
/merchants
Start New Merchant Registration
#
GET
/merchants/merchant_client_id/{merchant_client_id}
Get Merchant
#
POST
/payments
Send Payment to Merchant
#
GET
/payments/payment_client_id/{payment_client_id}
Get Payment
#
POST
/bill/add
CREATE UNASSIGNED BILL
#
POST
/bill
Create a Bill
#
POST
/bill/order
CREATE ASSIGNED BILL
#
POST
/refund/order
REFUND PAID BILL
#
GET
/refund/order
QUERY REFUND ORDER
#
POST
/trade/material/commit
自建站贸易材料真实性采集接口
#
GET
/bill/{billId}
Query Bill Info by BillID
#
PUT
/bill/{billId}
Edit the Payer Information
#
GET
/fundingtrans/{billId}
Query Funding Trans of Bill
#
GET
/refundingtrans/{refundingId}
Query Refunding Trans
#
POST
/refundingtrans
Create Refunding Trans
#
GET
/fundingtrans
Get List of Funding Trans
PUT
/exchange/{exchangeId}/cancel
Cancel Exchange Trans
#
GET
/exchangereturn/{exchangReturnId}
Query Exchange Return Trans
#
POST
/exchangereturn
Return Exchange Trans
#
GET
/exchange/{billId}
Query Bill Exchange Transaction
#
GET
/rate/{rateType}/{sourceCurrency}/{targetCurrency}
Get FX Rate
#
GET
/bc/va
Get BC VA Info
#
POST
/cnyva
Create a CNY Virtual Account
#
GET
/cnyva/{virtualAcctId}
Get CNY VA Information
#
GET
/fundingtrans/{fundingId}
Get Funding Trans by ID
#
POST
/paymenttrans
Create CNY Payment Transaction
#
GET
/paymenttrans/{paymentId}
Get CNY Payment Information
#
POST
/multipleExchange
Create Multiple FX Transactions
#
POST
/payer
Create a Payer
#
GET
/payer/{payerId}
Get Payer Info by PayerId
#
POST
/payout
Create Payout
#
GET
/payout/{payoutId}
Get Payout Detail
POST
/exchangepayout
Create Exchangepayout
GET
/exchangepayout/{payoutId}
Get Exchangepayout Detail
GET
/receipt/{receiptType}/{transactionId}
Get Receipt Info
#
POST
/tradeFile/supplementaryAttachment
Add Trade File Attachment
#
GET
/va/balance/{currency}
Get Currency Account Balance
GET
/vcc/card/authTransaction
Get List of VCC Card Authorization Transacions
GET
/vcc/card/authTransaction/{transactionId}
Get VCC Card Authorization Transaction
GET
/vcc/card/settleTransaction
Get List of VCC Card Settlement Transactions
GET
/outbound/card/v1/lockrate
Get Lock FX Rate
#
POST
/service-tradeFile
Create Trade File
#
GET
/service-tradeFile/{tradeFileId}
Get Trade File by trade file ID
#
POST
/tuitionevidences
Send Tuition Evidence
#
GET
/tuitionevidences/{billId}
Query Tuition evidence of Bill
#
POST
/payment
Create Payout
#
POST
/tradeinfo
Submit Trade File
#
POST
/get
Get Trade File Info
#
GET
/webhook/{webhookId}
Get Webhook Registration
#
DELETE
/webhook/{webhookId}
Delete Webhook Registration
#
POST
/apply
Submit Declaration
#
Specifications
Other Resources
Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Lianlian Global Operations API
version: '1.0'
description: 'Operations tagged Operations across 85 of this provider''s published API definitions: lianlian-global-e-wallet-openapi-attachment-openapi.yml, lianlian-global-e-wallet-openapi-balance-openapi.yml, lianlian-global-e-wallet-openapi-conversion-openapi.yml, lianlian-global-e-wallet-openapi-e-commerce-openapi.yml, lianlian-global-e-wallet-openapi-file-openapi.yml, lianlian-global-e-wallet-openapi-fx-openapi.yml, lianlian-global-e-wallet-openapi-payee4bankaccount-openapi.yml, lianlian-global-e-wallet-openapi-payee4network-openapi.yml, lianlian-global-e-wallet-openapi-payout-openapi.yml, lianlian-global-e-wallet-openapi-requestpayment-openapi.yml, lianlian-global-global-payout-balances-openapi.yml, lianlian-global-global-payout-document-openapi.yml, lianlian-global-global-payout-event-openapi.yml, lianlian-global-global-payout-exchange-openapi.yml, lianlian-global-global-payout-funding-openapi.yml, lianlian-global-global-payout-fx-exchange-openapi.yml, lianlian-global-global-payout-fx-fx-rate-openapi.yml, lianlian-global-global-payout-fx-rate-openapi.yml, lianlian-global-global-payout-fx-transaction-openapi.yml, lianlian-global-global-payout-payee-openapi.yml, lianlian-global-global-payout-receipt-openapi.yml, lianlian-global-global-payout-trade-file-openapi.yml, lianlian-global-global-payout-transaction-openapi.yml, lianlian-global-global-payout-tuition-event-openapi.yml, lianlian-global-global-payout-tuition-exchange-openapi.yml, lianlian-global-global-payout-tuition-funding-openapi.yml, lianlian-global-global-payout-tuition-payee-openapi.yml, lianlian-global-global-payout-tuition-transaction-openapi.yml, lianlian-global-global-payout-tuition-tuitionecidenceupd-openapi.yml, lianlian-global-global-payout-tuition-vcc-openapi.yml, lianlian-global-global-payout-tuition-webhook-openapi.yml, lianlian-global-global-payout-va-openapi.yml, lianlian-global-global-payout-vcc-openapi.yml, lianlian-global-global-payout-virtualaccount2-openapi.yml, lianlian-global-global-payout-webhook-openapi.yml, lianlian-global-llg-payments-client-openapi.yml, lianlian-global-llg-payments-merchant-openapi.yml, lianlian-global-llg-payments-payment-openapi.yml, lianlian-global-llp-api-platfrom-billpayment-openapi.yml, lianlian-global-llp-api-userapi-material-openapi.yml, lianlian-global-outbound-payout-billpay-openapi.yml, lianlian-global-outbound-payout-document-openapi.yml, lianlian-global-outbound-payout-event-openapi.yml, lianlian-global-outbound-payout-exchangetrans-openapi.yml, lianlian-global-outbound-payout-fxrate-openapi.yml, lianlian-global-outbound-payout-ka-bc-openapi.yml, lianlian-global-outbound-payout-ka-cny-va-openapi.yml, lianlian-global-outbound-payout-ka-document-openapi.yml, lianlian-global-outbound-payout-ka-event-openapi.yml, lianlian-global-outbound-payout-ka-exchangetrans-openapi.yml, lianlian-global-outbound-payout-ka-fxrate-openapi.yml, lianlian-global-outbound-payout-ka-payer-openapi.yml, lianlian-global-outbound-payout-ka-payout-openapi.yml, lianlian-global-outbound-payout-ka-receipt-openapi.yml, lianlian-global-outbound-payout-ka-tradefile-openapi.yml, lianlian-global-outbound-payout-ka-va-2-openapi.yml, lianlian-global-outbound-payout-ka-vcc-openapi.yml, lianlian-global-outbound-payout-ka-webhook-openapi.yml, lianlian-global-outbound-payout-payout-openapi.yml, lianlian-global-outbound-payout-service-cny-va-openapi.yml, lianlian-global-outbound-payout-service-document-openapi.yml, lianlian-global-outbound-payout-service-event-openapi.yml, lianlian-global-outbound-payout-service-exchangetrans-openapi.yml, lianlian-global-outbound-payout-service-fxrate-openapi.yml, lianlian-global-outbound-payout-service-payer-openapi.yml, lianlian-global-outbound-payout-service-payout-openapi.yml, lianlian-global-outbound-payout-service-receipt-openapi.yml, lianlian-global-outbound-payout-service-tradefile-openapi.yml, lianlian-global-outbound-payout-service-vcc-openapi.yml, lianlian-global-outbound-payout-service-webhook-openapi.yml, lianlian-global-outbound-payout-tuitionevidenceupd-openapi.yml, lianlian-global-outbound-payout-verification-cny-va-openapi.yml, lianlian-global-outbound-payout-verification-event-openapi.yml, lianlian-global-outbound-payout-verification-exchangetrans-openapi.yml, lianlian-global-outbound-payout-verification-payer-openapi.yml, lianlian-global-outbound-payout-verification-payout-openapi.yml, lianlian-global-outbound-payout-verification-tradefile-openapi.yml, lianlian-global-outbound-payout-verification-webhook-openapi.yml, lianlian-global-outbound-payout-webhook-openapi.yml, lianlian-global-standard-remittance-declare-openapi.yml, lianlian-global-standard-remittance-document-openapi.yml, lianlian-global-standard-remittance-event-openapi.yml, lianlian-global-standard-remittance-order-openapi.yml, lianlian-global-standard-remittance-payer-openapi.yml, lianlian-global-standard-remittance-tradefile-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://test-global-api.lianlianpay-inc.com/gateway/v1/
description: SANDBOX
- url: https://uk-api.lianlianglobal.com/gateway/v1/
description: UK PRD
- url: https://us-api.lianlianglobal.com/gateway/v1/
description: US PRD
- url: http://global-api-sandbox.lianlianpay-inc.com
- url: https://global-api-sandbox.lianlianpay-inc.com/common/v1
- url: http://global-api-sandbox.lianlianpay-inc.com/global/payout/v1
- url: https://global-api-sandbox.lianlianpay-inc.com/global/payout/v1
- url: http://global-api-sandbox.lianlianpay-inc.com/global/v1
- url: https://global-api.lianlianpay.com//global/payout/v1
- url: https://global-api-sandbox.lianlianpay-inc.com/payments/v2
- url: https://global-api-sandbox.lianlianpay-inc.com/api/v1/gateway
- url: https://gtest-open-api.lianlianpay-inc.com/api
- url: https://global-api.lianlianpay.com/outbound/bill/v1
- url: https://global-api-sandbox.lianlianpay-inc.com/common/V1
- url: https://global-api-sandbox.lianlianpay-inc.com/outbound/card/v1/
- url: https://global-api-sandbox.lianlianpay-inc.com
- url: https://global-api.lianlianpay.com/outbound/card/v1/
- url: https://gtest-open-api.lianlianpay-inc.com/remittance/outward/v2/declare
- url: https://gtest-open-api.lianlianpay-inc.com/remittance/outward/v2/order
- url: https://gtest-open-api.lianlianpay-inc.com/remittance/outward/payerinfo
- url: https://gtest-open-api.lianlianpay-inc.com/remittance/outward/v2/trade
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`.
servers:
- url: https://test-global-api.lianlianpay-inc.com/gateway/v1/
description: SANDBOX
- url: https://uk-api.lianlianglobal.com/gateway/v1/
description: UK PRD
- url: https://us-api.lianlianglobal.com/gateway/v1/
description: US PRD
/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: ''
servers:
- url: https://test-global-api.lianlianpay-inc.com/gateway/v1/
description: SANDBOX
- url: https://uk-api.lianlianglobal.com/gateway/v1/
description: UK PRD
- url: https://us-api.lianlianglobal.com/gateway/v1/
description: US PRD
/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.
servers:
- url: https://test-global-api.lianlianpay-inc.com/gateway/v1/
description: SANDBOX
- url: https://uk-api.lianlianglobal.com/gateway/v1/
description: UK PRD
- url: https://us-api.lianlianglobal.com/gateway/v1/
description: US PRD
/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
servers:
- url: https://test-global-api.lianlianpay-inc.com/gateway/v1/
description: SANDBOX
- url: https://uk-api.lianlianglobal.com/gateway/v1/
description: UK PRD
- url: https://us-api.lianlianglobal.com/gateway/v1/
description: US PRD
/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.
servers:
- url: https://test-global-api.lianlianpay-inc.com/gateway/v1/
description: SANDBOX
- url: https://uk-api.lianlianglobal.com/gateway/v1/
description: UK PRD
- url: https://us-api.lianlianglobal.com/gateway/v1/
description: US PRD
/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`. '
servers:
- url: https://test-global-api.lianlianpay-inc.com/gateway/v1/
description: SANDBOX
- url: https://uk-api.lianlianglobal.com/gateway/v1/
description: UK PRD
- url: https://us-api.lianlianglobal.com/gateway/v1/
description: US PRD
/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.
servers:
- url: https://test-global-api.lianlianpay-inc.com/gateway/v1/
description: SANDBOX
- url: https://uk-api.lianlianglobal.com/gateway/v1/
description: UK PRD
- url: https://us-api.lianlianglobal.com/gateway/v1/
description: US PRD
/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: ''
servers:
- url: https://test-global-api.lianlianpay-inc.com/gateway/v1/
description: SANDBOX
- url: https://uk-api.lianlianglobal.com/gateway/v1/
description: UK PRD
- url: https://us-api.lianlianglobal.com/gateway/v1/
description: US PRD
/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
servers:
- url: https://test-global-api.lianlianpay-inc.com/gateway/v1/
description: SANDBOX
- url: https://uk-api.lianlianglobal.com/gateway/v1/
description: UK PRD
- url: https://us-api.lianlianglobal.com/gateway/v1/
description: US PRD
/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
servers:
- url: https://test-global-api.lianlianpay-inc.com/gateway/v1/
description: SANDBOX
- url: https://uk-api.lianlianglobal.com/gateway/v1/
description: UK PRD
- url: https://us-api.lianlianglobal.com/gateway/v1/
description: US PRD
/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
servers:
- url: https://test-global-api.lianlianpay-inc.com/gateway/v1/
description: SANDBOX
- url: https://uk-api.lianlianglobal.com/gateway/v1/
description: UK PRD
- url: https://us-api.lianlianglobal.com/gateway/v1/
description: US PRD
/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.
servers:
- url: https://test-global-api.lianlianpay-inc.com/gateway/v1/
description: SANDBOX
- url: https://uk-api.lianlianglobal.com/gateway/v1/
description: UK PRD
- url: https://us-api.lianlianglobal.com/gateway/v1/
description: US PRD
/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: []
servers:
- url: https://test-global-api.lianlianpay-inc.com/gateway/v1/
description: SANDBOX
- url: https://uk-api.lianlianglobal.com/gateway/v1/
description: UK PRD
- url: https://us-api.lianlianglobal.com/gateway/v1/
description: US PRD
/ew-contacts/bank:
parameters: []
post:
summary: Create a New Bank Account Contact
operationId
# --- truncated at 32 KB (653 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lianlian-global/refs/heads/main/openapi/lianlian-global-operations-api-openapi.yml