Welcome to the Hyperwallet Python SDK documentation!

API Endpoints

class hyperwallet.api.Api(username=None, password=None, programToken=None, server='https://api.sandbox.hyperwallet.com', encryptionData=None)

A Python interface for the Hyperwallet API.

Parameters:

username – The username of this API user. REQUIRED
password – The password of this API user. REQUIRED
programToken – The token for the program this user is accessing. REQUIRED
server – Your UAT or Production API URL if applicable.
encryptionData – Dictionary with params for encrypted requests (keys: clientPrivateKeySetLocation, hyperwalletKeySetLocation, etc).

Note

server defaults to the Hyperwallet Sandbox URL if not provided.

__buildUrl(*paths)

__updateTransferMethod(userToken=None, transferMethodToken=None, transferMethodName=None, data=None)

Update a Transfer method.

Parameters:

userToken – A token identifying the User. REQUIRED
transferMethodToken – A token identifying the Transfer Method. REQUIRED
transferMethodName – A Transfer Method name used in url. REQUIRED
data – A dictionary containing Transfer Method information. REQUIRED

Returns:

An updated Transfer Method object.

activateUser(userToken=None)

Create User Activate Status Transition. :param userToken:

A token identifying the User Create UserToken. REQUIRED

Returns:: StatusTransition.

createBankAccount(userToken=None, data=None)

Create a Bank Account.

Parameters:

userToken – A token identifying the User. REQUIRED
data – A dictionary containing Bank Account information. REQUIRED

Returns:

A Bank Account.

createBankAccountStatusTransition(userToken=None, bankAccountToken=None, data=None)

Create a Bank Account Status Transition.

Parameters:

userToken – A token identifying the User. REQUIRED
bankAccountToken – A token identifying the Bank Account. REQUIRED
data – A dictionary containing Bank Account Status Transition information. REQUIRED

Returns:

A Bank Account Status Transition.

createBankCard(userToken=None, data=None)

Create a Bank Card.

Parameters:

userToken – A token identifying the User. REQUIRED
data – A dictionary containing Bank Card information. REQUIRED

Returns:

A Bank Card.

createBankCardStatusTransition(userToken=None, bankCardToken=None, data=None)

Create a Bank Card Status Transition.

Parameters:

userToken – A token identifying the User. REQUIRED
bankCardToken – A token identifying the Bank Card. REQUIRED
data – A dictionary containing Bank Card Status Transition information. REQUIRED

Returns:

A Bank Card Status Transition.

createPaperCheck(userToken=None, data=None)

Create a Paper Check.

Parameters:

userToken – A token identifying the User. REQUIRED
data – A dictionary containing Paper Check information. REQUIRED

Returns:

A Paper Check.

createPaperCheckStatusTransition(userToken=None, paperCheckToken=None, data=None)

Create a Paper Check Status Transition.

Parameters:

userToken – A token identifying the User. REQUIRED
paperCheckToken – A token identifying the Paper Check. REQUIRED
data – A dictionary containing Paper Check Status Transition information. REQUIRED

Returns:

A Paper Check Status Transition.

createPayPalAccount(userToken=None, data=None)

Create a PayPal Account. :param userToken:

A token identifying the User. REQUIRED

Parameters:: data – A dictionary containing PayPal Account information. Required fields transferMethodCountry, transferMethodCurrency , email or accountId REQUIRED
Returns:: A PayPal Account.

createPayPalAccountStatusTransition(userToken=None, payPalAccountToken=None, data=None)

Create a PayPal Account Status Transition.

Parameters:

userToken – A token identifying the User. REQUIRED
payPalAccountToken – A token identifying the PayPal Account. REQUIRED
data – A dictionary containing PayPal Account Status Transition information. REQUIRED

Returns:

A PayPal Account Status Transition.

createPayment(data=None)

Create a Payment.

Parameters:: data – A dictionary containing Payment information. REQUIRED
Returns:: A Payment.

createPaymentStatusTransition(paymentToken=None, data=None)

Create Payment Status Transition.

Parameters:

paymentToken – A token identifying the Payment. REQUIRED
data – A dictionary containing User Status Transition information. REQUIRED

Returns:

A Payment Status Transition.

createPrepaidCard(userToken=None, data=None)

Create a Prepaid Card.

Parameters:

userToken – A token identifying the User. REQUIRED
data – A dictionary containing Prepaid Card information. REQUIRED

Returns:

A Prepaid Card.

createPrepaidCardStatusTransition(userToken=None, prepaidCardToken=None, data=None)

Create a Prepaid Card Status Transition.

Parameters:

userToken – A token identifying the User. REQUIRED
prepaidCardToken – A token identifying the Prepaid Card. REQUIRED
data – A dictionary containing Prepaid Card Status Transition information. REQUIRED

Returns:

A Prepaid Card Status Transition.

createTransfer(data=None)

Create a Transfer. :param data:

A dictionary containing Transfer information. REQUIRED

Returns:: A Transfer.

createTransferMethod(userToken=None, cacheToken=None, data=None)

Create a Transfer Method.

Parameters:

userToken – A token identifying the User. REQUIRED
cacheToken – A cache token identifying the Transfer Method. REQUIRED
data – A dictionary containing Field Restriction information.

Returns:

A Transfer Method.

createTransferRefund(transferToken=None, data=None)

Create a Transfer Refund. :param transferToken:

A token identifying the Transfer. REQUIRED

Parameters:: data – A dictionary containing Transfer Refund information. REQUIRED
Returns:: A Transfer Refund.

createTransferSpendBackRefund(transferToken=None, sourceToken=None, params=None)

Create a Transfer Refund. :param transferToken:

A token identifying the Transfer. REQUIRED

Parameters:: data – A dictionary containing Transfer Refund information. REQUIRED
Returns:: A Transfer Refund.

createTransferStatusTransition(transferToken=None, data=None)

Create a Transfer Status Transition. :param transferToken:

A token identifying the Transfer. REQUIRED

Parameters:: data – A dictionary containing Transfer Status Transition information. REQUIRED
Returns:: A Transfer Status Transition.

createUser(data=None)

Create a User.

Parameters:: data – A dictionary containing User information. REQUIRED
Returns:: A User.

createUserStatusTransition(userToken=None, data=None)

Create User Status Transition. :param userToken:

A token identifying the User Create UserToken. REQUIRED

Parameters:: data – A dictionary containing User Status Create Data information. REQUIRED
Returns:: StatusTransition.

createVenmoAccount(userToken=None, data=None)

Create a Venmo Account. :param userToken:

A token identifying the User. REQUIRED

Parameters:: data – A dictionary containing Venmo Account information. REQUIRED
Returns:: A Venmo Account.

createVenmoAccountStatusTransition(userToken=None, venmoAccountToken=None, data=None)

Create a Venmo Account Status Transition.

Parameters:

userToken – A token identifying the User. REQUIRED
VenmoAccountToken – A token identifying the Venmo Account. REQUIRED
data – A dictionary containing Venmo Account Status Transition information. REQUIRED

Returns:

A Venmo Account Status Transition.

deactivateBankAccount(userToken=None, bankAccountToken=None, notes=None)

Deactivate a Bank Account.

Parameters:

userToken – A token identifying the User. REQUIRED
bankAccountToken – A token identifying the Bank Account. REQUIRED
notes – A string describing the deactivation.

Returns:

A Bank Account Status Transition.

deactivateBankCard(userToken=None, bankCardToken=None, notes=None)

Deactivate a Bank Card.

Parameters:

userToken – A token identifying the User. REQUIRED
bankCardToken – A token identifying the Bank Card. REQUIRED
notes – A string describing the deactivation.

Returns:

A Bank Card Status Transition.

deactivatePaperCheck(userToken=None, paperCheckToken=None, notes=None)

Deactivate a Paper Check.

Parameters:

userToken – A token identifying the User. REQUIRED
paperCheckToken – A token identifying the Paper Check. REQUIRED
notes – A string describing the deactivation.

Returns:

A Paper Check Status Transition.

deactivatePayPalAccount(userToken=None, payPalAccountToken=None, notes=None)

Deactivate a PayPal Account.

Parameters:

userToken – A token identifying the User. REQUIRED
payPalAccountToken – A token identifying the PayPal Account. REQUIRED
notes – A string describing the deactivation.

Returns:

A PayPal Account Status Transition.

deactivatePrepaidCard(userToken=None, prepaidCardToken=None, notes=None)

Deactivate a Prepaid Card.

Parameters:

userToken – A token identifying the User. REQUIRED
prepaidCardToken – A token identifying the Prepaid Card. REQUIRED
notes – A string describing the deactivation.

Returns:

A Prepaid Card Status Transition.

deactivateUser(userToken=None)

Create User DeActivate Status Transition. :param userToken:

A token identifying the User Create UserToken. REQUIRED

Returns:: StatusTransition.

deactivateVenmoAccount(userToken=None, venmoAccountToken=None, notes=None)

Deactivate a Venmo Account.

Parameters:

userToken – A token identifying the User. REQUIRED
venmoAccountToken – A token identifying the Venmo Account. REQUIRED
notes – A string describing the deactivation.

Returns:

A Venmo Account Status Transition.

freezeUser(userToken=None)

Create User Freeze Status Transition. :param userToken:

A token identifying the User Create UserToken. REQUIRED

Returns:: StatusTransition.

getAccount(programToken=None, accountToken=None)

Retrieve an Account.

Parameters:

programToken – A token identifying the Program. REQUIRED
accountToken – A token identifying the Account. REQUIRED

Returns:

An Account.

getAuthenticationToken(userToken=None)

Get a AuthenticationToken. :param userToken:

A user token. REQUIRED

Returns:: An AuthenticationToken.

getBankAccount(userToken=None, bankAccountToken=None)

Retrieve a Bank Account.

Parameters:

userToken – A token identifying the User. REQUIRED
bankAccountToken – A token identifying the Bank Account. REQUIRED

Returns:

A Bank Account.

getBankAccountStatusTransition(userToken=None, bankAccountToken=None, statusTransitionToken=None)

Retrieve a Bank Account Status Transition.

Parameters:

userToken – A token identifying the User. REQUIRED
bankAccountToken – A token identifying the Bank Account. REQUIRED
statusTransitionToken – A token identifying the Bank Account Status Transition. REQUIRED

Returns:

A Bank Account Status Transition.

getBankCard(userToken=None, bankCardToken=None)

Retrieve a Bank Card.

Parameters:

userToken – A token identifying the User. REQUIRED
bankCardToken – A token identifying the Bank Card. REQUIRED

Returns:

A Bank Card.

getBankCardStatusTransition(userToken=None, bankCardToken=None, statusTransitionToken=None)

Retrieve a Bank Card Status Transition.

Parameters:

userToken – A token identifying the User. REQUIRED
bankCardToken – A token identifying the Bank Card. REQUIRED
statusTransitionToken – A token identifying the Bank Card Status Transition. REQUIRED

Returns:

A Bank Card Status Transition.

getPaperCheck(userToken=None, paperCheckToken=None)

Retrieve a Paper Check.

Parameters:

userToken – A token identifying the User. REQUIRED
paperCheckToken – A token identifying the Paper Check. REQUIRED

Returns:

A Paper Check.

getPaperCheckStatusTransition(userToken=None, paperCheckToken=None, statusTransitionToken=None)

Retrieve a Paper Check Status Transition.

Parameters:

userToken – A token identifying the User. REQUIRED
paperCheckToken – A token identifying the Paper Check. REQUIRED
statusTransitionToken – A token identifying the Paper Check Status Transition. REQUIRED

Returns:

A Paper Check Status Transition.

getPayPalAccount(userToken=None, payPalAccountToken=None)

Retrieve a PayPal Account. :param userToken:

A token identifying the User. REQUIRED

Parameters:: payPalAccountToken – A token identifying the PayPal Account. REQUIRED
Returns:: A PayPal Account.

getPayPalAccountStatusTransition(userToken=None, payPalAccountToken=None, statusTransitionToken=None)

Retrieve a PayPal Account Status Transition.

Parameters:

userToken – A token identifying the User. REQUIRED
payPalAccountToken – A token identifying the PayPal Account. REQUIRED
statusTransitionToken – A token identifying the PayPal Account Status Transition. REQUIRED

Returns:

A PayPal Account Status Transition.

getPayment(paymentToken=None)

Retrieve a Payment.

Parameters:: paymentToken – A token identifying the Payment. REQUIRED
Returns:: A Payment.

getPaymentStatusTransition(paymentToken=None, statusTransitionToken=None)

Retrieve a Payment Status Transition.

Parameters:

paymentToken – A token identifying the Payment. REQUIRED
statusTransitionToken – A token identifying the Payment Status Transition. REQUIRED

Returns:

A Payment Status Transition.

getPrepaidCard(userToken=None, prepaidCardToken=None)

Retrieve a Prepaid Card.

Parameters:

userToken – A token identifying the User. REQUIRED
prepaidCardToken – A token identifying the Prepaid Card. REQUIRED

Returns:

A Prepaid Card.

getPrepaidCardStatusTransition(userToken=None, prepaidCardToken=None, statusTransitionToken=None)

Retrieve a Prepaid Card Status Transition.

Parameters:

userToken – A token identifying the User. REQUIRED
prepaidCardToken – A token identifying the Prepaid Card. REQUIRED
statusTransitionToken – A token identifying the Prepaid Card Status Transition. REQUIRED

Returns:

A Prepaid Card Status Transition.

getProgram(programToken=None)

Retrieve a Program.

Parameters:: programToken – A token identifying the Program. REQUIRED
Returns:: A Program.

getTransfer(transferToken=None)

Retrieve a Transfer. :param transferToken:

A token identifying the Transfer. REQUIRED

Returns:: A Transfer.

getTransferMethodConfiguration(userToken=None, country=None, currency=None, transferMethodType=None, profileType=None)

Retrieve a Transfer Method Configuration.

Parameters:

userToken – A token identifying the User. REQUIRED
country – An ISO 3166-1 code identifying the country. REQUIRED
currency – An ISO 4217-1 code identifying the currency. REQUIRED
transferMethodType – A string identifying the type of Transfer Method. REQUIRED
profileType – A string identifying the type of User. REQUIRED

Returns:

A Transfer Method Configuration.

getTransferRefund(transferToken=None, refundToken=None)

Get a Transfer Refund. :param transferToken:

A token identifying the Transfer. REQUIRED

Parameters:: refundToken – A token identifying Transfer Refund . REQUIRED
Returns:: Get Transfer Refund.

getTransferStatusTransition(transferToken=None, statusTransitionToken=None)

Retrieve a Transfer Status Transition.

Parameters:

transferToken – A token identifying the Transfer. REQUIRED
statusTransitionToken – A token identifying the Transfer Status Transition. REQUIRED

Returns:

A Transfer Status Transition.

getUser(userToken=None)

Retrieve a User.

Parameters:: userToken – A token identifying the User. REQUIRED
Returns:: A User.

getUserStatusTransition(userToken=None, statusTransitionToken=None)

Retrieve a User Status Transition.

Parameters:

userToken – A token identifying the User. REQUIRED
statusTransitionToken – A token identifying the User Status Transition. REQUIRED

Returns:

A User Status Transition.

getVenmoAccount(userToken=None, venmoAccountToken=None)

Retrieve a Venmo Account. :param userToken:

A token identifying the User. REQUIRED

Parameters:: VenmoAccountToken – A token identifying the Venmo Account. REQUIRED
Returns:: A Venmo Account.

getVenmoAccountStatusTransition(userToken=None, venmoAccountToken=None, statusTransitionToken=None)

Retrieve a Venmo Account Status Transition.

Parameters:

userToken – A token identifying the User. REQUIRED
VenmoAccountToken – A token identifying the Venmo Account. REQUIRED
statusTransitionToken – A token identifying the Venmo Account Status Transition. REQUIRED

Returns:

A Venmo Account Status Transition.

getWebhookNotification(webhookToken=None)

Retrieve a Webhook Notification.

Parameters:: webhookToken – A token identifying the Webhook. REQUIRED
Returns:: A Webhook.

listBalancesForAccount(programToken=None, accountToken=None, params=None)

List Account Balances.

Parameters:

programToken – A token identifying the Program. REQUIRED
accountToken – A token identifying the Account. REQUIRED
params – A dictionary containing query parameters.

Returns:

An array of Balances.

listBalancesForPrepaidCard(userToken=None, prepaidCardToken=None, params=None)

List Prepaid Card Balances.

Parameters:

userToken – A token identifying the User. REQUIRED
prepaidCardToken – A token identifying the Prepaid Card. REQUIRED
params – A dictionary containing query parameters.

Returns:

An array of Balances.

listBalancesForUser(userToken=None, params=None)

List User Balances.

Parameters:

userToken – A token identifying the User. REQUIRED
params – A dictionary containing query parameters.

Returns:

An array of Balances.

listBankAccountStatusTransitions(userToken=None, bankAccountToken=None, params=None)

List Bank Account Status Transitions.

Parameters:

userToken – A token identifying the User. REQUIRED
bankAccountToken – A token identifying the Bank Account. REQUIRED
params – A dictionary containing query parameters.

Returns:

An array of Bank Account Status Transitions.

listBankAccounts(userToken=None, params=None)

List Bank Accounts.

Parameters:

userToken – A token identifying the User. REQUIRED
params – A dictionary containing query parameters.

Returns:

An array of Bank Accounts.

listBankCardStatusTransitions(userToken=None, bankCardToken=None, params=None)

List Bank Card Status Transitions.

Parameters:

userToken – A token identifying the User. REQUIRED
bankCardToken – A token identifying the Bank Card. REQUIRED
params – A dictionary containing query parameters.

Returns:

An array of Bank Card Status Transitions.

listBankCards(userToken=None, params=None)

List Bank Cards.

Parameters:

userToken – A token identifying the User. REQUIRED
params – A dictionary containing query parameters.

Returns:

An array of Bank Cards.

listPaperCheckStatusTransitions(userToken=None, paperCheckToken=None, params=None)

List Paper Check Status Transitions.

Parameters:

userToken – A token identifying the User. REQUIRED
paperCheckToken – A token identifying the Paper Check. REQUIRED
params – A dictionary containing query parameters.

Returns:

An array of Paper Check Status Transitions.

listPaperChecks(userToken=None, params=None)

List Paper Checks.

Parameters:

userToken – A token identifying the User. REQUIRED
params – A dictionary containing query parameters.

Returns:

An array of Paper Checks.

listPayPalAccountStatusTransitions(userToken=None, payPalAccountToken=None, params=None)

List PayPal Account Status Transitions.

Parameters:

userToken – A token identifying the User. REQUIRED
payPalAccountToken – A token identifying the PayPal Account. REQUIRED
params – A dictionary containing query parameters.

Returns:

An array of PayPal Account Status Transitions.

listPayPalAccounts(userToken=None, params=None)

List PayPal Accounts. :param userToken:

A token identifying the User. REQUIRED

Parameters:: params – A dictionary containing query parameters.
Returns:: An array of PayPal Accounts.

listPaymentStatusTransitions(paymentToken=None, params=None)

List Payment Status Transitions.

Parameters:

paymentToken – A token identifying the Payment. REQUIRED
params – A dictionary containing query parameters.

Returns:

An array of Payment Status Transitions.

listPayments(params=None)

List Payments.

Parameters:: params – A dictionary containing query parameters.
Returns:: An array of Payments.

listPrepaidCardStatusTransitions(userToken=None, prepaidCardToken=None, params=None)

List Prepaid Card Status Transitions.

Parameters:

userToken – A token identifying the User. REQUIRED
prepaidCardToken – A token identifying the Prepaid Card. REQUIRED
params – A dictionary containing query parameters.

Returns:

An array of Prepaid Card Status Transitions.

listPrepaidCards(userToken=None, params=None)

List Prepaid Cards.

Parameters:

userToken – A token identifying the User. REQUIRED
params – A dictionary containing query parameters.

Returns:

An array of Prepaid Cards.

listReceiptsForAccount(programToken=None, accountToken=None, params=None)

List Account Receipts.

Parameters:

programToken – A token identifying the Program. REQUIRED
accountToken – A token identifying the Account. REQUIRED
params – A dictionary containing query parameters.

Returns:

An array of Receipts.

listReceiptsForPrepaidCard(userToken=None, prepaidCardToken=None, params=None)

List Prepaid Card Receipts.

Parameters:

userToken – A token identifying the User. REQUIRED
prepaidCardToken – A token identifying the Prepaid Card. REQUIRED
params – A dictionary containing query parameters.

Returns:

An array of Receipts.

listReceiptsForUser(userToken=None, params=None)

List User Receipts.

Parameters:

userToken – A token identifying the User. REQUIRED
params – A dictionary containing query parameters.

Returns:

An array of Receipts.

listTransferMethodConfigurations(userToken=None, params={})

List Transfer Method Configurations.

Parameters:

userToken – A token identifying the User. REQUIRED
params – A dictionary containing query parameters.

Returns:

An array of Transfer Method Configurations.

listTransferMethods(userToken=None, params=None)

List a Transfer Methods. :param userToken:

A token identifying the Transfer. REQUIRED

Returns:: List Transfer Methods.

listTransferRefunds(transferToken=None, params=None)

List a Transfer Refund. :param transferToken:

A token identifying the Transfer. REQUIRED

Returns:: List Transfer Refund.

listTransferStatusTransitions(transferToken=None, params=None)

Retrieve a Transfer Status Transition.

Parameters:: transferToken – A token identifying the Transfer. REQUIRED
Returns:: A Transfer Status Transition.

listTransfers(params=None)

List Transfers. :param params:

A dictionary containing query parameters.

Returns:: An array of Transfers.

listUserStatusTransitions(userToken=None, params=None)

List User Status Transitions.

Parameters:

userToken – A token identifying the User. REQUIRED
params – A dictionary containing query parameters.

Returns:

An array of User Status Transitions.

listUsers(params=None)

List Users.

Parameters:: params – A dictionary containing query parameters.
Returns:: An array of Users.

listVenmoAccountStatusTransitions(userToken=None, venmoAccountToken=None, params=None)

List Venmo Account Status Transitions.

Parameters:

userToken – A token identifying the User. REQUIRED
venmoAccountToken – A token identifying the Venmo Account. REQUIRED
params – A dictionary containing query parameters.

Returns:

An array of Venmo Account Status Transitions.

listVenmoAccounts(userToken=None, params=None)

List Venmo Accounts. :param userToken:

A token identifying the User. REQUIRED

Parameters:: params – A dictionary containing query parameters.
Returns:: An array of Venmo Accounts.

listWebhookNotifications(params=None)

List Webhook Notifications.

Parameters:: params – A dictionary containing query parameters.
Returns:: An array of Webhooks.

lockPrepaidCard(userToken=None, prepaidCardToken=None, notes=None)

Lock a Prepaid Card.

Parameters:

userToken – A token identifying the User. REQUIRED
prepaidCardToken – A token identifying the Prepaid Card. REQUIRED
notes – A string describing the lock.

Returns:

A Prepaid Card Status Transition.

lockUser(userToken=None)

Create User Lock Status Transition. :param userToken:

A token identifying the User Create UserToken. REQUIRED

Returns:: StatusTransition.

lostOrStolenPrepaidCard(userToken=None, prepaidCardToken=None, notes=None)

Report a Prepaid Card lost or stolen.

Parameters:

userToken – A token identifying the User. REQUIRED
prepaidCardToken – A token identifying the Prepaid Card. REQUIRED
notes – A string describing the lost or stolen report.

Returns:

A Prepaid Card Status Transition.

preactivateUser(userToken=None)

Create User Pre Activate Status Transition. :param userToken:

A token identifying the User Create UserToken. REQUIRED

Returns:: StatusTransition.

setDocumentAndReasonFromResponseHelper(data=None)

Helper to modify dictionary with Document and Reason classes

Parameters:: data – A dictionary containing data for either a User sample data: jsonData={‘data’: [‘{“documents”: [{“type”: “DRIVERS_LICENSE”, “country”: “US”, “category”: “IDENTIFICATION”, “reasons”: {“name”: 0, “description”: “STRING_VAL”}}]}’]};
Returns:: A Dictionary with documents and reasons information

suspendPrepaidCard(userToken=None, prepaidCardToken=None, notes=None)

Suspend a Prepaid Card.

Parameters:

userToken – A token identifying the User. REQUIRED
prepaidCardToken – A token identifying the Prepaid Card. REQUIRED
notes – A string describing the suspension.

Returns:

A Prepaid Card Status Transition.

unlockPrepaidCard(userToken=None, prepaidCardToken=None, notes=None)

Unlock a Prepaid Card.

Parameters:

userToken – A token identifying the User. REQUIRED
prepaidCardToken – A token identifying the Prepaid Card. REQUIRED
notes – A string describing the unlock.

Returns:

A Prepaid Card Status Transition.

unsuspendPrepaidCard(userToken=None, prepaidCardToken=None, notes=None)

Unsuspend a Prepaid Card.

Parameters:

userToken – A token identifying the User. REQUIRED
prepaidCardToken – A token identifying the Prepaid Card. REQUIRED
notes – A string describing the unsuspension.

Returns:

A Prepaid Card Status Transition.

updateBankAccount(userToken=None, bankAccountToken=None, data=None)

Update a Bank Account.

Parameters:

userToken – A token identifying the User. REQUIRED
bankAccountToken – A token identifying the Bank Account. REQUIRED
data – A dictionary containing Bank Account information. REQUIRED

Returns:

A Bank Account.

updateBankCard(userToken=None, bankCardToken=None, data=None)

Update a Bank Card.

Parameters:

userToken – A token identifying the User. REQUIRED
bankCardToken – A token identifying the Bank Card. REQUIRED
data – A dictionary containing Bank Card information. REQUIRED

Returns:

A Bank Card.

updatePaperCheck(userToken=None, paperCheckToken=None, data=None)

Update a Paper Check.

Parameters:

userToken – A token identifying the User. REQUIRED
paperCheckToken – A token identifying the Paper Check. REQUIRED
data – A dictionary containing Paper Check information. REQUIRED

Returns:

A Paper Check.

updatePayPalAccount(userToken=None, payPalAccountToken=None, data=None)

Update a PayPal Account.

Parameters:

userToken – A token identifying the User. REQUIRED
payPalAccountToken – A token identifying the PayPal Account. REQUIRED
data – A dictionary containing PayPal Account information. REQUIRED

Returns:

A PayPal Account.

updatePrepaidCard(userToken=None, prepaidCardToken=None, data=None)

Update a Prepaid Card.

Parameters:

userToken – A token identifying the User. REQUIRED
prepaidCardToken – A token identifying the Prepaid Card. REQUIRED
data – A dictionary containing Prepaid Card information. REQUIRED

Returns:

A Prepaid Card.

updateUser(userToken=None, data=None)

Update a User.

Parameters:

userToken – A token identifying the User. REQUIRED
data – A dictionary containing User information. REQUIRED

Returns:

A User.

updateVenmoAccount(userToken=None, venmoAccountToken=None, data=None)

Update a Venmo Account.

Parameters:

userToken – A token identifying the User. REQUIRED
VenmoAccountToken – A token identifying the Venmo Account. REQUIRED
data – A dictionary containing Venmo Account information. REQUIRED

Returns:

A Venmo Account.

uploadDocumentsForUser(userToken=None, data=None, files=None)

Upload documents for Users

Parameters:

userToken – A token identifying the User. REQUIRED
data – A dictionary containing data for the input documents. REQUIRED sample data: jsonData={‘data’: [‘{“documents”: [{“type”: “DRIVERS_LICENSE”, “country”: “US”, “category”: “IDENTIFICATION”}]}’]};
files – Dictionary of 'filename': file-like-objects for multipart encoding upload. REQUIRED sample data: files = { ‘drivers_license_front’: open(‘F1.png’, ‘rb’), ‘drivers_license_back’: open(‘F22.png’, ‘rb’) }

Returns:

A User with documents information

API Client

class hyperwallet.utils.apiclient.ApiClient(username, password, server, encryptionData=None)

The Hyperwallet API Client.

Parameters:

username – The username of this API user. REQUIRED
password – The password of this API user. REQUIRED
server – The base URL of the API. REQUIRED
encryptionData – Array with params for encrypted requests(Fields: clientPrivateKeySetLocation, hyperwalletKeySetLocation).

__checkResponseHeaderContentType(response)

Check response header Content-Type.

Parameters:: response – Response to be checked. REQUIRED

__getRequestData(data)

If encryption is enabled try to encrypt request data, otherwise no action required.

Parameters:: data – Not encrypted request data. REQUIRED
Returns:: Request data, encrypted if necessary.

_makeRequest(method=None, url=None, data=None, headers=None, params=None, files=None)

Process an API response to ensure a JSON object is returned always.

Parameters:

method – The HTTP method to use for the request. REQUIRED
url – A partial URL to specify the API endpoint. REQUIRED
data – A dictionary containing data for the request body.
headers – A dictionary containing additional request headers.
params – A dictionary containing query parameters.

Returns:

A JSON object containing the response data or an error object.

Note

The Hyperwallet API supports GET, POST, and PUT.

doGet(partialUrl, params={})

Submit a GET to the API.

Parameters:

partialUrl – A partial URL to specify the API endpoint. REQUIRED
params – A dictionary containing query parameters.

Returns:

The API response.

doPost(partialUrl, data, headers={})

Submit a POST to the API.

Parameters:

partialUrl – A partial URL to specify the API endpoint. REQUIRED
data – A dictionary containing data for the request body. REQUIRED
headers – A dictionary containing additional request headers.

Returns:

The API response.

doPut(partialUrl, data)

Submit a PUT to the API.

Parameters:

partialUrl – A partial URL to specify the API endpoint. REQUIRED
data – A dictionary containing data for the request body. REQUIRED

Returns:

The API response.

property encrypted

putDocument(partialUrl, data, files)

Submit a PUT to the API.

Parameters:

partialUrl – A partial URL to specify the API endpoint. REQUIRED
data – A dictionary containing data for the input documents. REQUIRED
files – Dictionary of 'filename': file-like-objects for multipart encoding upload. REQUIRED

Returns:

The API response.