API documentation

Add new card informations V1

Our platform is integrated with Netopia MobilPay and for the moment we use their sandbox platform. For further details please contact us.
Only for testing you can use the following cards that are accepted by the sandbox platform:

9900004810225098 - accepted card with CVV=111
9900541631437790 - expired card

GET /api/car_driver/cards/new

Include access_token in HTTP header:

Authorization: Bearer 0Bsa487fc3df...

Description

This web service can be used to get all the parameters that will be used to save a new credit card into the remote payment module and into the application.

REQUEST PARAMETERS

Parameter name Parameter type Description
return_url string Base64(return_url) where the payment service will redirect after the payment

Response

Status Code: 200 if OK

{
      "pay_url" : "add_card_url",
      "env_key" : "env_key",
      "data" : "data"
}

Response parameters

Parameter name Parameter type Description
pay_url string url to be used to post the env_key and data parameters in order to (make a payment)/(add a new card)
env_key string key to be sent to pay_url link in order to (make a payment)/(add a new card)
data string data to be sent to pay_url link in order to (make a payment)/(add a new card)

Status Code: 400 if request not ok


Add new card informations V2

V2 also integrates the EPX payment provider and it's in testing mode for now.

Only for testing you can use the following card that is accepted by EPX's testing platform:

4000000000000002 - accepted card with CVV=123, EXP_DATE=12/2025, ADDRESS=123 NN CENTRAL, ZIP=12345

When the MobilPay provider is enabled you can use the MobilPay cards from V1.

GET /api/car_driver/cards/new

Include access_token and version in HTTP headers:

Authorization: Bearer 09ba487fc3df...
Accept: application/vnd.parkingplus.v2+json

Description

Same as for v1.

REQUEST PARAMETERS

Same as for v1.

Response

Status Code: 200 if OK

{
  "pay_url": "add_card_url",
  "pay_params": {
    "env_key": "env_key",
    "data": "data"
  }
}

Response parameters

Parameter name Parameter type Description
pay_url string url to be used to post the env_key and data parameters in order to (make a payment)/(add a new card)
pay_params object object containing the parameters to be sent to pay_url in order to (make a payment)/(add a new card)
env_key string key to be sent to pay_url link in order to (make a payment)/(add a new card)
data string data to be sent to pay_url link in order to (make a payment)/(add a new card)

Note: The "pay_params" above are for when the MobilPay provider is enabled. And the pay_url, env_key and data can be used to create a payment the same way as for v1.

For when EPX provider is enabled the "pay_params" will look like this:

  "pay_params": {
    "cust_nbr": "<<cust_nbr>>",
    "merch_nbr": "<<merch_nbr>>",
    "dba_nbr": "<<dba_nbr>>",
    "terminal_nbr": "<<terminal_nbr>>",
    "amount": "48.00",
    "tac": "<<TAC token>>",
    "redirect_url": "http://www.example.com/epx_confirm",
    "tran_nbr": 1,
    "batch_id": 0,
    "invalid_redirect_url": "http://www.example.com/epx_invalid"
  }

You have to make a POST to pay_url with the parameters inside pay_params. This will redirect the user to the EPX web site that will make the actual payment and redirect to the redirect_url.

Status Code: 400 if request not ok, return_url param is required


Add new card informations V4

V4 integrates the EPX payment provider (as V2) and it's in testing mode for now.

Only for testing you can use the following card that is accepted by EPX's testing platform:

4000000000000002 - accepted card with CVV='', EXP_DATE=12/2025

When the MobilPay provider is enabled you can use the MobilPay cards from V1.

GET /api/car_driver/cards/new

Include access_token and version in HTTP headers:

Authorization: Bearer 09ba487fc3df...
Accept: application/vnd.parkingplus.v4+json

Description

This web service can be used to get a custom url that will be used to save a new credit card into the remote payment module and into the application.

REQUEST PARAMETERS

Same as for v1.

Response

Status Code: 200 if OK

{
  "pay_url": "pay_url"
}

Response parameters

Parameter name Parameter type Description
pay_url string url to be used to make a GET request in mobile WebView in order to (make a payment)/(add a new card)

Note: After the actual payment is finished on the remote payment service it will redirect to the redirect_url request parameter.

Status Code: 400 if request not ok, return_url param is required