Nexi

List Nexi subscriptions

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

Produces a list with subscriptions related to users Connect customer. Response is based on subscriptions registered in ConnectID, i.e subscriptions received from Connect and stored in ConnectID. Only subscriptions 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/api/payment/nexi/subscription
Request samples
Response samples
application/json
{
  • "subscriptions": [
    ]
}

Add Nexi subscription

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 subscription by redirecting the customer to loginServer/payment/nexi/subscription/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 subscription was registered correctly,
  • cancelled - user cancelled the adding the subscription, subscription is not added,
  • failed - it was not possible to create a subscription, adding of subscription fails,
  • unknown - unknown status of operation,
  • initiated - creation of subscription was initiated,
  • error - never shall happen, instead shall go to errorUrl.
SecurityAuthorization_Code
Request
Request Body schema: application/json
productCode
required
string

Specific product for subscription.

Responses
200

OK

Response Schema: application/json
success
boolean

It informs if the subscription was added.

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

The transactionId

400

Bad Request

429

Too Many Requests

500

Internal Server Error

post/v1/api/payment/nexi/subscription
Request samples
application/json
{
  • "productCode": "CO27409"
}
Response samples
application/json
{
  • "success": true,
  • "transactionId": 12378954
}

Remove Nexi subscription

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

This API can be used for removing subscriptions from a nexi paymentprovider

SecurityAuthorization_Code
Request
Request Body schema: application/json
required
subscriptionId
required
string <= 64 characters

Subscription that shall be marked as deleted.

paymentProviderId
required
integer

Payment provider id for subscription.

Responses
200

OK

Response Schema: application/json
success
boolean

Informs if subscription is marked as deleted.

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

Bad request

429

Too Many Requests

500

Internal server error

patch/v1/api/payment/nexi/subscription
Request samples
application/json
{
  • "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
  • "paymentProviderId": "12"
}
Response samples
application/json
{
  • "success": true
}