Skip to main content
API docs by Redocly

Wallet Management API (v1)

Download OpenAPI specification:Download

API for manage wallet and owner data (v1.155.0)

Buckets

GetWalletBuckets

Gets all Buckets associated to the given Wallet

path Parameters
walletId
required
string <uuid>

Responses

Response samples

Content type
[
  • {
    }
]

ResyncBuckets

Resyncs every Partner's Bucket for each Wallet with at least one deposit

path Parameters
walletId
required
string <uuid>

Responses

Response samples

Content type
{
  • "createdBuckets": 0,
  • "updatedBuckets": 0
}

Diagnostics

GetDiagnosticsInfo

Get current platform diagnostics data

Responses

Response samples

Content type
{
  • "applicationName": "string",
  • "applicationVersion": "string",
  • "environment": "string",
  • "properties": {
    }
}

GetCujDefinitions

Get Critical User Journey Definitions

Responses

Response samples

Content type
[
  • {
    }
]

Statistics

GetPartnerWalletsStatistics

Get the Partner's wallets aggregated statistics

Responses

Response samples

Content type
{
  • "walletsCount": 0,
  • "walletsOpen": 0,
  • "walletsSuspended": 0,
  • "walletsClosed": 0,
  • "walletsIbanValidated": 0,
  • "walletsPendingIbanValidation": 0,
  • "walletsWithoutIban": 0,
  • "walletsTotalAvailableBalance": 0.1,
  • "walletsEarliestCreationDate": "2019-08-24T14:15:22Z",
  • "walletsLatestCreationDate": "2019-08-24T14:15:22Z",
  • "walletsEarliestUsageDate": "2019-08-24T14:15:22Z",
  • "walletsLatestUsageDate": "2019-08-24T14:15:22Z",
  • "walletsEarliestUpdateDate": "2019-08-24T14:15:22Z",
  • "walletsLatestUpdateDate": "2019-08-24T14:15:22Z"
}

GetDealerWalletsStatistics

Get the Originating Dealer's wallets aggregated statistics

path Parameters
dealerKey
required
string

Responses

Response samples

Content type
{
  • "walletsCount": 0,
  • "walletsOpen": 0,
  • "walletsSuspended": 0,
  • "walletsClosed": 0,
  • "walletsIbanValidated": 0,
  • "walletsPendingIbanValidation": 0,
  • "walletsWithoutIban": 0,
  • "walletsTotalAvailableBalance": 0.1,
  • "walletsEarliestCreationDate": "2019-08-24T14:15:22Z",
  • "walletsLatestCreationDate": "2019-08-24T14:15:22Z",
  • "walletsEarliestUsageDate": "2019-08-24T14:15:22Z",
  • "walletsLatestUsageDate": "2019-08-24T14:15:22Z",
  • "walletsEarliestUpdateDate": "2019-08-24T14:15:22Z",
  • "walletsLatestUpdateDate": "2019-08-24T14:15:22Z"
}

GetCreatedWalletsCountByDay

Get the count of created Wallets per day per Partner

query Parameters
fromDate
string <date-time>
toDate
string <date-time>

Responses

Response samples

Content type
[
  • {
    }
]

GetOperationsAmountByDay

Get the total amount of a specific Operation in a specific Store per day

path Parameters
dealerKey
required
string
query Parameters
operationStatus
string
date
string <date-time>
pageSize
integer <int32>
Default: 50
pageNumber
integer <int32>
Default: 0

Responses

Response samples

Content type
{
  • "totalCount": 0,
  • "limitCount": 0,
  • "items": [
    ]
}

GetFeesStatistics

Get the count of created Wallets per day per Partner

Request Body schema:
required
operationType
required
string non-empty

Filter on the operation type

operationStatus
required
string non-empty

Filter on the operation status

fromDate
required
string <date-time> non-empty

Starting date filter (compared to CreatedDate)

toDate
required
string <date-time> non-empty

End date filter (compared to CreatedDate)

feeDebtor
required
string non-empty

Fee debtor filter

dealerKey
required
string or null

(Optional) Dealer key filter

storeId
required
string or null <uuid>

(Optional) Store Id filter

Responses

Request samples

Content type
{
  • "operationType": "string",
  • "operationStatus": "string",
  • "fromDate": "2019-08-24T14:15:22Z",
  • "toDate": "2019-08-24T14:15:22Z",
  • "feeDebtor": "string",
  • "dealerKey": "string",
  • "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c"
}

Response samples

Content type
{
  • "totalForFlowe": 0.1,
  • "totalForPartner": 0.1,
  • "totalForDealer": 0.1,
  • "totalForStore": 0.1
}

Wallets

GetWallet

Get wallet data using provided identifier

path Parameters
walletId
required
string <uuid>

Wallet identifier

Responses

Response samples

Content type
{
  • "walletId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "partnerKey": "NOME_PARTNER",
  • "taxId": "RSSMRA85M01H501U",
  • "firstName": "Mario",
  • "lastName": "Rossi",
  • "iban": null,
  • "bic": null,
  • "isIbanValidated": false,
  • "ibanValidationCode": null,
  • "phoneNumber": "+39.3331234567",
  • "email": "mario.rossi@example.com",
  • "creationDate": "2026-01-16T11:30:00+01:00",
  • "lastUpdateDate": "2026-01-16T11:30:00+01:00",
  • "lastUsageDate": "2026-01-16T11:30:00+01:00",
  • "closureDate": null,
  • "suspensionDate": null,
  • "originatingDealerKey": "NOME_DEALER",
  • "addressStreet": null,
  • "addressNumber": null,
  • "zipCode": null,
  • "city": null,
  • "province": null,
  • "country": null,
  • "status": "Active",
  • "metadata": { }
}

UpdateWallet

Allows updating TaxId and Email of an existing Wallet

path Parameters
walletId
required
string <uuid>

Wallet identifier

Request Body schema:
required

Request containing new TaxId and Email values

taxId
required
string non-empty

Owner TaxId

email
required
string non-empty ^(?!.*\.\.)(?!.*\+$)[a-zA-Z0-9!#$%&'*\/=?^_`{...

Owner Email

Responses

Request samples

Content type
{
  • "taxId": "string",
  • "email": "string"
}

Response samples

Content type
{
  • "walletId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "partnerKey": "NOME_PARTNER",
  • "taxId": "RSSMRA85M01H501U",
  • "firstName": "Mario",
  • "lastName": "Rossi",
  • "iban": null,
  • "bic": null,
  • "isIbanValidated": false,
  • "ibanValidationCode": null,
  • "phoneNumber": "+39.3331234567",
  • "email": "mario.rossi@example.com",
  • "creationDate": "2026-01-16T11:30:00+01:00",
  • "lastUpdateDate": "2026-01-16T11:30:00+01:00",
  • "lastUsageDate": "2026-01-16T11:30:00+01:00",
  • "closureDate": null,
  • "suspensionDate": null,
  • "originatingDealerKey": "NOME_DEALER",
  • "addressStreet": null,
  • "addressNumber": null,
  • "zipCode": null,
  • "city": null,
  • "province": null,
  • "country": null,
  • "status": "Active",
  • "metadata": { }
}

GetWalletBalance

Get wallet balance using provided identifier

path Parameters
walletId
required
string <uuid>

Wallet identifier

Responses

Response samples

Content type
{
  • "availableBalance": 0.1
}

GetAllWallets

Get all wallets on platform phase and will be removed as soon as the application goes live! ***

query Parameters
fromDate
string <date-time>
toDate
string <date-time>
pageSize
integer <int32>
Default: 50
pageNumber
integer <int32>
Default: 0

Responses

Response samples

Content type
{
  • "totalCount": 2,
  • "limitCount": null,
  • "items": [
    ]
}

CreateWallet

Creates a new wallet on platform

Request Body schema:
required

Request for creation

taxId
required
string non-empty

Owner tax identifier

firstName
required
string non-empty

Owner first name

lastName
required
string non-empty

Owner last name

phoneNumber
required
string non-empty

Owner phone number

email
required
string non-empty ^(?!.*\.\.)(?!.*\+$)[a-zA-Z0-9!#$%&'*\/=?^_`{...

Owner e-mail

originatingDealerKey
required
string non-empty

Original dealer for which the wallet was created

Responses

Request samples

Content type
{
  • "taxId": "RSSMRA85M01H501U",
  • "firstName": "Mario",
  • "lastName": "Rossi",
  • "phoneNumber": "+39.3331234567",
  • "email": "mario.rossi@example.com",
  • "originatingDealerKey": "NOME DEALER"
}

Response samples

Content type
{
  • "walletId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "partnerKey": "NOME_PARTNER",
  • "taxId": "RSSMRA85M01H501U",
  • "firstName": "Mario",
  • "lastName": "Rossi",
  • "iban": null,
  • "bic": null,
  • "isIbanValidated": false,
  • "ibanValidationCode": null,
  • "phoneNumber": "+39.3331234567",
  • "email": "mario.rossi@example.com",
  • "creationDate": "2026-01-16T11:30:00+01:00",
  • "lastUpdateDate": "2026-01-16T11:30:00+01:00",
  • "lastUsageDate": "2026-01-16T11:30:00+01:00",
  • "closureDate": null,
  • "suspensionDate": null,
  • "originatingDealerKey": "NOME_DEALER",
  • "addressStreet": null,
  • "addressNumber": null,
  • "zipCode": null,
  • "city": null,
  • "province": null,
  • "country": null,
  • "status": "Active",
  • "metadata": { }
}

GetSctInstructions

Gets the instructions to send an SCT in order to recharge the wallet

path Parameters
walletId
required
string <uuid>

Responses

Response samples

Content type
{
  • "walletId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "partnerKey": "NOME_PARTNER",
  • "destinationOwner": "Partner Company Name Inc.",
  • "destinationIban": "IT43D3600334210777000000001",
  • "reason": "H69ZUC",
  • "amountFirstDeposit": null
}

UpdateWalletAttributes

Allows updating FirstName, LastName and PhoneNumber of an existing Wallet

path Parameters
walletId
required
string <uuid>

Wallet identifier

Request Body schema:
required

Request containing new FirstName, LastName, PhoneNumber and optional Residence values

firstName
required
string non-empty

Owner first name

lastName
required
string non-empty

Owner last name

phoneNumber
required
string non-empty

Owner phone number

addressStreet
string or null

Street of residence

addressNumber
string or null

Street number

zipCode
string or null

City postal code

city
string or null

City of residence

province
string or null

Province of residence

country
string or null

Country of residence

object or null

Metadata for the wallet

Responses

Request samples

Content type
{
  • "firstName": "string",
  • "lastName": "string",
  • "phoneNumber": "string",
  • "addressStreet": "string",
  • "addressNumber": "string",
  • "zipCode": "string",
  • "city": "string",
  • "province": "string",
  • "country": "string",
  • "metadata": {
    }
}

Response samples

Content type
{
  • "walletId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "partnerKey": "NOME_PARTNER",
  • "taxId": "RSSMRA85M01H501U",
  • "firstName": "Mario",
  • "lastName": "Rossi",
  • "iban": null,
  • "bic": null,
  • "isIbanValidated": false,
  • "ibanValidationCode": null,
  • "phoneNumber": "+39.3331234567",
  • "email": "mario.rossi@example.com",
  • "creationDate": "2026-01-16T11:30:00+01:00",
  • "lastUpdateDate": "2026-01-16T11:30:00+01:00",
  • "lastUsageDate": "2026-01-16T11:30:00+01:00",
  • "closureDate": null,
  • "suspensionDate": null,
  • "originatingDealerKey": "NOME_DEALER",
  • "addressStreet": null,
  • "addressNumber": null,
  • "zipCode": null,
  • "city": null,
  • "province": null,
  • "country": null,
  • "status": "Active",
  • "metadata": { }
}

UpdateWalletIban

Sets the given IBAN to be verified and then associated to the Wallet

path Parameters
walletId
required
string <uuid>

Wallet identifier

Request Body schema:
required

Request containing the IBAN and BIC to associate to the Wallet

iban
string or null

Owner IBAN (every SEPA IBAN is accepted)

bic
string or null <= 11 characters

BIC associated to the IBAN (needed only if IBAN is not Italian)

Responses

Request samples

Content type
{
  • "iban": "string",
  • "bic": "string"
}

Response samples

Content type
{
  • "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",
  • "partnerKey": "string",
  • "iban": "string",
  • "bic": "string",
  • "isIbanValidated": true,
  • "destinationIban": "string",
  • "destinationOwner": "string",
  • "transferAmount": 0.1,
  • "ibanValidationCode": "string"
}

DeleteWalletIban

Removes the associated IBAN from the given Wallet, regardless of the validation state

path Parameters
walletId
required
string <uuid>

Wallet identifier

Responses

Response samples

Content type
{
  • "walletId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "partnerKey": "NOME_PARTNER",
  • "taxId": "RSSMRA85M01H501U",
  • "firstName": "Mario",
  • "lastName": "Rossi",
  • "iban": null,
  • "bic": null,
  • "isIbanValidated": false,
  • "ibanValidationCode": null,
  • "phoneNumber": "+39.3331234567",
  • "email": "mario.rossi@example.com",
  • "creationDate": "2026-01-16T11:30:00+01:00",
  • "lastUpdateDate": "2026-01-16T11:30:00+01:00",
  • "lastUsageDate": "2026-01-16T11:30:00+01:00",
  • "closureDate": null,
  • "suspensionDate": null,
  • "originatingDealerKey": "NOME_DEALER",
  • "addressStreet": null,
  • "addressNumber": null,
  • "zipCode": null,
  • "city": null,
  • "province": null,
  • "country": null,
  • "status": "Active",
  • "metadata": { }
}

SuspendWallet

Suspend an existing wallet using its identifier. Suspension deny to the end user the usage of his wallet for any operation (deposit, payment, withdrawal, etc).

path Parameters
walletId
required
string <uuid>

Wallet identifier

Responses

Response samples

Content type
{
  • "walletId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "partnerKey": "NOME_PARTNER",
  • "taxId": "RSSMRA85M01H501U",
  • "firstName": "Mario",
  • "lastName": "Rossi",
  • "iban": null,
  • "bic": null,
  • "isIbanValidated": false,
  • "ibanValidationCode": null,
  • "phoneNumber": "+39.3331234567",
  • "email": "mario.rossi@example.com",
  • "creationDate": "2026-01-16T11:30:00+01:00",
  • "lastUpdateDate": "2026-01-16T11:30:00+01:00",
  • "lastUsageDate": "2026-01-16T11:30:00+01:00",
  • "closureDate": null,
  • "suspensionDate": null,
  • "originatingDealerKey": "NOME_DEALER",
  • "addressStreet": null,
  • "addressNumber": null,
  • "zipCode": null,
  • "city": null,
  • "province": null,
  • "country": null,
  • "status": "Active",
  • "metadata": { }
}

ReactivateWallet

Reactivates an existing suspended wallet using its identifier.

path Parameters
walletId
required
string <uuid>

Wallet identifier

Responses

Response samples

Content type
{
  • "walletId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "partnerKey": "NOME_PARTNER",
  • "taxId": "RSSMRA85M01H501U",
  • "firstName": "Mario",
  • "lastName": "Rossi",
  • "iban": null,
  • "bic": null,
  • "isIbanValidated": false,
  • "ibanValidationCode": null,
  • "phoneNumber": "+39.3331234567",
  • "email": "mario.rossi@example.com",
  • "creationDate": "2026-01-16T11:30:00+01:00",
  • "lastUpdateDate": "2026-01-16T11:30:00+01:00",
  • "lastUsageDate": "2026-01-16T11:30:00+01:00",
  • "closureDate": null,
  • "suspensionDate": null,
  • "originatingDealerKey": "NOME_DEALER",
  • "addressStreet": null,
  • "addressNumber": null,
  • "zipCode": null,
  • "city": null,
  • "province": null,
  • "country": null,
  • "status": "Active",
  • "metadata": { }
}

CloseWallet

Close an existing suspended wallet using its identifier.

path Parameters
walletId
required
string <uuid>

Wallet identifier

Responses

Response samples

Content type
{
  • "walletId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "partnerKey": "NOME_PARTNER",
  • "taxId": "RSSMRA85M01H501U",
  • "firstName": "Mario",
  • "lastName": "Rossi",
  • "iban": null,
  • "bic": null,
  • "isIbanValidated": false,
  • "ibanValidationCode": null,
  • "phoneNumber": "+39.3331234567",
  • "email": "mario.rossi@example.com",
  • "creationDate": "2026-01-16T11:30:00+01:00",
  • "lastUpdateDate": "2026-01-16T11:30:00+01:00",
  • "lastUsageDate": "2026-01-16T11:30:00+01:00",
  • "closureDate": null,
  • "suspensionDate": null,
  • "originatingDealerKey": "NOME_DEALER",
  • "addressStreet": null,
  • "addressNumber": null,
  • "zipCode": null,
  • "city": null,
  • "province": null,
  • "country": null,
  • "status": "Active",
  • "metadata": { }
}

ReopenWallet

Reopens an existing closed wallet using its identifier.

path Parameters
walletId
required
string <uuid>

Wallet identifier

Responses

Response samples

Content type
{
  • "walletId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "partnerKey": "NOME_PARTNER",
  • "taxId": "RSSMRA85M01H501U",
  • "firstName": "Mario",
  • "lastName": "Rossi",
  • "iban": null,
  • "bic": null,
  • "isIbanValidated": false,
  • "ibanValidationCode": null,
  • "phoneNumber": "+39.3331234567",
  • "email": "mario.rossi@example.com",
  • "creationDate": "2026-01-16T11:30:00+01:00",
  • "lastUpdateDate": "2026-01-16T11:30:00+01:00",
  • "lastUsageDate": "2026-01-16T11:30:00+01:00",
  • "closureDate": null,
  • "suspensionDate": null,
  • "originatingDealerKey": "NOME_DEALER",
  • "addressStreet": null,
  • "addressNumber": null,
  • "zipCode": null,
  • "city": null,
  • "province": null,
  • "country": null,
  • "status": "Active",
  • "metadata": { }
}

SearchWallet

Searches for existing Wallets matching each given parameter.

NOTE: Ignores missing, null, empty of white space only search parameters

query Parameters
pageSize
integer <int32>
Default: 50

Number of wallets per page

pageNumber
integer <int32>
Default: 0

Page number

Request Body schema:
required

Request containing search fields

taxId
string or null

Owner tax identifier: exact match, case insensitive

firstName
string or null

Owner first name: partial match (contains), case insensitive

lastName
string or null

Owner last name: partial match (contains), case insensitive

phoneNumber
string or null

Owner phone number: partial match (contains), case insensitive

email
string or null

Owner e-mail: partial match (contains), case insensitive

iban
string or null

IBAN of wallet owner: exact match, case insensitive

isSuspended
boolean or null

If wallet is suspended (if null searches for both suspended and not suspended ones)

NOTE: cannot be false if IsClosed is true

isClosed
boolean or null

If wallet is closed (if null searches for both closed and open ones)

hasNeverBeenUsed
boolean or null

Searches only for Wallets that never executed any Operation (LastUsageDate never set)

Responses

Request samples

Content type
{
  • "taxId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "phoneNumber": "string",
  • "email": "string",
  • "iban": "string",
  • "isSuspended": true,
  • "isClosed": true,
  • "hasNeverBeenUsed": true
}

Response samples

Content type
{
  • "totalCount": 2,
  • "limitCount": null,
  • "items": [
    ]
}

GetWalletLimits

Get wallet limit using provided identifier

path Parameters
walletId
required
string <uuid>

Wallet identifier

Responses

Response samples

Content type
{
  • "maximum": {
    },
  • "minimum": {
    },
  • "maximumLastMonthCashDeposit": {
    },
  • "maximumLastMonthCashWithdrawal": {
    },
  • "maximumLastMonthSddDeposit": {
    }
}

GetWalletContractTemplate

Gets the Pdf file for the Wallet Contract template

Responses

Response samples

Content type
{ }

GetWalletContractFilled

Gets the Pdf file for the Wallet Contract filled with the given Wallet data

path Parameters
walletId
required
string <uuid>

Responses

Response samples

Content type
{ }

SignWalletContract

Signs the Wallet Contract after filling it with the given Wallet data

path Parameters
walletId
required
string <uuid>

Responses

Response samples

Content type
{ }

GetWalletContractSigned

Gets the Pdf file for the Wallet Contract once it's filled and signed

path Parameters
walletId
required
string <uuid>

Responses

Response samples

Content type
{ }

DestroyWallet

*** ATTENTION: THIS ENDPOINT IS AVALIABLE ONLY IN TESTING AND DEVELOPMENT ENVIRONMENTS *** Deletes a Closed Wallet alongside any associated Operation, Group, SDD mandate and Transaction.

path Parameters
walletId
required
string <uuid>

Wallet identifier

Responses

Response samples

Content type
{
  • "errorCode": "string",
  • "errorDescription": "string",
  • "errorProperties": {
    }
}