Skip to main content

AddExternalMemberResponse

access objectrequired

Membership access

urlstring<URI>required

Access URL

Possible values: <= 2147483647 characters

validUntilstring<Instant>required

Timestamp when the access URL expires

Possible values: <= 2147483647 characters

account objectrequired

Account

balance objectrequired

Account's balance

amountstringrequired

The amount of money. Example: 1000.12

Possible values: non-empty and <= 2147483647 characters

currencystringrequired

The currency of the money. Example: 'USD'

Possible values: non-empty and <= 10 characters

holderIdstring<uuid>required

Account holder id. For business-only accounts equal to ownerId, for member accounts equal to memberId

Possible values: <= 2147483647 characters

idstring<uuid>required

Account's id

Possible values: <= 2147483647 characters

name object

Account's name

oneOf
null
openedAtstring<Instant>required

The date and time when the account was opened. Example: 2021-07-01T12:00:00.000Z

Possible values: <= 2147483647 characters

ownerIdstring<uuid>required

Account owner id

Possible values: <= 2147483647 characters

typeCustomerAccountType (string)required

Account's type

Possible values: [CURRENT, SAVING]

membership objectrequired

Membership

memberIdstring<uuid>required

Customer id of member

Possible values: <= 2147483647 characters

roleMembershipRole (string)required

Membership type

Possible values: [MEMBER, VIEWER, PAYER, ADMIN, OWNER]

stateMembershipState (string)required

Membership status

Possible values: [ACTIVE, TERMINATED]

AddExternalMemberResponse
{
  "access": {
    "url": "string",
    "validUntil": "string"
  },
  "account": {
    "balance": {
      "amount": "string",
      "currency": "string"
    },
    "holderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "null",
    "openedAt": "string",
    "ownerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "CURRENT"
  },
  "membership": {
    "memberId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "role": "MEMBER",
    "state": "ACTIVE"
  }
}