Checklist
API version: 3.0
Endpoints to integrate
Integrate all the API endpoints. For examples of requests and responses, see the Postman collection and environment.
| Endpoint | Comment |
|---|---|
| Agreement: Create an agreement | POST:/agreements |
| Agreement: Retrieve an agreement | GET:/agreements/{agreementId} |
| Agreement: Update an agreement | PATCH:/agreements/{agreementId} |
| Agreement: List charges | GET:/agreements/{agreementId}/charges |
| Charge: Create Charge | POST:/agreements/{agreementId}/charges |
| Charge: Retrieve a charge | GET:/agreements/{agreementId}/charges/{chargeId} |
| Charge: Cancel a charge | DELETE:/agreements/{agreementId}/charges/{chargeId} |
| Charge: Refund a charge | POST:/agreements/{agreementId}/charges/{chargeId}/refund |
| Charge: Capture a reserved charge | POST:/agreements/{agreementId}/charges/{chargeId}/capture |
Quality assurance
| Action | Comment |
|---|---|
| Handle errors | Monitor the error messages Vipps returns from the APIs and correct problems as quickly as possible. It's recommended to log errors emitted by our APIs. This makes it easier to pinpoint what has gone wrong. |
| Include Vipps HTTP headers | Send the Vipps HTTP headers in all API requests for better tracking and troubleshooting (mandatory for partners and platforms, who must send these headers as part of the checklist approval). |
Avoid integration pitfalls
| Action | Comment |
|---|---|
| Poll for the agreement status | The Merchant must not rely on Redirect alone, but must always poll GET:/agreements/{agreementId} to check the status of the agreement. |
| Provide subscription tools | The merchant must have a way for the user to manage and stop subscription in merchantAgreementUrl in their agreement. This should result in a timely update of the Vipps Agreement. |
| Follow design guidelines | The Vipps branding must be according to the Vipps design guidelines. |
| Educate customer support | Make sure your customer service, etc. has all the tools and information they need available in your system, through the APIs listed in the first item in this checklist, and that they do not need to visit portal.vipps.no for normal work. |
Flow to go live for direct integrations
- The merchant orders Vipps på Nett.
- Vipps completes customer control (KYC, PEP, AML, etc.).
- The merchant receives an email from Vipps saying that they can log in with bankID on portal.vipps.no and retrieve API keys.
- The merchant completes all checklist items.
- The merchant verifies the integration in the test environment by checking that
there are test agreements and charges in the
Vipps test environment,
with the following states:
- A complete Agreement ending in
ACTIVE. - A complete Agreement ending in
STOPPED. - A complete
"type":"RECURRING"Charge ending inCHARGED. - A complete
"type":"RECURRING"Charge ending inREFUNDED.
- A complete Agreement ending in
- The recurring merchant starts using the MSN and API keys for the production environment.
- The merchant verifies that what worked in the test environment also work in the production environment. Please note: Vipps does not do any kind of activation or make any changes based on this checklist. The API keys for the production environment are made available on portal.vipps.no as soon as the customer control (see step 2) is completed, independently of this checklist.
- The merchant goes live 🎉