Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
h) Wallets

Update a wallet by walletId

Update an existing wallet. This will update any wallet in the tenant irrespective of it being tenant-level, customer or organisation. Null fields are ignored so it acts like a PATCH. Wallet type can be changed so long as: (1) The currency attribute is the same on both types (2) The wallet mode is the same on both types (3) The customer or organisation owning the wallet passes the KYC ruleset of the new wallet type.<br>(4) supported wallet mapping is RPP_PROXYNote : (1) When we enable the property checkRatificationOnWalletStatusUpdateToActive and attempt to update the wallet status from Barred to Active, then we check the KYC rule. (2) Updating the wallet status will not affect the status of the cards associated with the wallet. Cards can be updated independently

put/eclipse-conductor/rest/v1/tenants/{tenantId}/wallets/{walletId}

Path parameters

tenantIdinteger required
walletIdinteger required

Request body

accountNumberstring

A bank account number for deposits if supported by the underlying bank

customerIdinteger

The customer who owns this wallet. If not provided then the wallet must be owned by an organisation and hence organisationId should be provided

descriptionstring

Wallet Description

externalUniqueIdstring

A globally unique identifier set by the tenant for this wallet. Useful for correlating between the tenants systems and Eclipse

friendlyIdstring

A unique reference for a wallet used for deposits and other transactions

namestring

Name of the Wallet

organisationIdinteger

The organisation who owns this wallet. If not provided then the wallet must be owned by a customer and hence customerId should be provided

reasonCode'DUE_DILIGENCE' | 'EXCON' | 'FRAUD' | 'LEGAL' | 'NONE' | 'REGULATORY' | 'RISK'
status'ACTIVE' | 'BARRED' | 'CANCELED' | 'CANCELLED' | 'JOINT_ACTIVE' | 'JOINT_PARTIAL' | 'LOCKED' | 'PENDING'

Status of the wallet. ACTIVE:Can be used, LOCKED:Is blocked from use but can be customer controlled. CANCELED is deprecated. CANCELLED is in use, BARRED: Wallet cannot be used due to possible fraud or similar investigation

walletIdinteger

A unique system generated numeric identifier for the wallet

walletTypeIdinteger

Response

OK

accountNumberstring

A bank account number for deposits if supported by the underlying bank

availableBalancenumber

The amount available for spending

createdstring date-time

ISO 8601 date/time of when the record was first created

creditReservationsnumber

The credit reservations placed on the wallet (uncommitted transactions that will credit the wallet)

currencystring required

The currency of the wallet - e.g. USD, ZAR, NGN, TSH

currentBalancenumber

The balance in the wallet in the currency of the wallet

customerIdinteger

The customer who owns this wallet. If not provided then the wallet must be owned by an organisation and hence organisationId should be provided

debitReservationsnumber

The debit reservations placed on the wallet (uncommitted transactions)

descriptionstring

Wallet Description

externalUniqueIdstring

A globally unique identifier set by the tenant for this wallet. Useful for correlating between the tenants systems and Eclipse

friendlyIdstring

A unique reference for a wallet used for deposits and other transactions

namestring

Name of the Wallet

organisationIdinteger

The organisation who owns this wallet. If not provided then the wallet must be owned by a customer and hence customerId should be provided

reasonCode'DUE_DILIGENCE' | 'EXCON' | 'FRAUD' | 'LEGAL' | 'NONE' | 'REGULATORY' | 'RISK'
reservationsnumber

Deprecated - use debitReservations. The reservations placed on the wallet (uncommitted transactions that will debit the wallet)

status'ACTIVE' | 'BARRED' | 'CANCELED' | 'CANCELLED' | 'JOINT_ACTIVE' | 'JOINT_PARTIAL' | 'LOCKED' | 'PENDING' required

Status of the wallet. ACTIVE:Can be used, LOCKED:Is blocked from use but can be customer controlled. CANCELED is deprecated. CANCELLED is in use, BARRED: Wallet cannot be used due to possible fraud or similar investigation

voucherPinstring
walletIdinteger

A unique system generated numeric identifier for the wallet

walletTypeIdinteger

The type of wallet. This controls the behaviour and rules of the wallet

Example response

{
  "created": "2022-03-10T12:15:50-04:00"
}