The Hyperwallet SDK Client
| Methods | ||
|---|---|---|
public
|
__construct(
string $username,
string $password,
string|null $programToken = null,
string $server = 'https://api.sandbox.hyperwallet.com',
array $encryptionData = [],
array $clientOptions = [],
)
|
# |
public
|
createUser(User $user): User
|
# |
public
|
getUser(string $userToken): User
|
# |
public
|
updateUser(User $user): User
|
# |
public
|
listUsers(array $options = []): ListResponse
|
# |
public
|
getUserStatusTransition(string $userToken, string $statusTransitionToken): UserStatusTransition
|
# |
public
|
listUserStatusTransitions(string $userToken, array $options = []): ListResponse
|
# |
public
|
getAuthenticationToken(string $userToken): AuthenticationToken
|
# |
public
|
createPaperCheck(string $userToken, PaperCheck $paperCheck): PaperCheck
|
# |
public
|
getPaperCheck(string $userToken, string $paperCheckToken): PaperCheck
|
# |
public
|
updatePaperCheck(string $userToken, PaperCheck $paperCheck): PaperCheck
|
# |
public
|
listPaperChecks(string $userToken, array $options = []): ListResponse
|
# |
public
|
deactivatePaperCheck(string $userToken, string $paperCheckToken): PaperCheckStatusTransition
|
# |
public
|
createPaperCheckStatusTransition(
string $userToken,
string $paperCheckToken,
PaperCheckStatusTransition $transition,
): PaperCheckStatusTransition
|
# |
public
|
getPaperCheckStatusTransition(
string $userToken,
string $paperCheckToken,
string $statusTransitionToken,
): PaperCheckStatusTransition
|
# |
public
|
listPaperCheckStatusTransitions(string $userToken, string $paperCheckToken, array $options = []): ListResponse
|
# |
public
|
createTransfer(Transfer $transfer): Transfer
|
# |
public
|
createTransferRefund($transferToken, $transferRefund)
|
# |
public
|
getTransfer(string $transferToken): Transfer
|
# |
public
|
getTransferRefund($transferToken, $refundToken)
|
# |
public
|
listTransfers(array $options = []): ListResponse
|
# |
public
|
listTransferRefunds($transferToken, array $options = []): ListResponse
|
# |
public
|
createTransferStatusTransition(string $transferToken, TransferStatusTransition $transition): TransferStatusTransition
|
# |
public
|
getTransferStatusTransition(string $transferToken, string $statusTransitionToken): TransferStatusTransition
|
# |
public
|
listTransferStatusTransitions(string $transferToken, array $options = []): ListResponse
|
# |
public
|
createPayPalAccount(string $userToken, PayPalAccount $payPalAccount): PayPalAccount
|
# |
public
|
getPayPalAccount(string $userToken, string $payPalAccountToken): PayPalAccount
|
# |
public
|
updatePayPalAccount(string $userToken, PayPalAccount $payPalAccount): PayPalAccount
|
# |
public
|
listPayPalAccounts(string $userToken, array $options = []): ListResponse
|
# |
public
|
deactivatePayPalAccount(string $userToken, string $payPalAccountToken): PayPalAccountStatusTransition
|
# |
public
|
createPayPalAccountStatusTransition(
string $userToken,
string $payPalAccountToken,
PayPalAccountStatusTransition $transition,
): PayPalAccountStatusTransition
|
# |
public
|
getPayPalAccountStatusTransition(
string $userToken,
string $payPalAccountToken,
string $statusTransitionToken,
): PayPalAccountStatusTransition
|
# |
public
|
listPayPalAccountStatusTransitions(string $userToken, string $payPalAccountToken, array $options = []): ListResponse
|
# |
public
|
createPrepaidCard(string $userToken, PrepaidCard $prepaidCard): PrepaidCard
|
# |
public
|
replacePrepaidCard(string $userToken, PrepaidCard $prepaidCard): PrepaidCard
|
# |
public
|
getPrepaidCard(string $userToken, string $prepaidCardToken): PrepaidCard
|
# |
public
|
updatePrepaidCard(string $userToken, PrepaidCard $prepaidCard): PrepaidCard
|
# |
public
|
listPrepaidCards(string $userToken, array $options = []): ListResponse
|
# |
public
|
suspendPrepaidCard(string $userToken, string $prepaidCardToken): PrepaidCardStatusTransition
|
# |
public
|
unsuspendPrepaidCard(string $userToken, string $prepaidCardToken): PrepaidCardStatusTransition
|
# |
public
|
lostOrStolenPrepaidCard(string $userToken, string $prepaidCardToken): PrepaidCardStatusTransition
|
# |
public
|
deactivatePrepaidCard(string $userToken, string $prepaidCardToken): PrepaidCardStatusTransition
|
# |
public
|
lockPrepaidCard(string $userToken, string $prepaidCardToken): PrepaidCardStatusTransition
|
# |
public
|
unlockPrepaidCard(string $userToken, string $prepaidCardToken): PrepaidCardStatusTransition
|
# |
public
|
createPrepaidCardStatusTransition(
string $userToken,
string $prepaidCardToken,
PrepaidCardStatusTransition $transition,
): PrepaidCardStatusTransition
|
# |
public
|
getPrepaidCardStatusTransition(
string $userToken,
string $prepaidCardToken,
string $statusTransitionToken,
): PrepaidCardStatusTransition
|
# |
public
|
listPrepaidCardStatusTransitions(string $userToken, string $prepaidCardToken, array $options = []): ListResponse
|
# |
public
|
createBankAccount(string $userToken, BankAccount $bankAccount): BankAccount
|
# |
public
|
getBankAccount(string $userToken, string $bankAccountToken): BankAccount
|
# |
public
|
updateBankAccount(string $userToken, BankAccount $bankAccount): BankAccount
|
# |
public
|
listBankAccounts(string $userToken, array $options = []): ListResponse
|
# |
public
|
deactivateBankAccount(string $userToken, string $bankAccountToken): BankAccountStatusTransition
|
# |
public
|
createBankAccountStatusTransition(
string $userToken,
string $bankAccountToken,
BankAccountStatusTransition $transition,
): BankAccountStatusTransition
|
# |
public
|
getBankAccountStatusTransition(
string $userToken,
string $bankAccountToken,
string $statusTransitionToken,
): BankAccountStatusTransition
|
# |
public
|
listBankAccountStatusTransitions(string $userToken, string $bankAccountToken, array $options = []): ListResponse
|
# |
public
|
createBankCard(string $userToken, BankCard $bankCard): BankCard
|
# |
public
|
getBankCard(string $userToken, string $bankCardToken): BankCard
|
# |
public
|
updateBankCard(string $userToken, BankCard $bankCard): BankCard
|
# |
public
|
listBankCards(string $userToken, array $options = []): ListResponse
|
# |
public
|
deactivateBankCard(string $userToken, string $bankCardToken): BankCardStatusTransition
|
# |
public
|
createBankCardStatusTransition(
string $userToken,
string $bankCardToken,
BankCardStatusTransition $transition,
): BankCardStatusTransition
|
# |
public
|
getBankCardStatusTransition(
string $userToken,
string $bankCardToken,
string $statusTransitionToken,
): BankCardStatusTransition
|
# |
public
|
listBankCardStatusTransitions(string $userToken, string $bankCardToken, array $options = []): ListResponse
|
# |
public
|
createTransferMethod(
string $userToken,
string $jsonCacheToken,
TransferMethod $transferMethod = null,
): BankAccount|PrepaidCard
|
# |
public
|
listBalancesForUser(string $userToken, array $options = []): ListResponse
|
# |
public
|
listBalancesForPrepaidCard(string $userToken, string $prepaidCardToken, array $options = []): ListResponse
|
# |
public
|
listBalancesForAccount(string $programToken, string $accountToken, array $options = []): ListResponse
|
# |
public
|
createPayment(Payment $payment): Payment
|
# |
public
|
getPayment(string $paymentToken): Payment
|
# |
public
|
listPayments(array $options = []): ListResponse
|
# |
public
|
createPaymentStatusTransition(string $paymentToken, PaymentStatusTransition $transition): PaymentStatusTransition
|
# |
public
|
getPaymentStatusTransition(string $paymentToken, string $statusTransitionToken): PaymentStatusTransition
|
# |
public
|
listPaymentStatusTransitions(string $paymentToken, array $options = []): ListResponse
|
# |
public
|
getProgram(string $programToken): Program
|
# |
public
|
getProgramAccount(string $programToken, string $accountToken): ProgramAccount
|
# |
public
|
getTransferMethodConfiguration(
string $userToken,
string $country,
string $currency,
string $type,
string $profileType,
): TransferMethodConfiguration
|
# |
public
|
listTransferMethodConfigurations(string $userToken, array $options = []): ListResponse
|
# |
public
|
listReceiptsForProgramAccount(string $programToken, string $accountToken, array $options = []): ListResponse
|
# |
public
|
listReceiptsForUser(string $userToken, array $options = []): ListResponse
|
# |
public
|
listReceiptsForPrepaidCard(string $userToken, string $prepaidCardToken, array $options = []): ListResponse
|
# |
public
|
getWebhookNotification(string $webhookNotificationToken): WebhookNotification
|
# |
public
|
listWebhookNotifications(array $options = []): ListResponse
|
# |
public
|
updateVerificationStatus($userToken, $verificationStatus)
|
# |
public
|
createUserStatusTransition(string $userToken, UserStatusTransition $transition): UserStatusTransition
|
# |
public
|
activateUser(string $userToken): UserStatusTransition
|
# |
public
|
deactivateUser(string $userToken): UserStatusTransition
|
# |
public
|
lockUser(string $userToken): UserStatusTransition
|
# |
public
|
freezeUser(string $userToken): UserStatusTransition
|
# |
public
|
preactivateUser(string $userToken): UserStatusTransition
|
# |
public
|
uploadDocumentsForUser(string $userToken, array $options): User
|
# |
public
|
createVenmoAccount(string $userToken, VenmoAccount $venmoAccount): VenmoAccount
|
# |
public
|
getVenmoAccount(string $userToken, string $venmoAccountToken): VenmoAccount
|
# |
public
|
updateVenmoAccount(string $userToken, VenmoAccount $venmoAccount): VenmoAccount
|
# |
public
|
listVenmoAccounts(string $userToken, array $options = []): ListResponse
|
# |
public
|
deactivateVenmoAccount(string $userToken, string $venmoAccountToken): VenmoAccountStatusTransition
|
# |
public
|
createVenmoAccountStatusTransition(
string $userToken,
string $venmoAccountToken,
VenmoAccountStatusTransition $transition,
): VenmoAccountStatusTransition
|
# |
public
|
getVenmoAccountStatusTransition(
string $userToken,
string $venmoAccountToken,
string $statusTransitionToken,
): VenmoAccountStatusTransition
|
# |
public
|
listVenmoAccountStatusTransitions(string $userToken, string $venmoAccountToken, array $options = []): ListResponse
|
# |
public
|
uploadDocumentsForBusinessStakeholder(string $userToken, $businessToken, array $options): BusinessStakeholder
|
# |
public
|
createBusinessStakeholder(string $userToken, BusinessStakeholder $businessStakeholder): BusinessStakeholder
|
# |
public
|
updateBusinessStakeholder($userToken, $businessToken, $businessStakeholder): BusinessStakeholder
|
# |
public
|
listBusinessStakeholders($userToken, array $options): ListResponse
|
# |
public
|
createBusinessStakeholderStatusTransition(
string $userToken,
string $businessToken,
BusinessStakeholderStatusTransition $transition,
): BusinessStakeholderStatusTransition
|
# |
public
|
activateBusinessStakeholder(string $userToken, string $businessToken): BusinessStakeholderStatusTransition
|
# |
public
|
deactivateBusinessStakeholder(string $userToken, string $businessToken): BusinessStakeholderStatusTransition
|
# |
public
|
getBusinessStakeholderStatusTransition(
string $userToken,
string $businessToken,
string $statusTransitionToken,
): BusinessStakeholderStatusTransition
|
# |
public
|
listBusinessStakeholderStatusTransitions(string $userToken, string $businessToken, array $options = []): ListResponse
|
# |
public
|
listTransferMethods(string $userToken, array $options = []): ListResponse
|
# |