Skip to content

Latest commit

 

History

History
260 lines (192 loc) · 9.86 KB

CustomerMessageApi.md

File metadata and controls

260 lines (192 loc) · 9.86 KB
Raw

obp_python.CustomerMessageApi

All URIs are relative to http://test.openbankproject.com

Method HTTP request Description
o_bpv1_4_0_create_customer_message POST /obp/v5.0.0/banks/{BANK_ID}/customer/{CUSTOMER_ID}/messages Create Customer Message
o_bpv1_4_0_get_customer_messages GET /obp/v5.0.0/banks/{BANK_ID}/customer/messages Get Customer Messages for a Customer
o_bpv4_0_0_create_customer_message POST /obp/v5.0.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/messages Create Customer Message
o_bpv4_0_0_get_customer_messages GET /obp/v5.0.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/messages Get Customer Messages for a Customer

o_bpv1_4_0_create_customer_message

SuccessMessage o_bpv1_4_0_create_customer_message(body, customer_id, bank_id)

Create Customer Message

Create a message for the customer specified by CUSTOMER_ID

Authentication is Mandatory

Example

from __future__ import print_function
import time
import obp_python
from obp_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: directLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# Configure API key authorization: gatewayLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = obp_python.CustomerMessageApi(obp_python.ApiClient(configuration))
body = obp_python.AddCustomerMessageJson() # AddCustomerMessageJson | AddCustomerMessageJson object that needs to be added.
customer_id = 'customer_id_example' # str | The customer id
bank_id = 'bank_id_example' # str | The bank id

try:
    # Create Customer Message
    api_response = api_instance.o_bpv1_4_0_create_customer_message(body, customer_id, bank_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomerMessageApi->o_bpv1_4_0_create_customer_message: %s\n" % e)

Parameters

Name Type Description Notes
body AddCustomerMessageJson AddCustomerMessageJson object that needs to be added.
customer_id str The customer id
bank_id str The bank id

Return type

SuccessMessage

Authorization

directLogin, gatewayLogin

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

o_bpv1_4_0_get_customer_messages

CustomerMessagesJson o_bpv1_4_0_get_customer_messages(body, bank_id)

Get Customer Messages for a Customer

Get messages for the logged in customer
Messages sent to the currently authenticated user.

Authentication via OAuth is required.

Authentication is Mandatory

Example

from __future__ import print_function
import time
import obp_python
from obp_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: directLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# Configure API key authorization: gatewayLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = obp_python.CustomerMessageApi(obp_python.ApiClient(configuration))
body = obp_python.EmptyClassJson() # EmptyClassJson | EmptyClassJson object that needs to be added.
bank_id = 'bank_id_example' # str | The bank id

try:
    # Get Customer Messages for a Customer
    api_response = api_instance.o_bpv1_4_0_get_customer_messages(body, bank_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomerMessageApi->o_bpv1_4_0_get_customer_messages: %s\n" % e)

Parameters

Name Type Description Notes
body EmptyClassJson EmptyClassJson object that needs to be added.
bank_id str The bank id

Return type

CustomerMessagesJson

Authorization

directLogin, gatewayLogin

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

o_bpv4_0_0_create_customer_message

SuccessMessage o_bpv4_0_0_create_customer_message(body, customer_id, bank_id)

Create Customer Message

Create a message for the customer specified by CUSTOMER_ID
Authentication is Mandatory

Example

from __future__ import print_function
import time
import obp_python
from obp_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: directLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# Configure API key authorization: gatewayLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = obp_python.CustomerMessageApi(obp_python.ApiClient(configuration))
body = obp_python.CreateMessageJsonV400() # CreateMessageJsonV400 | CreateMessageJsonV400 object that needs to be added.
customer_id = 'customer_id_example' # str | The customer id
bank_id = 'bank_id_example' # str | The bank id

try:
    # Create Customer Message
    api_response = api_instance.o_bpv4_0_0_create_customer_message(body, customer_id, bank_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomerMessageApi->o_bpv4_0_0_create_customer_message: %s\n" % e)

Parameters

Name Type Description Notes
body CreateMessageJsonV400 CreateMessageJsonV400 object that needs to be added.
customer_id str The customer id
bank_id str The bank id

Return type

SuccessMessage

Authorization

directLogin, gatewayLogin

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

o_bpv4_0_0_get_customer_messages

CustomerMessagesJsonV400 o_bpv4_0_0_get_customer_messages(customer_id, bank_id)

Get Customer Messages for a Customer

Get messages for the customer specified by CUSTOMER_ID
Authentication is Mandatory

Example

from __future__ import print_function
import time
import obp_python
from obp_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: directLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# Configure API key authorization: gatewayLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = obp_python.CustomerMessageApi(obp_python.ApiClient(configuration))
customer_id = 'customer_id_example' # str | The customer id
bank_id = 'bank_id_example' # str | The bank id

try:
    # Get Customer Messages for a Customer
    api_response = api_instance.o_bpv4_0_0_get_customer_messages(customer_id, bank_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomerMessageApi->o_bpv4_0_0_get_customer_messages: %s\n" % e)

Parameters

Name Type Description Notes
customer_id str The customer id
bank_id str The bank id

Return type

CustomerMessagesJsonV400

Authorization

directLogin, gatewayLogin

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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