Add vipps agreement

Production

https://api.mediaconnect.no/capi

POST

/v1/customer/payment/vipps/agreement

Vipps

The user needs to be logged in to use this endpoint, click here to read more.

Use the id from the response to complete the adding the card by redirecting the customer to loginServer/payment/vipps/agreement/add?clientId=…&returnUrl=….&errorUrl=…..&transactionId=12378954. The system will redirect the customer to the proper third-party system for the change, and upon success will then redirect to the given returnUrl. If an system error occurs, the given errorUrl will be used instead.

In addition to return url will be returned the result of operation:

finished - if agreement was registered correctly,

cancelled - user cancelled the adding the agreement, agreement is not added,

failed - it was not possible to create an agreement, adding of agreement fails,

unknown - unknown status of operation,

initiated - creation of agreement was initiated,

error - never shall happen, instead shall go to errorUrl.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.mediaconnect.no/capi/v1/customer/payment/vipps/agreement' \
--header 'Content-Type: application/json' \
--data-raw '{
    "productCode": "CO27409"
}'

Response Example

200 - Success

{
    "success": true,
    "transactionId": 12378954
}

Request

Authorization

OAuth 2.0

Authorization Code

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Authorize URL: https://connectid.no/user/oauth/authorize

Token URL: https://connectid.no/user/oauth/token

Refresh URL: https://connectid.no/user/oauth/token

Scopes:

read-For all access

Body Params application/json

productCode

string

required

Specific product for agreement.

Examples

Responses

🟢200OK

application/json

Body

success

boolean

optional

It informs if the agreement was added.

true: The agreement was added.

false: The agreement was not added.

transactionId

integer

optional

The transactionId

🟠400Bad Request

🟠429429

🔴500Server Error

List vipps agreements

Remove vipps agreement