Versions Compared

Key

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

POST api/recurring/subscribe

Creates a new subscription per Msisdn

Expand
titleExample
Code Block
Request:
POST api/recurring/subscribe
POST api/recurring/subscribe?api-version=2.0

{
  "partnerId": 1,
  "msisdn": "sample string 2",
  "currency": "sample string 3",
  "orderNumber": "sample string 4",
  "amount": 5.0,
  "campaignAmount": 1.0,
  "paymentProvider": "sample string 6",
  "description": "sample string 7",
  "basis": 8,
  "memberId": "sample string 9",
  "agreementUrl": "sample string 10",
  "name": "sample string 11",
  "statusCallbackUrl": "sample string 12",
  "confirmSubscriptionCallbackUrl": "sample string 13",
  "sendSMS": true,
  "smsText": "sample string 15",
  "smsNotificationOriginator": "sample string 16"
}

Response:
{
  "method": "sample string 1",
  "url": "sample string 2",
  "fields": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

Request information (from body)

RecurringPaymentSubscriptionRequest

Response information

PaymentSetupV2

GET api/recurring/process/{partnerId}/{internalId}

When user opens the url returned from subscription to process and will be retidecter to the Pay url (Payment provider page)

Expand
titleExample
Code Block
Request:
GET api/recurring/process/{partnerId}/{internalId}
GET api/recurring/process/{partnerId}/{internalId}?api-version=2.0

Request information

Name

Value

Description

Data Type

Example

partnerId

required

PartnerId. Provided to you by LINK Mobility.

int

10295

internalId

required

Internal Id

string

“random-string”

Response information

HttpResponseMessage

GET api/recurring/return/{partnerId}/{transactionId}

Return after Vipps payment is done by the client, but this payment is not completed yet in Vipps

Expand
titleExample
Code Block
Request:
GET api/recurring/return/{partnerId}/{transactionId}
GET api/recurring/return/{partnerId}/{transactionId}?api-version=2.0

Request information

Name

Value

Description

Data Type

Example

partnerId

required

PartnerId. Provided to you by LINK Mobility.

int

10295

transactionId

required

Transaction Id

GUID

“random-string”

Response information

HttpResponseMessage

GET api/recurring/subscriptions/{partnerId}/{paymentTypeId}/{from}

Expand
titleExample
Code Block
Request:
GET api/recurring/subscriptions/{partnerId}/{paymentTypeId}/{from}
GET api/recurring/subscriptions/{partnerId}/{paymentTypeId}/{from}?api-version=2.0

Request information

Name

Value

Description

Data Type

Example

partnerId

required

PartnerId. Provided to you by LINK Mobility.

int

10295

paymentTypeId

required

Payment provider id

int

5

from

required

date

Response information

HttpResponseMessage

DELETE api/recurring/cancel/{id}

Expand
titleExample
Code Block
Request:
DELETE api/recurring/cancel/{id}?
DELETE api/recurring/cancel/{id}?api-version=2.0

Request information

Name

Value

Description

Data Type

Example

id

required

subscriptionId or memberId

int

10295

Response information

Status Code

Description

Message

200

OK

400

Bad Request

Invalid subscription identifier

Subscription with status: “chargeStatus” for “id” cannot be cancelled

404

Not Found

Recurring not found