16. Buyer Wallet

12.1 Overview

Users can add a virtual wallet for CPX buyer. The wallet acts as a virtual account where buyers can store money to make payments in future. Currently buyers can make wire payments via Wallet.

12.2 Attributes

Field	Sub-field	Type	Description
amount		Integer	Amount of money to be added or withdrawn from the wallet
paymentMethod		String	Method of adding/withdrawing money
accountId		String	Account to be used for wallet transaction
totalRecords		Integer	Total number of records available
totalType		String	Whether the records returned are an exact or in range
recordCount		Integer	Number of records fetched
records		Array of objects	Details of the records fetched
	id	String	Id of payment
	acl	Array	Access control list for the payment
	sent	String	Date and time of payment moving to sent
	ready	String	Date and time of payment moving to ready
	pending	String	Date and time of payment moving to pending
	amount	String	Amount of payment
	walletId	String	Wallet Id
	emailNotes	String	Email notes associated
	importDate	String	Date of import
	isProxyPay	Boolean	If payment is proxy pay
	accountType	String	Type of payment method
	statusDate	String	Date and time when the status was updated
	createdFrom	String	Payment creation platform
	hasInvoices	Boolean	If payment has invoices
	deliveryMode	String	Mode of delivery if check
	invoiceCount	String	Count of invoices
	paymentMethod	String	Payment method
	paymentStatus	String	Status of payment
	transactionId	String	Id of transaction
	walletDebitId	String	Id of wallet debit
	originalAmount	String	Amount of transaction
	hasPendingDebit	String	If debit is pending
	transactionDate	String	Date of payment transaction
	paymentReference	String	Payment reference
	totalDebitAmount	String	Total amount being debited
	achTransactionType	String	Type of ACH transaction - Debit/Credit
	paymentAuthMessage	String	Reason of payment status in case of error
	invoiceUploadCount	String	Count of invoices uploaded with payment
	paymentProcessDate	String	Date of payment being processed
	buyerBillingProduct	String	Type of Billing for Buyer Card/Check/ACH
	transactionCategory	String	Category for transaction
	paymentAccountNumber	String	Last 4 of the account for Reference
	settlement amount status unsettledAmount settlementAmount settlementDateTime	Object String String String String String	Settlement received for the payment Amount of settlement Status of settlement Amount not yet settled for the payment Amount settled for the payment Date and time of settlement
	settled	String	Amount settled
	debitAmount	String	Amount debited
	tags	Object	Tags associated
	passport send id status processingDetail memo originator wireReference	Object Object String String Object String String String	Passport details Send associated details Id of send Status of send transaction Processing Details Memo associated Originator Reference for wire
	created	string	Date and time of creation of transaction
	creator id username	array String String	Id of user creating the transaction Username of user creating the transaction
	modified	string	Date and time of last modification of transaction
	modifier id username	array String String	Id of user who has last modified the transaction Username of user who has last modified the transaction
	fileId	String	Id of file
	fileDate	String	Date of file
	filePath	String	Path of file
	network id nid name status externalStatus	Object String String String String String	Network details associated to Fee Id of Network NID of network Name of Network Status of Network External Status of Network
	institution id fid name Status revenue bankAccountId goodFunds bankAccountId fees bankAccountId achDelayDays vcnValidDays externalStatus paymentFileType bankAccountNumber hash mask bankRoutingNumber hash mask associatedNetworkId pifConfirmationEmail vcnHost vcnHostConfig braves corpId vendor clientOrg clientUserId companyNumber billLevel falcons vendor location products id name type value default isSingleUse suppressSIPEmail companyNumber bin	Object String String String String Object String Object String Object String String String String String Object String String Object String String String String String Object Object String String String String String String Object String String Object String String String String Boolean Boolean Boolean String String	Institution details Id of Institution FID of Institution Name of Institution Status of Institution Revenue account details BankAccount set for Revenue Good funds account details BankAccount set for Goodfunds Fee account details of Institution BankAccount set for Fee ACH Delay days set at Institution VCN Valid days set at Institution External Status of Institution Payment File Type set at Institution Bank Account Number Hash of account number Mask of account number Id of associated Network Email for disposition notification Default VCN host set at institution VCN Host Configuration Braves configuration CorpId for Braves Vendor for braves card products Client Org for braves Client UserID for braves Company Number for braves Bill Level for braves Falcons Configuration Vendor for falcons card products Location for falcons Product configurations for falcons Id of card product Name of card product Type of card product Value of card product If the product is default product If product is single use product Whether SIP emails are to be suppressed Company Number set at institution level Bin set at institution
	buyer id ach billing delayDays debitMethod bankAccountId exposureTracking days limit enabled lastUpdateDate currentExposureAmount bid name status creditLimit address street1 street2 city state country postalCode vcnHost vcnHostConfig braves companyNumber falcons paymentReferenceNumber LDG/PPD/VCN/VWA id name value passport account da id customerId syncError addressId buyerWallet id walletId bankAccount id achEnabled virtualCard billing bankAccountId exposureTracking enabled achRequested wireEnabled wireRequested externalStatus dualPifApproval enabled failOverPayment enabled associatedInstitutionId managedCheckRequested managedCheckEnabled invoiceUploadEnabled expeditedShippingEnabled plastiqPayEnabled dxcModelFromAccountNumber customRemittanceEnabled lodgePaymentEnabled checkInsertsEnabled checkEnabled virtualCardEnabled virtualCardRequested isEnhancedManagedCheck checkIssuingRequested checkIssuingEnabled wire billing walletId delayDays debitMethod plastiq payerId syncError wallet id	Object String Object String Integer Enum String Object Integer Number Boolean String Number String String Enum Number Object String String String String String String String Object Object String Object String Object String String String Object Object Object String String String String Object String String Object String String Object Object String String Boolean Object String String Object Boolean Boolean Boolean Enum Object Boolean Object Boolean String Boolean String String Boolean Boolean Boolean Boolean Boolean Boolean String Boolean Boolean Boolean Boolean Boolean Boolean Boolean Boolean Boolean Object String String Integer Enum Object String String Object String	Buyer associated to wallet transaction Id of buyer Ach billing information Billing method set for ACH Delay days set for ACH Debit Method set for ACH Id of Bank account set for ACH Exposure tracking for ACH Number of days for tracking Limit set for tracking If exposure tracking is enabled Last updated on Current exposure amount BID of the Buyer Name of the Buyer Status of the Buyer Credit limit set for buyer Address of the Buyer Street1 of the address Street2 of the address city of the address state of the address country of the address Postal Code of address VCN host of the Buyer VCN Host configuration for buyer Braves configuration Company Number for braves Falcons configuration of buyer Payment Reference Number for falcons Product set for falcon - LDG/PPD/VCN/VWA Id of Product Name of Product Value of Product Passport customer details for the buyer Passport Account details Deposit account Id of deposit account Customer ID of buyer in Passport Sync error if any Wallet details Id of wallet WalletID assigned by CPX Bank Account Id of Bank Account in Passport If ACH enabled for buyer Virtual Card details set for Buyer Billing method for Virtual Card Bank account ID set for VC Exposure tracking set for VC Whether Exposure tracking is enabled If ACH requested for buyer If wire is enabled for buyer If Wire toggle has been enabled External Status for Buyer Dual PIF approval If Dual PIF approval is enabled Fail Over payment setting If Fail Over payment is enabled ID of Institution associated to Buyer If managed Check is requested for buyer If managed Check is enabled for Buyer If invoice upload is enabled for Buyer If expedited shipping is enabled for Buyer If Plastiq Pay is enabled for Buyer DXC Model account number If Custom check remittance is enabled for Buyer If Lodge Payment is enabled for Buyer If check inserts are enabled for Buyer If check is enabled for Buyer If virtual card is enabled for Buyer If virtual card is requested for Buyer pending underwriting If enhanced managed Check is enabled for Buyer If check issuing is requested for buyer If Check issuing enabled for buyer Wire details for buyer Billing details for wire walletId for wire delayDays set for wire debitMethod set for wire Plastiq sync details for buyer Payer ID of buyer in plastiq Sync error message if any Wallet details Id of wallet
	supplier id mcc code description sid name status address street 1 street 2 city state country postalCode variance amount payeeType expirePreAuths externalStatus paymentTypes id type enabled accountType feeType flatFee netFees discountRate payableTo additionalPayableTo payableToLine3 lowTermDays highTermDays prepaidDebitId prepaidDebitBalance fax emails deliveryMethod noNotification virtualWalletId virtualWalletBalance address street1 street2 city state country postalCode phone contacts id name phone email primary passport addressId customerId externalAccount wire accountId checkIssuingAddressId syncError plastiq ACH syncError recipientId CHK syncError recipientId	Object String Object String String String String String Object String String String String String String Object String String String String Object String String Boolean String String String String String String String String String String String String String String Boolean String Boolean String String Object String String String String String String String Object String String String String String Object String String Object Object String String String Object Object String String Object String String	Supplier details Id of supplier Mcc of supplier Code of MCC Description of MCC Sid of supplier Name of supplier Status of supplier Address of supplier street 1 of supplier street 2 of supplier City of supplier State of supplier Country of supplier postalCode of supplier Variance of supplier Amount of supplier payeeType of supplier expirePreAuths of supplier externalStatus of supplier paymentTypes of supplier Id of payment type Type of payment type If payment type is Enabled accountType of payment type feeType of payment type If flatFee enabled If netFees enabled If discountRate enabled payableTo for check payments lowTermDays set for payment method highTermDays set for payment method prepaidDebitId for payment method prepaidDebitBalance for payment method Fax number for payment method deliveryMethod for payment method If noNotification is enabled Id of virtual Wallet Balance of virtual Wallet If Pin is required to access VC Proxy Payment enabled for supplier Address set for payment method Street1 Of address Street2 of address City of address State of address Country of address Postal Code of address Phone number for wire Contact details set for supplier Id of contact Name of contact Phone of contact Email of contact If contact is set as primary Passport details for supplier Id of Address in Passport Id of customer in Passport External Account details Wire details Id of account for wire Check issuing address Id Sync error message if any Plastiq details for supplier ACH details in Plastiq Sync error message if any Id of ACH recipient in plastiq Check details in Plastiq Sync error message if any Id of Check recipient in plastiq

12.3 Operations

12.3.1. Add Money
12.3.2. Withdraw Money
12.3.3. Get Wallet Transactions