Integration GuidesRecipesAPI Reference
Status MonitorWebsiteLog In
API Reference

Post Store Credit Redemption

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Post a store credit redemption. This resource will update the Croissant user's store credit balance for a given store credit ID (a value that uniquely identifies the credit in your system).

This resource is only necessary if you offer a store credit/gift card API directly on your platform. Merchants which handle store credit via manual issuance or by a third party need not integrate with this resource.

Path Params
string
required
Body Params
number
required

The amount of the store credit which was redeemed, in cents.

string
enum
required

The currency code of the store credit which was redeemed.

Allowed:
string
required

The time at which this credit redemption occurred, in ISO 8601 format.

string
required

The transaction id of the store credit redemption, in UUID format.

Responses
200

200 response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json