Store credit callout

Store credits are a flexible payment option that allows customers to apply a designated credit balance toward their purchases. Store credits can enhance customer satisfaction and streamline payment when integrated into the Digital River checkout flow. Configuring a store credit callout in the Prebuilt Checkout page ensures that each credit application is verified through a saved endpoint, maintaining transaction integrity and seamlessly validating credit amounts.

PreviousDrop-in shipping quotes

Last updated 4 months ago

Store credit callout

post

/checkouts/store-credits

Authorizations

Body

sessionIdstring

The identifier of the checkout session associated with the store credit request.

Example: 7765374748

sessionUpstreamIdstring

The upstream identifier of the checkout session associated with the store credit request.

Example: 8234373746

amountnumber · double

The store credit amount.

Example: 5

namestring

The store credit name.

Example: Gift card

upstreamIdstring

The upstream store credit identifier.

Example: 7654-2345-0987-123456

iconUrlstring

The store credit image url.

Example: https://test.com/logo.png

lastFourstring

The last four digits of the store credit.

Example: 7831

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.digitalriver.com/checkouts/store-credits' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"sessionId":"7765374748","sessionUpstreamId":"8234373746","amount":5,"name":"Gift card","upstreamId":"7654-2345-0987-123456","iconUrl":"https://test.com/logo.png","lastFour":"7831"}'

200

400

401

403

405

406

408

409

429

500

502

503

504

{
  "amount": 5,
  "upstreamId": "7654-2345-0987-123456",
  "approval": true
}

200 OK

Remove store credit callout

Store credit callout

delete

/checkouts/store-credits/{upstreamId}

Authorizations

Path parameters

upstreamIdstringrequired

The unique identifier of the store credit

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.digitalriver.com/checkouts/store-credits/{upstreamId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

400

401

403

404

405

406

408

409

429

500

502

503

504

No body

204 No Content