Vipps

List vipps agreements

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

Produces a list with Vipps recurring agreements. Only agreements marked as valid are returned.

SecurityAuthorization_Code
Responses
200

OK

Response Schema: application/json
Array of objects
400

Bad Request

429

Too Many Requests

500

Internal Server Error

get/v1/customer/payment/vipps/agreement
Request samples
Response samples
application/json
{
  • "recurringAgreements": [
    ]
}

Add vipps agreement

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.
SecurityAuthorization_Code
Request
Request Body schema: application/json
required
productCode
required
string

Specific product for agreement.

Responses
200

OK

Response Schema: application/json
success
boolean

It informs if the agreement was added.

  • true: The agreement was added.
  • false: The agreement was not added.
transactionId
integer

The transactionId

400

Bad Request

429

Too Many Requests

500

Internal Server Error

post/v1/customer/payment/vipps/agreement
Request samples
application/json
{
  • "productCode": "CO27409"
}
Response samples
application/json
{
  • "success": true,
  • "transactionId": 12378954
}

Remove vipps agreement

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

This API can be used for removing Vipps agreement.

SecurityAuthorization_Code
Request
Request Body schema: application/json
required
agreementRef
required
string <= 128 characters

Agreement that shall be marked as deleted.

paymentProviderId
required
integer

Payment provider id for agreement.

Responses
200

OK

Response Schema: application/json
success
boolean

Informs if agreement is marked as deleted.

  • true: The agreement marked as deleted.
  • false: The agreement may not be marked as deleted.
400

Bad request

429

Too Many Requests

500

Internal server error

patch/v1/customer/payment/vipps/agreement
Request samples
application/json
{
  • "agreementRef": "abcd-efgh",
  • "paymentProviderId": 25
}
Response samples
application/json
{
  • "success": true
}