Set payment provider

PUT{{API_BASE_URL}}/shop/v1/cart/:cart/payment-providers

The request updates the payment providers for a specific cart.

Request

paymentProviderId (string): The ID of the payment provider.
successUrl (string): The URL to redirect to upon successful payment.
cancelUrl (string): The URL to redirect to if the payment is canceled.
errorUrl (string): The URL to redirect to in case of an error.
token (string): A token for the payment.

Response

The response includes the following fields:

id (string): The ID of the cart.
expiryTime (string): The expiry time of the cart.
user (object): Details of the user associated with the cart, including:
- id (string): The ID of the user.
- isVerified (boolean): The verification status of the user.
- eMail (string): The email of the user.

The response also includes other details related to the cart, such as event information, items in the cart, totals, payment provider details, buyer's information, and culture.

Authentication#auth

This endpoint does not require authentication.

Query parameters#query

$expandAlloptional

—

Responses#responses

200OKSet payment provider

Request

curl -X PUT '{{API_BASE_URL}}/shop/v1/cart/:cart/payment-providers' \
  -H 'Content-Type: application/json' \
  --data '{
  "paymentProviderId": "{{PAYMENT_PROVIDER_ID}}",
  "successUrl": "https://www.your-shop-client.com",
  "cancelUrl": "https://www.cancel.com",
  "errorUrl": "https://www.error.com",
  "token": ""
}'

Body

application/json

{

"paymentProviderId": "{{PAYMENT_PROVIDER_ID}}",

"successUrl": "https://www.your-shop-client.com",

"cancelUrl": "https://www.cancel.com",

"errorUrl": "https://www.error.com",

"token": ""

}

Sample response

200 OK

{

"data": {

"paymentProviderSet": {

"cartId": "64ed9b39-6455-4df4-885a-1e7d6f4cadb3",

"paymentProviderId": "00000000-0000-0000-0000-000000000000",

"redirectRequired": true,

"paymentProviderRedirectUrl": "https://webfilesdev.blob.core.windows.net/comps/CMI/hosted.html?source=ADITUS_01-2024-1411793_DWTC&reference=ac877ed4-40b3-47bd-a77f-a19dfe0b4dec&rand=944485",

"expiresAt": "2025-04-25T14:16:33.9634022+00:00"

},

"cart": {

"id": "64ed9b39-6455-4df4-885a-1e7d6f4cadb3",

"expiryTime": "2025-04-29T18:00:00+02:00",

"user": {

"id": "00000000-0000-0000-0000-000000000000",

"isVerified": true,

"eMail": null

},

"event": {

"id": "f2e25737-4990-ee11-93cf-00155d960409",

"name": "Erlebnistage",

"year": "2024",

"number": "01",

"slug": "ed24"

},

"promotionCodes": [

],

"items": [

0: {

"id": "002dbee1-0000-0000-0000-000000000000",

"article": {

"id": "0736920e-4b90-ee11-93cf-00155d960409",

"name": "Day Pass",

"internalName": "Day Pass",

"description": "Das Tagesticket berechtigt Sie zum <strong>einmaligen Besuch</strong> der Experience Days an einem beliebigen Veranstaltungstag.",

"sort": 0,

"prices": [

0: {

"price": {

"price": 16.81,

"grossPrice": 20,

"tax": 3.19,

"taxRate": 19,

"currency": "EUR"

},

"originalPrice": {

"price": 16.81,

"grossPrice": 20,

"tax": 3.19,

"taxRate": 19,

"currency": "EUR"

}

}

],

"image": {

"key": "Default.OneDayTicket",

"uri": "https://dev.aditus.de/ADITUS-DEV-0_API/api/theme/v1/Images/Shop/ArticleImage/Default/OneDayTicket?context=article:0736920e-4b90-ee11-93cf-00155d960409&language=de&foregroundColor=%2300A4CC",

"type": "Icon"

},

"type": "VisitorTicket",

"ticketValidity": "OneDay",

"articleNumber": "01",

"category": "VISITOR",

"legitimationCategory": null,

"configuration": {

"showRemainingAmount": false,

"showRemainingAmountPerTimeslot": false,

"showIfSoldOut": false,

"soldOutText": null,

"maxLengthOfDescription": 250,

"maxNumberOfTicketsPerSale": 3,

"minNumberOfTicketsPerSale": null,

"isInvitationEmailAddressChangePossible": false

},

"articleGroup": {

"id": "42d6086d-c583-ee11-b2f8-00155d960308",

"name": "Messetickets",

"sort": 0,

"configuration": {

"maxNumberOfTicketsPerSale": null,

"isExclusiveAssortment": false

}

}

},

"promotionCodes": [

],

"voucherCode": null,

"price": {

"price": 16.81,

"grossPrice": 20,

"tax": 3.19,

"taxRate": 19,

"currency": "EUR"

},

"registration": {

"data": {

"type": "self",

"referencedSurveyResponse": null,

"answers": [

0: {

"isReadOnly": false,

"bindingMember": "[CRM.Persons].SalutationLookup",

"value": "Frau"

},

1: {

"isReadOnly": false,

"bindingMember": "[CRM.Persons].LastName",

"value": "Musterfrau"

},

2: {

"isReadOnly": false,

"bindingMember": "[CRM.Persons].FirstName",

"value": "Martina"

},

3: {

"isReadOnly": false,

"bindingMember": "[CRM.Persons].Info1",

"value": "ADITUS GMBH"

},

4: {

"isReadOnly": false,

"bindingMember": "[CRM.PartyAddresses].Street",

"value": "Straße der Nationen"

},

5: {

"isReadOnly": false,

"bindingMember": "[CRM.PartyAddresses].PostalCode",

"value": "12345"

},

6: {

"isReadOnly": false,

"bindingMember": "[CRM.PartyAddresses].City",

"value": "Hannover"

},

7: {

"isReadOnly": false,

"bindingMember": "[CRM.PartyAddresses].StreetNumber",

"value": "5"

},

8: {

"isReadOnly": false,

"bindingMember": "[CRM.PartyAddresses].CountryLookup",

"value": "DE"

}

],

"hasInformation": true

},

"isValid": false,

"problems": [

0: {

"code": 2208,

"name": "RegistrationResponseValidationFailed",

"category": "Registration",

"message": "The given response for the registration of the item is not valid",

"details": {

"affectedItem": "002dbee1-0000-0000-0000-000000000000",

"survey": "eyJVc2VDYXNlTmFtZSI6IlNob3AuUmVnaXN0cmF0aW9uLlNlbGYiLCJUZXJtaW5hbFNldElkIjpudWxsLCJGYWlyZXZlbnRJZCI6NTYsIlJvbGVJZCI6bnVsbCwiQXJ0aWNsZUlkcyI6WzI1NF19",

"errors": [

0: "The question 'Mobil-Nr.' must be answered!",

1: "The question 'Firmenbranche' must be answered!",

2: "The question 'Berufsbezeichnung' must be answered!",

3: "The question 'Verantwortungsbereich' must be answered!"

]

}

}

],

"isRequired": true,

"isPossible": true,

"types": {

"self": {

"isPossible": true,

"survey": "eyJVc2VDYXNlTmFtZSI6IlNob3AuUmVnaXN0cmF0aW9uLlNlbGYiLCJUZXJtaW5hbFNldElkIjpudWxsLCJGYWlyZXZlbnRJZCI6NTYsIlJvbGVJZCI6bnVsbCwiQXJ0aWNsZUlkcyI6WzI1NF19",

"hasToBeCompletedByTicketOwnerHimself": true

},

"thirdPerson": {

"isPossible": true,

"survey": "eyJVc2VDYXNlTmFtZSI6IlNob3AuUmVnaXN0cmF0aW9uLlRoaXJkUGVyc29uQnlIaW1zZWxmIiwiVGVybWluYWxTZXRJZCI6bnVsbCwiRmFpcmV2ZW50SWQiOjU2LCJSb2xlSWQiOm51bGwsIkFydGljbGVJZHMiOlsyNTRdfQ==",

"hasToBeCompletedByTicketOwnerHimself": true

}

}

},

"legitimation": {

"isRequired": false,

"isIncomplete": false

},

"timeslots": {

"isEnabled": true,

"isValid": false,

"minimumNumberOfBookings": 1,

"maximumNumberOfBookings": 1,

"bookings": [

]

}

}

],

"totals": [

0: {

"original": {

"price": 16.81,

"grossPrice": 20,

"tax": 3.19,

"taxRate": 19,

"currency": "EUR"

},

"price": 16.81,

"grossPrice": 20,

"tax": 3.19,

"taxRate": 19,

"currency": "EUR"

}

],

"isImmutable": false,

"isPaymentImmutable": false,

"isLegitimationImmutable": false,

"isRegistrationImmutable": false,

"isAmountImmutable": false,

"isRegistrationOnly": false,

"isRegistrationRequired": true,

"isLegitimationRequired": false,

"isPaymentRequired": true,

"paymentProvider": {

"expiresAt": "2025-04-25T14:16:33.9634022+00:00",

"redirectUrl": "https://webfilesdev.blob.core.windows.net/comps/CMI/hosted.html?source=ADITUS_01-2024-1411793_DWTC&reference=ac877ed4-40b3-47bd-a77f-a19dfe0b4dec&rand=944485",

"redirectRequired": true,

"transactionToken": null,

"isExpressCheckoutInitialized": false,

"id": "ffe35c40-9bf9-ef11-93dd-00155d96040a",

"name": "DWTC-Paymentgateway",

"description": null,

"paymentMethods": [

0: {

"methodType": "Visa"

},

1: {

"methodType": "Mastercard"

},

2: {

"methodType": "Amex"

}

],

"configuration": {

"useSandbox": "True"

},

"sort": 0,

"isDefault": false,

"isExpressCheckoutSupported": false

},

"buyerPerson": {

"email": null,

"firstName": null,

"lastName": null,

"company": null,

"salutation": null,

"vatId": null,

"address": null,

"isPrefilled": false,

"surveyId": "eyJVc2VDYXNlTmFtZSI6IlNob3AuTWlzc2luZ0J1eWVyIiwiVGVybWluYWxTZXRJZCI6bnVsbCwiRmFpcmV2ZW50SWQiOjU2LCJSb2xlSWQiOm51bGwsIkFydGljbGVJZHMiOltdfQ==",

"isValid": false

},

"status": "Active",

"culture": "de"

}

}

}