LogoLogo
System Status
2021-12-13
2021-12-13
  • 2021-12-13
  • Charges
    • Charge basics
  • Checkouts
  • Country specifications
  • Customers
  • Events
  • Fees
  • File Links
    • File link basics
  • Files
    • File basics
  • Fulfillments
  • Fulfillment cancellations
  • Fulfillment orders
  • Fulfillment returns
  • Inventory items
  • Inventory levels
  • Invoices
    • Invoice basics
  • Logistics returns
  • Orders
    • Order basics
  • Payouts
  • Plans
    • Plan basics
  • Refunds
  • Reservations
  • Returns
  • Sales summaries
  • Sales transactions
  • Shipments
  • Shipping labels
  • Shipping quotes
  • SKUs
  • SKU Groups
  • Sources
  • Subscriptions
    • Subscription basics
  • Tax identifiers
  • Webhooks
  • Drop-in checkout links
  • Drop-in checkout sessions
    • Checkout-sessions basics
  • Drop-in shipping quotes
  • Store credit callout
Powered by GitBook
On this page

Store credit callout

PreviousDrop-in shipping quotes

Last updated 6 months ago

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.

  • POSTStore credit callout
  • DELETERemove store credit callout

Remove store credit callout

delete

Store credit callout

Authorizations
Path parameters
upstreamIdstringRequired

The unique identifier of the store credit

Responses
204
204 No Content
400
400 Bad Request
application/json
401
401 Unauthorized
application/json
403
403 Forbidden
application/json
404
401 Not Found
application/json
405
405 Method Not Allowed
application/json
406
406 Not Acceptable
application/json
408
408 Request Timeout
application/json
409
409 Conflict
application/json
429
429 Too Many Requests
application/json
500
500 Internal Server Error
application/json
502
502 Bad Gateway Error
application/json
503
503 Service Unavailable Error
application/json
504
504 Gateway Timeout Error
application/json
delete
DELETE /checkouts/store-credits/{upstreamId} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

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
400
400 Bad Request
application/json
401
401 Unauthorized
application/json
403
403 Forbidden
application/json
405
405 Method Not Allowed
application/json
406
406 Not Acceptable
application/json
408
408 Request Timeout
application/json
409
409 Conflict
application/json
429
429 Too Many Requests
application/json
500
500 Internal Server Error
application/json
502
502 Bad Gateway Error
application/json
503
503 Service Unavailable Error
application/json
504
504 Gateway Timeout Error
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
}