init_paypal_token_creation_m
Summary
| API Name | init_paypal_token_creation_m |
|---|---|
| Class | transaction_services_m |
| Update Version | 70 |
Description
Creates a session with PayPal so that an account user can set up a billing agreement with an Aria client. The call returns a session token from PayPal, plus a client configured return_url (aka PayPal Agreement Confirmation URL) to instruct the USS/Reg software where it should direct the end user for the next step. PayPal will consider the token valid for 15 minutes. This API call does not store any information in the Aria database, but requires that the followup call to save_paypal_bill_agreement call is made while the token is valid. If Billing group inputs are provided then we will try to attempt the token creation action using Billing group's Collection group and store the created payment method as primary pay method of the billing group.Please note these billing group inputs are optional. If Billing group inputs are not provided, then we will use the account's collection group. We need to ensure consistency when providing billing group inputs for the init_paypal_token_creation_m and complete_paypal_token_creation_m APIs. If billing group inputs are provided, they must be included in both APIs. otherwise, they can be skipped from both APIs.
Inputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| client_no | long | 22 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
| auth_key | string | 32 | No |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
| acct_no | long | Yes |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. Alternative required field: client_acct_id |
|
| client_acct_id | string | 50 | Yes |
Client-defined account identifier. Alternative required field: acct_no |
| amount | double | No |
The monetary amount of the electronic authorization. This should be greater than 0 (zero). |
|
| billing_group_no | long | 22 | No |
The unique identifier of the billing group. Alternative field: client_billing_group_id, master_plan_instance_no, or client_master_plan_instance_id |
| client_billing_group_id | string | 100 | No |
The client-defined identifier of the billing group. Alternative field: billing_group_no, master_plan_instance_no, or client_master_plan_instance_id |
| master_plan_instance_no | long | 22 | No |
The unique identifier of the master plan instance. Alternative field: billing_group_no, client_billing_group_id, or client_master_plan_instance_id |
| client_master_plan_instance_id | string | 100 | No |
The client-defined identifier of the master plan instance. Alternative field: billing_group_no, client_billing_group_id, or master_plan_instance_no |
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error. |
|
| error_msg | string | No |
Description of any error that occurred. "OK" if there was no error. |
|
| proc_status_code | string | No |
The processor status code |
|
| proc_status_text | string | No |
The processors status description |
|
| agreement_confirmation_url | string | No |
The redirect URL provided by PayPal where the customer is sent to authenticate their PayPal account and approve wallet access for the specified Aria account. This URL must be used to complete the authorization step of wallet token creation. |
|
| request_token | string | No |
A temporary/initial PayPal token generated during the initialization step, returned after invoking PayPal's setup API. This token is passed back to Aria via the completion API (complete_paypal_token_creation_m) once the customer has confirmed the agreement on PayPal's side. |
|
| billing_group_no | long | 22 | No |
The unique identifier of the billing group. |