AsyncAPI for revocation service 0.0.1 documentation

Published Messages (revocation)

The service publishes one of these messages below.

revocationCompleted

Message is sent when revoking user item ownership. Contains fields from and the following payload.

Example value

{
  "payload": {
    "userId": "string",
    "source": "string",
    "meta": {},
    "creditRevocations": [
      {
        "walletId": "string",
        "currencyCode": "string",
        "balanceOrigin": "string",
        "amount": 0,
        "status": "SUCCESS",
        "revocationStrategy": "string",
        "skipped": true,
        "reason": "string"
      }
    ],
    "entitlementRevocations": [
      {
        "entitlementId": "string",
        "quantity": 0,
        "itemId": "string",
        "itemSku": "string",
        "revocationStrategy": "string",
        "status": "SUCCESS",
        "skipped": true,
        "reason": "string"
      }
    ],
    "revokeEntries": [
      {
        "type": "ITEM",
        "item": {
          "itemIdentityType": "ITEM_ID",
          "itemIdentity": "string"
        },
        "entitlement": {
          "entitlementId": "string",
          "type": "string",
          "clazz": "string"
        },
        "currency": {
          "walletId": "string",
          "namespace": "string",
          "currencyCode": "string",
          "balanceOrigin": "string"
        },
        "quantity": 0
      }
    ],
    "itemRevocations": [
      {
        "quantity": 0,
        "itemId": "string",
        "itemSku": "string",
        "itemType": "string",
        "revocationStrategy": "string",
        "status": "SUCCESS",
        "skipped": true,
        "reason": "string",
        "itemRevocations": [
          {
            "quantity": 0,
            "itemId": "string",
            "itemSku": "string",
            "itemType": "string",
            "revocationStrategy": "string",
            "status": "SUCCESS",
            "skipped": true,
            "reason": "string",
            "itemRevocations": [
              {}
            ],
            "creditRevocations": [
              {
                "walletId": "string",
                "currencyCode": "string",
                "balanceOrigin": "string",
                "amount": 0,
                "status": "SUCCESS",
                "revocationStrategy": "string",
                "skipped": true,
                "reason": "string"
              }
            ],
            "entitlementRevocations": [
              {
                "entitlementId": "string",
                "quantity": 0,
                "itemId": "string",
                "itemSku": "string",
                "revocationStrategy": "string",
                "status": "SUCCESS",
                "skipped": true,
                "reason": "string"
              }
            ]
          }
        ],
        "creditRevocations": [
          {
            "walletId": "string",
            "currencyCode": "string",
            "balanceOrigin": "string",
            "amount": 0,
            "status": "SUCCESS",
            "revocationStrategy": "string",
            "skipped": true,
            "reason": "string"
          }
        ],
        "entitlementRevocations": [
          {
            "entitlementId": "string",
            "quantity": 0,
            "itemId": "string",
            "itemSku": "string",
            "revocationStrategy": "string",
            "status": "SUCCESS",
            "skipped": true,
            "reason": "string"
          }
        ]
      }
    ],
    "revocationId": "string",
    "namespace": "string",
    "status": "SUCCESS",
    "revocationError": [
      {
        "httpStatus": 0,
        "code": 0,
        "message": "string"
      }
    ],
    "requestId": "string"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
userId	string	userId
source	string	current revocation source constains these DLC, ORDER, OTHER
meta	object	revocation source meta properties, will put store orderNo, DLC transaction record id into it
creditRevocations	array<object>	credit revocations
entitlementRevocations	array<object>	credit revocations
revokeEntries	array<object>	revoke entry request list
itemRevocations	array<object>	item revocations
revocationId	string	revocation history id
namespace	string	namespace
status	string	revocation status
revocationError	array<object>	-
requestId	string	-

payload.meta

This is a free-form object.

payload.creditRevocations[number]

Name	Type	Description
walletId	string	-
currencyCode	string	-
balanceOrigin	string	-
amount	integer (int32)	-
status	string	revocation status
revocationStrategy	string	-
skipped	boolean	-
reason	string	-

payload.entitlementRevocations[number]

Name	Type	Description
entitlementId	string	-
quantity	integer (int32)	-
itemId	string	-
itemSku	string	-
revocationStrategy	string	-
status	string	revocation status
skipped	boolean	-
reason	string	-

payload.revokeEntries[number]

Name	Type	Description
type	string	-
item	object	-
entitlement	object	-
currency	object	-
quantity	integer (int32)	-

payload.revokeEntries[number].item

Name	Type	Description
itemIdentityType	string	-
itemIdentity	string	item id or item sku

payload.revokeEntries[number].entitlement

Name	Type	Description
entitlementId	string	-
type	string	entitlement type
clazz	string	entitlement clazz

payload.revokeEntries[number].currency

Name	Type	Description
walletId	string	-
namespace	string	-
currencyCode	string	-
balanceOrigin	string	-

payload.itemRevocations[number]

Name	Type	Description
quantity	integer (int32)	-
itemId	string	-
itemSku	string	-
itemType	string	-
revocationStrategy	string	-
status	string	revocation status
skipped	boolean	-
reason	string	-
itemRevocations	array<object>	-
creditRevocations	array<object>	-
entitlementRevocations	array<object>	-

payload.itemRevocations[number].itemRevocations[number]

Name	Type	Description
quantity	integer (int32)	-
itemId	string	-
itemSku	string	-
itemType	string	-
revocationStrategy	string	-
status	string	revocation status
skipped	boolean	-
reason	string	-
itemRevocations	array<object>	This is an instance of itemRevocation but is treated as a freeform object to avoid infinite recursion.
creditRevocations	array<object>	-
entitlementRevocations	array<object>	-

payload.itemRevocations[number].itemRevocations[number].itemRevocations[number]

This is a free-form object.

payload.itemRevocations[number].itemRevocations[number].creditRevocations[number]

Name	Type	Description
walletId	string	-
currencyCode	string	-
balanceOrigin	string	-
amount	integer (int32)	-
status	string	revocation status
revocationStrategy	string	-
skipped	boolean	-
reason	string	-

payload.itemRevocations[number].itemRevocations[number].entitlementRevocations[number]

Name	Type	Description
entitlementId	string	-
quantity	integer (int32)	-
itemId	string	-
itemSku	string	-
revocationStrategy	string	-
status	string	revocation status
skipped	boolean	-
reason	string	-

payload.itemRevocations[number].creditRevocations[number]

Name	Type	Description
walletId	string	-
currencyCode	string	-
balanceOrigin	string	-
amount	integer (int32)	-
status	string	revocation status
revocationStrategy	string	-
skipped	boolean	-
reason	string	-

payload.itemRevocations[number].entitlementRevocations[number]

Name	Type	Description
entitlementId	string	-
quantity	integer (int32)	-
itemId	string	-
itemSku	string	-
revocationStrategy	string	-
status	string	revocation status
skipped	boolean	-
reason	string	-

payload.revocationError[number]

Name	Type	Description
httpStatus	integer (int32)	-
code	integer (int32)	-
message	string	-

Schemas