import Hyperwallet from 'hyperwallet-sdk/src/Hyperwallet.js'

public class | source

Hyperwallet

The Hyperwallet SDK Client

Test:

Hyperwallet

Static Method Summary

Static Public Methods
public static	isValidFilter(options: Object, listFilters: Object): * Validate the options filter

Static Private Methods
private static	handle204Response(callback: api-callback): api-callback Handle 204 response for list calls

Constructor Summary

Public Constructor
public	constructor(config: Object) Create a instance of the SDK Client

Member Summary

Protected Members
protected	client: ApiClient The instance of the ApiClient
protected	programToken: string The program token that is used for some API calls

Method Summary

Public Methods
public	activateBusinessStakeholder(userToken: string, stakeholderToken: string, callback: api-callback) Activate a Business Stakeholder transition
public	activatePayPalAccount(userToken: string, payPalAccountToken: string, callback: api-callback) Activate a PayPal account
public	activateUser(userToken: string, callback: api-callback) Activate a user
public	createBankAccount(userToken: string, data: Object, callback: api-callback) Create a bank account
public	createBankAccountStatusTransition(userToken: string, bankAccountToken: string, data: Object, callback: api-callback) Create a bank account status transition
public	createBankCard(userToken: string, data: Object, callback: api-callback) Create a Bank card
public	createBankCardStatusTransition(userToken: string, bankCardToken: string, data: Object, callback: api-callback) Create a bank card status transition
public	createBusinessStakeholder(userToken: string, data: Object, callback: api-callback) Create a Business Stakeholder
public	createBusinessStakeholderStatusTransition(userToken: string, stakeholderToken: string, data: Object, callback: api-callback) Create a Business Stakeholder transition
public	createPaperCheck(userToken: string, data: Object, callback: api-callback) Create a paper check
public	createPaperCheckStatusTransition(userToken: string, paperCheckToken: string, data: Object, callback: api-callback) Create a paper check status transition
public	createPayPalAccount(userToken: string, data: Object, callback: api-callback) Create a PayPal account
public	createPayPalAccountStatusTransition(userToken: string, payPalAccountToken: string, data: Object, callback: api-callback) Create PayPal account status transition
public	createPayment(data: Object, callback: api-callback) Create a payment
public	createPaymentStatusTransition(paymentToken: string, data: Object, callback: api-callback) Create a payment status transition
public	createPrepaidCard(userToken: string, data: Object, callback: api-callback) Create a prepaid card
public	createPrepaidCardStatusTransition(userToken: string, prepaidCardToken: string, data: Object, callback: api-callback) Create a prepaid card status transition
public	createTransfer(data: Object, callback: api-callback) Create a transfer
public	createTransferMethod(userToken: string, jsonCacheToken: string, data: Object, callback: api-callback) Create a transfer method
public	createTransferRefund(transferToken: string, data: Object, callback: api-callback) Create a transfer refund
public	createTransferStatusTransition(transferToken: string, data: Object, callback: api-callback) Create a transfer status transition
public	createUser(data: Object, callback: api-callback) Create a user
public	createUserStatusTransition(userToken: string, data: Object, callback: api-callback) Create a user status transition
public	createVenmoAccount(userToken: string, data: Object, callback: api-callback) Create a Venmo account
public	createVenmoAccountStatusTransition(userToken: string, venmoAccountToken: string, data: Object, callback: api-callback) Create Venmo account status transition
public	deactivateBankAccount(userToken: string, bankAccountToken: string, callback: api-callback) Deactivate a bank account
public	deactivateBankCard(userToken: string, bankCardToken: string, callback: api-callback) Deactivate a bank card
public	deactivateBusinessStakeholder(userToken: string, stakeholderToken: string, callback: api-callback) Deactivate a Business Stakeholder transition
public	deactivatePaperCheck(userToken: string, paperCheckToken: string, callback: api-callback) Deactivate a paper check
public	deactivatePayPalAccount(userToken: string, payPalAccountToken: string, callback: api-callback) Deactivate a PayPal account
public	deactivatePrepaidCard(userToken: string, prepaidCardToken: string, callback: api-callback) Deactivate a prepaid card
public	deactivateUser(userToken: string, callback: api-callback) Deactivate a user
public	deactivateVenmoAccount(userToken: string, venmoAccountToken: string, callback: api-callback) Deactivate a venmo account
public	freezeUser(userToken: string, callback: api-callback) Freeze a user account
public	getAuthenticationToken(userToken: string, callback: api-callback) Get authentication token
public	getBankAccount(userToken: string, bankAccountToken: string, callback: api-callback) Get a bank account
public	getBankAccountStatusTransition(userToken: string, bankAccountToken: string, bankAccountToken: string, statusTransitionToken: string, callback: api-callback) Get bank account status transition
public	getBankCard(userToken: string, bankCardToken: string, callback: api-callback) Get a bank card
public	getBankCardStatusTransition(userToken: string, bankCardToken: string, statusTransitionToken: string, callback: api-callback) Get a bank card status transition
public	getBusinessStakeholderStatusTransition(userToken: string, stakeholderToken: string, statusTransitionToken: string, callback: api-callback) Get Business Stakeholder status transition
public	getPaperCheck(userToken: string, paperCheckToken: string, callback: api-callback) Get a paper check
public	getPaperCheckStatusTransition(userToken: string, paperCheckToken: string, statusTransitionToken: string, callback: api-callback) Get a paper check status transition
public	getPayPalAccount(userToken: string, payPalAccountToken: string, callback: api-callback) Get a PayPal account
public	getPayPalAccountStatusTransition(userToken: string, payPalAccountToken: string, statusTransitionToken: string, callback: api-callback) Get PayPal account status transition
public	getPayment(paymentToken: string, callback: api-callback) Get a payment
public	getPaymentStatusTransition(paymentToken: string, statusTransitionToken: string, callback: api-callback) Get payment status transition
public	getPrepaidCard(userToken: string, prepaidCardToken: string, callback: api-callback) Get a prepaid card
public	getPrepaidCardStatusTransition(userToken: string, prepaidCardToken: string, statusTransitionToken: string, callback: api-callback) Get a prepaid card status transition
public	getProgram(programToken: string, callback: api-callback) Get a program
public	getProgramAccount(programToken: string, accountToken: string, callback: api-callback) Get a program account
public	getTransfer(transferToken: string, callback: api-callback) Get a transfer
public	getTransferMethodConfiguration(userToken: string, country: string, currency: string, type: string, profileType: string, callback: api-callback) Get a transfer method configuration
public	getTransferRefund(transferToken: string, transferRefundToken: string, callback: api-callback) Get a transfer
public	getTransferStatusTransition(transferToken: string, statusTransitionToken: string, callback: api-callback) Get a transfer status transition
public	getUser(userToken: string, callback: api-callback) Load a user
public	getUserStatusTransition(userToken: string, statusTransitionToken: string, callback: api-callback) Get user status transition
public	getVenmoAccount(userToken: string, venmoAccountToken: string, callback: api-callback) Get a Venmo account
public	getVenmoAccountStatusTransition(userToken: string, venmoAccountToken: string, statusTransitionToken: string, callback: api-callback) Get Venmo account status transition
public	getWebhookNotification(webhookToken: string, callback: api-callback) Get a single webhook notification
public	listBalancesForAccount(programToken: string, accountToken: string, options: Object, callback: api-callback) List balances for a program accounts
public	listBalancesForPrepaidCard(userToken: string, prepaidCardToken: string, options: Object, callback: api-callback) List balances for a prepaid card
public	listBalancesForUser(userToken: string, options: Object, callback: api-callback) List balances for a user
public	listBankAccountStatusTransitions(userToken: string, bankAccountToken: string, options: Object, callback: api-callback) List all bank account status transitions
public	listBankAccounts(userToken: string, options: Object, callback: api-callback) List all bank accounts
public	listBankCardStatusTransitions(userToken: string, bankCardToken: string, options: Object, callback: api-callback) List all bank card status transitions
public	listBankCards(userToken: string, options: Object, callback: api-callback) List all bank cards
public	listBusinessStakeholderStatusTransitions(userToken: string, stakeholderToken: string, options: Object, callback: api-callback) List all Business Stakeholder status transitions
public	listBusinessStakeholders(userToken: string, options: Object, callback: api-callback) List all Business Stakeholder
public	listPaperCheckStatusTransitions(userToken: string, paperCheckToken: string, options: Object, callback: api-callback) List all paper check status transitions
public	listPaperChecks(userToken: string, options: Object, callback: api-callback) List all paper checks
public	listPayPalAccountStatusTransitions(userToken: string, payPalAccountToken: string, options: Object, callback: api-callback) List PayPal account status transition
public	listPayPalAccounts(userToken: string, options: Object, callback: api-callback) List all PayPal accounts
public	listPaymentStatusTransitions(paymentToken: string, options: Object, callback: api-callback) List all payment status transitions
public	listPayments(options: Object, callback: api-callback) List all payments
public	listPrepaidCardStatusTransitions(userToken: string, prepaidCardToken: string, options: Object, callback: api-callback) List all prepaid card status transitions
public	listPrepaidCards(userToken: string, options: Object, callback: api-callback) List all prepaid cards
public	listReceiptsForPrepaidCard(userToken: string, prepaidCardToken: string, options: Object, callback: api-callback) List all prepaid card receipts
public	listReceiptsForProgramAccount(programToken: string, accountToken: string, options: Object, callback: api-callback) List all program account receipts
public	listReceiptsForUser(userToken: string, options: Object, callback: api-callback) List all user receipts
public	listTransferMethodConfigurations(userToken: string, options: Object, callback: api-callback) List all transfer method configurations
public	listTransferMethods(userToken: string, options: Object, callback: api-callback) List of Transfer Methods
public	listTransferRefunds(transferToken: string, options: Object, callback: api-callback) List all transfers
public	listTransferStatusTransition(transferToken: string, options: Object, callback: api-callback) List all transfer status transitions
public	listTransfers(options: Object, callback: api-callback) List all transfers
public	listUserStatusTransitions(userToken: string, options: Object, callback: api-callback) List all user status transitions
public	listUsers(options: Object, callback: api-callback) List all users
public	listVenmoAccountStatusTransitions(userToken: string, venmoAccountToken: string, options: Object, callback: api-callback) List all venmo account status transitions
public	listVenmoAccounts(userToken: string, options: Object, callback: api-callback) List all Venmo accounts
public	listWebhookNotifications(options: Object, callback: api-callback) List webhook notifications
public	lockPrepaidCard(userToken: string, prepaidCardToken: string, callback: api-callback) Lock a prepaid card
public	lockUser(userToken: string, callback: api-callback) Lock a user account
public	lostOrStolenPrepaidCard(userToken: string, prepaidCardToken: string, callback: api-callback) Mark a prepaid card as lost or stolen
public	preactivateUser(userToken: string, callback: api-callback) Pre-activate a user account
public	suspendPrepaidCard(userToken: string, prepaidCardToken: string, callback: api-callback) Suspend a prepaid card
public	unlockPrepaidCard(userToken: string, prepaidCardToken: string, callback: api-callback) Unlock a prepaid card
public	unsuspendPrepaidCard(userToken: string, prepaidCardToken: string, callback: api-callback) Unsuspend a prepaid card
public	updateBankAccount(userToken: string, bankAccountToken: string, data: Object, callback: api-callback) Update a bank account
public	updateBankCard(userToken: string, bankCardToken: string, data: Object, callback: api-callback) Update a bank card
public	updateBusinessStakeholder(userToken: string, stakeholderToken: string, data: Object, callback: api-callback) Update a Business Stakeholder
public	updatePaperCheck(userToken: string, paperCheckToken: string, data: Object, callback: api-callback) Update a paper check
public	updatePayPalAccount(userToken: string, payPalAccountToken: string, data: Object, callback: api-callback) Update a PayPal account
public	updatePrepaidCard(userToken: string, prepaidCardToken: string, data: Object, callback: api-callback) Update a prepaid card
public	updateUser(userToken: string, data: Object, callback: api-callback) Update a user
public	updateVenmoAccount(userToken: string, venmoAccountToken: string, data: Object, callback: api-callback) Update a venmo account
public	uploadBusinessStakeholderDocuments(userToken: string, stakeholderToken: string, data: Object, callback: api-callback) Upload Documents to Business Stakeholder
public	uploadDocuments(userToken: string, data: Object, callback: api-callback) Upload Documents to User

Private Methods
private	addProgramToken(data: Object): Object Add program token to data object if not already set

Static Public Methods

public static isValidFilter(options: Object, listFilters: Object): * source

Validate the options filter

Params:

Name	Type	Attribute	Description
options	Object		The query parameters in the URI
listFilters	Object		Defined list of filters for a business object

Return:

Static Private Methods

private static handle204Response(callback: api-callback): api-callback source

Handle 204 response for list calls

Params:

Name	Type	Attribute	Description
callback	api-callback		The api callback

Return:

api-callback

A wrapper api callback

Public Constructors

public constructor(config: Object) source

Create a instance of the SDK Client

Params:

Name	Type	Attribute	Description
config	Object		The API config
config.username	string		The API username
config.password	string		The API password
config.programToken	string	optional	The program token that is used for some API calls
config.encryptionData	Object	optional	The JSON object of encryption data
config.server	string	optional default: https://api.sandbox.hyperwallet.com	The API server to connect to

Test:

Protected Members

protected client: ApiClient source

The instance of the ApiClient

protected programToken: string source

The program token that is used for some API calls

Public Methods

public activateBusinessStakeholder(userToken: string, stakeholderToken: string, callback: api-callback) source

Activate a Business Stakeholder transition

Params:

Name	Type	Attribute	Description
userToken	string		user token
stakeholderToken	string		stakeholder token
callback	api-callback		callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public activatePayPalAccount(userToken: string, payPalAccountToken: string, callback: api-callback) source

Activate a PayPal account

Params:

Name	Type	Attribute	Description
userToken	string		The user token
payPalAccountToken	string		The PayPal account token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or payPalAccountToken is not provided

Test:

public activateUser(userToken: string, callback: api-callback) source

Activate a user

Params:

Name	Type	Attribute	Description
userToken	string		user token
callback	api-callback		callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public createBankAccount(userToken: string, data: Object, callback: api-callback) source

Create a bank account

Params:

Name	Type	Attribute	Description
userToken	string		The user token
data	Object		The bank account data
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public createBankAccountStatusTransition(userToken: string, bankAccountToken: string, data: Object, callback: api-callback) source

Create a bank account status transition

Params:

Name	Type	Attribute	Description
userToken	string		The user token
bankAccountToken	string		The bank account token
data	Object		The bank account status transition data
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or bankAccountToken is not provided

Test:

public createBankCard(userToken: string, data: Object, callback: api-callback) source

Create a Bank card

Params:

Name	Type	Attribute	Description
userToken	string		The user token
data	Object		The bank card data
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public createBankCardStatusTransition(userToken: string, bankCardToken: string, data: Object, callback: api-callback) source

Create a bank card status transition

Params:

Name	Type	Attribute	Description
userToken	string		The user token
bankCardToken	string		The bank card token
data	Object		The bank card status transition data
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or bankCardToken is not provided

Test:

public createBusinessStakeholder(userToken: string, data: Object, callback: api-callback) source

Create a Business Stakeholder

Params:

Name	Type	Attribute	Description
userToken	string		The Stakeholder token
data	Object		The Stakeholder data
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

Hyperwallet createBusinessStakeholder()

public createBusinessStakeholderStatusTransition(userToken: string, stakeholderToken: string, data: Object, callback: api-callback) source

Create a Business Stakeholder transition

Params:

Name	Type	Attribute	Description
userToken	string		user token
stakeholderToken	string		stakeholder token
data	Object		Stakeholder transition data
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public createPaperCheck(userToken: string, data: Object, callback: api-callback) source

Create a paper check

Params:

Name	Type	Attribute	Description
userToken	string		The user token
data	Object		The paper check data
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public createPaperCheckStatusTransition(userToken: string, paperCheckToken: string, data: Object, callback: api-callback) source

Create a paper check status transition

Params:

Name	Type	Attribute	Description
userToken	string		The user token
paperCheckToken	string		The paper check token
data	Object		The paper check status transition data
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or paperCheckToken is not provided

Test:

public createPayPalAccount(userToken: string, data: Object, callback: api-callback) source

Create a PayPal account

Params:

Name	Type	Attribute	Description
userToken	string		The user token
data	Object		The PayPal account data
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public createPayPalAccountStatusTransition(userToken: string, payPalAccountToken: string, data: Object, callback: api-callback) source

Create PayPal account status transition

Params:

Name	Type	Attribute	Description
userToken	string		The user token
payPalAccountToken	string		PayPal account token
data	Object		PayPal account status transition data
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or payPalAccountToken is not provided

Test:

public createPayment(data: Object, callback: api-callback) source

Create a payment

Params:

Name	Type	Attribute	Description
data	Object		The payment data
callback	api-callback		The callback for this call

Test:

public createPaymentStatusTransition(paymentToken: string, data: Object, callback: api-callback) source

Create a payment status transition

Params:

Name	Type	Attribute	Description
paymentToken	string		The payment token
data	Object		The payment status transition data
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if paymentToken is not provided

Test:

public createPrepaidCard(userToken: string, data: Object, callback: api-callback) source

Create a prepaid card

Params:

Name	Type	Attribute	Description
userToken	string		The user token
data	Object		The prepaid card data
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public createPrepaidCardStatusTransition(userToken: string, prepaidCardToken: string, data: Object, callback: api-callback) source

Create a prepaid card status transition

Params:

Name	Type	Attribute	Description
userToken	string		The user token
prepaidCardToken	string		The prepaid card token
data	Object		The prepaid card status transition data
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or prepaidCardToken is not provided

Test:

public createTransfer(data: Object, callback: api-callback) source

Create a transfer

Params:

Name	Type	Attribute	Description
data	Object		The transfer data
callback	api-callback		The callback for this call

Test:

public createTransferMethod(userToken: string, jsonCacheToken: string, data: Object, callback: api-callback) source

Create a transfer method

Params:

Name	Type	Attribute	Description
userToken	string		The user token
jsonCacheToken	string		The json cache token supplied by the widget
data	Object		Transfer method data
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken is not provided
*	Will throw an error if jsonCacheToken is not provided

Test:

public createTransferRefund(transferToken: string, data: Object, callback: api-callback) source

Create a transfer refund

Params:

Name	Type	Attribute	Description
transferToken	string		The transfer token
data	Object		The transfer refund data
callback	api-callback		The callback for this call

Test:

public createTransferStatusTransition(transferToken: string, data: Object, callback: api-callback) source

Create a transfer status transition

Params:

Name	Type	Attribute	Description
transferToken	string		The transfer token
data	Object		The transfer status transition data
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if transferToken is not provided

Test:

public createUser(data: Object, callback: api-callback) source

Create a user

Params:

Name	Type	Attribute	Description
data	Object		The user data
callback	api-callback		The callback for this call

Test:

public createUserStatusTransition(userToken: string, data: Object, callback: api-callback) source

Create a user status transition

Params:

Name	Type	Attribute	Description
userToken	string		user token
data	Object		user status transition data
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public createVenmoAccount(userToken: string, data: Object, callback: api-callback) source

Create a Venmo account

Params:

Name	Type	Attribute	Description
userToken	string		The user token
data	Object		The Venmo account data
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public createVenmoAccountStatusTransition(userToken: string, venmoAccountToken: string, data: Object, callback: api-callback) source

Create Venmo account status transition

Params:

Name	Type	Attribute	Description
userToken	string		The user token
venmoAccountToken	string		venmo account token
data	Object		Venmo account status transition data
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or venmoAccountToken is not provided

Test:

public deactivateBankAccount(userToken: string, bankAccountToken: string, callback: api-callback) source

Deactivate a bank account

Params:

Name	Type	Attribute	Description
userToken	string		The user token
bankAccountToken	string		The bank account token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or bankAccountToken is not provided

Test:

public deactivateBankCard(userToken: string, bankCardToken: string, callback: api-callback) source

Deactivate a bank card

Params:

Name	Type	Attribute	Description
userToken	string		The user token
bankCardToken	string		The bank card token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or bankCardToken is not provided

Test:

public deactivateBusinessStakeholder(userToken: string, stakeholderToken: string, callback: api-callback) source

Deactivate a Business Stakeholder transition

Params:

Name	Type	Attribute	Description
userToken	string		user token
stakeholderToken	string		stakeholder token
callback	api-callback		callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public deactivatePaperCheck(userToken: string, paperCheckToken: string, callback: api-callback) source

Deactivate a paper check

Params:

Name	Type	Attribute	Description
userToken	string		The user token
paperCheckToken	string		The paper check token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or paperCheckToken is not provided

Test:

public deactivatePayPalAccount(userToken: string, payPalAccountToken: string, callback: api-callback) source

Deactivate a PayPal account

Params:

Name	Type	Attribute	Description
userToken	string		The user token
payPalAccountToken	string		The PayPal account token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or payPalAccountToken is not provided

Test:

public deactivatePrepaidCard(userToken: string, prepaidCardToken: string, callback: api-callback) source

Deactivate a prepaid card

Params:

Name	Type	Attribute	Description
userToken	string		The user token
prepaidCardToken	string		The prepaid card token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or prepaidCardToken is not provided

Test:

public deactivateUser(userToken: string, callback: api-callback) source

Deactivate a user

Params:

Name	Type	Attribute	Description
userToken	string		user token
callback	api-callback		callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public deactivateVenmoAccount(userToken: string, venmoAccountToken: string, callback: api-callback) source

Deactivate a venmo account

Params:

Name	Type	Attribute	Description
userToken	string		user token
venmoAccountToken	string		Venmo account token
callback	api-callback		callback for this call

Throw:

*	Will throw an error if userToken or venmoAccountToken is not provided

Test:

public freezeUser(userToken: string, callback: api-callback) source

Freeze a user account

Params:

Name	Type	Attribute	Description
userToken	string		user token
callback	api-callback		callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public getAuthenticationToken(userToken: string, callback: api-callback) source

Get authentication token

Params:

Name	Type	Attribute	Description
userToken	string		The user token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public getBankAccount(userToken: string, bankAccountToken: string, callback: api-callback) source

Get a bank account

Params:

Name	Type	Attribute	Description
userToken	string		The user token
bankAccountToken	string		The bank account token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or bankAccountToken is not provided

Test:

public getBankAccountStatusTransition(userToken: string, bankAccountToken: string, bankAccountToken: string, statusTransitionToken: string, callback: api-callback) source

Get bank account status transition

Params:

Name	Type	Attribute	Description
userToken	string		The user token
bankAccountToken	string		The bank account token
bankAccountToken	string		The bank account token
statusTransitionToken	string		The bank account status transition token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or bankAccountToken is not provided

Test:

public getBankCard(userToken: string, bankCardToken: string, callback: api-callback) source

Get a bank card

Params:

Name	Type	Attribute	Description
userToken	string		The user token
bankCardToken	string		The bank card token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or bankCardToken is not provided

Test:

public getBankCardStatusTransition(userToken: string, bankCardToken: string, statusTransitionToken: string, callback: api-callback) source

Get a bank card status transition

Params:

Name	Type	Attribute	Description
userToken	string		The user token
bankCardToken	string		The bank card token
statusTransitionToken	string		The bank card status transition token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken, bankCardToken or statusTransitionToken is not provided

Test:

public getBusinessStakeholderStatusTransition(userToken: string, stakeholderToken: string, statusTransitionToken: string, callback: api-callback) source

Get Business Stakeholder status transition

Params:

Name	Type	Attribute	Description
userToken	string		user token
stakeholderToken	string		The Business Stakeholder token
statusTransitionToken	string		The Business Stakeholder status transition token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or stakeholderToken is not provided

Test:

public getPaperCheck(userToken: string, paperCheckToken: string, callback: api-callback) source

Get a paper check

Params:

Name	Type	Attribute	Description
userToken	string		The user token
paperCheckToken	string		The paper check token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or paperCheckToken is not provided

Test:

public getPaperCheckStatusTransition(userToken: string, paperCheckToken: string, statusTransitionToken: string, callback: api-callback) source

Get a paper check status transition

Params:

Name	Type	Attribute	Description
userToken	string		The user token
paperCheckToken	string		The paper check token
statusTransitionToken	string		The paper check status transition token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken, paperCheckToken or statusTransitionToken is not provided

Test:

public getPayPalAccount(userToken: string, payPalAccountToken: string, callback: api-callback) source

Get a PayPal account

Params:

Name	Type	Attribute	Description
userToken	string		The user token
payPalAccountToken	string		The PayPal account token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or payPalAccountToken is not provided

Test:

public getPayPalAccountStatusTransition(userToken: string, payPalAccountToken: string, statusTransitionToken: string, callback: api-callback) source

Get PayPal account status transition

Params:

Name	Type	Attribute	Description
userToken	string		The user token
payPalAccountToken	string		PayPal account token
statusTransitionToken	string		The PayPal account status transition token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or payPalAccountToken or statusTransitionToken is not provided

Test:

public getPayment(paymentToken: string, callback: api-callback) source

Get a payment

Params:

Name	Type	Attribute	Description
paymentToken	string		The payment token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if paymentToken is not provided

Test:

public getPaymentStatusTransition(paymentToken: string, statusTransitionToken: string, callback: api-callback) source

Get payment status transition

Params:

Name	Type	Attribute	Description
paymentToken	string		The payment token
statusTransitionToken	string		The payment status transition token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if paymentToken is not provided

Test:

public getPrepaidCard(userToken: string, prepaidCardToken: string, callback: api-callback) source

Get a prepaid card

Params:

Name	Type	Attribute	Description
userToken	string		The user token
prepaidCardToken	string		The prepaid card token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or prepaidCardToken is not provided

Test:

public getPrepaidCardStatusTransition(userToken: string, prepaidCardToken: string, statusTransitionToken: string, callback: api-callback) source

Get a prepaid card status transition

Params:

Name	Type	Attribute	Description
userToken	string		The user token
prepaidCardToken	string		The prepaid card token
statusTransitionToken	string		The prepaid card status transition token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken, prepaidCardToken or statusTransitionToken is not provided

Test:

public getProgram(programToken: string, callback: api-callback) source

Get a program

Params:

Name	Type	Attribute	Description
programToken	string		The program token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if programToken is not provided

Test:

public getProgramAccount(programToken: string, accountToken: string, callback: api-callback) source

Get a program account

Params:

Name	Type	Attribute	Description
programToken	string		The program token
accountToken	string		The account token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if programToken is not provided

Test:

public getTransfer(transferToken: string, callback: api-callback) source

Get a transfer

Params:

Name	Type	Attribute	Description
transferToken	string		The transfer token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if transferToken is not provided

Test:

public getTransferMethodConfiguration(userToken: string, country: string, currency: string, type: string, profileType: string, callback: api-callback) source

Get a transfer method configuration

Params:

Name	Type	Attribute	Description
userToken	string		The user token
country	string		The transfer method country
currency	string		The transfer method currency
type	string		The transfer method type
profileType	string		The profile type
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken, country, currency, type or profileType is not provided

Test:

public getTransferRefund(transferToken: string, transferRefundToken: string, callback: api-callback) source

Get a transfer

Params:

Name	Type	Attribute	Description
transferToken	string		The transfer token
transferRefundToken	string		The transfer refund token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if transferToken is not provided

Test:

public getTransferStatusTransition(transferToken: string, statusTransitionToken: string, callback: api-callback) source

Get a transfer status transition

Params:

Name	Type	Attribute	Description
transferToken	string		The transfer token
statusTransitionToken	string		The status transition token token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if transferToken is not provided
*	Will throw an error if statusTransitionToken is not provided

Test:

public getUser(userToken: string, callback: api-callback) source

Load a user

Params:

Name	Type	Attribute	Description
userToken	string		The user token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public getUserStatusTransition(userToken: string, statusTransitionToken: string, callback: api-callback) source

Get user status transition

Params:

Name	Type	Attribute	Description
userToken	string		The user token
statusTransitionToken	string		The user status transition token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public getVenmoAccount(userToken: string, venmoAccountToken: string, callback: api-callback) source

Get a Venmo account

Params:

Name	Type	Attribute	Description
userToken	string		The user token
venmoAccountToken	string		The venmo account token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or venmoAccountToken is not provided

Test:

public getVenmoAccountStatusTransition(userToken: string, venmoAccountToken: string, statusTransitionToken: string, callback: api-callback) source

Get Venmo account status transition

Params:

Name	Type	Attribute	Description
userToken	string		user token
venmoAccountToken	string		The venmo account token
statusTransitionToken	string		The venmo account status transition token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or venmoAccountToken is not provided

Test:

public getWebhookNotification(webhookToken: string, callback: api-callback) source

Get a single webhook notification

Params:

Name	Type	Attribute	Description
webhookToken	string		Webhook token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if webhookToken is not provided

Test:

public listBalancesForAccount(programToken: string, accountToken: string, options: Object, callback: api-callback) source

List balances for a program accounts

Params:

Name	Type	Attribute	Description
programToken	string		The program token
accountToken	string		The account token
options	Object		The query parameters to send
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if programToken or accountToken is not provided

Test:

public listBalancesForPrepaidCard(userToken: string, prepaidCardToken: string, options: Object, callback: api-callback) source

List balances for a prepaid card

Params:

Name	Type	Attribute	Description
userToken	string		The user token
prepaidCardToken	string		The prepaid card token
options	Object		The query parameters to send
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or prepaidCardToken is not provided

Test:

public listBalancesForUser(userToken: string, options: Object, callback: api-callback) source

List balances for a user

Params:

Name	Type	Attribute	Description
userToken	string		The user token
options	Object		The query parameters to send
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public listBankAccountStatusTransitions(userToken: string, bankAccountToken: string, options: Object, callback: api-callback) source

List all bank account status transitions

Params:

Name	Type	Attribute	Description
userToken	string		The user token
bankAccountToken	string		The bank account token
options	Object		The query parameters to send
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or bankAccountToken is not provided

Test:

public listBankAccounts(userToken: string, options: Object, callback: api-callback) source

List all bank accounts

Params:

Name	Type	Attribute	Description
userToken	string		The user token
options	Object		The query parameters to send
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public listBankCardStatusTransitions(userToken: string, bankCardToken: string, options: Object, callback: api-callback) source

List all bank card status transitions

Params:

Name	Type	Attribute	Description
userToken	string		The user token
bankCardToken	string		The bank card token
options	Object		The query parameters to send
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or bankCardToken is not provided

Test:

public listBankCards(userToken: string, options: Object, callback: api-callback) source

List all bank cards

Params:

Name	Type	Attribute	Description
userToken	string		The user token
options	Object		The query parameters to send
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public listBusinessStakeholderStatusTransitions(userToken: string, stakeholderToken: string, options: Object, callback: api-callback) source

List all Business Stakeholder status transitions

Params:

Name	Type	Attribute	Description
userToken	string		user token
stakeholderToken	string		Business Stakeholder token
options	Object		query parameters to send
callback	api-callback		callback for this call

Throw:

*	Will throw an error if userToken or stakeholderToken is not provided

Test:

public listBusinessStakeholders(userToken: string, options: Object, callback: api-callback) source

List all Business Stakeholder

Params:

Name	Type	Attribute	Description
userToken	string		The user token
options	Object		The query parameters to send
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public listPaperCheckStatusTransitions(userToken: string, paperCheckToken: string, options: Object, callback: api-callback) source

List all paper check status transitions

Params:

Name	Type	Attribute	Description
userToken	string		The user token
paperCheckToken	string		The paper check token
options	Object		The query parameters to send
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or paperCheckToken is not provided

Test:

public listPaperChecks(userToken: string, options: Object, callback: api-callback) source

List all paper checks

Params:

Name	Type	Attribute	Description
userToken	string		The user token
options	Object		The query parameters to send
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public listPayPalAccountStatusTransitions(userToken: string, payPalAccountToken: string, options: Object, callback: api-callback) source

List PayPal account status transition

Params:

Name	Type	Attribute	Description
userToken	string		The user token
payPalAccountToken	string		PayPal account token
options	Object		The query parameters to send
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or payPalAccountToken is not provided

Test:

public listPayPalAccounts(userToken: string, options: Object, callback: api-callback) source

List all PayPal accounts

Params:

Name	Type	Attribute	Description
userToken	string		The user token
options	Object		The query parameters to send
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public listPaymentStatusTransitions(paymentToken: string, options: Object, callback: api-callback) source

List all payment status transitions

Params:

Name	Type	Attribute	Description
paymentToken	string		The payment token
options	Object		The query parameters to send
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if paymentToken is not provided

Test:

public listPayments(options: Object, callback: api-callback) source

List all payments

Params:

Name	Type	Attribute	Description
options	Object		The query parameters to send
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if invalid payment is provided

Test:

public listPrepaidCardStatusTransitions(userToken: string, prepaidCardToken: string, options: Object, callback: api-callback) source

List all prepaid card status transitions

Params:

Name	Type	Attribute	Description
userToken	string		The user token
prepaidCardToken	string		The prepaid card token
options	Object		The query parameters to send
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or prepaidCardToken is not provided

Test:

public listPrepaidCards(userToken: string, options: Object, callback: api-callback) source

List all prepaid cards

Params:

Name	Type	Attribute	Description
userToken	string		The user token
options	Object		The query parameters to send
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public listReceiptsForPrepaidCard(userToken: string, prepaidCardToken: string, options: Object, callback: api-callback) source

List all prepaid card receipts

Params:

Name	Type	Attribute	Description
userToken	string		The user token
prepaidCardToken	string		The prepaid card token
options	Object		The query parameters to send
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or prepaidCardToken is not provided

Test:

public listReceiptsForProgramAccount(programToken: string, accountToken: string, options: Object, callback: api-callback) source

List all program account receipts

Params:

Name	Type	Attribute	Description
programToken	string		The program token
accountToken	string		The account token
options	Object		The query parameters to send
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if programToken or accountToken is not provided

Test:

public listReceiptsForUser(userToken: string, options: Object, callback: api-callback) source

List all user receipts

Params:

Name	Type	Attribute	Description
userToken	string		The user token
options	Object		The query parameters to send
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public listTransferMethodConfigurations(userToken: string, options: Object, callback: api-callback) source

List all transfer method configurations

Params:

Name	Type	Attribute	Description
userToken	string		The user token
options	Object		The query parameters to send
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public listTransferMethods(userToken: string, options: Object, callback: api-callback) source

List of Transfer Methods

Params:

Name	Type	Attribute	Description
userToken	string		The user token
options	Object		The query parameters to send
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public listTransferRefunds(transferToken: string, options: Object, callback: api-callback) source

List all transfers

Params:

Name	Type	Attribute	Description
transferToken	string		The transfer token
options	Object		The query parameters to send
callback	api-callback		The callback for this call

Test:

public listTransferStatusTransition(transferToken: string, options: Object, callback: api-callback) source

List all transfer status transitions

Params:

Name	Type	Attribute	Description
transferToken	string		The transfer token
options	Object		The query parameters to send
callback	api-callback		The callback for this call

Test:

public listTransfers(options: Object, callback: api-callback) source

List all transfers

Params:

Name	Type	Attribute	Description
options	Object		The query parameters to send
callback	api-callback		The callback for this call

Test:

public listUserStatusTransitions(userToken: string, options: Object, callback: api-callback) source

List all user status transitions

Params:

Name	Type	Attribute	Description
userToken	string		The user token
options	Object		The query parameters to send
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public listUsers(options: Object, callback: api-callback) source

List all users

Params:

Name	Type	Attribute	Description
options	Object		The query parameters to send
callback	api-callback		The callback for this call

Test:

public listVenmoAccountStatusTransitions(userToken: string, venmoAccountToken: string, options: Object, callback: api-callback) source

List all venmo account status transitions

Params:

Name	Type	Attribute	Description
userToken	string		user token
venmoAccountToken	string		venmo account token
options	Object		query parameters to send
callback	api-callback		callback for this call

Throw:

*	Will throw an error if userToken or venmoAccountToken is not provided

Test:

public listVenmoAccounts(userToken: string, options: Object, callback: api-callback) source

List all Venmo accounts

Params:

Name	Type	Attribute	Description
userToken	string		The user token
options	Object		The query parameters to send
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public listWebhookNotifications(options: Object, callback: api-callback) source

List webhook notifications

Params:

Name	Type	Attribute	Description
options	Object		The query parameters to send
callback	api-callback		The callback for this call

Test:

public lockPrepaidCard(userToken: string, prepaidCardToken: string, callback: api-callback) source

Lock a prepaid card

Params:

Name	Type	Attribute	Description
userToken	string		The user token
prepaidCardToken	string		The prepaid card token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or prepaidCardToken is not provided

Test:

public lockUser(userToken: string, callback: api-callback) source

Lock a user account

Params:

Name	Type	Attribute	Description
userToken	string		user token
callback	api-callback		callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public lostOrStolenPrepaidCard(userToken: string, prepaidCardToken: string, callback: api-callback) source

Mark a prepaid card as lost or stolen

Params:

Name	Type	Attribute	Description
userToken	string		The user token
prepaidCardToken	string		The prepaid card token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or prepaidCardToken is not provided

Test:

public preactivateUser(userToken: string, callback: api-callback) source

Pre-activate a user account

Params:

Name	Type	Attribute	Description
userToken	string		user token
callback	api-callback		callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public suspendPrepaidCard(userToken: string, prepaidCardToken: string, callback: api-callback) source

Suspend a prepaid card

Params:

Name	Type	Attribute	Description
userToken	string		The user token
prepaidCardToken	string		The prepaid card token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or prepaidCardToken is not provided

Test:

public unlockPrepaidCard(userToken: string, prepaidCardToken: string, callback: api-callback) source

Unlock a prepaid card

Params:

Name	Type	Attribute	Description
userToken	string		The user token
prepaidCardToken	string		The prepaid card token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or prepaidCardToken is not provided

Test:

public unsuspendPrepaidCard(userToken: string, prepaidCardToken: string, callback: api-callback) source

Unsuspend a prepaid card

Params:

Name	Type	Attribute	Description
userToken	string		The user token
prepaidCardToken	string		The prepaid card token
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or prepaidCardToken is not provided

Test:

public updateBankAccount(userToken: string, bankAccountToken: string, data: Object, callback: api-callback) source

Update a bank account

Params:

Name	Type	Attribute	Description
userToken	string		The user token
bankAccountToken	string		The bank account token
data	Object		The bank account data to update
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or bankAccountToken is not provided

Test:

public updateBankCard(userToken: string, bankCardToken: string, data: Object, callback: api-callback) source

Update a bank card

Params:

Name	Type	Attribute	Description
userToken	string		The user token
bankCardToken	string		The bank card token
data	Object		The bank card data to update
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or bankCardToken is not provided

Test:

public updateBusinessStakeholder(userToken: string, stakeholderToken: string, data: Object, callback: api-callback) source

Update a Business Stakeholder

Params:

Name	Type	Attribute	Description
userToken	string		The user token
stakeholderToken	string		The user token
data	Object		The Stakeholder data that should be updated
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public updatePaperCheck(userToken: string, paperCheckToken: string, data: Object, callback: api-callback) source

Update a paper check

Params:

Name	Type	Attribute	Description
userToken	string		The user token
paperCheckToken	string		The paper check token
data	Object		The paper check data to update
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or paperCheckToken is not provided

Test:

public updatePayPalAccount(userToken: string, payPalAccountToken: string, data: Object, callback: api-callback) source

Update a PayPal account

Params:

Name	Type	Attribute	Description
userToken	string		The user token
payPalAccountToken	string		The PayPal account token
data	Object		The PayPal account data to update
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or payPalAccountToken is not provided

Test:

public updatePrepaidCard(userToken: string, prepaidCardToken: string, data: Object, callback: api-callback) source

Update a prepaid card

Params:

Name	Type	Attribute	Description
userToken	string		The user token
prepaidCardToken	string		The prepaid card token
data	Object		The prepaid card data to update
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or prepaidCardToken is not provided

Test:

public updateUser(userToken: string, data: Object, callback: api-callback) source

Update a user

Params:

Name	Type	Attribute	Description
userToken	string		The user token
data	Object		The user data that should be updated
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public updateVenmoAccount(userToken: string, venmoAccountToken: string, data: Object, callback: api-callback) source

Update a venmo account

Params:

Name	Type	Attribute	Description
userToken	string		The user token
venmoAccountToken	string		The bank account token
data	Object		The venmo account data to update
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken or venmoAccountToken is not provided

Test:

public uploadBusinessStakeholderDocuments(userToken: string, stakeholderToken: string, data: Object, callback: api-callback) source

Upload Documents to Business Stakeholder

Params:

Name	Type	Attribute	Description
userToken	string		The user token
stakeholderToken	string		stakeholder token
data	Object		JSON object of the data and files to be uploaded
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

public uploadDocuments(userToken: string, data: Object, callback: api-callback) source

Upload Documents to User

Params:

Name	Type	Attribute	Description
userToken	string		The user token
data	Object		JSON object of the data and files to be uploaded
callback	api-callback		The callback for this call

Throw:

*	Will throw an error if userToken is not provided

Test:

Private Methods

private addProgramToken(data: Object): Object source

Add program token to data object if not already set

Params:

Name	Type	Attribute	Description
data	Object		The data object

Return:

Object

The adjusted object