Wallets

Get wallet details

Method: GET

Endpoint: {{env}}/api/wallet

Canada

{
    "statusCode": 200,
    "message": "GET Request successful.",
    "isError": false,
    "result": [
        {
            "Id": "36501dca-f89e-4c30-b1ed-fb959176ea7a",
            "Type": "Unified",
            "EftProvider": "RBC",
            "Balance": 300.0,
            "BankAccountInformationId": "777bd812-141c-4a4f-a98e-d086d318adb9",
            "Customer": {
                "Enable3DSecureVisa": true,
                "ApiKeyVisa": "052e0e0fa95248e6bd9975bb0e135039 ",
                "Enable3DSecureCreditCard": true,
                "ApiKeyCreditCard": "052e0e0fa95248e6bd9975bb0e135639",
                "InteracProvider": "RBC",
                "AddressCountry": "Canada",
                "Id": "ca54ad7d-7920-4bcc-ba68-62e793ce1fce",
                "CompanyName": "Your Company Name",
                "CompanyEmail": "[e-mail]"
            },
            "Currency": "CAD"
        }
    ]
}

US

{
    "statusCode": 200,
    "message": "GET Request successful.",
    "isError": false,
    "result": [
        {
            "Id": "5dc648ba-5cf4-4fc7-8cd8-30f738ac8848",
            "Type": "Unified",
            "Balance": 300.0,
            "BankAccountInformationId": "00000000-0000-0000-0000-000000000000",
            "Customer": {
                "AddressCountry": "USA",
                "Id": "32e76c70-a0ab-42f4-864b-c6fed0fc7832",
                "CompanyName": "Your Company Name",
                "CompanyEmail": "[e-mail]"
            },
            "Currency": "USD"
        }
    ]
}

You can retrieve all Zūm Rails Wallet information with a single API call. The response includes details such as: Wallet Type, Wallet ID and Wallet Balance.

This endpoint is especially useful when using a Zūm Rails wallet for Accounts Payable (AP) or Accounts Receivable (AR), as the Wallet ID is required in those workflows.

NOTE

Each customer can have only one wallet.

Response

Canada

Parameter	Type	Description
Id	guid	Wallet Id
Type	string	Wallet type
EftProvider	string	The EFT provider
Balance	string	Wallet balance
BankAccountInformationId	guid	Bank account information Id
Customer		Customer details
Enable3DSecureVisa	boolean	If 3D Secure is enabled for Visa Direct
ApiKeyVisa	string	API Key for Visa Direct (used when 3D secured is enabled)
Enable3DSecureCreditCard	boolean	If 3D Secure is enabled for Credit Card
ApiKeyCreditCard	string	API Key for Credit Card (used when 3D secured is enabled)
InteracProvider	string	The Interac provider
AddressCountry	string	Customer Country
Id	guid	Customer Id
CompanyName	string	Customer name
CompanyEmail	string	Customer email
Currency	string	The currency of the wallet

US

Parameter	Type	Description
Id	guid	Wallet Id
Type	string	Wallet type
Balance	string	Wallet balance
BankAccountInformationId	guid	Bank account information Id
Customer		Customer details
AddressCountry	string	Customer Country
Id	guid	Customer Id
CompanyName	string	Customer name
CompanyEmail	string	Customer email
Currency	string	The currency of the wallet

Filter wallet transactions

Use this endpoint if you want to list the transactions from a specific wallet. These are the debits and credits that happened in the respective wallet.

Method: POST

Endpoint: {{env}}/api/wallet/transactions/filter

Payload

{
  "WalletId": "30126b59-...-008376504210",
  "Pagination": {
    "PageNumber": 1
  }
}

Response

{
  "statusCode": 200,
  "message": "POST Request successful.",
  "isError": false,
  "result": [
    {
      "CurrentPage": 1,
      "PageSize": 8,
      "TotalCount": 1,
      "Items": [
        {
          "Id": "faa32009-...-a52cc8996b61",
          "Description": "Funds received by Funding Source (RBC-01234-1234567)",
          "Debit": 0,
          "Credit": 0.01,
          "Balance": 0.01,
          "Type": "Credit",
          "Authorized": true,
          "CreatedAt": "2020-04-28T15:15:09.208515"
        }
      ]
    }
  ]
}

INFO

This endpoint is also available in {{env}}/api/wallet/transactions, but it may be removed eventually.

Input parameters

Parameter	Type	Mandatory	Description
WalletId	guid	yes	Wallet id
TransactionMethod	string	no	Transaction method
ZumRailsType	string	no	Transaction Type
GenericSearch	string	no	Filter wallets by description
CreatedAtFrom	datetime	no	Start date (This field is only used when the operator is between)
CreatedAtTo	datetime	no	End date (This field is only used when the operator is between)
CreatedAt	datetime	no	Create date
CreatedAtOperator	string	no	Operator to filter with CreatedAt properties
Pagination		no
PageNumber	number	no	The respective page, starting at 1

Response

Parameter	Type	Description
CurrentPage	number	The current page
PageSize	number	The amount of rows returned in the current page
TotalCount	number	The total rows the filter returns
Items		List of wallet transactions
Id	guid	Transaction id
CreatedAt	datetime	When the transaction was created
Description	string	Transaction description
Debit	decimal	Debit amount
Credit	decimal	Credit amount
Balance	decimal	Balance at that moment
Type	string	Credit or Debit
Authorized	bool	If the transaction is completed and authorized