Consola del desarrollador
Gracias por tu visita. Esta página solo está disponible en inglés.

Activate physical cards

Please make sure to set up your Amazon Incentives API account before starting integration. Create Incentives API account.


The Incentives API enables you to create and distribute Amazon Gift Card claim codes on demand. Using this API, you can insert claim codes into electronic gift cards, support group gifting, and provide real time redemption of claim codes in loyalty programs (i.e. points programs).

Every gift card is associated with a unique pre-generated Web Activated Card (WAC) and denomination (numeric value). The gift card can be activated in real time. Once activated, the gift card associated with the WAC can be distributed, and the customer can use it towards purchases on Amazon.

The Incentives API Web Activation operations provide a programmatic interface you can use to activate/deactivate GCs in real time. You make synchronous requests to the endpoint that specifies the value of the WAC they want to activate for the non-denominated cards or provides the matching pre-denominated amount for the pre-denominated cards. The API responds with the success or failure status of the operation.

There are two types of Web Activated Cards(WAC):

  • Denominated (fixed amount) – amount is already predetermined for the claim code
  • Non-denominated (variable amount) – amount assigned when claim code is activated

Your Account Manager will provide the WAC numbers along with the associated claim codes as needed.

Request identifiers

A call to an endpoint includes a RequestId value in the body of the request.

  • activationRequestId - A unique identifier for every ActivateGiftCard / DeactivateGiftCard call that results in the activate / deactivate of a Web Activated Card (WAC). You must generate a new value for every Activate request (except for retries). Every activationRequestId value starts with your partnerId, followed by an alphanumeric value you generate that is unique within your systems. The value cannot exceed 40 characters. A second call with the same activationRequestId value returns the original status that was created the first time the activationRequestId value was seen.
  • statusCheckRequestId - An identifier used in an ActivationStatusCheck call to get the status of a WAC any time after a successful ActivateGiftCard request. This value must match the activationRequestId value used in the previous ActivateGiftCard call.

Web Activation Card Number and Checksum

The 16-digit WAC number sent with the three digit checksum when making endpoint requests (example: 1400000005567585358). Since card numbers are typically issued over a range (example: 1400000005567585 - 1400000005568000), use the checksum to validate that the correct card number has been sent in your activation request. This check is particularly important if a card is activated manually, and card numbers are read off verbally. See the following example containing WACs, and note that Amazon will provide a similar format when providing WACs/Claim Codes for the Web Activation use case.

SEQUENCE CARD NUMBER CHECKSUM AMOUNT CLAIM CODE
1 1400000005567585 358 $0.00 WA2W-A3CYCB-RDAMZ
2 1400000005567586 149 $0.00 WAS3-C8PP8R-MZMMD

Operations

The below operations are avalible on the Activate Gift Cards API.

Operation Description
ActivateGiftCard Puts a physical card into an active state, so it can be redeemed by a customer.
DeactivateGiftCard Puts a physical card into an inactive state, so it cannot be redeemed.
ActivationStatusCheck Report's activation status of a physical gift card.

Common parameters

Below you can see some common parameters that are used across all three API operations.

Parameter Example value
HTTP Request Method POST
Canonical URI (starts with /)
Canonical Query String (empty string)
Canonical Headers (see below)
SignedHeaders content-type;host;x-amz-date;x-amz-target
Algorithm AWS4-HMAC-SHA256
Request Date 20140327T212600Z
CredentialScope 20140327/us-east-1/AGCODService/aws4_request
Service Name AGCODService
Activation Request Id Awssb0327141418PM
Host agcod-v2-gamma.amazon.com (applicable endpoint can be found in the tech spec)
Region Name us-east-1 (applicable region can be found in the tech spec)
Partner Id Awssb (use your own Partner ID)
Card Number 1700000005489413

Canonical Headers can be:

content-type:application/json
host: agcod-v2-gamma.amazon.com
x-amz-date: 20140327T212600Z
x-amz-target: com.amazonaws.agcod.AGCODService.ActivateGiftCard

or

content-type:application/x-www-form-urlencoded; charset=UTF-8
host: agcod-v2-gamma.amazon.com
x-amz-date: 20140327T212600Z
x-amz-target: com.amazonaws.agcod.AGCODService.ActivateGiftCard

ActivateGiftCard

The ActivateGiftCard operation puts a physical card into an active state. A physical card in an active state can be redeemed by a customer.

You send an activationRequestId that uniquely identifies that activation request, along with other details like the denomination, currency, etc. (in addition to the metadata about that request, authentication info, etc.)

To perform this operation, send an ActivateGiftCard request. Amazon checks for sufficient funds in your Amazon Payments account or other pre-payment account, and then deducts funds from the account and responds with a synchronous response message that includes the activation status, cardNumber, cardStatus, and activationRequestId. You must store the activationRequestId, amount, and currencyCode for all subsequent requests related to the same transaction. The response message also contains some metadata, along with the status of the execution. Currently, the Web Activated Card (WAC) statuses returned are either Activated, AwaitingActivation, or Invalidated.

This operation is idempotent, so if the Incentives API receives more than one request with the same activationRequestId, then the first request will result in the activation of a new WAC, while all subsequent responses will return the originally activated WAC, and will not be treated as separate transactions.

One ActivateGiftCard call results in only one activation. (Bulk activation is not supported at this time)

Sample ActivateGiftCard HTTP POST request with JSON payload

POST /ActivateGiftCard HTTP/1.1
accept:application/json
content-type:application/json
host:agcod-v2-gamma.amazon.com
x-amz-date:20140327T211822Z
x-amz-target:com.amazonaws.agcod.AGCODService.ActivateGiftCard
Authorization:AWS4-HMAC-SHA256 Credential=AKIAJBYCL67O6NJUNYBQ/20140327/us-east-1/AGCODService/aws4_request, SignedHeaders=accept;content-type;host;x-amz-date;x-amz-target, Signature=519cd671dd26ab45cca71f8a1cbd56d07409b4649b0dbba0b2f5aa248a489b1c
{
  "activationRequestId": "Awssb0327141418PM",
  "partnerId": "Awssb",
  "cardNumber": "1700000005489413",
  "value": {
    "currencyCode": "USD",
    "amount": 10
  }
}

Sample ActivateGiftCard HTTP POST request with XML payload

POST /ActivateGiftCard HTTP/1.1
accept:charset=UTF-8
content-type:charset=UTF-8
host:agcod-v2-gamma.amazon.com
x-amz-date:20140327T212600Z
x-amz-target:com.amazonaws.agcod.AGCODService.ActivateGiftCard
Authorization:AWS4-HMAC-SHA256 Credential=AKIAJBYCL67O6NJUNYBQ/20140327/us-east-1/AGCODService/aws4_request, SignedHeaders=accept;content-type;host;x-amz-date;x-amz-target, Signature=bb4acbe8b115e24e07627fb862d2b3ea21c4f043fd4344c6f24b0a4d39961d9c
<ActivateGiftCardRequest>
    <activationRequestId>Awssb0327141418PM</activationRequestId>
    <partnerId>Awssb</partnerId>
    <cardNumber>1700000005489413</cardNumber>
    <value>
        <currencyCode>USD</currencyCode>
        <amount>10</amount>
    </value>
</ActivateGiftCardRequest>

Sample ActivationGiftCardResponse

JSON

{
  "activationRequestId": "Awssb0327141418PM",
  "cardInfo": {
    "cardNumber": "1700000005489413",
    "cardStatus": "Activated",
    "expirationDate": null,
    "value": {
      "amount": 10,
      "currencyCode": "USD"
    }
  },
  "status": "SUCCESS"
}

XML

<ActivateGiftCardResponse>
  <cardInfo>
    <value>
      <amount>10.0</amount>
      <currencyCode>USD</currencyCode>
    </value>
    <cardStatus>Activated</cardStatus>
    <cardNumber>1700000005489413</cardNumber>
  </cardInfo>
  <status>SUCCESS</status>
  <activationRequestId>Awssb0327141418PM</activationRequestId>
</ActivateGiftCardResponse>

Additional requirements at brick-and-mortar locations

Every call to ActivateGiftCard that occurs at a brick-and-mortar location must include details of the location where the transaction occurred. Requests to these endpoints can include a transactionSource object that describes the physical location of the event.

Field in transactionSource Description
sourceId Identifier of a transaction source entity (Example: Store Number or Store ID).
institutionId Identifier of a parent entity of a transaction source (Example: Merchant Id). If parent entity does not exist, copy sourceId.
sourceDetails string to provide further information about transaction source. It must contain institutionName key with value as name of the source (e.g. Merchant Name). Other information such as source location, phone-number, etc. should be included.
institutionParentCompany Name of the parent company for instituitionName. If there is no parent company, institutionName should be repeated.

There are two options for sending store location data to Amazon:

  1. Long form – partner provides specific store location data for each transaction (must include sourceId, institutionId and sourceDetails)
  2. Short form – partner provides only the sourceId and institutionId in the API request. A separate location mapping file must be sent that maps these identifiers to physical locations. See Location Mapping file instructions in this spreadsheet.

Sample "long form" payload for transaction source in both XML and JSON format is shown below. Note that sourceDetails must be formatted as a JSON blob. In the JSON example, the JSON blob uses the backslash to escape quotation marks.

Long form example of XML body (note that the sourceDetails value must be formatted as a JSON blob):

<ActivateGiftCardRequest>
   <value>
      <currencyCode>USD</currencyCode>
      <amount>150</amount>
   </value>
   <activationRequestId>Awssb0327141418PM</activationRequestId>
   <cardNumber>6215366885893081</cardNumber>
   <partnerId>Apppt</partnerId>
   <externalReference>{"promoCode":"855238"}</externalReference>
   <transactionSource>
      <sourceDetails>{"institutionName" : "Fred Meyer", "institutionParentCompany" : "Kroger", "address1" : "2041 148th Ave NE", "address2" : "", "city" : "Bellevue", "state" : "Washington", "zip" : "98007", "phoneNumber" : "+14258658560"}</sourceDetails>
      <id>{"institutionId" : "97263700007" , "sourceId" : "84000000109"}</id>
   </transactionSource>
</ActivateGiftCardRequest>

Long form example of JSON body:

{
  "value": {
    "currencyCode": "USD",
    "amount": 150
  },
  "activationRequestId": "Awssb0327141418PM",
  "cardNumber": "6215366885893081",
  "partnerId": "Apppt",
  "externalReference": "{\"promoCode\":\"855238\"}",
  "transactionSource": {
    "sourceDetails": "{\"institutionName\" : \"Fred Meyer\", \"institutionParentCompany\" : \"Kroger\", \"address1\" : \"2041 148th Ave NE\", \"address2\" : \"\", \"city\" : \"Bellevue\", \"state\" : \"Washington\", \"zip\" : \"98007\", \"phoneNumber\" : \"+14258658560\"}",
    "id": "{\"institutionId\" : \"97263700007\" , \"sourceId\" : \"84000000109\"}"
  }
}

Required for Resellers Only – ProgramID

You can use the programID field to assist in better tracking of client and use case transactions. The programID is an approved identifier provided by Amazon through a submission process where you submit client and use case information through the Incentives API Portal. Approved submissions will receive a reference number that will be added to each transaction call to the API. The programID is alphanumeric and can be up to 100 characters in length.

The below sample message highlights the modifications needed to accommodate the programID field.

<ActivateGiftCardRequest>
  <activationRequestId>Awssb0327141418PM</activationRequestId>
  <partnerId>Awssb</partnerId>
  <cardNumber>1700000005489413</cardNumber>
  <value>
    <currencyCode>USD</currencyCode>
    <amount>10</amount>
  </value>
  <programId>ObY8ftkZQoG3lp2cmEleqg</programId>
</ActivateGiftCardRequest>

Optional: externalReference attribute

You can use the externalReference field to pass your own reference identifier as a string when making claim code requests (up to 100 Unicode characters). The externalReference field may be used to store a convenient mapping to assist you with tracking. For example, you might specify insurance claims, kiosks, customer cases, order Ids, reseller customer accounts, or store information within the externalReference field.

The identifier passed in the externalReference field appears with the transaction in the Incentives API Portal, in the Detailed Activity download.

The following example includes an externalReference field.

POST /CreateGiftCard HTTP/1.1
accept:application/x-www-form-urlencoded; charset=UTF-8
content-type:application/x-www-form-urlencoded; charset=UTF-8
host:agcod-v2-eu-gamma.amazon.com
x-amz-date:20130910T221949Z
x-amz-target:com.amazonaws.agcod.AGCODService.CreateGiftCard
Authorization:AWS4-HMAC-SHA256 Credential=AKIAJBYCL67O6NJUNYBQ/20130910/us-east-1/AGCODService/aws4_request, SignedHeaders=accept;content-type;host;x-amz-date;x-amz-target, Signature=6dce900ea3557473ee750dfe11489dc667366ffc8823541fadf13934e5d64790
<CreateGiftCardRequest>
    <creationRequesgittId>AwssbTSpecTest001</creationRequesgittId>
    <partnerId>Awssb</partnerId>
   <value>
	      <currencyCode>EUR</currencyCode>
	      <amount>1.00</amount>
	  </value>
   <externalReference>889jj14797<externalReference>
</CreateGiftCardRequest>

DeactivateGiftCard

The DeactivateGiftCard opeartion puts a physical card into an inactive state. An inactive card cannot be redeemed by a customer.

You can deactivate a WAC under the following conditions:

  • The claim code associated with the WAC is not claimed by an Amazon customer.
  • The WAC is not in Invalidated state.
  • The WAC was previously activated by the same partner. Both the original activationRequestId used for activating the WAC and the card number must be supplied for a DeactivateGiftCard operation.

To perform this operation, send a DeactivateGiftCard request. The Incentives API responds with a synchronous DeactivateGiftCardResponse.

This operation is idempotent, so if the Incentives API receives more than one request with the same activationRequestId, then the first request will result in the deactivation of the WAC, while all subsequent responses will do nothing (they will not be treated as a different transaction).

Sample DeactivateGiftCard HTTP POST request with JSON payload

SIGNED REQUEST

POST /DeactivateGiftCard HTTP/1.1
accept:application/json
content-type:application/json
host:agcod-v2-gamma.amazon.com
x-amz-date:20140327T213727Z
x-amz-target:com.amazonaws.agcod.AGCODService.DeactivateGiftCard
Authorization:AWS4-HMAC-SHA256 Credential=AKIAJBYCL67O6NJUNYBQ/20140327/us-east-1/AGCODService/aws4_request, SignedHeaders=accept;content-type;host;x-amz-date;x-amz-target, Signature=86a6ce1bfdb1e0e5842b5e351ad87058b673bdc6f7fd770c6fdb8349a1de1bde
{
  "activationRequestId": "Awssb0327141418PM", 
  "partnerId": "Awssb", 
  "cardNumber": "1700000005489413"
}

Sample DeactivateGiftCard HTTP POST request with XML payload

POST /DeactivateGiftCard HTTP/1.1
accept:charset=UTF-8
content-type:charset=UTF-8
host:agcod-v2-gamma.amazon.com
x-amz-date:20140327T213942Z
x-amz-target:com.amazonaws.agcod.AGCODService.DeactivateGiftCard
Authorization:AWS4-HMAC-SHA256 Credential=AKIAJBYCL67O6NJUNYBQ/20140327/us-east-1/AGCODService/aws4_request, SignedHeaders=accept;content-type;host;x-amz-date;x-amz-target, Signature=0ace0a2eaefc9ecf62e1224c7e59abe46af934a8e772b808c18dccdfdab009a5
<DeactivateGiftCardRequest>
    <activationRequestId>Awssb0327141418PM</activationRequestId>
    <partnerId>Awssb</partnerId>
    <cardNumber>1700000005489413</cardNumber>
</DeactivateGiftCardRequest>

Sample DeactivateGiftCardResponse

JSON

{
  "activationRequestId": "Awssb0327141418PM",
  "cardInfo": {
    "cardNumber": "1700000005489413",
    "cardStatus": "AwaitingActivation",
    "expirationDate": null,
    "value": null
  },
  "status": "SUCCESS"
}

XML

<DeactivateGiftCardResponse>
  <cardInfo>
    <cardStatus>AwaitingActivation</cardStatus>
    <cardNumber>1700000005489413</cardNumber>
  </cardInfo>
  <status>SUCCESS</status>
  <activationRequestId>Awssb0327141418PM</activationRequestId>
</DeactivateGiftCardResponse>

ActivationStatusCheck

Use the ActivationStatusCheck operation to verify the status of the WAC after executing the ActivateGiftCard/DeactivateGiftCard call, Amazon will respond with a synchronous ActivationStatusCheckResponse that provides the current status of the WAC.

The WAC statuses returned are Activated, AwaitingActivation, or Invalidated.

Sample ActivationStatusCheck HTTP POST request with JSON payload

POST /ActivationStatusCheck HTTP/1.1
accept:application/json
content-type:application/json
host:agcod-v2-gamma.amazon.com
x-amz-date:20140327T234321Z
x-amz-target:com.amazonaws.agcod.AGCODService.ActivationStatusCheck
Authorization:AWS4-HMAC-SHA256 Credential=AKIAJBYCL67O6NJUNYBQ/20140327/us-east-1/AGCODService/aws4_request, SignedHeaders=accept;content-type;host;x-amz-date;x-amz-target, Signature=ae3aa76cdc3043d45ca962a3a85ea9b95c6202a87f9700e7fe04b4c8d956ca31
{
  "statusCheckRequestId": "Awssb0327141418PM", 
  "partnerId": "Awssb", 
  "cardNumber": "1700000005489413"
}

Sample ActivationStatusCheck HTTP POST request with XML payload

POST /ActivationStatusCheck HTTP/1.1
accept:charset=UTF-8
content-type:charset=UTF-8
host:agcod-v2-gamma.amazon.com
x-amz-date:20140327T234634Z
x-amz-target:com.amazonaws.agcod.AGCODService.ActivationStatusCheck
Authorization:AWS4-HMAC-SHA256 Credential=AKIAJBYCL67O6NJUNYBQ/20140327/us-east-1/AGCODService/aws4_request, SignedHeaders=accept;content-type;host;x-amz-date;x-amz-target, Signature=96025ab925782595bffde21366bcd1927406ce5ddb723e89088f2cb0026040e8
<ActivationStatusCheckRequest>
  <statusCheckRequestId>Awssb0327141418PM</statusCheckRequestId>
  <partnerId>Awssb</partnerId>
  <cardNumber>1700000005489413</cardNumber>
</ActivationStatusCheckRequest>

Sample ActivationStatusCheckResponse

JSON

If WAC is not already activated:

{
  "cardInfo": {
    "cardNumber": "1700000005489413",
    "cardStatus": "AwaitingActivation",
    "expirationDate": null,
    "value": null
  },
  "status": "SUCCESS",
  "statusCheckRequestId": "Awssb0327141418PM"
}

If WAC is already activated:

{
  "cardInfo": {
    "cardNumber": "1700000005489413",
    "cardStatus": "Activated",
    "value": null
  },
  "status": "SUCCESS",
  "statusCheckRequestId": " Awssb0327141418PM"
}

XML

If WAC is not already activated:

<ActivationStatusCheckResponse>
  <cardInfo>
    <cardStatus>AwaitingActivation</cardStatus>
    <cardNumber>1700000005489413</cardNumber>
  </cardInfo>
  <status>SUCCESS</status>
  <statusCheckRequestId>Awssb0327141418PM</statusCheckRequestId>
</ActivationStatusCheckResponse>

If WAC is already activated:

<ActivationStatusCheckResponse>
  <cardInfo>
    <cardStatus>Activated</cardStatus>
    <cardNumber>1700000005489413</cardNumber>
  </cardInfo>
  <status>SUCCESS</status>
  < statusCheckRequestId> Awssb0327141418PM</statusCheckRequestId>
</ActivationStatusCheckResponse>

GetAvailableFunds

The GetAvailableFunds operation returns the amount of funds currently available in your Amazon Incentives account. It provides an alternative to logging into the Incentives API Portal to view available funds. You can use this operation to monitor your balance and raise alerts.

Request Parameter Description
partnerId A case sensitive unique identifier assigned to your account by Amazon
Response Parameter Description
amount The value of funds currently available in your prepay/postpay account. Note: the Sandbox environment will always return a zero value.
currencyCode The ISO-4217 currency code
status The status of the request. In normal operation, this value is success.
timestamp Date returned in UTC yyyy-MM-dd HH:mm:ss

Sample request

POST
/GetAvailableFunds HTTP/1.1

accept:application/json
host:agcod-v2-gamma.amazon.com
x-amz-date:20170111T000339Z
x-amz-target:com.amazonaws.agcod.AGCODService.GetAvailableFunds
Authorization:AWS4-HMAC-SHA256 Credential=AKIAIGHKAVYIDBOH3O3A/20170111/us-east-1/AGCODService/aws4_request,SignedHeaders=accept;host;x-amz-date;x-amz-target, Signature=ec86661c1d39f74b5891666505bb7656b172b0d060d911bee3b6a1c29ae17657
{"partnerId": "Aptuk"}

Sample response

{
  "availableFunds":{
    "amount":10.0,
    "currencyCode":"USD"
  },
  "status":"SUCCESS",
  "timestamp":20170915T200959Z
}

Test examples

We have provided mock error request IDs to simulate certain responses with the Activate/Deactivate calls. When simulating an error response, the mock error request ID will need to be passed in as the activationRequestId. The values provided for the rest of the fields will be echoed in the response.

SUCCESS Mocking test with requestId "F0000"

SIGNED REQUEST

POST /ActivateGiftCard HTTP/1.1
accept:charset=UTF-8
content-type:charset=UTF-8
host:agcod-v2-gamma.amazon.com
x-amz-date:20140402T234117Z
x-amz-target:com.amazonaws.agcod.AGCODService.ActivateGiftCard
Authorization:AWS4-HMAC-SHA256 Credential=AKIAJBYCL67O6NJUNYBQ/20140402/us-east-1/AGCODService/aws4_request, SignedHeaders=accept;content-type;host;x-amz-date;x-amz-target, Signature=fdd5f610c04cea390b07d6f2e4891516f6bdfa0158595e7deda8eedc8468422d
<ActivateGiftCardRequest>
  <activationRequestId>F0000</activationRequestId> 
  <partnerId>Awssb</partnerId>
  <cardNumber>abc123</cardNumber>
  <value>
    <currencyCode>phonybucks</currencyCode
    ><amount>10</amount>
  </value>
</ActivateGiftCardRequest>

RESPONSE

<ActivateGiftCardResponse>
  <cardInfo>
    <value>
      <amount>10.0</amount>
      <currencyCode>phonybucks</currencyCode>
    </value>
    <cardStatus>Activated</cardStatus>
    <cardNumber>abc123</cardNumber>
  </cardInfo>
  <status>SUCCESS</status>
  <activationRequestId>F0000</activationRequestId>
</ActivateGiftCardResponse>



## FAILURE Mocking test with requestId “F2005”  

**SIGNED REQUEST**

```xml
POST /ActivateGiftCard HTTP/1.1
accept:charset=UTF-8
content-type:charset=UTF-8
host:agcod-v2-gamma.amazon.com
x-amz-date:20140402T234840Z
x-amz-target:com.amazonaws.agcod.AGCODService.ActivateGiftCard
Authorization:AWS4-HMAC-SHA256 Credential=AKIAJBYCL67O6NJUNYBQ/20140402/us-east-1/AGCODService/aws4_request, SignedHeaders=accept;content-type;host;x-amz-date;x-amz-target, Signature=fa280d821ac7a8ba3e031e463c7c121509642cd6f7bf54c3a4586bfc2d8eae8f
<ActivateGiftCardRequest>
  <activationRequestId>F2005</activationRequestId> 
  <partnerId>Awssb</partnerId>
  <cardNumber>abcdef</cardNumber>
  <value>
    <currencyCode>phonybucks</currencyCode>
    <amount>10</amount>
  </value>
</ActivateGiftCardRequest>

RESPONSE

<AGCODValidationException>
  <Message>Currency Code can't be null or empty</Message>
  <errorType>InvalidCurrencyCodeInput</errorType>
  <errorCode>F200</errorCode>
  <agcodResponse>
    <status>FAILURE</status>
  </agcodResponse>
</AGCODValidationException>

Activate Physical Stock (AKA: POSA) Test Script

To verify your integration with the API run through the following tests:

Test Description Test Case Detail Expected Result
1. Status Check Send an ActivationStatusCheck request for a sandbox card number that has not been used before. You should receive a SUCCESS response with the card status of Activated.
2. Activate Card Send an ActivateGiftCard request to the Sandbox URL for the card number used in the Status Check (1). You should receive a SUCCESS response with the card status of Activated.
3. Deactivate Card Send a DeactivateGiftCard request using the same requestId for the card number that was activated (2). You should receive a SUCCESS with the card status of AwaitingActivation.
4. Activate Idempotency Send a new ActivateGiftCard request and record the response. Resend the same Activate request using the same request Id and amount. You should receive a SUCCESS with the same response as the original request.

Web Activation FAQ

Q.1 How should I use the Activate and Deactivate APIs?

A.1 Use the ActivateGiftCard operation to activate a gift card by providing the activationRequestId and amount (denominated or pre-denominated amount depending on the card type). If you have already successfully activated a GC, and need to cancel it, you need to provide the original activationRequestId, amount, and currency values you used in the successful ActivateGiftCard operation. If you see a timeout from the AGCOD Gateway when making a ActivateGiftCard or DeactivateGiftCard operation, and are unsure if your call succeeded, then invoke ActivationStatusCheck to check the card status.


Q.2 I am getting “The card was already activated with a different request id” error when making an ActivateGiftCard call.

A.2 This might be caused by the same Card Serial Number activated with a different ```activationRequestId. Find the original activationRequestId` and try the call again.


Q.3 Are there time limits from when an ActivateGiftCard request is made and when a DeactivateGiftCard will be accepted?

A.3 There is currently no time limit. Calls to DeactivateGiftCard will fail after a usage transaction has been processed for the gift card. For example, if the gift card has been claimed by your end customer, a call to DeactivateGiftCard will fail. In addition, an activated gift card cannot be deactivated after its expiration date. Gift cards issued in the United States, Canada, and Australia do not expire.


Last updated: May 26, 2021