System Status

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.

Store credit callout

post

Store credit callout

Authorizations
Body
sessionIdstringOptional

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

Example: 7765374748
sessionUpstreamIdstringOptional

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

Example: 8234373746
amountnumber · doubleOptional

The store credit amount.

Example: 5
namestringOptional

The store credit name.

Example: Gift card
upstreamIdstringOptional

The upstream store credit identifier.

Example: 7654-2345-0987-123456
iconUrlstringOptional

The store credit image url.

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

The last four digits of the store credit.

Example: 7831
Responses
200

200 OK

application/json
post
POST /checkouts/store-credits HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 182

{
  "sessionId": "7765374748",
  "sessionUpstreamId": "8234373746",
  "amount": 5,
  "name": "Gift card",
  "upstreamId": "7654-2345-0987-123456",
  "iconUrl": "https://test.com/logo.png",
  "lastFour": "7831"
}
{
  "amount": 5,
  "upstreamId": "7654-2345-0987-123456",
  "approval": true
}

Remove store credit callout

delete

Store credit callout

Authorizations
Path parameters
upstreamIdstringRequired

The unique identifier of the store credit

Responses
204

204 No Content

delete
DELETE /checkouts/store-credits/{upstreamId} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
PreviousDrop-in shipping quotes

Last updated