Skip to main content
Aria Knowledge Central

init_paypal_token_creation_m Guide

The init_paypal_token_creation_m API 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.

API Specification: init_paypal_token_creation_m
Required Fields:
  • <client_no>
  • <auth_key>
  • <acct_no>
  • <client_acct_id>
TOP
  • Was this article helpful?