Activar tarjetas físicas
Asegúrese de configurar su cuenta de la API de Amazon Incentives antes de iniciar la integración. Crear una cuenta de la API de Incentives.
La API de Incentives le permite crear y distribuir códigos de reclamación de cheques regalo de Amazon bajo demanda. Con esta API, puede insertar códigos de reclamación a modo de cheques regalo electrónicos, admitir regalos grupales y proporcionar el canjeo en tiempo real de códigos de reclamación en programas de fidelidad (es decir, programas de puntos).
Cada cheque regalo está asociado a una única tarjeta activada por web (WAC) y a una denominación (valor en dólares) pregenerada. El cheque regalo se puede activar en tiempo real. Una vez activado, el cheque regalo asociado a la WAC se puede distribuir y el cliente puede utilizarlo para realizar compras en Amazon.
Las operaciones de Activación web de la API de Incentives proporcionan una interfaz programática que puede utilizar para activar/desactivar los cheques regalo en tiempo real. Realice solicitudes simultáneas en el punto de enlace que especifica el valor de la WAC que desee activar para las tarjetas no denominadas o que proporciona la cantidad predenominada coincidente para las tarjetas predenominadas. La API responde con un estado positivo o de error de la operación.
Hay dos tipos de tarjetas activadas por web:
- Denominada (importe fijo): el importe ya está predeterminado para el código de reclamación
- No denominada (importe variable) : importe asignado cuando se activa el código de reclamación
El administrador de cuentas proporcionará los números WAC junto con los códigos de reclamación asociados según sea necesario.
Nota: Solo los socios autorizados pueden activar tarjetas por web.
- Identificadores de solicitud
- Operaciones
- Ejemplos de prueba
- Activar stock físico (también conocido como: POSA) Script de prueba
- Preguntas frecuentes sobre Activación web
Identificadores de solicitud
Una llamada a un punto de enlace incluye un valor RequestId en el cuerpo de la solicitud.
activationRequestId
: identificador único para cada llamada de ActivateGiftCard/DeactivateGiftCard que dé como resultado la activación/desactivación de una tarjeta activada por web (WAC). Debe generar un nuevo valor para cada solicitud de activación (excepto para reintentos). Cada valor de activationRequestId comienza con su partnerId, seguido del valor alfanumérico que usted genere (debe ser único dentro de sus sistemas). Un valoractivationRequestId
no puede superar los 40 caracteres. Una segunda llamada con el mismo valoractivationRequestId
devuelve el estado original que se creó la primera vez que se vio el valoractivationRequestId
.statusCheckRequestId
: identificador utilizado en una llamadaActivationStatusCheck
para obtener el estado de una WAC en cualquier momento después de una solicitudActivateGiftCard
positiva. Este valor debe coincidir con el valoractivationRequestId
utilizado en la anterior llamadaActivateGiftCard
.
Número de activación de tarjeta por web y Suma de comprobación: el número de tarjeta WA de 16 dígitos enviado con la suma de comprobación de tres dígitos al realizar solicitudes de punto de enlace (ejemplo: 1400000005567585358). Dado que los números de la tarjeta suelen emitirse en un rango (por ejemplo: 1400000005567585 - 1400000005568000), debe utilizar la suma de comprobación para verificar que se haya enviado el número de tarjeta correcto en su solicitud de activación. Esta comprobación es especialmente importante si una tarjeta se activa manualmente y los números se verbalizan. Consulte el siguiente ejemplo que contiene una WAC y tenga en cuenta que Amazon utilizará un formato similar al proporcionar WAC/códigos de reclamación cuando se use la Activación web.
SECUENCIA | NÚMERO DE TARJETA | SUMA DE COMPROBACIÓN | CANTIDAD | CÓDIGO DE RECLAMACIÓN |
---|---|---|---|---|
1 | 1400000005567585 | 358 | $0.00 | WA2W-A3CYCB-RDAMZ |
2 | 1400000005567586 | 149 | $0.00 | WAS3-C8PP8R-MZMMD |
Origen de la transacción (solo socios en físico): datos de ubicación para identificar dónde se activó el cheque regalo. Este parámetro es necesario para todas las solicitudes físicas (POSA).
Este parámetro se compone de estos componentes:
Componente | Descripción |
---|---|
sourceId |
Identificador de la entidad de origen de una transacción (Ejemplo: número de tienda o ID de tienda). |
institutionId |
Identificador de una entidad matriz de origen de una transacción (Ejemplo: ID del vendedor). Si la entidad matriz no existe, copie sourceId. |
sourceDetails |
cadena para proporcionar más información sobre el origen de la transacción. Debe contener la clave institutionName con valor como nombre de la fuente (por ejemplo, nombre del comerciante). Debe incluirse otra información, como la ubicación de la fuente, el número de teléfono, etc. |
institutionParentCompany |
Nombre de la empresa matriz para instituitionName. Si no hay una empresa matriz, se debe repetir institutionName. |
Tiene dos opciones para enviar datos de ubicación de la tienda de Amazon.
- Formulario largo: el socio proporciona datos específicos de ubicación de almacén para cada transacción (debe incluir
sourceId
,institutionId
ysourceDetails
). - Formulario corto: el socio proporciona solo el sourceId y el institutionId en la solicitud de la API. Para que Amazon pueda analizar los datos, se debe enviar un archivo de mapeo de ubicación independiente.
Instrucciones del archivo de mapeo de ubicación
Los siguientes ejemplos muestran una carga de "formulario largo" para el origen de la transacción en formato XML y JSON. Tenga en cuenta que sourceDetails
debe formatearse como un blob de JSON.
XML
<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>
JSON
{"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\"}"}}
Requerido solo para revendedores: ProgramId
Puede utilizar el campo programId para ayudar a hacer un seguimiento de las transacciones de clientes y ejemplos de uso. El programID es un identificador aprobado proporcionado por Amazon a través de un proceso de entrega en el que se envía información del cliente y del ejemplo de uso a través del portal de la API de Incentives. Los envíos aprobados recibirán un número de referencia que se agregará a cada llamada de transacción a la API. El programID es alfanumérico y puede tener hasta 100 caracteres de longitud.
El siguiente mensaje de muestra resalta las modificaciones necesarias para acomodar el campo programID.
<ActivateGiftCardRequest>
<activationRequestId>Awssb0327141418PM</activationRequestId>
<partnerId>Awssb</partnerId>
<cardNumber>1700000005489413</cardNumber>
<value>
<currencyCode>USD</currencyCode>
<amount>10</amount>
</value>
<programId>ObY8ftkZQoG3lp2cmEleqg</programId>
</ActivateGiftCardRequest>
Nota: Para los socios de cupones de producto, no hay ningún cambio en el formato de solicitud, ya que el "cardNumber" enviado se asignará al tipo de cupón de producto correspondiente durante la generación de la tarjeta.
Operaciones
Operación | Descripción |
---|---|
ActivateGiftCard |
Activa una tarjeta física, para que un cliente pueda canjearla. |
DeactivateGiftCard |
Desactiva una tarjeta física, por lo que no se puede canjear. |
ActivationStatusCheck |
Informa del estado de activación de un cheque regalo físico. |
Parámetros comunes
Parámetro | Valor de ejemplo |
---|---|
Método de solicitud HTTP | POST |
URI canónico | (comienza con /) |
Cadena de consulta canónica | (cadena vacía) |
Encabezados canónicos | (ver más abajo) |
SignedHeaders | content-type;host;x-amz-date;x-amz-target |
Algoritmo | AWS4-HMAC-SHA256 |
Fecha de solicitud | 20140327T212600Z |
CredentialScope | 20140327/us-east-1/AGCODService/aws4_request |
Nombre del servicio | AGCODService |
Id. de solicitud de activación | Awssb0327141418PM |
Servidor | agcod-v2-gamma.amazon.com (el punto de enlace aplicable se puede encontrar en las especificaciones técnicas) |
Nombre de la región | us-east-1 (la región aplicable se puede encontrar en las especificaciones técnicas) |
ID de socio | Awssb (use your own Partner ID) |
Número de tarjeta | 1700000005489413 |
Los encabezados canónicos pueden ser:
content-type:application/json
host: agcod-v2-gamma.amazon.com
x-amz-date: 20140327T212600Z
x-amz-target: com.amazonaws.agcod.AGCODService.ActivateGiftCard
o
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
La operación ActivateGiftCard
activa una tarjeta física. Un cliente puede canjear una tarjeta física activa.
Envíe un activationRequestId
que identifica de forma exclusiva esa solicitud de activación, junto con otros detalles como la denominación, moneda, etc. (además de los metadatos sobre esa solicitud, información de autenticación, etc.)
Para realizar esta operación, envíe una solicitud ActivateGiftCard
. Amazon comprueba si hay fondos suficientes en su cuenta de Amazon Payments u otra cuenta de pago anticipado y, a continuación, deduce los fondos de la cuenta y responde con un mensaje de respuesta simultáneo que incluye el estado de activación, cardNumber
, cardStatus
y activationRequestId
. Debe almacenar activationRequestId
, amount
y currencyCode
para todas las solicitudes posteriores relacionadas con la misma transacción. El mensaje de respuesta también contiene algunos metadatos, junto con el estado de la ejecución. Actualmente, los estados de la tarjeta activada por web (WAC) devueltos son Activated
, AwaitingActivation
o Invalidated
.
Esta operación es idempotente, por lo que si la API de Incentives recibe más de una solicitud con el mismo activationRequestId
, la primera solicitud dará como resultado la activación de una nueva WAC, mientras que todas las respuestas posteriores devolverán la WAC activada originalmente, y no serán tratadas como transacciones separadas.
Notas:
- Una llamada de
ActivateGiftCard
da como resultado una sola activación. (La activación masiva no es compatible en este momento). - Como capa adicional de protección contra fraude, cuando se realizan tres intentos de reclamación a un código de reclamación asociado a una variable denominada WAC (denota por un valor inicial de 0 $) cuando se encuentra en el estado
AwaitingActivation
el estado WAC cambiará aInvalidated
.ActivateGiftCard/DeactivateGiftCard
no podrá operar contra la WAC en el estadoInvalidated
. Si encuentra un gran número de WAC con estadoInvalidated
podría ser indicativo de actividades fraudulentas contra las tarjetas WAC o errores de procesamiento por su parte. Póngase en contacto con su administrador de cuentas para obtener ayuda. - El valor de la moneda varía según el segmento de mercado nacional.
Muestra de solicitud ActivateGiftCard HTTP POST con carga JSON
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
}
}
Muestra de solicitud ActivateGiftCard HTTP POST con carga XML
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: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>
Muestra de 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>
Requisitos adicionales en emplazamientos físicos
Cada llamada a ActivateGiftCard que se produzca en una ubicación física debe incluir detalles de la ubicación en la que se produjo la transacción. Las solicitudes a estos puntos de enlace pueden incluir un objeto transactionSource
que describe la ubicación física del evento.
Campo en transactionSource |
Descripción |
---|---|
sourceId |
Identificador de la entidad de origen de una transacción (Ejemplo: número de tienda o ID de tienda). |
institutionId |
Identificador de una entidad matriz de origen de una transacción (Ejemplo: ID del vendedor). Si la entidad matriz no existe, copie sourceId . |
sourceDetails |
cadena para proporcionar más información sobre el origen de la transacción. Debe contener la clave institutionName con valor como nombre de la fuente (por ejemplo, nombre del comerciante). Debe incluirse otra información, como la ubicación de la fuente, el número de teléfono, etc. |
institutionParentCompany |
Nombre de la empresa matriz para instituitionName . Si no hay una empresa matriz, se debe repetir institutionName . |
Existen dos opciones para enviar datos de ubicación de tienda a Amazon:
- Formulario largo: el socio proporciona datos específicos de ubicación del almacén para cada transacción (debe incluir
sourceId
,institutionId
ysourceDetails
) - Formulario corto: el socio proporciona solo el
sourceId
y elinstitutionId
en la solicitud de la API. Debe enviarse un archivo de mapeo de ubicación independiente que asigne estos identificadores a ubicaciones físicas. Consulte las instrucciones del archivo de mapeo de ubicaciones en esta hoja de cálculo.
A continuación se muestra un ejemplo de carga de "formulario largo" para el origen de la transacción en formato XML y JSON. Tenga en cuenta que sourceDetails
debe formatearse como un blob de JSON. En el ejemplo JSON, el blob de JSON utiliza la barra invertida para evitar las comillas.
Ejemplo de formulario largo del cuerpo XML (tenga en cuenta que el valor sourceDetails
` debe formatearse como un blob de JSON):
<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>
Ejemplo de formulario largo del cuerpo JSON:
{
"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\"}"
}
}
DeactivateGiftCard
La funciónDeactivateGiftCard desactiva una tarjeta física. Un cliente no puede canjear una tarjeta inactiva.
Puede desactivar una WAC en las siguientes condiciones:
- El código de reclamación asociado a la WAC no lo ha reclamado un cliente de Amazon.
- La WAC no se encuentra en el estado Invalidated.
- El mismo socio activó la WAC previamente. Tanto el activationRequestId original utilizado para activar la WAC como el número de tarjeta deben suministrarse para llevar a cabo la operación DeactivateGiftCard.
Para realizar esta operación, envíe una solicitud DeactivateGiftCard. La API de Incentives responde con una respuesta simultánea DeactivateGiftCardResponse.
Esta operación es idempotente, por lo que si la API de Incentives recibe más de una solicitud con el mismo activationRequestId, entonces la primera solicitud dará como resultado la desactivación de la WAC, mientras que todas las respuestas posteriores no harán nada (no se tratarán como un transacción).
Nota: Las operaciones de ActivateGiftCard/DeactivateGiftCard solo se deben utilizar con cheques regalo físicos y no con códigos de reclamación creados con la API CreateGiftCard.
Muestra de solicitud DeactivateGiftCard HTTP POST con carga JSON
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"}
Muestra de solicitud DeactivateGiftCard HTTP POST con carga XML
SIGNED REQUEST
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>
Muestra de 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
Utilice la operación ActivationStatusCheck para verificar el estado de la WAC después de ejecutar la llamada ActivateGiftCard/DeactivateGiftCard, Amazon responderá con un ActivationStatusCheckResponse simultáneo que proporciona el estado de la WAC.
Los estados WAC devueltos son Activated, AwaitingActivation o Invalidated.
Nota: Las operaciones de CreateGiftCard/CancelGiftCard y ActivateGiftCard/DeactivateGiftCard no deben mezclarse, por ejemplo, un código de reclamación creado con la llamada CreateGiftCard no debe desactivarse con la llamada DeactivateGiftCard. Del mismo modo, un código de reclamación activado con ActivateGiftCard no debe cancelarse con la llamada CancelGiftCard.
Muestra de solicitud ActivationStatusCheck HTTP POST con carga JSON
SIGNED REQUEST
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"}
Muestra de solicitud ActivationStatusCheck HTTP POST con carga XML
SIGNED REQUEST
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>
Muestra de ActivationStatusCheckResponse
JSON
Si la WAC aún no está activada:
{
"cardInfo": {
"cardNumber": "1700000005489413",
"cardStatus": "AwaitingActivation",
"expirationDate": null,
"value": null
},
"status": "SUCCESS",
"statusCheckRequestId": "Awssb0327141418PM"
}
O, si la WAC ya está activada:
{
"cardInfo": {
"cardNumber": "1700000005489413",
"cardStatus": "Activated",
"value": null
},
"status": "SUCCESS",
"statusCheckRequestId": " Awssb0327141418PM"
}
XML
Si la WAC aún no está activada:
<ActivationStatusCheckResponse>
<cardInfo>
<cardStatus>AwaitingActivation</cardStatus>
<cardNumber>1700000005489413</cardNumber>
</cardInfo>
<status>SUCCESS</status>
<statusCheckRequestId>Awssb0327141418PM</statusCheckRequestId>
</ActivationStatusCheckResponse>
O, si la WAC ya está activada:
<ActivationStatusCheckResponse>
<cardInfo>
<cardStatus>Activated</cardStatus>
<cardNumber>1700000005489413</cardNumber>
</cardInfo>
<status>SUCCESS</status>
< statusCheckRequestId> Awssb0327141418PM</statusCheckRequestId>
</ActivationStatusCheckResponse>
Ejemplos de prueba
Hemos proporcionado ID de solicitud de error simulados para simular ciertas respuestas con las llamadas Activar/Desactivar. Al simular una respuesta de error, el ID de solicitud de error simulado tendrá que pasar como el activationRequestId. Los valores proporcionados para el resto de los campos se repetirán en la respuesta.
Prueba de simulación positiva con 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>
Prueba de simulación fallida con requestId "F2005"
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: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>
Activar inventario físico (también conocido como: POSA) Script de prueba
Para verificar su integración con la API, ejecute las siguientes pruebas:
Descripción de la prueba | Detalle del caso de prueba | Resultado esperado |
---|---|---|
1. Comprobar estado | Envíe una solicitud ActivationStatusCheck para un número de tarjeta de Sandbox que no se haya utilizado antes. |
Debe recibir una respuesta SUCCESS con el estado en la tarjeta de Activated . |
2. Activar tarjeta | Envíe una solicitud ActivateGiftCard a la URL de Sandbox para el número de tarjeta utilizado en la comprobación de estado (1). |
Debe recibir una respuesta SUCCESS con el estado en la tarjeta de Activated . |
3. Desactivar tarjeta | Envíe una solicitud DeactivateGiftCard utilizando el mismo requestId para el número de tarjeta que se activó (2). |
Debe recibir SUCCESS con el estado de la tarjeta de AwaitingActivation . |
4. Activar Idempotencia | Envíe una nueva solicitud ActivateGiftCard y registre la respuesta. Vuelva a enviar la misma solicitud de activación utilizando el mismo ID de solicitud y el mismo importe. |
Debe recibir un SUCCESS con la misma respuesta que la solicitud original. |
Preguntas frecuentes sobre Activación web
P.1 ¿Cómo debo usar las API de activación y desactivación?
R.1 Utilice la operación ActivateGiftCard
para activar un cheque regalo proporcionando activationRequestId
y la cantidad (cantidad denominada o predenominada según el tipo de tarjeta). Si ya ha activado correctamente un cheque regalo y necesita cancelarlo, debe proporcionar los valores originales activationRequestId
, el importe y la moneda que utilizó en la operación positiva de ActivateGiftCard
. Si ve un límite de tiempo desde el portal de AGCOD al realizar una operación ActivateGiftCard
o DeactivateGiftCard
y no está seguro de si la llamada se ha realizado correctamente, invoque ActivationStatusCheck
para comprobar el estado de la tarjeta.
P.2 He recibido el error "The card was already activated with a different request id" al realizar una llamada a ActivateGiftCard
.
R.2 La causa podría ser que el mismo número de serie de tarjeta se haya activado con un activationRequestId
diferente. Busque el activationRequestId
original e intente la llamada de nuevo.
P.3 ¿Hay límites de tiempo desde el momento en que se realiza una solicitud ActivateGiftCard
y desde el momento en que se acepta DeactivateGiftCard
?
R.3 Actualmente no hay límite de tiempo. Las llamadas a DeactivateGiftCard
fallarán después de que se haya procesado una transacción de uso para el cheque regalo. Por ejemplo, si el cliente final ha reclamado el cheque regalo, se producirá un error en la llamada a DeactivateGiftCard
. Además, un cheque regalo activado no se podrá desactivar después de su fecha de caducidad. Los cheques regalo emitidos en Estados Unidos, Canadá y Australia no caducan.