v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Invites

Create Wallet Invite

This API method allows the calling application to create new Wallet Invite for a specific wallet.

post/wallet/{walletId}/invite

Path parameters

walletIdstring string required

EES AIR Wallet ID

Request body

descriptionstring

Invite description

referencestring

Invite reference

statestring

Invite state

typestring

Type of the Invite

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

Wallet Transaction status

validFromstring

Date this invite is valid from

validTostring

Date this invite is valid to

Example request

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

Response

Created

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"
}