Skip to main content
POST
Retrieve settlement wallet for Venue

Response

OK

id
string
required

ID of the settlement wallet

Required string length: 1 - 40
Pattern: <companyId>-ISW-*
Example:

"ZTEST-ISW-TBHJYXEFN4"

venueId
string
required

ID of the venue to which the settlement wallet is linked

name
string
required

Display name of the settlement wallet

Required string length: 1 - 128
Example:

"Demo settlement wallet"

status
enum<string>
required

Current status of the settlement wallet

Available options:
ACTIVE,
DEACTIVATED
companyId
string
required

ID of the company

Required string length: 1 - 12
Example:

"ZTEST"

balances
object[]
required
createdAt
string<date-time>
required

Date/time (in UTC) of creation of the settlement wallet

Example:

"2021-05-11 04:43:43.056"

customProperties
object
createdBy
string

ID of the user who created the settlement wallet

Example:

"SYS_SettlementFundManager"

updatedAt
string<date-time>

Date/time (in UTC) of the settlement wallet's last update

Example:

"2021-05-11 04:43:43.056"