Profiles

Address

terminusgps.authorizenet.profiles.addresses.create_customer_shipping_address(customer_profile_id: int, new_address: customerAddressType, default: bool = True)

createCustomerShippingAddressRequest.

Parameters:

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

• new_address (customerAddressType) – An Authorizenet customer address object.

• default (bool) – Whether or not to mark the new shipping address as default. Default is True.

Returns:

An Authorizenet createCustomerShippingAddress response.

Return type:

dict

terminusgps.authorizenet.profiles.addresses.delete_customer_shipping_address(customer_profile_id: int, customer_address_profile_id: int)

deleteCustomerShippingAddressRequest.

Parameters:

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

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

Returns:

An Authorizenet deleteCustomerShippingAddress response.

Return type:

dict

terminusgps.authorizenet.profiles.addresses.get_customer_shipping_address(customer_profile_id: int, customer_address_profile_id: int)

getCustomerShippingAddressRequest.

Parameters:

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

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

Returns:

An Authorizenet getCustomerShippingAddress response.

Return type:

dict

terminusgps.authorizenet.profiles.addresses.update_customer_shipping_address(customer_profile_id: int, new_address: customerAddressType, default: bool = False)

updateCustomerShippingAddressRequest.

Parameters:

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

• new_address (customerAddressType) – An Authorizenet customer address object.

• default (bool) – Whether or not to mark the new shipping address as default. Default is False.

Returns:

An Authorizenet updateCustomerShippingAddress response.

Return type:

dict

Customer

terminusgps.authorizenet.profiles.customers.create_customer_profile(merchant_id: int | str, email: str, description: str = '')

createCustomerProfileRequest.

Parameters:

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

• email (str) – A customer email address.

• description (str) – An optional customer description.

Returns:

An Authorizenet createCustomerProfile response.

Return type:

dict

terminusgps.authorizenet.profiles.customers.delete_customer_profile(customer_profile_id: int)

deleteCustomerProfileRequest.

Parameters:

customer_profile_id (int) – An Authorizenet customer profile id.

Returns:

An Authorizenet deleteCustomerProfile response.

Return type:

dict

terminusgps.authorizenet.profiles.customers.get_customer_profile(customer_profile_id: int, include_issuer_info: bool = False)

getCustomerProfileRequest.

Parameters:

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

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

Returns:

An Authorizenet getCustomerProfile response.

Return type:

dict

terminusgps.authorizenet.profiles.customers.get_customer_profile_ids()

getCustomerProfileIdsRequest.

Returns:

An Authorizenet getCustomerProfileIds response.

Return type:

dict

terminusgps.authorizenet.profiles.customers.update_customer_profile(customer_profile_id: int, new_profile: customerProfileExType)

updateCustomerProfileRequest.

Parameters:

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

• new_profile (customerProfileExType) – An Authorizenet customer profile ex object.

Returns:

An Authorizenet updateCustomerProfile response.

Return type:

dict

Payment

terminusgps.authorizenet.profiles.payments.create_customer_payment_profile(customer_profile_id: int, new_payment_profile: customerPaymentProfileType)

createCustomerPaymentProfileRequest.

Parameters:

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

• new_payment_profile (customerPaymentProfileType) – An Authorizenet payment profile object.

Returns:

An Authorizenet createCustomerPaymentProfile response.

Return type:

dict

terminusgps.authorizenet.profiles.payments.delete_customer_payment_profile(customer_profile_id: int, customer_payment_profile_id: int)

deleteCustomerPaymentProfileRequest.

Parameters:

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

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

Returns:

An Authorizenet deleteCustomerPaymentProfile response.

Return type:

dict

terminusgps.authorizenet.profiles.payments.get_customer_payment_profile(customer_profile_id: int, customer_payment_profile_id: int, include_issuer_info: bool = False)

getCustomerPaymentProfileRequest.

Parameters:

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

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

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

Returns:

An Authorizenet getCustomerPaymentProfile response.

Return type:

dict

terminusgps.authorizenet.profiles.payments.update_customer_payment_profile(customer_profile_id: int, customer_payment_profile_id: int, new_payment_profile: customerPaymentProfileType)

updateCustomerPaymentProfileRequest.

Parameters:

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

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

• new_payment_profile (customerPaymentProfileType) – An Authorizenet payment profile object.

Returns:

An Authorizenet updateCustomerPaymentProfile response.

Return type:

dict

terminusgps.authorizenet.profiles.payments.validate_customer_payment_profile(customer_profile_id: int, customer_payment_profile_id: int)

validateCustomerPaymentProfileRequest.

Parameters:

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

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

Returns:

An Authorizenet validateCustomerPaymentProfile response.

Return type:

dict