material-symbols:code-blocks-outline

Web API

View all API objects, methods, attributes and responses embedded within Fasstap SDK

Create Company

Header Parameters
Authorizationstringrequired

The Bearer token for the request.

Request

Properties are not available.

Responses

String

post/api/processRequest
                {
  "apiServiceName": "CREATE_COMPANY",
  "companyDetails": {
    "businessName": "Ergonomic Soft Tuna Limited",
    "businessShortName": "Ergonomic Soft Tuna",
    "businessRegistrationAddress": "82/485 Gleichner Overpass Falls officia",
    "postcode": "3249",
    "city": "temporibus",
    "region": "WA",
    "merchantDetails": [
      {
        "mid": "378862146526047",
        "dba": "Ergonomic Soft Tuna",
        "tyroMid": "902130"
      }
    ],
    "lcrEnabled": false,
    "lcrMinThreshold": "0",
    "lcrMaxThreshold": "100000",
    "mcc": "4112"
  }
}
Response Sample
                {
  "status": "Success",
  "message": "Request is successful.",
  "uid": "1"
}

Update Company

Header Parameters
Authorizationstringrequired

The Bearer token for the request.

Request

Properties are not available.

Responses

String

post/api/processRequest
                {
  "apiServiceName": "UPDATE_COMPANY",
  "uid": "32376",
  "companyDetails": {
    "businessName": "Ergonomic Soft Tuna Limited",
    "businessShortName": "Ergonomic Soft Tuna",
    "postcode": "3249",
    "city": "Sydney",
    "region": "NSW",
    "lcrEnabled": true,
    "lcrMinThreshold": "0",
    "lcrMaxThreshold": "100000",
    "mcc": "8011"
  }
}
Response Sample
                {
  "status": "Success",
  "message": "Request is successful.",
  "uid": "1"
}

View Company

Header Parameters
Authorizationstringrequired

The Bearer token for the request.

Request

Properties are not available.

Responses

String

post/api/processRequest
                {
  "apiServiceName": "VIEW_COMPANY",
  "companyDetails": {
    "businessName": "Ergonomic Soft Tuna Limited"
  },
  "uid": "32376"
}
Response Sample
                {
  "status": "Success",
  "message": "Request is successful.",
  "companyDetails": {
    "businessName": "Ergonomic Soft Tuna Limited",
    "businessShortName": "EST",
    "businessRegistrationAddress": "215 E Tasman Dr, Po Box 65502",
    "postcode": "95134",
    "city": "San Jose",
    "region": "CA",
    "mcc": "1234",
    "lcrEnabled": "true",
    "lcrMinThreshold": "10000",
    "lcrMaxThreshold": "50000",
    "merchantDetails": {
      "mid": "378862146526047",
      "dba": "test1"
    }
  }
}

Add Merchant ID

Header Parameters
Authorizationstringrequired

The Bearer token for the request.

Request

Properties are not available.

Responses

String

post/api/processRequest
                {
  "apiServiceName": "REGISTER_MID",
  "uid": "32376",
  "companyDetails": {
    "businessName": "Ergonomic Soft Tuna Limited",
    "merchantDetails": {
      "mid": "378862146526047",
      "dba": "test1"
    }
  }
}
Response Sample
                {
  "status": "Success",
  "message": "Request is successful."
}

Register Terminal

Header Parameters
Authorizationstringrequired

The Bearer token for the request.

Request

Properties are not available.

Responses

String

post/api/processRequest
                {
  "apiServiceName": "REGISTER_TID",
  "terminalDetails": {
    "mid": "378862146526047",
    "tid": "46840418"
  }
}
Response Sample
                {
  "status": "Success",
  "message": "Request is successful.",
  "uid": "TID[11000001]UID:9, TID[11000002]UID:10,TID[11000003]UID:11,TID[13000001]UID:12,TID[13000002]UID:13,TID[15000001]UID:14,TID[15000002]UID:15,TID[15000003]UID:16"
}

View Terminal

Header Parameters
Authorizationstringrequired

The Bearer token for the request.

Request

Properties are not available.

Responses

String

post/api/processRequest
                {
  "apiServiceName": "VIEW_TID",
  "uid": "56861",
  "terminalDetails": {
    "tid": "46840418"
  }
}
Response Sample
                {
  "status": "Success",
  "message": "Request is successful.",
  "terminalDetails": {
    "mid": "378862146526047",
    "tid": "46840418"
  }
}

Register Mobile User

Header Parameters
Authorizationstringrequired

The Bearer token for the request.

Request

Properties are not available.

Responses

String

post/api/processRequest
                {
  "apiServiceName": "REGISTER_MOBILE_USER",
  "mobileUserDetails": {
    "mobileUserID": "user902130"
  },
  "terminalDetails": {
    "mid": "378862146526047",
    "tid": "46840418"
  }
}
Response Sample
                {
  "status": "Success",
  "message": "Request is successful.",
  "uid": "1",
  "tempPin": "299522",
  "mobileUserDetails": {
    "mobileUserID": "user902130",
    "userStatus": "Active"
  }
}

View Mobile User

Header Parameters
Authorizationstringrequired

The Bearer token for the request.

Request

Properties are not available.

Responses

String

post/api/processRequest
                {
  "apiServiceName": "VIEW_MOBILE_USER",
  "mobileUserDetails": {
    "mobileUserID": "user902130"
  },
  "uid": "55490"
}
Response Sample
                {
  "status": "Success",
  "message": "Request is successful.",
  "mobileUserDetails": {
    "mobileUserID": "user902130",
    "userStatus": "Active"
  },
  "terminalDetails": {
    "mid": "378862146526047",
    "tid": "46840418"
  }
}

Update Mobile User Status

Header Parameters
Authorizationstringrequired

The Bearer token for the request.

Request

Properties are not available.

Responses

String

post/api/processRequest
                {
  "apiServiceName": "UPDATE_MOBILE_USER_STATUS",
  "mobileUserDetails": {
    "mobileUserID": "user902130",
    "userStatus": "Suspended"
  },
  "uid": "55490"
}
Response Sample
                {
  "status": "Success",
  "message": "Request is successful.",
  "tempPin": "299522",
  "mobileUserDetails": {
    "mobileUserID": "user902130",
    "userStatus": "Suspended"
  }
}

Reset Pin

Header Parameters
Authorizationstringrequired

The Bearer token for the request.

Request

Properties are not available.

Responses

String

post/api/processRequest
                {
  "apiServiceName": "RESET_PIN",
  "mobileUserDetails": {
    "mobileUserID": "user902130"
  },
  "uid": "55490"
}
Response Sample
                {
  "status": "Success",
  "message": "Request is successful.",
  "tempPin": "299522",
  "mobileUserDetails": {
    "mobileUserID": "user902130"
  }
}

SDK API

Explore all API objects, methods, attributes and responses embedded within Fasstap SDK

App to App Integration

Explore all API objects, methods, attributes and responses embedded within Fasstap App-to-App