copy_acct_payment_method_m

Last updated
Save as PDF

This API copies one or more payment methods (and their associated billing contact information) from one customer account in Aria to a different customer account. Clients must validate that the account owner is the same for both the source and target accounts prior to calling this API. Note that payment methods copied to the target account are not by default associated with a billing group. If no payment methods are specified, all non-disabled payment methods on the source account are copied to the target account.

This API must be enabled for use with your organization. Please contact Aria Support for additional information.

SPECIAL NOTICE: To provide both security and flexibility, you can copy payment information between accounts within an Aria client environment. Movement of payment data from a source account to a target account is not validated. It is is the client's responsibility when using this API to ensure that the owner of the source account and the target account is the same. Aria is not responsible for any errors caused when using this API to move payment data.

Input Arguments

Req	Field Name	Field Type	Max Length	Description
	client_no	long	22	Aria-assigned unique identifier indicating the Aria client providing service to this account.
	auth_key	string	32	Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
	source_acct_no	long	22	Aria-assigned account identifier associated with the account from which the payment method will be copied.
	OR
	client_source_acct_id	string	50	Client-defined account identifier associated with the account from which the payment method will be copied.
	target_acct_no	long	22	Aria-assigned account identifier associated with the account to which the payment method will be copied.
	OR
	client_target_acct_id	string	50	Client-defined account identifier associated with the account to which the payment method will be copied.
Start of copy_payment_methods array
	copy_payment_methods	array
	Field Name	Field Type	Max Length	Description
	payment_method_no	long	22	Aria-assigned identifier associated with the payment method on the source account to be copied to the target account.
	OR
	client_payment_method_id	string	100	Client-defined identifier associated with the payment method on the source account to be copied to the target account.
	client_new_tgt_pmt_method_id	string	100	The client-defined identifier of the payment method on the source account will be copied as the client-defined identifier for that payment method on the target account. This input will specify the new client-defined identifier to be used for the payment method on the source account. If not specified, the client-defined identifier for this payment method on the source account will be removed (made null).
End of copy_payment_methods array
Start of payment_methods array DEPRECATED
	payment_methods	array		DEPRECATED
	Field Name	Field Type	Max Length	Description
	payment_method_no	long	22	Aria-assigned identifier associated with the payment method on the source account to be copied to the target account.DEPRECATED
	OR
	client_payment_method_id	string	100	Client-defined identifier associated with the payment method on the source account to be copied to the target account.&DEPRECATED
	client_new_tgt_pmt_method_id	string	100	The client-defined identifier of the payment method on the source account will be copied as the client-defined identifier for that payment method on the target account. This input will specify the new client-defined identifier to be used for the payment method on the source account. If not specified, the client-defined identifier for this payment method on the source account will be removed (made null).DEPRECATED
End of payment_methods array

	alt_caller_id	string	30	Person or process that submitted the API call. This can be someone's user ID, or the name of an application.
Start of optional_transaction_qualifiers array
	optional_transaction_qualifiers	array		Array of additional values you can associate with this API call.
	Field Name	Field Type	Max Length	Description
	qualifier_name	string	100	Name of the field you want to associate with this API call.
	qualifier_value	string	100	Corresponding value of the field you want to associate with this API call.
End of optional_transaction_qualifiers array

Field Name	Field Type	Description
error_code	long	Aria-assigned error identifier. 0 indicates no error.
error_msg	string	Description of any error that occurred. "OK" if there was no error.
payment_method_map	hash
source_pmt_method_no	long	Aria-assigned identifier of the payment method copied from the source account.
client_source_pmt_method_id	string	Client-defined identifier of the payment method copied from the source account.
target_pmt_method_no	long	Aria-assigned identifier of the payment method copied to the target account.
client_target_pmt_method_id	string	Client-defined identifier of the payment method copied to the target account.