Configure Digital River in Dashboard
Learn how to configure Digital River in Dashboard.
The following configuration tasks must be completed for the Digital River commercetools integration to work successfully:
The configuration steps described in this topic are done in the Digital River Dashboard.
Configure standard Digital River keys
Your Digital River account provides separate keys for testing and for running live transactions. You can use these keys when sending API requests in either test or live mode. Resources in one mode cannot change resources in another mode.
You can apply a different API version to each individual key. You can update the version on all keys in the current mode (test or live). Configure your standard keys in the Digital River dashboard. The API version must be 2021-03-23. Refer to Getting your API keys for more information.
Configure webhooks and webhook events
To keep commercetools synchronized with data in Digital River, a webhook is required that is configured with the following values:
| Property | Value | Note |
|---|---|---|
API version | 2021-12-13 | |
Transport type | HTTP | Only HTTP transport type is supported |
Endpoint URL | {baseUrl}/api/v1/webhooks/digitalriver | The baseUrl will be defined by where you deploy the connector. You should front the connector with HTTPS in production |
Username | Not required but you may enable basic auth on the server fronting the connector | |
Password | Not required but you may enable basic auth on the server fronting the connector |
Once the webhook is configured, enable the following webhook events:
| Event | Purpose |
|---|---|
customer.source.created | Adds data to customer.custom.fields.drSources when a payment method is saved |
customer.source.deleted | Removes data from customer.custom.fields.drSources when a payment method is deleted |
order.blocked | Updates order.custom.fields.drOrderState and order.custom.fields.drFraudState |
order.cancelled | Updates order.custom.fields.drOrderState and order.custom.fields.drFraudState |
order.charge.cancel.complete | Creates/Updates CancelAuthorization transactions and payment.paymentStatus.interfaceCode |
order.charge.cancel.failed | Creates/Updates CancelAuthorization transactions and payment.paymentStatus.interfaceCode |
order.charge.capture.complete | Creates/Updates Charge transactions and payment.paymentStatus.interfaceCode |
order.charge.capture.failed | Creates/Updates Charge transactions and payment.paymentStatus.interfaceCode |
order.charge.capture.pending | Creates/Updates Charge transactions and payment.paymentStatus.interfaceCode |
order.complete | Updates order.custom.fields.drOrderState and order.custom.fields.drFraudState |
order.created | Updates cart shipping and tax info, creates cart from order |
order.accepted | Updates order.custom.fields.drOrderState and order.custom.fields.drFraudState. Adds authorize transaction if required data was not in order.created event |
order.credit_memo.created | Adds URL to order.custom.fields.drCreditMemoUrls |
order.fulfilled | Updates order.custom.fields.drOrderState and order.custom.fields.drFraudState |
order.invoice.created | Adds URL to order.custom.fields.drInvoiceUrls. |
order.review_closed | Updates order.custom.fields.drOrderState and order.custom.fields.drFraudState |
refund.complete | Creates/Updates Refund transaction and payment.paymentStatus.interfaceCode |
refund.failed | Creates/Updates Refund transaction and payment.paymentStatus.interfaceCode |
refund.pending | Creates/Updates Refund transaction and payment.paymentStatus.interfaceCode |
Obtain the Digital River secret key
Once you have configured the webhook and enabled webhook events, you can reveal and obtain the secret (confidential) key in the Digital River dashboard. This key is used when configuring the demo customer application (described later in this document).
Last updated