Sign in
latestOpenAPI 3.0.12026-08-101292701.1 MB

f21981db32be

Store credit callout

Store credit callout

Store credit callout

post/checkouts/store-credits

Request body

sessionIdstring

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

sessionUpstreamIdstring

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

amountnumber double

The store credit amount.

namestring

The store credit name.

upstreamIdstring

The upstream store credit identifier.

iconUrlstring

The store credit image url.

lastFourstring

The last four digits of the store credit.

Example request

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

Response

200 OK

amountnumber double

The store credit amount.

upstreamIdstring

The upstream store credit identifier.

approvalboolean

Indicates whether the store credit .

Example response

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