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.
OK
Response Schema: application/json
Array of objects |
Bad Request
Too Many Requests
Internal Server Error
- curl
- 200
- 400
- 500
{- "recurringAgreements": [
- {
- "agreementRef": "abcd-efgh",
- "paymentProviderId": 55,
- "productCode": "CO27409"
}
]
}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.
- Payload
- curl
{- "productCode": "CO27409"
}- 200
- 400
- 500
{- "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.
- Payload
- curl
{- "agreementRef": "abcd-efgh",
- "paymentProviderId": 25
}- 200
- 400
- 500
{- "success": true
}