EAeagleeye
Invites

Cancel Wallet Invite

This API method allows the calling application to cancel a wallet invite.

patch/wallet/{walletId}/invite/{walletInviteId}/cancel

Request

  • Base URL
    https://wallet.uk.eagleeye.com/2.0
  • URL
    https://wallet.uk.eagleeye.com/2.0/wallet/{walletId}/invite/{walletInviteId}/cancel
  • Auth
    API key in header X-EES-AUTH-CLIENT-ID and API key in header X-EES-AUTH-HASH

Path parameters

walletIdstring string required

EES AIR Wallet ID

walletInviteIdstring string required

EES AIR Wallet Invite ID

Request body

EmptyPatchPayload required

Response

OK

walletInviteIdstring

Invite ID

walletIdstring

The Wallet ID

guidstring

Invite GUID

descriptionstring

Invite description

referencestring

Invite reference

status'ACTIVE' | 'CANCELLED' | 'EXPIRED' | 'ACCEPTED' | 'REJECTED'

Invite status

statestring

Invite state

typestring

Type of the Invite

validFromstring

Date this invite is valid from

validTostring

Date this invite is valid to

dateCreatedstring

Date this invite was created

lastUpdatedstring

Date this invite was last updated

Example response

{
  "validFrom": "2017-01-17T13:20:48+00:00",
  "validTo": "2017-01-17T13:20:48+00:00",
  "dateCreated": "2017-01-17T13:20:48+00:00",
  "lastUpdated": "2017-01-17T13:20:48+00:00"
}

Changes