Payment Service

This API allows you to retrieve a list of payment services by payment channel. This enables extra controls of what payment services that you want to display on your application.

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|2141df4a3cb633d5ce8683bb0c55067e5caebfbe07390dde277dc455bcc95c91723a81b5e565c7c02d68fb84e396722563016bf99e576a4b8cdbe4423fbf226P 
}

Getting Payment Service List

Note that for B2C payment please use payment_model_reference_id = 1 while B2B is payment_model_reference_id = 2

B2B payment service list are only available for payment type WEB_PAYMENT. Jump to Getting B2B Payment Service List here

HTTP Method: POST

https://api.leanx.dev/api/v1/merchant/list-payment-services

Request Body

{
  "payment_type": "WEB_PAYMENT",
  "payment_status": "active",
  "payment_model_reference_id": 1
}

Attributes

Property	Type	Description
payment_type*	String	Payment service type WEB_PAYMENT = Web Payment (FPX) GLOBAL_CARD_PAYMENT = Card DIGITAL_PAYMENT = E-Wallet BUY_NOW_PAY_LATER = Buy Now Pay Later SWITCH_PAYPAL = PayPal GLOBAL_CARD_PAYMENT_STRIPE = Stripe
payment_model_reference_id*	String	The web payment (FPX) channel 1 = B2C 2 = B2B If using other payment type than WEB_PAYMENT , please use 1 = Default
payment_status*	String	Payment service channel status active or inactive

Response

{
  "response_code": 2000,
  "description": "SUCCESS",
  "app_version": "/api/v1",
  "talk_to_server_before": "2023-11-28T19:22:13.243431",
  "data": {
    "list": {
      "draw": 25,
      "record_total": 25,
      "record_filtered": 25,
      "data": [
        {
          "WEB_PAYMENT": [
            {
              "payment_service_id": 16,
              "payment_model_reference_id": 1,
              "payment_model_reference": "B2C",
              "unique_reference": "AFFIN_BANK_WEBPAY",
              "payment_service": "WEB_PAYMENT",
              "name": "Affin Bank",
              "record_status_id": 1,
              "record_status": "ACTIVE"
            },
            ...........
            {
              "payment_service_id": 85,
              "payment_model_reference_id": 1,
              "payment_model_reference": "B2C",
              "unique_reference": "UOB_TESTID_WEBPAY",
              "payment_service": "WEB_PAYMENT",
              "name": "United Overseas Bank - B2C Test",
              "record_status_id": 1,
              "record_status": "ACTIVE"
            }
          ]
        }
      ],
      "next_page_start": null,
      "next_page_length": null,
      "previous_page_start": null,
      "previous_page_length": null
    }
  },
  "breakdown_errors": null,
  "token": ""
}

Getting Payment Service List (FPX B2B)

HTTP Method: POST

https://api.leanx.dev/api/v1/merchant/list-payment-services

Request Body

{
  "payment_type": "WEB_PAYMENT",
  "payment_status": "active",
  "payment_model_reference_id": 2
}

Attributes

Property	Type	Description
payment_type*	String	Payment service type WEB_PAYMENT = Web Payment (FPX)
payment_model_reference_id*	String	The web payment (FPX) channel 2 = B2B
payment_status*	String	Payment service channel status active or inactive

Response

{
  "response_code": 2000,
  "description": "SUCCESS",
  "app_version": "/api/v1",
  "talk_to_server_before": "2023-12-05T14:38:08.409962",
  "data": {
    "list": {
      "draw": 24,
      "record_total": 24,
      "record_filtered": 24,
      "data": [
        {
          "WEB_PAYMENT": [
            {
              "payment_service_id": 60,
              "payment_model_reference_id": 2,
              "payment_model_reference": "B2B1",
              "unique_reference": "AFFIN_BANK_B2B1_WEBPAY",
              "payment_service": "WEB_PAYMENT",
              "name": "Affin Bank Staging",
              "record_status_id": 1,
              "record_status": "ACTIVE"
            },
            ........
            {
              "payment_service_id": 86,
              "payment_model_reference_id": 2,
              "payment_model_reference": "B2B1",
              "unique_reference": "AFFIN_BANK_AFFINMAX_B2B1_WEBPAY",
              "payment_service": "WEB_PAYMENT",
              "name": "AFFINMAX",
              "record_status_id": 1,
              "record_status": "ACTIVE"
            }
          ]
        }
      ],
      "next_page_start": null,
      "next_page_length": null,
      "previous_page_start": null,
      "previous_page_length": null
    }
  },
  "breakdown_errors": null,
  "token": ""
}