LogoLogo
System Status
  • Digital River API
  • Getting started
  • Using our services
    • Local pricing
    • Item classification
    • Subscriptions
    • e-Invoicing
  • Integration options
    • Low-code checkouts
      • Implementing a Prebuilt Checkout
      • Implementing a Components checkout
      • Offering local pricing
      • Using a shipping endpoint
      • Processing subscription acquisitions
      • Adding custom fields
      • Offering store credit
      • Displaying policies and getting consent
      • Collecting e-invoice information
      • Handling completed checkout-sessions
    • Direct integrations
      • Standard flow
      • Building checkouts
        • Checking out guest and registered customers
        • Describing line items
          • Setting the price of an item
          • Managing items with shared SKU identifiers
        • Providing address information
        • Handling shipping choice
        • Tax identifiers
        • Applying a discount
        • Setting the customer type
        • Providing the IP address
        • Selecting a currency
        • Initiating a charge
        • Setting the purchase location
        • Configuring taxes
        • Accessing regulatory fee information
        • Localizing invoices and credit memos
        • Providing an upstream identifier
        • Applying store credit
        • Handling e-invoicing requirements
        • Landed cost
        • Tax calculation inputs
        • Selling entities
        • Payment sessions
        • Applying store credit (legacy)
        • Country specs
      • Building payment workflows
        • Handling redirect payment methods
        • Handling delayed payment methods
      • Subscription acquisitions
        • Handling subscription acquisitions
        • Handling external subscription acquisitions
        • Subscription information
      • Digital River coordinated fulfillments
        • Checking inventory levels
        • Using shipping quotes
        • Reserving inventory items
        • Managing a fulfillment order
        • Cancelling a fulfillment order
    • Connectors
  • Order management
    • Processing orders
    • Handling a rejected order
    • Accessing invoices and credit memos
    • Fulfilling goods and services
    • Capturing and cancelling charges
    • Payment reauthorizations
    • Handling reversals
      • Return basics
        • Digital River coordinated returns
        • Third party coordinated returns
      • Refund basics
        • Issuing refunds
        • Refunding asynchronous payment methods
      • Disputes and chargebacks
    • Customer notifications
    • Responding to events
      • Events
        • Key event types
        • All event types
      • Webhooks
        • Creating a webhook
        • Digital River API safelist
        • Digital River signature
      • Expanding events
      • Preventing webhooks from getting disabled
    • Distributor model
  • Subscription Management
    • Managing a subscription
    • Managing an external subscription
  • Payments
    • Payment solutions
      • Drop-in payments
        • How Drop-in payments work
        • Drop-in payments integration guide
      • DigitalRiver.js with Elements
        • Elements integration guide
        • Configuring payment methods
          • Configuring Afterpay
          • Configuring Alipay+ (cross-border)
          • Configuring Alipay (domestic)
          • Configuring Amazon Pay
          • Configuring Apple Pay
          • Configuring Bancontact
          • Configuring BNP Paribas
          • Configuring BLIK
          • Configuring CCAvenue
          • Configuring Clearpay
          • Configuring Credit Cards
          • Configuring FPX Online Banking
          • Configuring Google Pay
          • Configuring iDEAL
          • Configuring Klarna
          • Configuring Konbini
          • Configuring Online Banking (IBP)
          • Configuring Online Banking (Korea Bank Transfer)
          • Configuring PayCo
          • Configuring PayPal
          • Configuring SEPA Direct Debit
          • Configuring Trustly
          • Configuring Wire Transfer
          • Common payment sources
          • Common payment objects
    • Supported payment methods
      • Afterpay
      • Alipay (domestic)
      • Alipay+ (cross-border)
      • Amazon Pay
      • Apple Pay
      • Bancontact
      • BNP Paribas
      • BLIK
      • CCAvenue
      • Clearpay
      • Credit Cards
      • FPX Online Banking
      • Google Pay
      • iDEAL
      • Klarna
      • Konbini
      • Korea Bank Transfer (Online Banking)
      • Online Banking (IBP)
      • Pay with Installments France
      • PayCo
      • PayPal
      • PayPal Billing Agreement
      • PayPal Credit
      • PayPal Pay in 3
      • PayPal Pay in 4
      • PayPal RatenZahlung (Installment Payment)
      • SEPA Direct Debit
      • Trustly
      • Wire Transfer
    • Source basics
      • Managing sources
      • Handling credit card sources
      • Retrieving sources
    • Authorization declines
    • PSD2 and SCA
      • How to ensure SCA compliance
    • Payment testing scenarios
  • Product management
    • Product basics
    • Managing SKUs
    • Using product details
    • Grouping SKUs
    • SKU-inventory item pairs
    • Managing inventory items
    • Regulatory fees
      • What are regulatory fees?
        • Fees terminology
        • Regulatory fee management
        • European regulatory fees
        • Compliance obligations
        • WEEE directive requirements
        • Copyright directive requirements
        • Compliance challenges
      • Managing regulatory fees
  • Customer management
    • Customer basics
    • Creating and updating customers
    • Setting up tax exemptions
    • Recording a customer's request to be forgotten
  • Financial reporting
    • Financials basics
    • Sales transactions
      • Returning a list of sales transactions
      • Getting a sales transaction by ID
    • Sales summaries
      • Returning a list of sales summaries
      • Getting a sales summary by ID
    • Payouts
      • Returning a list of payouts
      • Getting a payout by ID
      • Get a list of transactions included in payout by ID
  • Developer resources
    • Digital River API reference
    • DigitalRiver.js reference
      • Including DigitalRiver.js
      • Initializing DigitalRiver.js
      • DigitalRiver object
      • Elements
        • Amazon Pay element
        • Apple Pay elements
        • Google Pay elements
        • IBAN element
        • iDEAL element
        • Konbini elements
        • Compliance element
        • Offline Refund elements
        • Online Banking elements
        • Tax Identifier element
        • Invoice attribute element
        • Delayed Payment Instructions element
        • PayPal elements
      • Guidelines for capturing payment details
      • Security
      • Digital River payment objects
      • Error types, codes, and objects
    • DigitalRiverCheckout.js reference
      • Including DigitalRiverCheckout.js
      • Initializing DigitalRiverCheckout.js
        • DigitalRiverCheckout configuration object
      • DigitalRiverCheckout object
        • Configuring Prebuilt Checkout
          • Performing actions
          • Defining experience
        • Components
          • Configuring components
          • Address component
          • Shipping component
          • Tax identifier component
          • Invoice component
          • Wallet component
          • Payment component
          • Compliance component
          • Order summary component
          • Thank you component
        • Rendering a checkout button
          • Performing actions on the checkout button
        • Determining the checkout's status
      • Accessing country and currency
    • DynamicPricing.js reference
    • Postman collection
  • administration
    • Sign in
    • Digital River Dashboard
      • Digital River Dashboard quick start guide
      • Key features
      • Reset your password
      • Test and production environments
      • Account
        • Adding an account
        • Switching accounts
        • Account access
      • Profile settings
        • Viewing your personal information
        • Changing your password
        • Updating your phone number
        • Enabling multi-factor authentication
      • Finance
        • Payouts
          • Viewing your payout details
          • Filtering your payouts
          • Exporting your payouts
        • Sales summaries
          • Viewing your sales summaries details
          • Filtering your sales summaries
          • Exporting your sales summaries
          • Exporting your sales summary details
        • Transactions
          • Viewing your transaction details
          • Filtering your transactions
          • Exporting your transactions
      • Order management
        • Orders
          • Searching for orders
          • Filtering your orders
          • Viewing the order details
          • Cancelling items
          • Fulfilling items
          • Downloading an invoice
          • Downloading a credit memo
          • Creating shipping labels
          • Recording a customer's request to be forgotten
          • Viewing returns and refunds
          • Creating a return
          • Accepting a return
          • Creating a refund
          • Viewing the order's timeline
        • Checkouts
          • Searching for checkouts
          • Filtering your checkouts
          • Viewing the checkout details
        • Prebuilt Checkout links
          • Generate Prebuilt Checkout links
          • View and work with Prebuilt Checkout link details
          • Add a customer during Prebuilt Checkout
          • Add a product during Prebuilt Checkout
      • Customers
        • Viewing customer details
        • Searching for customers
        • Filtering your customers
        • Editing account information
        • Adding a customer
        • Tax IDs and certificates
          • Adding a tax certificate
          • Adding a tax ID
          • Deleting a tax ID
        • Metadata
          • Adding metadata
          • Editing metadata
        • Manage subscriptions from the Customer Details page
        • Disabling a customer
        • Recording a customer's request to be forgotten
        • Deleting a customer
      • Catalog
        • SKUs
          • Viewing the SKU details
          • Searching for SKUs
          • Filtering your SKUs
          • Adding a SKU
          • Editing a SKU
          • Deleting a SKU
          • Adding a fee to a SKU
          • Editing a fee
          • Deleting a fee
          • Viewing product tariff codes
        • Managing customer subscriptions from Digital River Dashboard
      • Developers
        • API keys
          • Updating your API version
          • Getting your API keys
          • Changing the API version for your key
          • Creating a restricted key
          • Editing a restricted key
          • Deleting a restricted key
          • Rotating keys
        • Webhooks
          • Creating a webhook
          • Editing a webhook
          • Deleting a webhook
          • Rotating a webhook's secret
        • API logs
          • Filtering the API log
          • Viewing the API log details
        • Event logs
          • Filtering the events log
          • Viewing the event details
      • Settings
        • Users and roles
          • Roles
          • Searching for a user by name or email
          • Filtering your users and roles
          • Adding a user
          • Editing a user
          • Deleting a user
        • Prebuilt Checkout
        • Payment methods
          • Viewing your payment methods
          • Viewing payment method details
            • Enabling currencies
            • Managing countries
          • Enabling or disabling a payment method
  • General Resources
    • eCompass
    • eCompass documentation
    • Release notes
      • 2024
      • 2023
      • 2022
      • 2021
      • 2020
      • 2019
    • Standards and certifications
      • Certification process
      • Compliance requirements
      • Documentation requirements
      • Integration checklists
        • Admin portal
        • Products and SKUs
        • Customers and tax exemptions
        • Checkouts, payment sources, and orders
        • Disclosures, compliance statements, and emails
        • Fulfillments and cancellations
        • Customer portal
        • Order refund synchronization
        • Reversals
        • Error handling
      • Test and use cases
    • Commerce infrastructure
    • Versioning
    • Glossary
Powered by GitBook
On this page
  • Creating store credit
  • Attaching store credit to checkouts
  • Handling store credit in orders
  1. Integration options
  2. Direct integrations
  3. Building checkouts

Applying store credit

Learn how to apply store credit

PreviousProviding an upstream identifierNextHandling e-invoicing requirements

Last updated 3 months ago

This page explains how to use store credit in 2021-03-23 and higher. For versions 2020-09-30, 2020-12-17, and 2021-02-23, refer to .

For non-recurring transactions, customers can pay using store credit, a unique payment type that allows you to connect your credit management system to the Digital River APIs. With store credit, you manage customers' credit on your end and can display the amount available to them during the checkout process.

Therefore, store credit is a that can't be saved to a record.

You and then . Once the is created, you must also .

With store credit, the steps necessary to and remain the same, but, if an sources[] contain store credit and a , you should know how .

Digital River API does not currently support Amazon Pay with store credit.

Creating store credit

When customers opt to pay with store credit and they've specified an allowable amount, send your in a .

When defining the request:

  • Retrieve the and use it to set paymentSessionId.

  • Pass the amount of credit you're extending the customer.

  • Set type to customerCredit.

  • Use upstreamId to pass the identifier of the line of credit in your system.

  • Send an empty customerCredit object.

An owner hash table is optional and can be used to meet .

curl --location --request POST 'https://api.digitalriver.com/sources' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <Your secret API key>' \
...
--data-raw '{
	"type": "customerCredit",
        "paymentSessionId": "96e199dc-e9a4-4bb1-86ca-2adc502e62bf",
    	"amount": 12.50,
    	"upstreamId": "76-87-1298",
	"customerCredit": {
	}
}'
{
    "id": "f2f6bced-37a0-4b10-965a-7c4f27e59288",
    "createdTime": "2022-10-13T19:52:57Z",
    "type": "customerCredit",
    "currency": "USD",
    "amount": 12.5,
    "reusable": false,
    "state": "chargeable",
    "upstreamId": "76-87-1298",
    "owner": {
        "firstName": "Chase",
        "lastName": "Marshall",
        "address": {
            "line1": "4321 Any Road W",
            "city": "Minneapolis",
            "postalCode": "55401",
            "state": "MN",
            "country": "US"
        }
    },
    "paymentSessionId": "96e199dc-e9a4-4bb1-86ca-2adc502e62bf",
    "clientSecret": "f2f6bced-37a0-4b10-965a-7c4f27e59288_fba8241d-b0f4-4305-bad4-1ecff4e03d3b",
    "customerCredit": {},
    "liveMode": false
}

Attaching store credit to checkouts

curl --location --request POST 'https://api.digitalriver.com/checkouts/e869b46e-dd24-4896-a79e-6ad80bbbd460/sources/f2f6bced-37a0-4b10-965a-7c4f27e59288' \
--header 'Content-Type: application/json' \
--header 'Authorization: <Your secret API key>' \
...
--data-raw ''
409 Conflict
{
    "type": "conflict",
    "errors": [
        {
            "code": "session_source_amount_too_large",
            "message": "Source amount(s) exceed session amount"
        }
    ]
}

In any of these cases, Digital River first computes taxes based on the checkout's totalAmount, and then applies the store credit.

Handling store credit in orders

{
    "id": "242764070336",
    ...
    "payment": {
        "charges": [
            {
                "id": "db5f33b5-3b1a-40c7-9e63-0e5b8a7dcad5",
                "createdTime": "2022-10-13T19:55:58Z",
                "currency": "USD",
                "amount": 12.5,
                "state": "capturable",
                "captured": false,
                "refunded": false,
                "sourceId": "f2f6bced-37a0-4b10-965a-7c4f27e59288",
                "type": "customer_initiated"
            },
            {
                "id": "f30999a2-23c3-46b0-ae35-335f7ddd967b",
                "createdTime": "2022-10-13T19:55:57Z",
                "currency": "USD",
                "amount": 14.51,
                "state": "capturable",
                "captured": false,
                "refunded": false,
                "sourceId": "a83ad586-c4ad-4b27-8676-1e0a897cf029",
                "type": "customer_initiated"
            }
        ],
        "sources": [
            {
                "id": "a83ad586-c4ad-4b27-8676-1e0a897cf029",
                "type": "creditCard",
                "amount": 14.51,
                "owner": {
                    "firstName": "Chase",
                    "lastName": "Marshall",
                    "email": "marshallsBillingEmail@digitalriver.com",
                    "address": {
                        "line1": "Any other road W",
                        "city": "Eagan",
                        "postalCode": "55122",
                        "state": "MN",
                        "country": "US"
                    }
                },
                "creditCard": {
                    "brand": "Visa",
                    "expirationMonth": 7,
                    "expirationYear": 2027,
                    "lastFourDigits": "1111"
                }
            },
            {
                "id": "f2f6bced-37a0-4b10-965a-7c4f27e59288",
                "type": "customerCredit",
                "amount": 12.5,
                "upstreamId": "76-87-1298",
                "owner": {
                    "firstName": "Chase",
                    "lastName": "Marshall",
                    "address": {
                        "line1": "4321 Any Road W",
                        "city": "Minneapolis",
                        "postalCode": "55401",
                        "state": "MN",
                        "country": "US"
                    }
                },
                "customerCredit": {}
            }
        ],
        "session": {
            "id": "96e199dc-e9a4-4bb1-86ca-2adc502e62bf",
            "amountContributed": 27.01,
            "amountRemainingToBeContributed": 0.0,
            "state": "complete",
            "clientSecret": "96e199dc-e9a4-4bb1-86ca-2adc502e62bf_57cb6a31-9594-4879-8cbd-740121cd35f7"
        }
    },
    "state": "accepted",
    "stateTransitions": {
        "accepted": "2022-10-13T19:55:59Z"
    },
    ...
    "checkoutId": "e869b46e-dd24-4896-a79e-6ad80bbbd460"
}

A response with a 201 OK status code contains a unique with a type of customerCredit whose is chargeable.

If you pass paymentSessionId and set the checkout's before sending the create source request, Digital River retrieves that data and uses it to populate the source's owner. We also retrieve the checkout's and use it to set the source's currency.

After you , you'll need to retrieve its id and use that value to .

Before submitting this request, check to determine whether the source's amount is less than or equal to the checkout's . If that's not the case, then the following error is thrown:

At what point in the flow you should submit this request depends on whether customers are (1) paying entirely with store credit, (2) combining store credit with a single-use , or (3) combining store credit with a primary payment source.

For details, refer to on the page.

After the are met to successfully , and the state is , iterate through its sources[] and identify any that have a type of customerCredit. For each of these objects, use its upstreamId to look up the line of credit in your system and deduct what's available by amount.

Applying store credit (legacy)
handle fulfillments
request refunds
create the store credit payment source
attach the resource to the checkout
search for store credit and deduct its amount
currency
Managing sources
create a store credit payment source
confidential API key
versions
source
state
customer's
order
order's
POST /sources
checkout's
single-use payment source
order's
reusable
billTo
our billing address requirements
convert the checkout to an order
accepted
payment.session.amountRemainingToContribute
necessary payment preconditions
associate the source with the checkout
primary payment source
Combining primary and secondary sources
primary payment source
Digital River handles captures, cancels, and refunds
payment.session.id