Class used to call the SandboxItem sub-product.

Sections
Namespace
Methods
F
R
S
Public
Instance Public methods
fire_webhook(access_token, webhook_code)

Fires a webhook for a sandbox item

Does a POST /sandbox/item/fire_webhook call.

access_token

access_token of the item to fire a webhook for.

webhook_code

webhook_code to fire.

Returns

Returns a FireWebhookResponse object.

# File lib/plaid/products/sandbox.rb, line 33
def fire_webhook(access_token, webhook_code)
  post_with_auth 'sandbox/item/fire_webhook',
                 FireWebhookResponse,
                 access_token: access_token,
                 webhook_code: webhook_code
end
reset_login(access_token)

Resets sandbox item login.

Does a POST /sandbox/item/reset_login call.

access_token

access_token which item to reset login for.

Returns

Returns a ResetLoginResponse object.

# File lib/plaid/products/sandbox.rb, line 11
def reset_login(access_token)
  post_with_auth 'sandbox/item/reset_login',
                 ResetLoginResponse,
                 access_token: access_token
end
set_verification_status(access_token, account_id, verification_status)

Sets the verification status for an item created via automated microdeposits

Does a POST /sandbox/item/set_verification_status call.

access_token

access_token of the item

account_id

id of the account to verify

verification_status

status to set

Returns

Returns a Models::BaseResponse object.

# File lib/plaid/products/sandbox.rb, line 58
def set_verification_status(access_token, account_id, verification_status)
  post_with_auth '/sandbox/item/set_verification_status',
                 Models::BaseResponse,
                 access_token: access_token,
                 account_id: account_id,
                 verification_status: verification_status
end