Modification
Update Wallet
Parameters
Below are the specific set of information that can be updated.
Attribute | Type | Description |
---|---|---|
tariffId | integer | The fees applied to the Wallet, as defined by your contract with Treezor. Usually required, but may have a default value set by Treezor. |
walletTypeId | integer | Either 9 or 10 . Available types depend on your agreement with Treezor. |
walletTag | integer | Custom attribute to use as you see fit. Learn more in the Object tags article. Max length: 250 characters Format: hc characters and / ! - _ . * ' ( ) |
eventName | string | The name of the Wallet. |
eventMessage | string | Can be used to describe the Wallet. |
Tip – The Wallet type is editable up to the first operation
Once the first transaction occurred, the walletTypeId
can no longer be updated.
Request
Use the following request to update a Wallet information.
bash
curl -X PUT {baseUrl}/v1/wallets/{walletId}
--header 'Authorization: Bearer {accessToken}' \
--header 'Content-Type: application/json' \
Here is an example of {payload}
:
json
{
"walletTag":"Updated Tag",
"tariffId":{tariffId},
"eventName": "Main Account",
"eventMessage":"My Payment Account Wallet"
}
Returns the Wallet object with the updated information.
json
{
"wallets": [
{
"walletId": 2585102,
"walletTypeId": 10,
"walletStatus": "VALIDATED",
"codeStatus": 120005,
"informationStatus": "",
"walletTag": "Updated Tag",
"userId": 100060463,
"userLastname": "Alex",
"userFirstname": "Oak",
"jointUserId": 0,
"tariffId": 136,
"eventName": "Main Account",
"eventAlias": "main-account-659d1cdd12c892024-01-09 11:16:59",
"eventDate": "2024-01-16",
"eventMessage": "My Payment Account Wallet",
"eventPayinStartDate": "2024-01-09",
"eventPayinEndDate": "0000-00-00",
"contractSigned": 0,
"bic": "TRZOFR21XXX",
"iban": "FR7616798000010000XXXXXXXXX",
"urlImage": "",
"currency": "EUR",
"createdDate": "2024-01-09 11:15:57",
"modifiedDate": "2024-10-09 11:16:59",
"payinCount": 0,
"payoutCount": 0,
"transferCount": 0,
"solde": 0,
"authorizedBalance": 0,
"totalRows": 1,
"country": "FR"
}
]
}
Treezor also sends the wallet.update
webhook.
Delete Wallet
For safety and legal reasons Wallets cannot be deleted, they are permanently deactivated instead.
Once deactivated, no operations can be made to or from the Wallet.
Prerequisites – To Deactivate a Wallet
- The Balance must be equal to
0
- No operations can be pending
Parameters
Attribute | Type | Description |
---|---|---|
id | integer | The unique identifier of the Wallet to deactivate. |
origin | string | The origin of the request for cancelling the Wallet, which can be one of the following:
|
Request
To deactivate a Wallet, you can use the following request:
bash
curl -X DELETE {baseUrl}/v1/wallets/{walletId}?origin={origin}
--header 'Authorization: Bearer {accessToken}' \
--header 'Content-Type: application/json' \
Returns the Wallet object with the walletStatus
attribute set to CANCELED
.
json
{
"wallets": [
{
"walletId": 2585102,
"walletTypeId": 10,
"walletStatus": "CANCELED",
"codeStatus": 120003,
"informationStatus": "",
"walletTag": "",
"userId": 100060463,
"userLastname": "Alex",
"userFirstname": "Oak",
"jointUserId": 0,
"tariffId": 136,
"eventName": "Account 1",
"eventAlias": "test-delete-659d1cdd12c892024-01-09 11:16:59",
"eventDate": "2024-01-16",
"eventMessage": "",
"eventPayinStartDate": "2024-01-09",
"eventPayinEndDate": "0000-00-00",
"contractSigned": 0,
"bic": "TRZOFR21XXX",
"iban": "FR7616798000010000XXXXXXXXX",
"urlImage": "",
"currency": "EUR",
"createdDate": "2024-01-09 11:15:57",
"modifiedDate": "2024-01-09 11:16:59",
"payinCount": 0,
"payoutCount": 0,
"transferCount": 0,
"solde": 0,
"authorizedBalance": 0,
"totalRows": 1,
"country": "FR"
}
]
}
Treezor also sends the wallet.cancel
webhook.