Vipps API Functions
Overview
This page aims to document API calls used by developers integrating Vipps 2 SMS and recurring payments
Per Jun 8, 2021 , API resources in Next CRM and Next Dialog will be used to provide the needed functionality.
A convenient wrapper API that will package all needed functionality in one structure is under construction and will be ready in Q2 2021
|
|---|
Authentication
HMAC
Base URL and swagger
https://dialog-api.linkmobility.com/
https://dialog-api.linkmobility.com/swagger/ui/index#
https://crm-api.linkmobility.com/
https://crm-api.linkmobility.com/swagger/ui/index#
Creating new vipps recurring subscription
POST api/recurring/subscribe
Register new vipps recurring subscription.
One of the conditions to be able to create a subscription is to have
The parameters that should be passed are as follow:
Name | Description | Data Type | Example |
|---|---|---|---|
PartnerId | PartnerId from NEXT portal | int | 10295 |
Msisdn | Phone Number of the Vipps user | string | “+47123456789” |
Currency | Currency | string | “NOK' |
Amount | The initial charge and the following charges | deccimal | 2.0 |
PaymentProvider |
| string | "Vipps" |
Description | The description of the subscription that will appear in Vipps app | string | "Recurring payments" |
Name | The name of the subscriptions that will appear in Vipps app | string | "Rec test" |
AgreementUrl | The page where a end user can visit in order to unsubscribe from the subscription. It is the member profile page of NEXT platform. | string | "https://crm.linkmobility.com/?memberId=59a338f1-7e96-412e-9bd7-9823128ad8eb" |
Seeing status of end users
GET v1/subscribers/{serviceId}
Gets recurring service subscribers by serviceId. (See a list of end users opted in to a recurring payment)
Parameters
Name | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
serviceId | required | An existing Link serviceId (internal) | path | integer |
start | optional | Start data and time | query | date-time |
end | optional | End data and time | query | date-time |
searchString | optional | Optional searchString to get a subset of results | query | string |
Sample call
GET https://dialog-api.linkmobility.com/v1/subscribers/1
Sample response
{
"id": 1,
"msisdn": "+359895555190",
"subscriptionId": "chr_k4rJmRL",
"memberId": "d3ed382b-e9f4-4443-9b9b-a4a3dfcbf6ba",
"serviceId": 1,
"recurringType": "Weekly",
"amount": 1.0,
"dateCreated": "2021-04-06T10:15:14.1250575Z",
"currency": null,
"message": null,
"shortCode": null
}
GET v1/subscribers/recurring/excel/
Gets recurring service subscribers to be exported in excel file. (See a list of end users opted in to a recurring payment)
Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Parameters
Name | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
partnerId | required | An existing Link partnerId (internal) | query | integer |
serviceId | required | An existing Link serviceId (internal) | query | integer |
start | required | Start data and time | query | date-time |
end | required | End data and time | query | date-time |
groupName | required | An existing Link CRM groupName | query | string |
dialogName | required | An existing Link CRM groupName | query | string |
searchString | optional | Optional searchString to get a subset of results | query | string |
Sample call
GET https://dialog-api.linkmobility.com/v1/subscribers/recurring/excel?partnerId=10295&serviceId=3511&start=1970-01-01T21:59:59&end=2021-04-08T21:00:00&groupName=induction%202&dialogName=test%20recurring%20vipps%2010.03
Sample response
GET /api/lookup/address-info
Gets address info for an msisdn. (See details for an end user opted in)
Parameters
Name | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
msisdn | required | A contact/opted in user phone number. | query | string |
Sample call
GET https://crm-api.linkmobility.com/api/lookup/address-info?msisdn=4748207906
Sample response
{
"firstname": null,
"middlename": null,
"lastname": null,
"company": "Link Mobility Group AS",
"address": "Langkaia",
"streetnumber": "1",
"postalCode": "0150",
"area": "Oslo",
"coAddress": null,
"country": "NO",
"socialSecurityNumber": null,
"birthdate": null,
"mobileNumber": "+4790059567",
"telephoneNumber": "+4722994400",
"customParameters": {
"altMobileNumber5": "+4790209207",
"altMobileNumber4": "+4748180167",
"altMobileNumber7": "+4791395622",
"altMobileNumber6": "+4740317810",
"altMobileNumber9": "+4791395320",
"altMobileNumber8": "+4791395355",
"municipality": "Oslo",
"county": "Oslo",
"countryPart": "Ø",
"companyNumber": "984066910",
"municipalityNumber": "301",
"altMobileNumber22": "+4741399335",
"altMobileNumber20": "+4790289241",
"altMobileNumber21": "+4793946833",
"altMobileNumber19": "+4790289184",
"altMobileNumber15": "+4797470202",
"altMobileNumber16": "+4794829580",
"altMobileNumber17": "+4746230447",
"altMobileNumber18": "+4791918849",
"altMobileNumber11": "+4791374501",
"altMobileNumber12": "+4790685524",
"altMobileNumber13": "+4796978577",
"altMobileNumber14": "+4741519628",
"altMobileNumber1": "+4748207906",
"altMobileNumber3": "+4790081741",
"altMobileNumber2": "+4741319020",
"altMobileNumber10": "+4790936605"
}
}
GET /api/lookup/address-info-member-profile-page
Gets address info for an msisdn without authorization. (See details for an end user opted in)
Parameters
Name | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
msisdn | required | A contact/opted in user phone number. | query | string |
Sample call
GET https://crm-api.linkmobility.com/api/lookup/api/lookup/address-info-member-profile-page?msisdn=4748207906
Sample response
{
"firstname": null,
"middlename": null,
"lastname": null,
"company": "Link Mobility Group AS",
"address": "Langkaia",
"streetnumber": "1",
"postalCode": "0150",
"area": "Oslo",
"coAddress": null,
"country": "NO",
"socialSecurityNumber": null,
"birthdate": null,
"mobileNumber": "+4790059567",
"telephoneNumber": "+4722994400",
"customParameters": {
"altMobileNumber5": "+4790209207",
"altMobileNumber4": "+4748180167",
"altMobileNumber7": "+4791395622",
"altMobileNumber6": "+4740317810",
"altMobileNumber9": "+4791395320",
"altMobileNumber8": "+4791395355",
"municipality": "Oslo",
"county": "Oslo",
"countryPart": "Ø",
"companyNumber": "984066910",
"municipalityNumber": "301",
"altMobileNumber22": "+4741399335",
"altMobileNumber20": "+4790289241",
"altMobileNumber21": "+4793946833",
"altMobileNumber19": "+4790289184",
"altMobileNumber15": "+4797470202",
"altMobileNumber16": "+4794829580",
"altMobileNumber17": "+4746230447",
"altMobileNumber18": "+4791918849",
"altMobileNumber11": "+4791374501",
"altMobileNumber12": "+4790685524",
"altMobileNumber13": "+4796978577",
"altMobileNumber14": "+4741519628",
"altMobileNumber1": "+4748207906",
"altMobileNumber3": "+4790081741",
"altMobileNumber2": "+4741319020",
"altMobileNumber10": "+4790936605"
}
}
Seeing status and results from payments
GET v1/subscriber/{subscriberId}
Gets payments for subscription by subscriberId. (See list of payments that is done for an end user)
Parameters
Name | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
subscriberId | required | A Link RecurringServiceSubscriberId for reoccurring Vipps to SMS (internal) | path | integer |
Sample call
GET https://dialog-api.linkmobility.com/v1/subscriber/196
Sample response
GET v1/messages/payment/excel/
Gets list of payment results to be exported in excel file.
Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Parameters
Name | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
partnerId | required | An existing Link partnerId (internal) | query | integer |
serviceId | required | An existing Link serviceId (internal) | query | integer |
start | required | Start data and time | query | date-time |
end | required | End data and time | query | date-time |
groupName | required | An existing Link CRM groupName | query | string |
dialogName | required | An existing Link CRM groupName | query | string |
searchString | optional | Optional searchString to get a subset of results | query | string |
tag | optional | Optional link tag used by partner | query | string |
excludeIncomming | optional | Optional (true/false) parameter to exclude incoming messages | query | boolean |
excludeOutgoing | optional | Optional (true/false) parameter to exclude outgoing messages | query | boolean |
excludeRead | optional | Optional (true/false) parameter to exclude read messages | query | boolean |
Sample call
GET https://dialog-api.linkmobility.com/v1/messages/payment/excel?partnerId=10295&serviceId=3561&start=1970-01-01T21:59:59&end=2021-04-08T21:00:00&groupName=No%CRM%Group
Sample response
Feeling lost? Click on this link! Portal page