Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

API to get list of all available card types

...

Method :

Status
colourGreen
titlePost
/api/v1/card-type

Aura button
paramseyJocmVmIjoiaHR0cDovL2FwaS5kZXYubWliby5jbG91ZDo5Mi9zd2FnZ2VyL2luZGV4Lmh0bWwiLCJocmVmVHlwZSI6ImxpbmsiLCJocmVmVGFyZ2V0IjoiX2JsYW5rIiwiYmFja2dyb3VuZCI6IiMzNDQ1NjMiLCJjb2xvciI6IiNGRkZGRkYiLCJsYWJlbCI6IlRyeSBpdCBvdXQiLCJib3JkZXJSYWRpdXMiOiIyNCIsIm91dGxpbmVkIjoib3V0bGluZWQiLCJpY29uUG9zaXRpb24iOiJsZWZ0Iiwic2l6ZSI6Im1lZGl1bSIsImVsZXZhdGlvbiI6ImZsYXQiLCJhbGlnbm1lbnQiOiJsZWZ0In0=
Paste code macro
languagejson
titleCode 200 (Success)
[ { "merchantCardTypeId": "d915657e-e9fe-4142-9bb6-a516fe8562ca", "merchantId": "d7bb1d04-8cbb-4b02-a252-555554fa8eeb", "code": "60efb7ab40998", "name": "Silver Membership", "remarks": null, "designCardId": "17774fde-45f6-4dc9-99df-c33dec55156f", "isDefault": false, "sort": 3, "level": 0, "createdBy": "00000000-0000-0000-0000-000000000000", "createdDate": "2021-07-15T12:20:25.18", "modifiedBy": "00000000-0000-0000-0000-000000000000", "modifiedDate": "2021-07-15T12:20:25.18" }, { "merchantCardTypeId": "afc4ebb6-bdfd-4667-886b-aad05d1c31fe", "merchantId": "d7bb1d04-8cbb-4b02-a252-555554fa8eeb", "code": "60efb773507a2", "name": "Gold Membership", "remarks": null, "designCardId": "29b42052-2f38-4c05-a48b-28c486713136", "isDefault": true, "sort": 2, "level": 0, "createdBy": "00000000-0000-0000-0000-000000000000", "createdDate": "2021-07-15T12:20:00.643", "modifiedBy": "00000000-0000-0000-0000-000000000000", "modifiedDate": "2021-07-15T12:20:00.643" }, { "merchantCardTypeId": "0c171915-ee46-4420-a8ba-c558d0b5fd46", "merchantId": "d7bb1d04-8cbb-4b02-a252-555554fa8eeb", "code": "", "name": "DEFAULT", "remarks": "Created by system", "designCardId": "00000000-0000-0000-0000-000000000000", "isDefault": false, "sort": 1, "level": 0, "createdBy": "00000000-0000-0000-0000-000000000000", "createdDate": "2021-07-08T16:08:22.39", "modifiedBy": "00000000-0000-0000-0000-000000000000", "modifiedDate": "2021-07-08T16:08:22.39" } ]

Aura tab collection
paramseyJ0YWIiOjEsInNldHRpbmdzIjoie1wiZ2VuZXJhbFNldHRpbmdzXCI6e1widGFiU3BhY2luZ1wiOjAsXCJ0YWJXaWR0aFwiOjEwMCxcInRhYkhlaWdodFwiOjQ1LFwiZGlyZWN0aW9uXCI6XCJob3Jpem9udGFsXCJ9LFwiYWN0aXZlU2V0dGluZ3NcIjp7XCJiYWNrZ3JvdW5kQ29sb3JcIjp7XCJjb2xvclwiOlwiIzI2ODRmZmI4XCJ9LFwidGV4dFwiOntcImZvbnRTaXplXCI6MTYsXCJjb2xvclwiOlwiI2ZmZmZmZlwiLFwidGV4dEFsaWduXCI6XCJsZWZ0XCIsXCJmb250V2VpZ2h0XCI6XCJib2xkXCJ9fSxcImluYWN0aXZlU2V0dGluZ3NcIjp7XCJiYWNrZ3JvdW5kQ29sb3JcIjp7XCJjb2xvclwiOlwiI2ZmZmZmZlwifSxcInRleHRcIjp7XCJmb250U2l6ZVwiOjE2LFwiY29sb3JcIjpcIiM1ZTZjODRcIixcInRleHRBbGlnblwiOlwibGVmdFwiLFwiZm9udFdlaWdodFwiOlwibGlnaHRlclwifX0sXCJjb250ZW50U2V0dGluZ3NcIjp7XCJiYWNrZ3JvdW5kQ29sb3JcIjp7XCJjb2xvclwiOlwiI2ZmZlwifSxcInBhZGRpbmdcIjp7XCJ0b3BcIjoxMCxcInJpZ2h0XCI6MTAsXCJib3R0b21cIjoxMCxcImxlZnRcIjoxMH0sXCJib3JkZXJcIjp7XCJzdHlsZVwiOlwic29saWRcIixcIndpZHRoXCI6MixcInRvcFwiOnRydWUsXCJib3R0b21cIjp0cnVlLFwibGVmdFwiOnRydWUsXCJyaWdodFwiOnRydWUsXCJjb2xvclwiOlwiI2Y0ZjVmN1wifX0sXCJob3ZlclNldHRpbmdzXCI6e1wiYmFja2dyb3VuZENvbG9yXCI6e1wiY29sb3JcIjpcIiNmNGY1ZjdcIn0sXCJ0ZXh0XCI6e1wiZm9udFNpemVcIjoxNixcImNvbG9yXCI6XCIjNWU2Yzg0XCIsXCJ0ZXh0QWxpZ25cIjpcImxlZnRcIixcImZvbnRXZWlnaHRcIjpcImJvbGRcIn19fSJ9
Aura tab
paramseyJ0aXRsZSI6IlJlcXVlc3QgIn0=

Param

Required

Type

Default Value & Description

apiId

Y

string

apiKey

Y

string

authenticationType

Y

Enum

  • Sys2Sys integration value must be 1 → i.e. POS, ERP

  • For client system integration value must be 2 → Customer portal

sessionId

Y

string

To get session id refer to → Authenticate

Aura tab
paramseyJ0aXRsZSI6IkV4YW1wbGUgUmVxIn0=
paste-
Code Block
-macro
languagejson
titleRaw Request
{
  "apiId": "d7bb1d04-8cbb-4b02-a252-555554fa8eeb",
  "apiKey": "K96fWH1zjZrI7tt1rBTEgP06Zs0laaMEW5f6h1Jmk1YgYwPMdbB865LxTvrwm+IJ",
  "authenticationType": 1,
  "sessionId": "7GSZN6LWCB9L1V2SVGL5S5A7UZ12NKBM6GZII0ILI3NBU56XAG"
}
Aura tab
paramseyJ0aXRsZSI6IlJlc3BvbnNlIn0=

Param

Type

Description

Aura tab
paramseyJ0aXRsZSI6IkV4YW1wbGUgUmVzcCJ9
Paste code macrolanguagejsontitleCode 200 (Success)

TblMerchantCardType → List

merchantCardTypeId

string($uuid)

It is refer to Card Type unique ID (Auto Generated Upon card creation)

merchantId


string($uuid)

Your mibo Unique ID

code

string

Card Code (Auto Generated Upon card creation)

name

string

Card/Membership Name have been set on Mibo Backend

remarks

string

If System default the the value will be → Created by system

else null

isDefault

boolean

If the card type has been set as default then value will be true

Note

Any new member will be assigned with default card type

sort

integer

Sort No of the Card type (Lower to higher )

Info

Card type with Sort no 1 has the highest level

createdDate


string($date-time)

modifiedDate

string($date-time)

Aura tab
paramseyJ0aXRsZSI6IkV4YW1wbGUgUmVzcCJ9
Code Block
[
    {
        "merchantCardTypeId": "d915657e-e9fe-4142-9bb6-a516fe8562ca",
        "merchantId": "d7bb1d04-8cbb-4b02-a252-555554fa8eeb",
        "code": "60efb7ab40998",
        "name": "Silver Membership",
        "remarks": null,
        "designCardId": "17774fde-45f6-4dc9-99df-c33dec55156f",
        "isDefault": false,
        "sort": 3,
        "level": 0,
        "createdBy": "00000000-0000-0000-0000-000000000000",
        "createdDate": "2021-07-15T12:20:25.18",
        "modifiedBy": "00000000-0000-0000-0000-000000000000",
        "modifiedDate": "2021-07-15T12:20:25.18"
    },
    {
        "merchantCardTypeId": "afc4ebb6-bdfd-4667-886b-aad05d1c31fe",
        "merchantId": "d7bb1d04-8cbb-4b02-a252-555554fa8eeb",
        "code": "60efb773507a2",
        "name": "Gold Membership",
        "remarks": null,
        "designCardId": "29b42052-2f38-4c05-a48b-28c486713136",
        "isDefault": true,
        "sort": 2,
        "level": 0,
        "createdBy": "00000000-0000-0000-0000-000000000000",
        "createdDate": "2021-07-15T12:20:00.643",
        "modifiedBy": "00000000-0000-0000-0000-000000000000",
        "modifiedDate": "2021-07-15T12:20:00.643"
    },
    {
        "merchantCardTypeId": "0c171915-ee46-4420-a8ba-c558d0b5fd46",
        "merchantId": "d7bb1d04-8cbb-4b02-a252-555554fa8eeb",
        "code": "",
        "name": "DEFAULT",
        "remarks": "Created by system",
        "designCardId": "00000000-0000-0000-0000-000000000000",
        "isDefault": false,
        "sort": 1,
        "level": 0,
        "createdBy": "00000000-0000-0000-0000-000000000000",
        "createdDate": "2021-07-08T16:08:22.39",
        "modifiedBy": "00000000-0000-0000-0000-000000000000",
        "modifiedDate": "2021-07-08T16:08:22.39"
    }
]

...