Functions

Address Profiles

terminusgps.authorizenet.api.address_profiles.create_customer_shipping_address(customer_profile_id: int, address: customerAddressType, default: bool = False) → tuple[ObjectifiedElement, type[APIOperationBase]][source]

createCustomerShippingAddressRequest.

Parameters:

  • customer_profile_id (int) – An Authorizenet customer profile id.

  • address (customerAddressType) – An Authorizenet customer address element.

  • default (bool) – Whether to set the address profile as default. Default is False.

Returns:

A tuple containing an Authorizenet API request element and controller class.

Return type:

tuple[ObjectifiedElement, type[APIOperationBase]]

terminusgps.authorizenet.api.address_profiles.delete_customer_shipping_address(customer_profile_id: int, address_profile_id: int) → tuple[ObjectifiedElement, type[APIOperationBase]][source]

deleteCustomerShippingAddressRequest.

Parameters:

  • customer_profile_id (int) – An Authorizenet customer profile id.

  • address_profile_id (int) – An Authorizenet customer address profile id.

Returns:

A tuple containing an Authorizenet API request element and controller class.

Return type:

tuple[ObjectifiedElement, type[APIOperationBase]]

terminusgps.authorizenet.api.address_profiles.get_customer_shipping_address(customer_profile_id: int, address_profile_id: int) → tuple[ObjectifiedElement, type[APIOperationBase]][source]

getCustomerShippingAddressRequest.

Parameters:

  • customer_profile_id (int) – An Authorizenet customer profile id.

  • address_profile_id (int) – An Authorizenet customer address profile id.

Returns:

A tuple containing an Authorizenet API request element and controller class.

Return type:

tuple[ObjectifiedElement, type[APIOperationBase]]

terminusgps.authorizenet.api.address_profiles.update_customer_shipping_address(customer_profile_id: int, address: customerAddressType, default: bool = False) → tuple[ObjectifiedElement, type[APIOperationBase]][source]

updateCustomerShippingAddressRequest.

Parameters:

  • customer_profile_id (int) – An Authorizenet customer profile id.

  • address (customerAddressType) – An Authorizenet customer address element.

  • default (bool) – Whether to set the address profile as default. Default is False.

Returns:

A tuple containing an Authorizenet API request element and controller class.

Return type:

tuple[ObjectifiedElement, type[APIOperationBase]]

Customer Profiles

terminusgps.authorizenet.api.customer_profiles.create_customer_profile(merchant_id: str, email: str, description: str = '') → tuple[ObjectifiedElement, type[APIOperationBase]][source]

createCustomerProfileRequest.

Parameters:

  • merchant_id (str) – A merchant designated customer id.

  • email (str) – A customer email address.

  • description (str) – An optional customer description.

Returns:

A tuple containing an Authorizenet API request element and controller class.

Return type:

tuple[ObjectifiedElement, type[APIOperationBase]]

terminusgps.authorizenet.api.customer_profiles.delete_customer_profile(customer_profile_id: int) → tuple[ObjectifiedElement, type[APIOperationBase]][source]

deleteCustomerProfileRequest.

Parameters:

customer_profile_id (int) – An Authorizenet customer profile id.

Returns:

A tuple containing an Authorizenet API request element and controller class.

Return type:

tuple[ObjectifiedElement, type[APIOperationBase]]

terminusgps.authorizenet.api.customer_profiles.get_customer_profile(customer_profile_id: int, include_issuer_info: bool = False) → tuple[ObjectifiedElement, type[APIOperationBase]][source]

getCustomerProfileRequest.

Parameters:

  • customer_profile_id (int) – Authorizenet customer profile id.

  • include_issuer_info (bool) – Whether to include issuer info in the response. Default is False.

Returns:

A tuple containing an Authorizenet API request element and controller class.

Return type:

tuple[ObjectifiedElement, type[APIOperationBase]]

terminusgps.authorizenet.api.customer_profiles.get_customer_profile_ids() → tuple[ObjectifiedElement, type[APIOperationBase]][source]

getCustomerProfileIdsRequest.

Returns:

A tuple containing an Authorizenet API request element and controller class.

Return type:

tuple[ObjectifiedElement, type[APIOperationBase]]

terminusgps.authorizenet.api.customer_profiles.update_customer_profile(profile: customerProfileExType) → tuple[ObjectifiedElement, type[APIOperationBase]][source]

updateCustomerProfileRequest.

Parameters:

profile (customerProfileExType) – An Authorizenet customer profile ex element.

Returns:

A tuple containing an Authorizenet API request element and controller class.

Return type:

tuple[ObjectifiedElement, type[APIOperationBase]]

Payment Profiles

terminusgps.authorizenet.api.payment_profiles.create_customer_payment_profile(customer_profile_id: int, payment: paymentType, address: customerAddressType, default: bool = False, validation: str | None = None) → tuple[ObjectifiedElement, type[APIOperationBase]][source]

createCustomerPaymentProfileRequest.

Parameters:

  • customer_profile_id (int) – An Authorizenet customer profile id.

  • payment (paymentType) – An Authorizenet payment element.

  • address (customerAddressType) – An Authorizenet address element.

  • default (bool) – Whether to set the payment profile as default. Default is False.

  • validation (str | None) – Validation mode to use when validating the payment profile. If not provided, the payment profile is not validated. Default is None.

Returns:

A tuple containing an Authorizenet API request element and controller class.

Return type:

tuple[ObjectifiedElement, type[APIOperationBase]]

terminusgps.authorizenet.api.payment_profiles.delete_customer_payment_profile(customer_profile_id: int, payment_profile_id: int) → tuple[ObjectifiedElement, type[APIOperationBase]][source]

deleteCustomerPaymentProfileRequest.

Parameters:

  • customer_profile_id (int) – An Authorizenet customer profile id.

  • payment_profile_id (int) – An Authorizenet customer payment profile id.

Returns:

A tuple containing an Authorizenet API request element and controller class.

Return type:

tuple[ObjectifiedElement, type[APIOperationBase]]

terminusgps.authorizenet.api.payment_profiles.get_customer_payment_profile(customer_profile_id: int, payment_profile_id: int, include_issuer_info: bool = False) → tuple[ObjectifiedElement, type[APIOperationBase]][source]

getCustomerPaymentProfileRequest.

Parameters:

  • customer_profile_id (int) – An Authorizenet customer profile id.

  • payment_profile_id (int) – An Authorizenet customer payment profile id.

  • include_issuer_info (bool) – Whether to include issuer info in the response. Default is False.

Returns:

A tuple containing an Authorizenet API request element and controller class.

Return type:

tuple[ObjectifiedElement, type[APIOperationBase]]

terminusgps.authorizenet.api.payment_profiles.update_customer_payment_profile(customer_profile_id: int, payment_profile_id: int, payment: paymentType | None = None, address: customerAddressType | None = None, default: bool | None = None, validation: str | None = None) → tuple[ObjectifiedElement, type[APIOperationBase]][source]

updateCustomerPaymentProfileRequest.

Parameters:

  • customer_profile_id (int) – An Authorizenet customer profile id.

  • payment_profile_id (int) – An Authorizenet customer payment profile id.

  • payment (paymentType | None) – An Authorizenet payment element.

  • address (customerAddressType | None) – An Authorizenet address element.

  • default (bool | None) – Whether to set the payment profile as default. If not provided, the payment profile’s default state is not updated. Default is None.

  • validation (str | None) – Validation mode to use when validating the payment profile. If not provided, the payment profile is not validated. Default is None.

Raises:

ValueError – If neither payment nor address was provided.

Returns:

A tuple containing an Authorizenet API request element and controller class.

Return type:

tuple[ObjectifiedElement, type[APIOperationBase]]

terminusgps.authorizenet.api.payment_profiles.validate_customer_payment_profile(customer_profile_id: int, payment_profile_id: int, validation: str) → tuple[ObjectifiedElement, type[APIOperationBase]][source]

validateCustomerPaymentProfileRequest.

Parameters:

  • customer_profile_id (int) – An Authorizenet customer profile id.

  • payment_profile_id (int) – An Authorizenet customer payment profile id.

  • validation (str) – Validation mode to use when validating the payment profile.

Returns:

A tuple containing an Authorizenet API request element and controller class.

Return type:

tuple[ObjectifiedElement, type[APIOperationBase]]

Subscriptions

terminusgps.authorizenet.api.subscriptions.cancel_subscription(subscription_id: int) → tuple[ObjectifiedElement, type[APIOperationBase]][source]

ARBCancelSubscriptionRequest.

Parameters:

subscription_id (int) – An Authorizenet subscription id.

Returns:

A tuple containing an Authorizenet API request element and controller class.

Return type:

tuple[ObjectifiedElement, type[APIOperationBase]]

terminusgps.authorizenet.api.subscriptions.create_subscription(subscription: ARBSubscriptionType) → tuple[ObjectifiedElement, type[APIOperationBase]][source]

ARBCreateSubscriptionRequest.

Parameters:

subscription (ARBSubscriptionType) – An Authorizenet ARBSubscriptionType element.

Returns:

A tuple containing an Authorizenet API request element and controller class.

Return type:

tuple[ObjectifiedElement, type[APIOperationBase]]

terminusgps.authorizenet.api.subscriptions.get_subscription(subscription_id: int, include_transactions: bool = True) → tuple[ObjectifiedElement, type[APIOperationBase]][source]

ARBGetSubscriptionRequest.

Parameters:

  • subscription_id (int) – An Authorizenet subscription id.

  • include_transactions (bool) – Whether to include the subscription transaction list in the response. Default is True.

Returns:

A tuple containing an Authorizenet API request element and controller class.

Return type:

tuple[ObjectifiedElement, type[APIOperationBase]]

terminusgps.authorizenet.api.subscriptions.get_subscription_status(subscription_id: int) → tuple[ObjectifiedElement, type[APIOperationBase]][source]

ARBGetSubscriptionStatusRequest.

Parameters:

subscription_id (int) – An Authorizenet subscription id.

Returns:

A tuple containing an Authorizenet API request element and controller class.

Return type:

tuple[ObjectifiedElement, type[APIOperationBase]]

terminusgps.authorizenet.api.subscriptions.update_subscription(subscription_id: int, subscription: ARBSubscriptionType) → tuple[ObjectifiedElement, type[APIOperationBase]][source]

ARBUpdateSubscriptionRequest.

Parameters:

  • subscription_id (int) – An Authorizenet subscription id.

  • subscription (ARBSubscriptionType) – An Authorizenet ARBSubscriptionType element.

Returns:

A tuple containing an Authorizenet API request element and controller class.

Return type:

tuple[ObjectifiedElement, type[APIOperationBase]]

Transactions

terminusgps.authorizenet.api.transactions.authorize_credit_card(amount: Decimal, credit_card: creditCardType, address: customerAddressType, order: orderType | None = None, customer_data: customerDataType | None = None, settings: ArrayOfSetting | None = None, line_items: ArrayOfLineItem | None = None) → tuple[ObjectifiedElement, type[APIOperationBase]][source]

Authorizes a credit card.

Parameters:

  • amount (Decimal) – Dollar amount to authorize.

  • credit_card (creditCardType) – A credit card.

  • address (customerAddressType) – A customer address.

  • order (orderType | None) – Additional order information. Default is None.

  • customer_data (customerDataType | None) – Additional customer data. Default is None.

  • settings (ArrayOfSetting | None) – Transaction settings. Default is None.

  • line_items (ArrayOfLineItem | None) – An array of line items. Default is None.

Returns:

A tuple containing an Authorizenet API request element and controller class.

Return type:

tuple[ObjectifiedElement, type[APIOperationBase]]

terminusgps.authorizenet.api.transactions.capture_authorized_amount(amount: Decimal) → tuple[ObjectifiedElement, type[APIOperationBase]][source]

Captures a previously authorized amount.

Parameters:

amount (Decimal) – Dollar amount to capture.

Returns:

A tuple containing an Authorizenet API request element and controller class.

Return type:

tuple[ObjectifiedElement, type[APIOperationBase]]

terminusgps.authorizenet.api.transactions.charge_credit_card(amount: Decimal, credit_card: creditCardType, address: customerAddressType, order: orderType | None = None, customer_data: customerDataType | None = None, settings: ArrayOfSetting | None = None, line_items: ArrayOfLineItem | None = None) → tuple[ObjectifiedElement, type[APIOperationBase]][source]

Charges a credit card.

Parameters:

  • amount (Decimal) – Dollar amount to charge.

  • credit_card (creditCardType) – A credit card.

  • address (customerAddressType) – A customer address.

  • order (orderType | None) – Order information. Default is None.

  • customer_data (customerDataType | None) – Customer data. Default is None.

  • settings (ArrayOfSetting | None) – Transaction settings. Default is None.

  • line_items (ArrayOfLineItem | None) – An array of line items. Default is None.

Returns:

A tuple containing an Authorizenet API request element and controller class.

Return type:

tuple[ObjectifiedElement, type[APIOperationBase]]

terminusgps.authorizenet.api.transactions.refund_credit_card(amount: Decimal, credit_card: creditCardType) → tuple[ObjectifiedElement, type[APIOperationBase]][source]

Refunds a credit card.

Parameters:

  • amount (Decimal) – Dollar amount to refund.

  • credit_card (creditCardType) – Destination credit card.

Returns:

A tuple containing an Authorizenet API request element and controller class.

Return type:

tuple[ObjectifiedElement, type[APIOperationBase]]