Oracle Cloud Infrastructure Documentation
Try Free Tier

OSP Gateway Common Types

DBMS_CLOUD_OCI_OSP_GATEWAY_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_varchar2_tbl FORCE IS TABLE OF (varchar2(32767)) NOT PERSISTABLE;

DBMS_CLOUD_OCI_OSP_GATEWAY_ADDRESS_T Type

Address details model.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_address_t FORCE AUTHID CURRENT_USER IS OBJECT (
  address_key varchar2(32767),
  line1 varchar2(32767),
  line2 varchar2(32767),
  line3 varchar2(32767),
  line4 varchar2(32767),
  street_name varchar2(32767),
  street_number varchar2(32767),
  city varchar2(32767),
  county varchar2(32767),
  country varchar2(32767),
  province varchar2(32767),
  postal_code varchar2(32767),
  state varchar2(32767),
  email_address varchar2(32767),
  company_name varchar2(32767),
  first_name varchar2(32767),
  middle_name varchar2(32767),
  last_name varchar2(32767),
  phone_country_code varchar2(32767),
  phone_number varchar2(32767),
  job_title varchar2(32767),
  department_name varchar2(32767),
  internal_number varchar2(32767),
  contributor_class varchar2(32767),
  state_inscription varchar2(32767),
  municipal_inscription varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_address_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_address_t (
    address_key varchar2,
    line1 varchar2,
    line2 varchar2,
    line3 varchar2,
    line4 varchar2,
    street_name varchar2,
    street_number varchar2,
    city varchar2,
    county varchar2,
    country varchar2,
    province varchar2,
    postal_code varchar2,
    state varchar2,
    email_address varchar2,
    company_name varchar2,
    first_name varchar2,
    middle_name varchar2,
    last_name varchar2,
    phone_country_code varchar2,
    phone_number varchar2,
    job_title varchar2,
    department_name varchar2,
    internal_number varchar2,
    contributor_class varchar2,
    state_inscription varchar2,
    municipal_inscription varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

address_key

(optional) Address identifier.

line1

(optional) Address line 1.

line2

(optional) Address line 2.

line3

(optional) Address line 3.

line4

(optional) Address line 4.

street_name

(optional) Street name of the address.

street_number

(optional) Street number of the address.

city

(optional) Name of the city.

county

(optional) County of the address.

country

(optional) Country of the address.

province

(optional) Province of the address.

postal_code

(optional) Post code of the address.

state

(optional) State of the address.

email_address

(optional) Contact person email address.

company_name

(optional) Name of the customer company.

first_name

(optional) First name of the contact person.

middle_name

(optional) Middle name of the contact person.

last_name

(optional) Last name of the contact person.

phone_country_code

(optional) Phone country code of the contact person.

phone_number

(optional) Phone number of the contact person.

job_title

(optional) Job title of the contact person.

department_name

(optional) Department name of the customer company.

internal_number

(optional) Internal number of the customer company.

contributor_class

(optional) Contributor class of the customer company.

state_inscription

(optional) State Inscription.

municipal_inscription

(optional) Municipal Inscription.

DBMS_CLOUD_OCI_OSP_GATEWAY_FORMAT_T Type

Format information

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_format_t FORCE AUTHID CURRENT_USER IS OBJECT (
  value varchar2(32767),
  example varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_format_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_format_t (
    value varchar2,
    example varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

value

(required) Regex format specification

example

(optional) Example of the desired format that matches the regex

DBMS_CLOUD_OCI_OSP_GATEWAY_LABEL_T Type

Label information

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_label_t FORCE AUTHID CURRENT_USER IS OBJECT (
  value varchar2(32767),
  example varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_label_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_label_t (
    value varchar2,
    example varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

value

(required) Language token of the required label

example

(optional) English translation of the label (for reference only - translation is not provided)

DBMS_CLOUD_OCI_OSP_GATEWAY_FIELD_T Type

Field information

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_field_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  is_required number,
  format dbms_cloud_oci_osp_gateway_format_t,
  label dbms_cloud_oci_osp_gateway_label_t,
  language varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_field_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_field_t (
    name varchar2,
    is_required number,
    format dbms_cloud_oci_osp_gateway_format_t,
    label dbms_cloud_oci_osp_gateway_label_t,
    language varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) The field name

is_required

(required) The given field is requeired or not

format

(optional)

label

(optional)

language

(optional) Locale code (rfc4646 format) of a forced language (e.g.: jp addresses require jp always)

DBMS_CLOUD_OCI_OSP_GATEWAY_FIELD_TBL Type

Nested table type of dbms_cloud_oci_osp_gateway_field_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_field_tbl FORCE IS TABLE OF (dbms_cloud_oci_osp_gateway_field_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_OSP_GATEWAY_ADDRESS_TYPE_RULE_T Type

Address type rule information

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_address_type_rule_t FORCE AUTHID CURRENT_USER IS OBJECT (
  third_party_validation varchar2(32767),
  fields dbms_cloud_oci_osp_gateway_field_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_address_type_rule_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_address_type_rule_t (
    third_party_validation varchar2,
    fields dbms_cloud_oci_osp_gateway_field_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

third_party_validation

(optional) Third party validation.

Allowed values are: 'OPTIONAL', 'REQUIRED', 'NEVER'

fields

(required) Address type rule fields

DBMS_CLOUD_OCI_OSP_GATEWAY_CONTACT_TYPE_RULE_T Type

Contact type rule information

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_contact_type_rule_t FORCE AUTHID CURRENT_USER IS OBJECT (
  fields dbms_cloud_oci_osp_gateway_field_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_contact_type_rule_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_contact_type_rule_t (
    fields dbms_cloud_oci_osp_gateway_field_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

fields

(required) Contact type rule fields

DBMS_CLOUD_OCI_OSP_GATEWAY_TAX_TYPE_RULE_T Type

Tax type rule information

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_tax_type_rule_t FORCE AUTHID CURRENT_USER IS OBJECT (
  fields dbms_cloud_oci_osp_gateway_field_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_tax_type_rule_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_tax_type_rule_t (
    fields dbms_cloud_oci_osp_gateway_field_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

fields

(required) Tax type rule fields

DBMS_CLOUD_OCI_OSP_GATEWAY_ADDRESS_RULE_T Type

Addres rule information

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_address_rule_t FORCE AUTHID CURRENT_USER IS OBJECT (
  country_code varchar2(32767),
  address dbms_cloud_oci_osp_gateway_address_type_rule_t,
  contact dbms_cloud_oci_osp_gateway_contact_type_rule_t,
  tax dbms_cloud_oci_osp_gateway_tax_type_rule_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_address_rule_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_address_rule_t (
    country_code varchar2,
    address dbms_cloud_oci_osp_gateway_address_type_rule_t,
    contact dbms_cloud_oci_osp_gateway_contact_type_rule_t,
    tax dbms_cloud_oci_osp_gateway_tax_type_rule_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

country_code

(required) Country code for the address rule in ISO-3166-1 2-letter format

address

(required)

contact

(optional)

tax

(optional)

DBMS_CLOUD_OCI_OSP_GATEWAY_TAX_INFO_T Type

Tax details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_tax_info_t FORCE AUTHID CURRENT_USER IS OBJECT (
  tax_payer_id varchar2(32767),
  tax_reg_number varchar2(32767),
  no_tax_reason_code varchar2(32767),
  no_tax_reason_code_details varchar2(32767),
  tax_cnpj varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_tax_info_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_tax_info_t (
    tax_payer_id varchar2,
    tax_reg_number varchar2,
    no_tax_reason_code varchar2,
    no_tax_reason_code_details varchar2,
    tax_cnpj varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

tax_payer_id

(optional) Tay payer identifier.

tax_reg_number

(optional) Tax registration number.

no_tax_reason_code

(optional) Tax exemption reason code.

no_tax_reason_code_details

(optional) Tax exemption reason description.

tax_cnpj

(optional) Brazilian companies' CNPJ number.

DBMS_CLOUD_OCI_OSP_GATEWAY_PAYMENT_OPTION_T Type

Payment option of a subscription.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_payment_option_t FORCE AUTHID CURRENT_USER IS OBJECT (
  wallet_instrument_id varchar2(32767),
  wallet_transaction_id varchar2(32767),
  payment_method varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_payment_option_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_payment_option_t (
    wallet_instrument_id varchar2,
    wallet_transaction_id varchar2,
    payment_method varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

wallet_instrument_id

(optional) Wallet instrument internal id.

wallet_transaction_id

(optional) Wallet transaction id.

payment_method

(required) Payment method

Allowed values are: 'CREDIT_CARD', 'PAYPAL'

DBMS_CLOUD_OCI_OSP_GATEWAY_MERCHANT_DEFINED_DATA_T Type

Merchant details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_merchant_defined_data_t FORCE AUTHID CURRENT_USER IS OBJECT (
  promo_type varchar2(32767),
  cloud_account_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_merchant_defined_data_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_merchant_defined_data_t (
    promo_type varchar2,
    cloud_account_name varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

promo_type

(optional) Promotion type code.

cloud_account_name

(optional) Cloud account name.

DBMS_CLOUD_OCI_OSP_GATEWAY_PAYMENT_GATEWAY_T Type

Payment gateway details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_payment_gateway_t FORCE AUTHID CURRENT_USER IS OBJECT (
  merchant_defined_data dbms_cloud_oci_osp_gateway_merchant_defined_data_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_payment_gateway_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_payment_gateway_t (
    merchant_defined_data dbms_cloud_oci_osp_gateway_merchant_defined_data_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

merchant_defined_data

(optional)

DBMS_CLOUD_OCI_OSP_GATEWAY_PAYMENT_OPTION_TBL Type

Nested table type of dbms_cloud_oci_osp_gateway_payment_option_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_payment_option_tbl FORCE IS TABLE OF (dbms_cloud_oci_osp_gateway_payment_option_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_OSP_GATEWAY_SUBSCRIPTION_T Type

Subscription details object which extends the SubscriptionSummary

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_subscription_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  subscription_plan_number varchar2(32767),
  plan_type varchar2(32767),
  time_start timestamp with time zone,
  ship_to_cust_acct_site_id varchar2(32767),
  ship_to_cust_acct_role_id varchar2(32767),
  bill_to_cust_account_id varchar2(32767),
  is_intent_to_pay number,
  currency_code varchar2(32767),
  gsi_org_code varchar2(32767),
  language_code varchar2(32767),
  organization_id varchar2(32767),
  upgrade_state varchar2(32767),
  upgrade_state_details varchar2(32767),
  account_type varchar2(32767),
  tax_info dbms_cloud_oci_osp_gateway_tax_info_t,
  payment_options dbms_cloud_oci_osp_gateway_payment_option_tbl,
  payment_gateway dbms_cloud_oci_osp_gateway_payment_gateway_t,
  billing_address dbms_cloud_oci_osp_gateway_address_t,
  time_plan_upgrade timestamp with time zone,
  time_personal_to_corporate_conv timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_subscription_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_subscription_t (
    id varchar2,
    subscription_plan_number varchar2,
    plan_type varchar2,
    time_start timestamp with time zone,
    ship_to_cust_acct_site_id varchar2,
    ship_to_cust_acct_role_id varchar2,
    bill_to_cust_account_id varchar2,
    is_intent_to_pay number,
    currency_code varchar2,
    gsi_org_code varchar2,
    language_code varchar2,
    organization_id varchar2,
    upgrade_state varchar2,
    upgrade_state_details varchar2,
    account_type varchar2,
    tax_info dbms_cloud_oci_osp_gateway_tax_info_t,
    payment_options dbms_cloud_oci_osp_gateway_payment_option_tbl,
    payment_gateway dbms_cloud_oci_osp_gateway_payment_gateway_t,
    billing_address dbms_cloud_oci_osp_gateway_address_t,
    time_plan_upgrade timestamp with time zone,
    time_personal_to_corporate_conv timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(optional) Subscription id identifier (OCID).

subscription_plan_number

(required) Subscription plan number.

plan_type

(optional) Subscription plan type.

Allowed values are: 'FREE_TIER', 'PAYG'

time_start

(optional) Start date of the subscription.

ship_to_cust_acct_site_id

(optional) Ship to customer account site address id.

ship_to_cust_acct_role_id

(optional) Ship to customer account role.

bill_to_cust_account_id

(optional) Bill to customer Account id.

is_intent_to_pay

(optional) Payment intension.

currency_code

(optional) Currency code

gsi_org_code

(optional) GSI Subscription external code.

language_code

(optional) Language short code (en, de, hu, etc)

organization_id

(optional) GSI organization external identifier.

upgrade_state

(optional) Status of the upgrade.

Allowed values are: 'PROMO', 'SUBMITTED', 'ERROR', 'UPGRADED'

upgrade_state_details

(optional) This field is used to describe the Upgrade State in case of error (E.g. Upgrade failure caused by interfacing Tax details- TaxError)

Allowed values are: 'TAX_ERROR', 'UPGRADE_ERROR'

account_type

(optional) Account type.

Allowed values are: 'PERSONAL', 'CORPORATE', 'CORPORATE_SUBMITTED'

tax_info

(optional)

payment_options

(optional) Payment option list of a subscription.

payment_gateway

(optional)

billing_address

(optional)

time_plan_upgrade

(optional) Date of upgrade/conversion when planType changed from FREE_TIER to PAYG

time_personal_to_corporate_conv

(optional) Date of upgrade/conversion when account type changed from PERSONAL to CORPORATE

DBMS_CLOUD_OCI_OSP_GATEWAY_AUTHORIZE_SUBSCRIPTION_PAYMENT_DETAILS_T Type

Request object for a subscription payment authorization

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_authorize_subscription_payment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  subscription dbms_cloud_oci_osp_gateway_subscription_t,
  language_code varchar2(32767),
  email varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_authorize_subscription_payment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_authorize_subscription_payment_details_t (
    subscription dbms_cloud_oci_osp_gateway_subscription_t,
    language_code varchar2,
    email varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

subscription

(required)

language_code

(required) Language code

email

(required) User email

DBMS_CLOUD_OCI_OSP_GATEWAY_AUTHORIZE_SUBSCRIPTION_PAYMENT_RECEIPT_T Type

Subscription payment authorization response

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_authorize_subscription_payment_receipt_t FORCE AUTHID CURRENT_USER IS OBJECT (
  header_id varchar2(32767),
  api_token varchar2(32767),
  user_token varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_authorize_subscription_payment_receipt_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_authorize_subscription_payment_receipt_t (
    header_id varchar2,
    api_token varchar2,
    user_token varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

header_id

(required) Payment header id

api_token

(optional) Parameters in a token for Payment Service

user_token

(optional) Session token created for Payment Service

DBMS_CLOUD_OCI_OSP_GATEWAY_COUNTRY_T Type

Country details model

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_country_t FORCE AUTHID CURRENT_USER IS OBJECT (
  country_id number,
  country_code varchar2(32767),
  country_name varchar2(32767),
  language_id number,
  ascii3_country_code varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_country_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_country_t (
    country_id number,
    country_code varchar2,
    country_name varchar2,
    language_id number,
    ascii3_country_code varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

country_id

(optional) Indentifier of the country. This is a DB side unique id which was generated when the entity was created in the table

country_code

(optional) Country code in ISO-3166-1 2-letter format

country_name

(optional) Name of the country

language_id

(optional) Language identifier

ascii3_country_code

(optional) Country code in ISO-3166-1 3-letter format

DBMS_CLOUD_OCI_OSP_GATEWAY_BILL_TO_ADDRESS_T Type

Address details model

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_bill_to_address_t FORCE AUTHID CURRENT_USER IS OBJECT (
  contact_name varchar2(32767),
  company_name varchar2(32767),
  address_line1 varchar2(32767),
  address_line2 varchar2(32767),
  address_line3 varchar2(32767),
  address_line4 varchar2(32767),
  street_name varchar2(32767),
  street_number varchar2(32767),
  city varchar2(32767),
  country dbms_cloud_oci_osp_gateway_country_t,
  county varchar2(32767),
  state varchar2(32767),
  postal_code varchar2(32767),
  province varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_bill_to_address_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_bill_to_address_t (
    contact_name varchar2,
    company_name varchar2,
    address_line1 varchar2,
    address_line2 varchar2,
    address_line3 varchar2,
    address_line4 varchar2,
    street_name varchar2,
    street_number varchar2,
    city varchar2,
    country dbms_cloud_oci_osp_gateway_country_t,
    county varchar2,
    state varchar2,
    postal_code varchar2,
    province varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

contact_name

(optional) Name of the contact person

company_name

(optional) Name of the customer company

address_line1

(optional) Address line 1

address_line2

(optional) Address line 2

address_line3

(optional) Address line 3

address_line4

(optional) Address line 4

street_name

(optional) Street name

street_number

(optional) House no

city

(optional) Name of the city

country

(optional)

county

(optional) County name

state

(optional) Name of the state

postal_code

(optional) ZIP no

province

(optional) Name of the province

DBMS_CLOUD_OCI_OSP_GATEWAY_PAYMENT_DETAIL_T Type

Payment related details

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_payment_detail_t FORCE AUTHID CURRENT_USER IS OBJECT (
  time_paid_on timestamp with time zone,
  paid_by varchar2(32767),
  payment_method varchar2(32767),
  amount_paid number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_payment_detail_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_payment_detail_t (
    time_paid_on timestamp with time zone,
    paid_by varchar2,
    payment_method varchar2,
    amount_paid number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

time_paid_on

(optional) Paid the invoice on this day

paid_by

(optional) example

payment_method

(required) Payment method

Allowed values are: 'CREDIT_CARD', 'PAYPAL', 'ECHECK', 'OTHER'

amount_paid

(optional) Amount that paid

DBMS_CLOUD_OCI_OSP_GATEWAY_CREDIT_CARD_PAYMENT_DETAIL_T Type

Credit card Payment related details

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_credit_card_payment_detail_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_osp_gateway_payment_detail_t (
  name_on_card varchar2(32767),
  credit_card_type varchar2(32767),
  last_digits varchar2(32767),
  time_expiration timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_credit_card_payment_detail_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_credit_card_payment_detail_t (
    time_paid_on timestamp with time zone,
    paid_by varchar2,
    payment_method varchar2,
    amount_paid number,
    name_on_card varchar2,
    credit_card_type varchar2,
    last_digits varchar2,
    time_expiration timestamp with time zone
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_osp_gateway_credit_card_payment_detail_t is a subtype of the dbms_cloud_oci_osp_gateway_payment_detail_t type.

Fields

Field Description

name_on_card

(optional) Name on the credit card

credit_card_type

(optional) Credit card type

Allowed values are: 'VISA', 'AMEX', 'MASTERCARD', 'DISCOVER', 'JCB', 'DINER', 'ELO'

last_digits

(optional) Last four digits of the card

time_expiration

(optional) Expired date of the credit card

DBMS_CLOUD_OCI_OSP_GATEWAY_CREDIT_CARD_PAYMENT_OPTION_T Type

Credit card Payment related details

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_credit_card_payment_option_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_osp_gateway_payment_option_t (
  credit_card_type varchar2(32767),
  last_digits varchar2(32767),
  name_on_card varchar2(32767),
  time_expiration timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_credit_card_payment_option_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_credit_card_payment_option_t (
    wallet_instrument_id varchar2,
    wallet_transaction_id varchar2,
    payment_method varchar2,
    credit_card_type varchar2,
    last_digits varchar2,
    name_on_card varchar2,
    time_expiration timestamp with time zone
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_osp_gateway_credit_card_payment_option_t is a subtype of the dbms_cloud_oci_osp_gateway_payment_option_t type.

Fields

Field Description

credit_card_type

(optional) Credit card type.

Allowed values are: 'VISA', 'AMEX', 'MASTERCARD', 'DISCOVER', 'JCB', 'DINER', 'ELO'

last_digits

(optional) Last four digits of the card.

name_on_card

(optional) Name on the credit card.

time_expiration

(optional) Expired date of the credit card.

DBMS_CLOUD_OCI_OSP_GATEWAY_CURRENCY_T Type

Currency details model

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_currency_t FORCE AUTHID CURRENT_USER IS OBJECT (
  currency_code varchar2(32767),
  currency_symbol varchar2(32767),
  name varchar2(32767),
  usd_conversion number,
  round_decimal_point number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_currency_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_currency_t (
    currency_code varchar2,
    currency_symbol varchar2,
    name varchar2,
    usd_conversion number,
    round_decimal_point number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

currency_code

(optional) Currency code

currency_symbol

(optional) Currency symbol

name

(optional) Name of the currency

usd_conversion

(optional) USD conversion rate of the currency

round_decimal_point

(optional) Round decimal point

DBMS_CLOUD_OCI_OSP_GATEWAY_ECHECK_PAYMENT_DETAIL_T Type

Echeck Payment related details

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_echeck_payment_detail_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_osp_gateway_payment_detail_t (
  name_on_card varchar2(32767),
  card_type varchar2(32767),
  account_number varchar2(32767),
  routing_number varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_echeck_payment_detail_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_echeck_payment_detail_t (
    time_paid_on timestamp with time zone,
    paid_by varchar2,
    payment_method varchar2,
    amount_paid number,
    name_on_card varchar2,
    card_type varchar2,
    account_number varchar2,
    routing_number varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_osp_gateway_echeck_payment_detail_t is a subtype of the dbms_cloud_oci_osp_gateway_payment_detail_t type.

Fields

Field Description

name_on_card

(optional) Name on the echeck card

card_type

(optional) Echeck card type

Allowed values are: 'SAVING', 'CHECKING', 'CORPORATE_CHECKING'

account_number

(optional) Account number of the card owner

routing_number

(optional) Routing number of the echeck card

DBMS_CLOUD_OCI_OSP_GATEWAY_ERROR_T Type

Error Information.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_error_t (
    code varchar2,
    message varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

code

(required) A short error code that defines the error, meant for programmatic parsing.

message

(required) A human-readable error string.

DBMS_CLOUD_OCI_OSP_GATEWAY_INVOICE_T Type

Invoice details

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_invoice_t FORCE AUTHID CURRENT_USER IS OBJECT (
  invoice_id varchar2(32767),
  invoice_number varchar2(32767),
  internal_invoice_id varchar2(32767),
  is_credit_card_payable number,
  time_invoice timestamp with time zone,
  tax number,
  invoice_amount number,
  invoice_amount_due number,
  invoice_amount_credited number,
  invoice_amount_adjusted number,
  invoice_amount_applied number,
  currency dbms_cloud_oci_osp_gateway_currency_t,
  invoice_type varchar2(32767),
  time_invoice_due timestamp with time zone,
  invoice_ref_number varchar2(32767),
  invoice_po_number varchar2(32767),
  invoice_status varchar2(32767),
  preferred_email varchar2(32767),
  is_pdf_email_available number,
  is_display_download_pdf number,
  is_payable number,
  payment_terms varchar2(32767),
  last_payment_detail dbms_cloud_oci_osp_gateway_payment_detail_t,
  bill_to_address dbms_cloud_oci_osp_gateway_bill_to_address_t,
  subscription_ids dbms_cloud_oci_osp_gateway_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_invoice_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_invoice_t (
    invoice_id varchar2,
    invoice_number varchar2,
    internal_invoice_id varchar2,
    is_credit_card_payable number,
    time_invoice timestamp with time zone,
    tax number,
    invoice_amount number,
    invoice_amount_due number,
    invoice_amount_credited number,
    invoice_amount_adjusted number,
    invoice_amount_applied number,
    currency dbms_cloud_oci_osp_gateway_currency_t,
    invoice_type varchar2,
    time_invoice_due timestamp with time zone,
    invoice_ref_number varchar2,
    invoice_po_number varchar2,
    invoice_status varchar2,
    preferred_email varchar2,
    is_pdf_email_available number,
    is_display_download_pdf number,
    is_payable number,
    payment_terms varchar2,
    last_payment_detail dbms_cloud_oci_osp_gateway_payment_detail_t,
    bill_to_address dbms_cloud_oci_osp_gateway_bill_to_address_t,
    subscription_ids dbms_cloud_oci_osp_gateway_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

invoice_id

(required) Invoice identifier which is generated on the on-premise sie. Pls note this is not an OCID

invoice_number

(optional) Invoice external reference

internal_invoice_id

(optional) Transaction identifier

is_credit_card_payable

(optional) Is credit card payment eligible

time_invoice

(optional) Date of invoice

tax

(optional) Tax of invoice amount

invoice_amount

(optional) Total amount of invoice

invoice_amount_due

(optional) Balance of invoice

invoice_amount_credited

(optional) Invoice amount credit

invoice_amount_adjusted

(optional) Invoice amount adjust

invoice_amount_applied

(optional) Invoice amount applied

currency

(optional)

invoice_type

(optional) Type of invoice

Allowed values are: 'HARDWARE', 'SUBSCRIPTION', 'SUPPORT', 'LICENSE', 'EDUCATION', 'CONSULTING', 'SERVICE', 'USAGE'

time_invoice_due

(optional) Due date of invoice

invoice_ref_number

(optional) Invoice reference number

invoice_po_number

(optional) Invoice PO number

invoice_status

(optional) Invoice status

Allowed values are: 'OPEN', 'PAST_DUE', 'PAYMENT_SUBMITTED', 'CLOSED'

preferred_email

(optional) Preferred Email on the invoice

is_pdf_email_available

(optional) Is emailing pdf allowed

is_display_download_pdf

(optional) Is pdf download access allowed

is_payable

(optional) Whether invoice can be payed

payment_terms

(optional) Payment terms

last_payment_detail

(optional)

bill_to_address

(optional)

subscription_ids

(optional) List of subscription identifiers

DBMS_CLOUD_OCI_OSP_GATEWAY_INVOICE_SUMMARY_T Type

Invoice list elements

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_invoice_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  invoice_id varchar2(32767),
  invoice_number varchar2(32767),
  internal_invoice_id varchar2(32767),
  is_credit_card_payable number,
  invoice_status varchar2(32767),
  invoice_type varchar2(32767),
  is_paid number,
  is_payable number,
  invoice_amount number,
  invoice_amount_due number,
  invoice_amount_credited number,
  invoice_amount_adjusted number,
  invoice_amount_applied number,
  time_invoice_due timestamp with time zone,
  is_payment_failed number,
  invoice_amount_in_dispute number,
  invoice_ref_number varchar2(32767),
  invoice_po_number varchar2(32767),
  time_invoice timestamp with time zone,
  currency dbms_cloud_oci_osp_gateway_currency_t,
  is_pdf_email_available number,
  is_display_view_pdf number,
  is_display_download_pdf number,
  last_payment_detail dbms_cloud_oci_osp_gateway_payment_detail_t,
  party_name varchar2(32767),
  subscription_ids dbms_cloud_oci_osp_gateway_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_invoice_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_invoice_summary_t (
    invoice_id varchar2,
    invoice_number varchar2,
    internal_invoice_id varchar2,
    is_credit_card_payable number,
    invoice_status varchar2,
    invoice_type varchar2,
    is_paid number,
    is_payable number,
    invoice_amount number,
    invoice_amount_due number,
    invoice_amount_credited number,
    invoice_amount_adjusted number,
    invoice_amount_applied number,
    time_invoice_due timestamp with time zone,
    is_payment_failed number,
    invoice_amount_in_dispute number,
    invoice_ref_number varchar2,
    invoice_po_number varchar2,
    time_invoice timestamp with time zone,
    currency dbms_cloud_oci_osp_gateway_currency_t,
    is_pdf_email_available number,
    is_display_view_pdf number,
    is_display_download_pdf number,
    last_payment_detail dbms_cloud_oci_osp_gateway_payment_detail_t,
    party_name varchar2,
    subscription_ids dbms_cloud_oci_osp_gateway_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

invoice_id

(required) Invoice identifier

invoice_number

(optional) Invoice external reference

internal_invoice_id

(optional) PC invoice identifier

is_credit_card_payable

(optional) Is credit card payment eligible

invoice_status

(optional) Invoice status

Allowed values are: 'OPEN', 'PAST_DUE', 'PAYMENT_SUBMITTED', 'CLOSED'

invoice_type

(optional) Type of invoice

Allowed values are: 'HARDWARE', 'SUBSCRIPTION', 'SUPPORT', 'LICENSE', 'EDUCATION', 'CONSULTING', 'SERVICE', 'USAGE'

is_paid

(optional) Is the invoice has been already payed

is_payable

(optional) Whether invoice can be payed

invoice_amount

(optional) Invoice amount

invoice_amount_due

(optional) Invoice amount due

invoice_amount_credited

(optional) Invoice amount credit

invoice_amount_adjusted

(optional) Invoice amount adjust

invoice_amount_applied

(optional) Invoice amount applied

time_invoice_due

(optional) Due date of invoice amount

is_payment_failed

(optional) Is the last payment failed

invoice_amount_in_dispute

(optional) Invoice amount in dispute

invoice_ref_number

(optional) Invoice reference number

invoice_po_number

(optional) Invoice PO number

time_invoice

(optional) Date of invoice

currency

(optional)

is_pdf_email_available

(optional) Is emailing pdf allowed

is_display_view_pdf

(optional) Is view access allowed

is_display_download_pdf

(optional) Is pdf download access allowed

last_payment_detail

(optional)

party_name

(optional) Name of the bill to customer

subscription_ids

(optional) List of subscription identifiers

DBMS_CLOUD_OCI_OSP_GATEWAY_INVOICE_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_osp_gateway_invoice_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_invoice_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_osp_gateway_invoice_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_OSP_GATEWAY_INVOICE_COLLECTION_T Type

Invoice list

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_invoice_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_osp_gateway_invoice_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_invoice_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_invoice_collection_t (
    items dbms_cloud_oci_osp_gateway_invoice_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) Invoice list elements

DBMS_CLOUD_OCI_OSP_GATEWAY_INVOICE_LINE_SUMMARY_T Type

Product items of the invoice

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_invoice_line_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  product varchar2(32767),
  order_no varchar2(32767),
  part_number varchar2(32767),
  time_start timestamp with time zone,
  time_end timestamp with time zone,
  quantity number,
  net_unit_price number,
  total_price number,
  currency dbms_cloud_oci_osp_gateway_currency_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_invoice_line_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_invoice_line_summary_t (
    product varchar2,
    order_no varchar2,
    part_number varchar2,
    time_start timestamp with time zone,
    time_end timestamp with time zone,
    quantity number,
    net_unit_price number,
    total_price number,
    currency dbms_cloud_oci_osp_gateway_currency_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

product

(required) Product of the item

order_no

(optional) Product of the item

part_number

(optional) Part number

time_start

(optional) Start date

time_end

(optional) End date

quantity

(optional) Quantity of the ordered product

net_unit_price

(optional) Unit price of the ordered product

total_price

(optional) Total price of the ordered product (Net unit price x quantity)

currency

(optional)

DBMS_CLOUD_OCI_OSP_GATEWAY_INVOICE_LINE_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_osp_gateway_invoice_line_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_invoice_line_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_osp_gateway_invoice_line_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_OSP_GATEWAY_INVOICE_LINE_COLLECTION_T Type

Invoice line list

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_invoice_line_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_osp_gateway_invoice_line_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_invoice_line_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_invoice_line_collection_t (
    items dbms_cloud_oci_osp_gateway_invoice_line_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) Invoice line list elements

DBMS_CLOUD_OCI_OSP_GATEWAY_OTHER_PAYMENT_DETAIL_T Type

Other Payment related details

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_other_payment_detail_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_osp_gateway_payment_detail_t (
  echeck_routing varchar2(32767),
  name_on_card varchar2(32767),
  credit_card_type varchar2(32767),
  last_digits varchar2(32767),
  time_expiration timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_other_payment_detail_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_other_payment_detail_t (
    time_paid_on timestamp with time zone,
    paid_by varchar2,
    payment_method varchar2,
    amount_paid number,
    echeck_routing varchar2,
    name_on_card varchar2,
    credit_card_type varchar2,
    last_digits varchar2,
    time_expiration timestamp with time zone
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_osp_gateway_other_payment_detail_t is a subtype of the dbms_cloud_oci_osp_gateway_payment_detail_t type.

Fields

Field Description

echeck_routing

(optional) Last four routing digits of the card

name_on_card

(optional) Name on the echeck card

credit_card_type

(optional) Echeck card type

Allowed values are: 'VISA', 'AMEX', 'MASTERCARD', 'DISCOVER', 'JCB', 'DINER', 'ELO', 'SAVING', 'CHECKING', 'CORPORATE_CHECKING'

last_digits

(optional) Last four digits of the card

time_expiration

(optional) Expired date of the echeck card

DBMS_CLOUD_OCI_OSP_GATEWAY_PAY_INVOICE_DETAILS_T Type

Request object for invoice payment

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_pay_invoice_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  language_code varchar2(32767),
  return_url varchar2(32767),
  email varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_pay_invoice_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_pay_invoice_details_t (
    language_code varchar2,
    return_url varchar2,
    email varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

language_code

(optional) Language code

return_url

(optional) Callback URL

email

(required) User email

DBMS_CLOUD_OCI_OSP_GATEWAY_PAY_INVOICE_RECEIPT_T Type

Invoice payment action response

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_pay_invoice_receipt_t FORCE AUTHID CURRENT_USER IS OBJECT (
  url varchar2(32767),
  header_id varchar2(32767),
  token varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_pay_invoice_receipt_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_pay_invoice_receipt_t (
    url varchar2,
    header_id varchar2,
    token varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

url

(optional) Url of the Payment Service

header_id

(required) Payment header id

token

(optional) Token created for Payment Service

DBMS_CLOUD_OCI_OSP_GATEWAY_PAY_SUBSCRIPTION_DETAILS_T Type

Request object for paying a subscription

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_pay_subscription_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  subscription dbms_cloud_oci_osp_gateway_subscription_t,
  language_code varchar2(32767),
  email varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_pay_subscription_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_pay_subscription_details_t (
    subscription dbms_cloud_oci_osp_gateway_subscription_t,
    language_code varchar2,
    email varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

subscription

(required)

language_code

(required) Language code

email

(required) User email

DBMS_CLOUD_OCI_OSP_GATEWAY_PAY_SUBSCRIPTION_RECEIPT_T Type

Subscription payment action response

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_pay_subscription_receipt_t FORCE AUTHID CURRENT_USER IS OBJECT (
  header_id varchar2(32767),
  api_token varchar2(32767),
  user_token varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_pay_subscription_receipt_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_pay_subscription_receipt_t (
    header_id varchar2,
    api_token varchar2,
    user_token varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

header_id

(required) Payment header id

api_token

(optional) Parameters in a token for Payment Service

user_token

(optional) Session token created for Payment Service

DBMS_CLOUD_OCI_OSP_GATEWAY_PAYPAL_PAYMENT_DETAIL_T Type

PayPal Payment related details

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_paypal_payment_detail_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_osp_gateway_payment_detail_t (
  paypal_id varchar2(32767),
  paypal_reference varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_paypal_payment_detail_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_paypal_payment_detail_t (
    time_paid_on timestamp with time zone,
    paid_by varchar2,
    payment_method varchar2,
    amount_paid number,
    paypal_id varchar2,
    paypal_reference varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_osp_gateway_paypal_payment_detail_t is a subtype of the dbms_cloud_oci_osp_gateway_payment_detail_t type.

Fields

Field Description

paypal_id

(optional) The id (email address) of the paypal payment

paypal_reference

(optional) paypal payment reference

DBMS_CLOUD_OCI_OSP_GATEWAY_PAYPAL_PAYMENT_OPTION_T Type

PayPal Payment related details

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_paypal_payment_option_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_osp_gateway_payment_option_t (
  email_address varchar2(32767),
  first_name varchar2(32767),
  last_name varchar2(32767),
  ext_billing_agreement_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_paypal_payment_option_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_paypal_payment_option_t (
    wallet_instrument_id varchar2,
    wallet_transaction_id varchar2,
    payment_method varchar2,
    email_address varchar2,
    first_name varchar2,
    last_name varchar2,
    ext_billing_agreement_id varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_osp_gateway_paypal_payment_option_t is a subtype of the dbms_cloud_oci_osp_gateway_payment_option_t type.

Fields

Field Description

email_address

(optional) The email address of the paypal user.

first_name

(optional) First name of the paypal user.

last_name

(optional) Last name of the paypal user.

ext_billing_agreement_id

(optional) Agreement id for the paypal account.

DBMS_CLOUD_OCI_OSP_GATEWAY_SUBSCRIPTION_SUMMARY_T Type

Subscription object which contains the common subscription data.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_subscription_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  subscription_plan_number varchar2(32767),
  plan_type varchar2(32767),
  time_start timestamp with time zone,
  ship_to_cust_acct_site_id varchar2(32767),
  ship_to_cust_acct_role_id varchar2(32767),
  bill_to_cust_account_id varchar2(32767),
  is_intent_to_pay number,
  currency_code varchar2(32767),
  gsi_org_code varchar2(32767),
  language_code varchar2(32767),
  organization_id varchar2(32767),
  upgrade_state varchar2(32767),
  upgrade_state_details varchar2(32767),
  account_type varchar2(32767),
  tax_info dbms_cloud_oci_osp_gateway_tax_info_t,
  payment_options dbms_cloud_oci_osp_gateway_payment_option_tbl,
  payment_gateway dbms_cloud_oci_osp_gateway_payment_gateway_t,
  billing_address dbms_cloud_oci_osp_gateway_address_t,
  time_plan_upgrade timestamp with time zone,
  time_personal_to_corporate_conv timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_subscription_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_subscription_summary_t (
    id varchar2,
    subscription_plan_number varchar2,
    plan_type varchar2,
    time_start timestamp with time zone,
    ship_to_cust_acct_site_id varchar2,
    ship_to_cust_acct_role_id varchar2,
    bill_to_cust_account_id varchar2,
    is_intent_to_pay number,
    currency_code varchar2,
    gsi_org_code varchar2,
    language_code varchar2,
    organization_id varchar2,
    upgrade_state varchar2,
    upgrade_state_details varchar2,
    account_type varchar2,
    tax_info dbms_cloud_oci_osp_gateway_tax_info_t,
    payment_options dbms_cloud_oci_osp_gateway_payment_option_tbl,
    payment_gateway dbms_cloud_oci_osp_gateway_payment_gateway_t,
    billing_address dbms_cloud_oci_osp_gateway_address_t,
    time_plan_upgrade timestamp with time zone,
    time_personal_to_corporate_conv timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(optional) Subscription id identifier (OCID).

subscription_plan_number

(required) Subscription plan number.

plan_type

(optional) Subscription plan type.

Allowed values are: 'FREE_TIER', 'PAYG'

time_start

(optional) Start date of the subscription.

ship_to_cust_acct_site_id

(optional) Ship to customer account site address id.

ship_to_cust_acct_role_id

(optional) Ship to customer account role.

bill_to_cust_account_id

(optional) Bill to customer Account id.

is_intent_to_pay

(optional) Payment intension.

currency_code

(optional) Currency code

gsi_org_code

(optional) GSI Subscription external code.

language_code

(optional) Language short code (en, de, hu, etc)

organization_id

(optional) GSI organization external identifier.

upgrade_state

(optional) Status of the upgrade.

Allowed values are: 'PROMO', 'SUBMITTED', 'ERROR', 'UPGRADED'

upgrade_state_details

(optional) This field is used to describe the Upgrade State in case of error (E.g. Upgrade failure caused by interfacing Tax details- TaxError)

Allowed values are: 'TAX_ERROR', 'UPGRADE_ERROR'

account_type

(optional) Account type.

Allowed values are: 'PERSONAL', 'CORPORATE', 'CORPORATE_SUBMITTED'

tax_info

(optional)

payment_options

(optional) Payment option list of a subscription.

payment_gateway

(optional)

billing_address

(optional)

time_plan_upgrade

(optional) Date of upgrade/conversion when planType changed from FREE_TIER to PAYG

time_personal_to_corporate_conv

(optional) Date of upgrade/conversion when account type changed from PERSONAL to CORPORATE

DBMS_CLOUD_OCI_OSP_GATEWAY_SUBSCRIPTION_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_osp_gateway_subscription_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_subscription_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_osp_gateway_subscription_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_OSP_GATEWAY_SUBSCRIPTION_COLLECTION_T Type

Subscription list

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_subscription_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_osp_gateway_subscription_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_subscription_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_subscription_collection_t (
    items dbms_cloud_oci_osp_gateway_subscription_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) Subscription list elements

DBMS_CLOUD_OCI_OSP_GATEWAY_UPDATE_SUBSCRIPTION_DETAILS_T Type

Request object for updating a subscription

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_update_subscription_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  subscription dbms_cloud_oci_osp_gateway_subscription_t,
  email varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_update_subscription_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_update_subscription_details_t (
    subscription dbms_cloud_oci_osp_gateway_subscription_t,
    email varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

subscription

(required)

email

(required) User email

DBMS_CLOUD_OCI_OSP_GATEWAY_VERIFY_ADDRESS_DETAILS_T Type

Verify address related details

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_verify_address_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  address_key varchar2(32767),
  line1 varchar2(32767),
  line2 varchar2(32767),
  line3 varchar2(32767),
  line4 varchar2(32767),
  street_name varchar2(32767),
  street_number varchar2(32767),
  city varchar2(32767),
  county varchar2(32767),
  country varchar2(32767),
  province varchar2(32767),
  postal_code varchar2(32767),
  state varchar2(32767),
  email_address varchar2(32767),
  company_name varchar2(32767),
  first_name varchar2(32767),
  middle_name varchar2(32767),
  last_name varchar2(32767),
  phone_country_code varchar2(32767),
  phone_number varchar2(32767),
  job_title varchar2(32767),
  department_name varchar2(32767),
  internal_number varchar2(32767),
  contributor_class varchar2(32767),
  state_inscription varchar2(32767),
  municipal_inscription varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_verify_address_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_verify_address_details_t (
    address_key varchar2,
    line1 varchar2,
    line2 varchar2,
    line3 varchar2,
    line4 varchar2,
    street_name varchar2,
    street_number varchar2,
    city varchar2,
    county varchar2,
    country varchar2,
    province varchar2,
    postal_code varchar2,
    state varchar2,
    email_address varchar2,
    company_name varchar2,
    first_name varchar2,
    middle_name varchar2,
    last_name varchar2,
    phone_country_code varchar2,
    phone_number varchar2,
    job_title varchar2,
    department_name varchar2,
    internal_number varchar2,
    contributor_class varchar2,
    state_inscription varchar2,
    municipal_inscription varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

address_key

(optional) Address identifier.

line1

(optional) Address line 1.

line2

(optional) Address line 2.

line3

(optional) Address line 3.

line4

(optional) Address line 4.

street_name

(optional) Street name of the address.

street_number

(optional) Street number of the address.

city

(optional) Name of the city.

county

(optional) County of the address.

country

(optional) Country of the address.

province

(optional) Province of the address.

postal_code

(optional) Post code of the address.

state

(optional) State of the address.

email_address

(optional) Contact person email address.

company_name

(optional) Name of the customer company.

first_name

(optional) First name of the contact person.

middle_name

(optional) Middle name of the contact person.

last_name

(optional) Last name of the contact person.

phone_country_code

(optional) Phone country code of the contact person.

phone_number

(optional) Phone number of the contact person.

job_title

(optional) Job title of the contact person.

department_name

(optional) Department name of the customer company.

internal_number

(optional) Internal number of the customer company.

contributor_class

(optional) Contributor class of the customer company.

state_inscription

(optional) State Inscription.

municipal_inscription

(optional) Municipal Inscription.

DBMS_CLOUD_OCI_OSP_GATEWAY_VERIFY_ADDRESS_RECEIPT_T Type

Address verficiation result

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_osp_gateway_verify_address_receipt_t FORCE AUTHID CURRENT_USER IS OBJECT (
  address dbms_cloud_oci_osp_gateway_address_t,
  quality varchar2(32767),
  verification_code varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_verify_address_receipt_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_osp_gateway_verify_address_receipt_t (
    address dbms_cloud_oci_osp_gateway_address_t,
    quality varchar2,
    verification_code varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

address

(required)

quality

(required) Address quality type.

Allowed values are: 'EXCELLENT', 'GOOD', 'AVERAGE', 'POOR', 'BAD'

verification_code

(required) Address verification code.

Allowed values are: 'VERIFIED', 'PARTIALLY_VERIFIED', 'AMBIGUOUS', 'REVERTED', 'UNVERIFIED'

Was this article helpful?