About Amazon Gift Codes on Demand - incentives-api/agcod GitHub Wiki
Amazon Gift Codes on Demand (AGCOD) Overview
AGCOD is a simple and secure application programming interface (API) that enables business partners to quickly issue Amazon gift cards for a variety of use cases, ranging from gifting, employee incentives, customer acquisition, insurance payouts or refunds.
AGCOD Gateway provides a programmatic interface for partners to create GCs in real time. Partners can make synchronous requests to the AGCOD endpoint, specifying the value of the GC they want to create. The AGCOD API responds with a status indicating the success/failure of the operation and with a claim code if successful, which partners can deliver to their customers in a manner that has been approved by Amazon.
High-level AGCOD Gateway Service Architecture
Definitions
- partnerId: A unique identifier (CASE SENSITIVE, 1st letter is capitalized and the next four are lower case) provided by the Amazon GC team. This value is part of the Payload of every AGCOD Gateway request.
- creationRequestId: A unique identifier for every CreateGiftCard call that results in the creation of a GC. The partner must generate a new value for every Create request (except for retries). To keep this as the globally unique transaction identifier, the partner needs to:
- Generate an alphanumeric value that is unique within the partner’s systems. ID may have a maximum of 19 alphanumeric characters
- Begin every creationRequestId with the partner ID
- CreateGiftCardResponse/CancelGiftCardResponse: AGCOD Gateway will generate a status response on every successful Create/Cancel call associated with the GC.
- Transaction: A transaction is any request-response that results in the Create/Cancel of a GC within Amazon systems.