Getmomo Public API (1.0.0-alpha.5)

Download OpenAPI specification:Download (JSON)

License: Proprietary

Public API for interfacing with the Getmomo service offering.

Deposit Accounts

Endpoints for managing deposit accounts

List all deposit accounts

Retrieves all deposit accounts with pagination support

Authorizations:

bearerAuth

query Parameters

offset	integer >= 0 Default: 0 Example: offset=15 Number of items to skip before returning results
limit	integer [ 1 .. 100 ] Default: 15 Example: limit=15 Maximum number of items to return

Responses

Response Schema: application/json

offset required	integer >= 0 Number of items skipped before these results
limit required	integer [ 1 .. 100 ] Maximum number of items returned in this response
totalItems required	integer >= 0 Total number of items available
required	Array of objects (DepositAccount) List of deposit accounts for the current page

Response samples

200
401
500

Content type

application/json

{"offset": 0,
"limit": 15,
"totalItems": 2,
"items": [{"id": "vWRaPWn3iIDr8iBpdAHpW",
"createdAt": "2025-09-15T09:00:00+02:00",
"updatedAt": "2025-10-20T11:30:00+02:00",
"name": "Property Management GmbH",
"title": "Primary Account",
"iban": "DE89370400440532013000",
"bic": "HSHNDEHHXXX"
},
{"id": "moTEwlVvx2N7U7Eo9Kl6n",
"createdAt": "2025-09-20T14:15:00+02:00",
"updatedAt": "2025-10-22T16:45:00+02:00",
"name": "Property Management GmbH",
"iban": "DE89370400440532013001",
"bic": "HSHNDEHHXXX"
}
]
}

Get a single deposit account

Retrieves a single deposit account by its unique identifier

Authorizations:

bearerAuth

path Parameters

depositAccountId

required

string

Example: q3a2bQPpNz2tu4nkTrjmI

The unique identifier of the deposit account

Responses

Response Schema: application/json

id required	string Unique identifier for the entity
createdAt required	string <date-time> Timestamp when the entity was created (ISO 8601 with timezone)
updatedAt	string <date-time> Timestamp when the entity was last updated (ISO 8601 with timezone)
name required	string Name of the deposit account
title	string Optional title for the deposit account
iban required	string^[A-Z]{2}[0-9]{2}[A-Z0-9]+$ IBAN of the deposit account
bic required	string BIC/SWIFT code of the deposit account

Response samples

200
401
404
500

Content type

application/json

{"id": "q3a2bQPpNz2tu4nkTrjmI",
"createdAt": "2025-09-10T08:30:00+02:00",
"updatedAt": "2025-10-23T09:15:00+02:00",
"name": "Property Management GmbH",
"title": "Primary Account",
"iban": "DE89370400440532013000",
"bic": "HSHNDEHHXXX"
}

Virtual Deposit Accounts

Endpoints for managing virtual deposit accounts for rental properties

List all virtual deposit accounts for a deposit account

Retrieves all virtual deposit accounts associated with a specific deposit account with pagination support

Authorizations:

bearerAuth

path Parameters

depositAccountId

required

string

Example: TgQBfyro4OHY6Iza0zPQa

The unique identifier of the deposit account

query Parameters

offset	integer >= 0 Default: 0 Example: offset=15 Number of items to skip before returning results
limit	integer [ 1 .. 100 ] Default: 15 Example: limit=15 Maximum number of items to return

Responses

Response Schema: application/json

offset required	integer >= 0 Number of items skipped before these results
limit required	integer [ 1 .. 100 ] Maximum number of items returned in this response
totalItems required	integer >= 0 Total number of items available
required	Array of any (VirtualDepositAccount) List of virtual deposit accounts for the current page

Response samples

200
401
404
500

Content type

application/json

{"offset": 0,
"limit": 15,
"totalItems": 2,
"items": [{"id": "C9NS3gndTEXrX6CoHIyGy",
"createdAt": "2025-09-25T10:30:00+02:00",
"updatedAt": "2025-10-15T14:20:00+02:00",
"iban": "DE89370400440532013000",
"appLink": "https://getmomo.app/kautionsverwaltung/barkaution/C9NS3gndTEXrX6CoHIyGy",
"type": "individual",
"givenReference": "M03879.Obj0842",
"sourceId": "pm-2024-unit-789",
"tenants": [{"firstName": "Max",
"lastName": "Mustermann"
}
],
"streetName": "Hauptstraße",
"streetNumber": "123",
"postalCode": "10115",
"region": "Berlin",
"countryCode": "DE",
"depositAmountCents": 150000
},
{"id": "MCAtSsrg4gjYK1b9NnZia",
"createdAt": "2025-09-28T11:45:00+02:00",
"updatedAt": "2025-10-18T09:30:00+02:00",
"iban": "DE89370400440532013001",
"appLink": "https://getmomo.app/kautionsverwaltung/barkaution/MCAtSsrg4gjYK1b9NnZia",
"type": "company",
"givenReference": "M03880.Obj0843",
"sourceId": "pm-2024-unit-789",
"tenants": [{"companyName": "Mustermann GmbH",
"companyDirectors": [{"firstName": "Max",
"lastName": "Mustermann"
}
]
}
],
"streetName": "Nebenstraße",
"streetNumber": "456",
"postalCode": "10117",
"region": "Berlin",
"countryCode": "DE",
"depositAmountCents": 200000
}
]
}

Create virtual deposit account

Creates a new virtual deposit account for individual tenant(s) or company tenant. Use the 'type' field to specify which type to create.

Authorizations:

bearerAuth

path Parameters

depositAccountId

required

string

Example: EQ4Npb2K_yTUch0oIKWZH

The unique identifier of the deposit account

Request Body schema: application/json
required

givenReference	string Optional reference for the tenancy. We recommend a combination of the tenancy agreement number and property number (e.g. M03879.Obj0842)
sourceId	string Optional identifier from your own system. Use this to link the virtual deposit account to records in your property management software or internal database
streetName required	string Street name of the rental property
streetNumber required	string Street number of the rental property
postalCode required	string Postal code of the rental property
region required	string Region/state of the rental property
countryCode required	string Value: "DE" Country code. Only 'DE' (Deutschland) is accepted as we only support German addresses
depositAmountCents required	integer > 0 Deposit amount in cents. Must be a positive integer
type required	string Type of virtual deposit account. Must be 'individual' individual
required	Array of objects (IndividualTenant) [ 1 .. 2 ] items Array of individual tenants (minimum 1, maximum 2)

Responses

Response Schema: application/json

id required	string Unique identifier for the entity
createdAt required	string <date-time> Timestamp when the entity was created (ISO 8601 with timezone)
updatedAt	string <date-time> Timestamp when the entity was last updated (ISO 8601 with timezone)
iban required	string^[A-Z]{2}[0-9]{2}[A-Z0-9]+$ The virtual IBAN allocated to this virtual deposit account
appLink required	string <uri> Deep link to this virtual deposit account in the Manager App
type required	string Type of tenant for this virtual deposit account individual
givenReference	string Optional reference for the tenancy. We recommend a combination of the tenancy agreement number and property number (e.g. M03879.Obj0842)
sourceId	string Optional identifier from your own system. Use this to link the virtual deposit account to records in your property management software or internal database
streetName required	string Street name of the rental property
streetNumber required	string Street number of the rental property
postalCode required	string Postal code of the rental property
region required	string Region/state of the rental property
countryCode required	string Value: "DE" Country code. Only 'DE' (Deutschland) is accepted as we only support German addresses
depositAmountCents required	integer > 0 Deposit amount in cents. Must be a positive integer
required	Array of objects (IndividualTenant) [ 1 .. 2 ] items Array of tenants (minimum 1, maximum 2)

Request samples

Payload

Content type

application/json

Example

Individual tenant(s) example

{"type": "individual",
"givenReference": "M03879.Obj0842",
"sourceId": "pm-2024-unit-789",
"tenants": [{"firstName": "Max",
"lastName": "Mustermann"
},
{"firstName": "Erika",
"lastName": "Musterfrau"
}
],
"streetName": "Hauptstraße",
"streetNumber": "123",
"postalCode": "10115",
"region": "Berlin",
"countryCode": "DE",
"depositAmountCents": 200000
}

Response samples

201
400
401
409
500

Content type

application/json

Example

Individual tenant response

{"id": "C9NS3gndTEXrX6CoHIyGy",
"createdAt": "2025-10-23T11:00:00+02:00",
"updatedAt": "2025-10-23T11:00:00+02:00",
"iban": "DE89370400440532013000",
"appLink": "https://getmomo.app/kautionsverwaltung/barkaution/C9NS3gndTEXrX6CoHIyGy",
"type": "individual",
"givenReference": "M03879.Obj0842",
"sourceId": "pm-2024-unit-789",
"tenants": [{"firstName": "Max",
"lastName": "Mustermann"
}
],
"streetName": "Hauptstraße",
"streetNumber": "123",
"postalCode": "10115",
"region": "Berlin",
"countryCode": "DE",
"depositAmountCents": 150000
}

Get a single virtual deposit account

Retrieves a single virtual deposit account by its unique identifier

Authorizations:

bearerAuth

path Parameters

depositAccountId required	string Example: iDVh8yNUQ8y2hh1jkXTbi The unique identifier of the deposit account
virtualDepositAccountId required	string Example: C9NS3gndTEXrX6CoHIyGy The unique identifier of the virtual deposit account

Responses

Response Schema: application/json

id required	string Unique identifier for the entity
createdAt required	string <date-time> Timestamp when the entity was created (ISO 8601 with timezone)
updatedAt	string <date-time> Timestamp when the entity was last updated (ISO 8601 with timezone)
iban required	string^[A-Z]{2}[0-9]{2}[A-Z0-9]+$ The virtual IBAN allocated to this virtual deposit account
appLink required	string <uri> Deep link to this virtual deposit account in the Manager App
type required	string Type of tenant for this virtual deposit account individual
givenReference	string Optional reference for the tenancy. We recommend a combination of the tenancy agreement number and property number (e.g. M03879.Obj0842)
sourceId	string Optional identifier from your own system. Use this to link the virtual deposit account to records in your property management software or internal database
streetName required	string Street name of the rental property
streetNumber required	string Street number of the rental property
postalCode required	string Postal code of the rental property
region required	string Region/state of the rental property
countryCode required	string Value: "DE" Country code. Only 'DE' (Deutschland) is accepted as we only support German addresses
depositAmountCents required	integer > 0 Deposit amount in cents. Must be a positive integer
required	Array of objects (IndividualTenant) [ 1 .. 2 ] items Array of tenants (minimum 1, maximum 2)

Response samples

200
401
404
500

Content type

application/json

{"id": "C9NS3gndTEXrX6CoHIyGy",
"createdAt": "2025-09-25T10:30:00+02:00",
"updatedAt": "2025-10-15T14:20:00+02:00",
"iban": "DE89370400440532013000",
"appLink": "https://getmomo.app/kautionsverwaltung/barkaution/C9NS3gndTEXrX6CoHIyGy",
"type": "individual",
"givenReference": "M03879.Obj0842",
"sourceId": "pm-2024-unit-789",
"tenants": [{"firstName": "Max",
"lastName": "Mustermann"
}
],
"streetName": "Hauptstraße",
"streetNumber": "123",
"postalCode": "10115",
"region": "Berlin",
"countryCode": "DE",
"depositAmountCents": 150000
}

Get virtual deposit account balance

Retrieves the current balance of a virtual deposit account

Authorizations:

bearerAuth

path Parameters

depositAccountId required	string Example: uYfXVMXfUrTkv2vT4xZel The unique identifier of the deposit account
virtualDepositAccountId required	string Example: vKo8sCA4VWbTNk8msiqPA The unique identifier of the virtual deposit account

Responses

Response Schema: application/json

amountCents required	integer Current balance in cents
currency required	string Value: "EUR" Currency of the balance
updatedAt required	string <date-time> Timestamp when the balance was last updated (ISO 8601 with timezone)

Response samples

200
400
401
404
500

Content type

application/json

{"amountCents": 150000,
"currency": "EUR",
"updatedAt": "2025-10-23T14:30:00+02:00"
}

Getmomo Public API (1.0.0-alpha.5)

Deposit Accounts

List all deposit accounts

Authorizations:

query Parameters

Responses

Response Schema: application/json

Response samples

Get a single deposit account

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Virtual Deposit Accounts

List all virtual deposit accounts for a deposit account

Authorizations:

path Parameters

query Parameters

Responses

Response Schema: application/json

Response samples

Create virtual deposit account

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Get a single virtual deposit account

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Get virtual deposit account balance

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Request Body schema: application/json
required