Skip to content

Latest commit

 

History

History
139 lines (99 loc) · 5.02 KB

AccountTokenApi.md

File metadata and controls

139 lines (99 loc) · 5.02 KB
Raw

yodlee.AccountTokenApi

All URIs are relative to http://localhost

Method HTTP request Description
generate_payment_processor_token POST /paymentProcessor/token Create Account Token
revoke_payment_processor_token DELETE /paymentProcessor/token Delete Account Token

generate_payment_processor_token

PaymentProcessorTokenResponse generate_payment_processor_token(token_request)

Create Account Token

The create account token service allows you to create a secure processorToken for a user's verified financial account. This processorToken can then be shared with one of our payment processor partners.

Example

from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.AccountTokenApi(api_client)
    token_request = yodlee.PaymentProcessorTokenRequest() # PaymentProcessorTokenRequest | account information

    try:
        # Create Account Token
        api_response = api_instance.generate_payment_processor_token(token_request)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountTokenApi->generate_payment_processor_token: %s\n" % e)

Parameters

Name Type Description Notes
token_request PaymentProcessorTokenRequest account information

Return type

PaymentProcessorTokenResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json;charset=UTF-8

HTTP response details

Status code Description Response headers
200 OK -
400 Y007 : Authorization header missing<br>Y008 : Invalid token in authorization header<br>Y833 : Invalid values(s) for accountId<br>Y800 : Invalid value for processor<br>Y813 : accountId should be provided<br>Y813 : processor should be provided -
401 Unauthorized -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

revoke_payment_processor_token

revoke_payment_processor_token(processor_token)

Delete Account Token

The delete account token service allows you to revoke a previously generated processorToken. It is recommended to use this service when you want to disallow further access to the user's financial account, for instance when a user removes their account from your application.

Example

from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.AccountTokenApi(api_client)
    processor_token = 'processor_token_example' # str | The token that you want to delete.

    try:
        # Delete Account Token
        api_instance.revoke_payment_processor_token(processor_token)
    except ApiException as e:
        print("Exception when calling AccountTokenApi->revoke_payment_processor_token: %s\n" % e)

Parameters

Name Type Description Notes
processor_token str The token that you want to delete.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json;charset=UTF-8

HTTP response details

Status code Description Response headers
400 Y007 : Authorization header missing<br>Y008 : Invalid token in authorization header<br>Y016 : processorToken header missing -
401 Unauthorized -
204 No Content -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]