Home > Aria6 User Documentation > Aria6 core api > copy_acct_payment_method
copy_acct_payment_method
copy_acct_payment_method
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. | |
| 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. | |
| optional_transaction_qualifiers | array | Array of additional values you can associate with this API call. | ||
 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. |
Output Arguments
| 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. | ||||||
| seq_nos | hash | |||||||
| source_acct_seq_no |
long | Sequence number of the payment method copied from the source account. | ||||||
| target_acct_seq_no |
long | Sequence number of the payment method copied to the target account. | ||||||
| primary_indicator_cd |
long | Indicates whether the payment method is the primary or backup payment method on the account.
Allowable values for primary_indicator_cd:
|
- © Copyright 2023 Aria Developer Central