API Docs
  • Introduction
  • Credential
  • Error Codes
  • Token Validation
  • Signature Validation
  • Quick Start
    • Accepting via Payment Page
    • Accepting Using Own Page
    • Paying Out
  • ACCOUNT
    • Pool Balance
  • Cloud Payment
    • Payment Service
    • Collection
      • Create Collection
      • Manage
        • Get Collection List
        • Get a Collection
        • Update Collection
        • Activate Collection
        • Deactivate Collection
        • Delete Collection
    • Bill
      • Create Bill
      • Callback
      • Manage
        • Get Bill List
        • Get a Bill
        • Get Bill Transaction Status
        • Update Bill
        • Delete Bill
    • Transaction List
    • Transaction Status
  • Payout
    • Payout Service
    • Payout Transaction List
    • Create Payout
    • Payout Status
      • Callback
      • Status Checking
    • Bank Account Verification
      • Bank Verification Channel ( Deprecated )
      • Bank Account Validation
  • Suite Plugin
    • Woocommerce
    • Open Cart
  • Library
    • Credit Card
  • SUPPORT
    • Frequently Asked Question
Powered by GitBook
On this page
  • Authentication
  • Step 1 : Getting Payment Page URL
  • Step 2 : Getting transaction status
  1. Quick Start

Accepting via Payment Page

By following these steps, you can quickly integrate payment collection into your applications using our payment page. This method is efficient and requires minimal integration effort

Authentication

LeanX uses Auth Token to authenticate in each request's header.

Auth Token can be retrieved in your portal dashboard under API page.

Request Header

{
    "auth-token": "LP-0D7C06DE-MM|7394e58e-edee-4c42-9ca5-bcbc449f1b9f|2141df4a3cb633d5ce8683bb0c55067e5caebfbe07390dde277dc455bcc95c91723a81b5e565c7c02d68fb84e396722563016bf99e576a4b8cdbe4423fbf226b"
}

Step 1 : Getting Payment Page URL

This will create a bill and return a URL to our LeanX Payment page.

HTTP Method: POST

https://api.leanx.dev/api/v1/merchant/create-bill-page

Query

Query
Type
Description

invoice_no

String

Your bill number

Request Body

{
  "collection_uuid": "DP-1F6762F9E4-LX",
  "amount": 119.00,
  "invoice_ref": "INV023312312",
  "redirect_url": "https://www.yourdomain.com/return-page",
  "callback_url": "https://www.yourdomain.com/api-callback-url",
  "full_name": "puteri balqis",
  "email": "puteri.balqis@gmail.com",
  "phone_number": "0112459822"
}

Attributes

Property
Type
Description

collection_uuid*

String

amount*

Decimal (10,2)

Total amount to be paid in MYR

invoice_ref*

String

Merchant Invoice Reference

callback_url

String

Your callback URL

redirect_url*

String

Your redirect URL

full_name*

String

Name of the payer

email*

String

Email of the payer

phone_number*

String

Mobile number of the payer

Response

{
  "response_code": 2000,
  "description": "SUCCESS",
  "app_version": "/api/v1",
  "talk_to_server_before": "2023-11-28T17:06:33.905941",
  "data": {
    "collection_uuid": "DP-1F6762F9E4-LX",
    "redirect_url": "https://www.yourdomain.com/return-page",
    "bill_no": "bpdp-0C7D3D2826-lx",
    "invoice_ref": "INV023312312"
  },
  "breakdown_errors": "",
  "token": ""
}

Step 2 : Getting transaction status

This API provides a link to retrieve the status of previous transactions, encompassing all payment statuses.

HTTP Method: POST

https://api.leanx.dev/api/v1/merchant/manual-checking-transaction

Request Query

?invoice_no=BP-AD5112621A-LNP

Attributes

Property
Type
Description

invoice_no

string

The transaction invoice number for which you want to retrieve the status can be either a system-generated invoice number or an invoice_ref added by the merchant.

Response

{
  "response_code": 2000,
  "description": "SUCCESS",
  "app_version": "/api/v1",
  "talk_to_server_before": "2024-03-29T15:59:17.597177",
  "data": {
    "transaction_details": {
      "invoice_no": "BP-AD5112621A-LNP",
      "fpx_invoice_no": "FPX17116902144iiAlu58",
      "amount": "15.00",
      "invoice_status": "SUCCESS",
      "providerTypeReference": "FPX",
      "bank_provider": "Maybank2U",
      "category_code": "WEBPAY",
      "amount_with_fee": 15.80,
      "fee": 0.80,
      "fee_by_customer": false
    },
    "customer_details": {
      "name": "Ahmad Fuad",
      "phone_number": "0123249478",
      "email": "ahmadfuadzamri@gmail.com"
    }
  },
  "breakdown_errors": "",
  "token": ""
}

PreviousSignature ValidationNextAccepting Using Own Page

Last updated 9 months ago

Your UUID

Collection