API Overview Resources Schemas

Finance Renewal

Finance Renewal takes customer and account information among other data and makes a request to the Risk API to evaluate the feasibility or not of selling or financing a new device while you have financing in progress

financeRenewal

undefined

POST /orgs/{orgId}/finance/renewal

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	Organization name as it is registered in Mas-Stack
sf-client-ip	header	string	false	Client IP address
body	body	finance_renewal_request	false	‘none’

Request body - instance of finance_renewal_request

1
2
3
4
5
6
7


{
  "customer_id": "963085b0-f526-4a53-88bc-4d14d8311eaa",
  "account_id": "963085b0-f526-4a53-88bc-4d14d8311eaa",
  "subscription_id": "125474c9-b563-487d-abe1-37106da7d4f6",
  "app_id": 4,
  "dealer_id": "54321"
}

Name	Type	Required	Description
customer_id	string	true	new uuid format used by MasCustomers
account_id	string	true	new uuid format used by MasCustomers
subscription_id	string(int64)	true	uuid legacy id
app_id	integer	true	sales application
dealer_id	string	true	dealer id

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13



curl -X POST https://feasibility.sta.masstack.com/v1/orgs/{orgId}/finance/renewal \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "sf-client-ip: 192.168.1.1" \
 --data-raw "{
  'customer_id': '963085b0-f526-4a53-88bc-4d14d8311eaa',
  'account_id': '963085b0-f526-4a53-88bc-4d14d8311eaa',
  'subscription_id': '125474c9-b563-487d-abe1-37106da7d4f6',
  'app_id': 4,
  'dealer_id': '54321'
}" 

Responses

Code	Meaning	Description	Schema
200	OK	Success	finance_renewal_response
400	Bad Request	Bad request	bad_request_response
401	Unauthorized	Unauthorized	unauthorized_response
404	Not Found	Not found	not_found_response
408	Request Timeout	Time out Error	timeout_response
500	Internal Server Error	Internal Server Error	error_response
502	Bad Gateway	Bad Gateway error	bad_gateway_error_response
default	Default	Error	error_response

credit-availability

undefined

POST /orgs/{orgId}/finance/credit_limit

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	Organization name as it is registered in Mas-Stack
body	body	finance_availability_credit_limit_request	false	‘none’

Request body - instance of finance_availability_credit_limit_request

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29


{
  "customer_id": "963085b0-f526-4a53-88bc-4d14d8311eaa",
  "account_id": "963085b0-f526-4a53-88bc-4d14d8311eaa",
  "operation": "CONVERGENT",
  "sales_app": 4,
  "dealer_id": "54321",
  "customer_info": {
    "first_name": "Lorenzo",
    "last_name": "Lopez Lopez",
    "middle_name": "Medina",
    "birth_date": "1990-05-23",
    "address_info": {
      "address": "CALLE DE FRANCISCO GINER",
      "postal_code": 28830,
      "locality": "San Fernando de Henares",
      "region_code": "MA",
      "administrative_area": "Madrid",
      "country_id": "ES"
    },
    "associated_user": {
      "first_name": "Lorenzo",
      "middle_name": "Lopez",
      "second_name": "Medina",
      "document_type": "NIF",
      "document_id": "88662844Y",
      "nationality": "ES"
    }
  }
}

Name	Type	Required	Description
customer_id	string	false	new uuid format used by MasCustomers
account_id	string	false	new uuid format used by MasCustomers
operation	string	false	none
sales_app	integer	false	sales application
dealer_id	string	false	dealer id
customer_info	customer_info	false	none

Property	Values
operation	one of [CONVERGENT, MOBILE_ONLY, MIGRATION, ADDLINE]

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34



curl -X POST https://feasibility.sta.masstack.com/v1/orgs/{orgId}/finance/credit_limit \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'customer_id': '963085b0-f526-4a53-88bc-4d14d8311eaa',
  'account_id': '963085b0-f526-4a53-88bc-4d14d8311eaa',
  'operation': 'CONVERGENT',
  'sales_app': 4,
  'dealer_id': '54321',
  'customer_info': {
    'first_name': 'Lorenzo',
    'last_name': 'Lopez Lopez',
    'middle_name': 'Medina',
    'birth_date': '1990-05-23',
    'address_info': {
      'address': 'CALLE DE FRANCISCO GINER',
      'postal_code': 28830,
      'locality': 'San Fernando de Henares',
      'region_code': 'MA',
      'administrative_area': 'Madrid',
      'country_id': 'ES'
    },
    'associated_user': {
      'first_name': 'Lorenzo',
      'middle_name': 'Lopez',
      'second_name': 'Medina',
      'document_type': 'NIF',
      'document_id': '88662844Y',
      'nationality': 'ES'
    }
  }
}" 

Responses

Code	Meaning	Description	Schema
200	OK	Success	finance_renewal_response
400	Bad Request	Bad request	bad_request_response
401	Unauthorized	Unauthorized	unauthorized_response
404	Not Found	Not found	not_found_response
408	Request Timeout	Time out Error	timeout_response
500	Internal Server Error	Internal Server Error	error_response
502	Bad Gateway	Bad Gateway error	bad_gateway_error_response
default	Default	Error	error_response

Endpoints

Coverage

Coverage management

Blacklist Contact Data

Map

Connection installation

Portability

Device Finance Prebooking

Subscription Limit

Sales Documents

Pole Info

Finance Renewal