Customer Wallet

Get Customer Wallet Financial Instruments

Role Requirements

tenant-bridge-read or tenant-transaction-read or tenant-admin

Description

Get all financial instruments currently stored in the wallet for the customerRef.

Securitybearer
Request
path Parameters
customerRef
required
string [ 1 .. 50 ] characters ^[a-zA-Z0-9-_\.]+$

The Customer reference.

header Parameters
x-account-id
required
string <uuid> = 36 characters

The Account Id (lowercase and hyphenated).

Example: 1aa81e1e-b072-4e64-b1ec-fdcc54f2d08c
x-tenant-id
required
string <uuid> = 36 characters

The Tenant Id (lowercase and hyphenated).

Example: ef848af6-4d8f-4b62-88c4-4856dd2aec02
x-correlation-id
string

Correlation Id for the request.

Responses
200

OK - Returns the Customer Wallet response.

400

Bad Request - Validation error response, containing errors such as:

  • CustomerRef contains invalid characters. It must contain only alphanumeric characters or [-_.].
default

All other managed 4xx and 5xx errors

get/v1/customer-vault/{customerRef}/wallet
Request samples 
Response samples 
application/json
{
  • "_links": {
    • "self": {
      • "href": "/v1/customer-vault/customer1"
      },
    • "financialInstruments": [
      • {
        • "href": "/v1/customer-vault/customer1/financial-instrument/4249b9ae-f238-cce4-474e-49bcd3ab7363",
        • "name": "4249b9ae-f238-cce4-474e-49bcd3ab7363"
        }
      ]
    },
  • "status": "ACTIVE",
  • "metadata": {
    • "customKey1": "custom string 1"
    },
  • "financialInstruments": [
    • {
      • "id": "4249b9ae-f238-cce4-474e-49bcd3ab7363",
      • "type": "MANDATE:ACH",
      • "status": "INACTIVE",
      • "displayName": "AC7PA3NTHT",
      • "createdDate": 1687508113388,
      • "authorizationSource": "WEB",
      • "details": {
        • "financialInstrumentType": "ACH",
        • "mandateReference": "AC7PA3NTHT",
        • "debtorName": "JOE BLOGGS",
        • "debtorAccountNumber": "000123456",
        • "debtorBranchCode": "082082",
        • "debtorBankName": "Bank of Imburse",
        • "debtorSignatoryName": "JOE BLOGGS",
        • "creditorName": "Imburse",
        • "creditorIdentifier": "123456",
        • "imburseMandateId": "92db029e-7d76-41d4-8c9e-78302f7ca091",
        • "statusReason": "1: Invalid Routing number",
        • "hasFirstTransactionBeenSent": "True",
        • "providerName": "Ach",
        • "providerMandateRef": "MXAOQKEJW",
        • "debtorAccountType": "Checking",
        • "authorizationSource": "WEB",
        • "authorizationFrequency": "Monthly"
        },
      • "capabilities": {
        • "valueType": "VARIABLE",
        • "usageType": "MULTIPLE",
        • "canCredit": true,
        • "canDebit": true
        },
      • "agreement": {
        • "agreementType": "Reuse"
        },
      • "wallet": {
        • "enabled": true
        }
      }
    ]
}
Add Financial Instrument to Customer Wallet
Role Requirements


tenant-bridge-write or tenant-transaction-write or tenant-admin


Description


Add a financial instrument (by financialInstrumentId) to the customerRef customer wallet.


Securitybearer 
Request 
path Parameters
customerRef
required
string  [ 1 .. 50 ] characters ^[a-zA-Z0-9-_\.]+$
The Customer reference.


 
financialInstrumentId
required
string <uuid>   = 36 characters 
The Financial Instrument Id (lowercase and hyphenated).


 
 Example:  d9e44965-60ae-4f8c-bdc0-e17005bfa0a8
header Parameters
x-account-id
required
string <uuid>   = 36 characters 
The Account Id (lowercase and hyphenated).


 
 Example:  1aa81e1e-b072-4e64-b1ec-fdcc54f2d08c
x-tenant-id
required
string <uuid>   = 36 characters 
The Tenant Id (lowercase and hyphenated).


 
 Example:  ef848af6-4d8f-4b62-88c4-4856dd2aec02
x-correlation-id
string
Correlation Id for the request.


 
Request Body schema: application/json
reason
string or null  <= 100 characters 
A short reason for the financial instrument wallet update.


 
Responses 
202
Accepted.


400
Bad Request - Validation error response, containing errors such as:


    

  • Reason exceeds the maximum length 100.
    • 



default
All other managed 4xx and 5xx errors


post/v1/customer-vault/{customerRef}/wallet/financial-instrument/{financialInstrumentId}
Request samples 
application/json
{
  • "reason": "Adding financial instrument to wallet."
}
Response samples 
application/json
{
  • "timestamp": 1636115730812,
  • "correlationId": "0HMCAFJ1GF1A8:00000003",
  • "errors": [
    • {
      • "errorCode": "REASON_LENGTH_OUT_OF_RANGE",
      • "message": "Reason exceeds the maximum length 100.",
      • "messageTemplate": "Reason exceeds the maximum length {MaxLength}.",
      • "metadata": {
        • "maxLength": 100
        }
      }
    ]
}
Remove Financial Instrument from Customer Wallet
Role Requirements


tenant-bridge-write or tenant-transaction-write or tenant-admin


Description


Remove a financial instrument (by financialInstrumentId) from the customerRef customer wallet.


Securitybearer 
Request 
path Parameters
customerRef
required
string  [ 1 .. 50 ] characters ^[a-zA-Z0-9-_\.]+$
The Customer reference.


 
financialInstrumentId
required
string <uuid>   = 36 characters 
The Financial Instrument Id (lowercase and hyphenated).


 
 Example:  d9e44965-60ae-4f8c-bdc0-e17005bfa0a8
header Parameters
x-account-id
required
string <uuid>   = 36 characters 
The Account Id (lowercase and hyphenated).


 
 Example:  1aa81e1e-b072-4e64-b1ec-fdcc54f2d08c
x-tenant-id
required
string <uuid>   = 36 characters 
The Tenant Id (lowercase and hyphenated).


 
 Example:  ef848af6-4d8f-4b62-88c4-4856dd2aec02
x-correlation-id
string
Correlation Id for the request.


 
Request Body schema: application/json
reason
string or null  <= 100 characters 
A short reason for the financial instrument wallet update.


 
Responses 
202
Accepted.


400
Bad Request - Validation error response, containing errors such as:


    

  • Reason exceeds the maximum length 100.
    • 



default
All other managed 4xx and 5xx errors


delete/v1/customer-vault/{customerRef}/wallet/financial-instrument/{financialInstrumentId}
Request samples 
application/json
{
  • "reason": "Removing financial instrument from wallet."
}
Response samples 
application/json
{
  • "timestamp": 1636115730812,
  • "correlationId": "0HMCAFJ1GF1A8:00000003",
  • "errors": [
    • {
      • "errorCode": "REASON_LENGTH_OUT_OF_RANGE",
      • "message": "Reason exceeds the maximum length 100.",
      • "messageTemplate": "Reason exceeds the maximum length {MaxLength}.",
      • "metadata": {
        • "maxLength": 100
        }
      }
    ]
}
Copyright 2025 Duck Creek Technologies. All Rights Reserved.