You have two options for accepting payments on websites.

1. Processing the payments using payment APIs and sending the card details to Telgoo5 via API

2. Processing the payments using Stripe hosted checkout pages.

 

 

Processing the payments using payment APIs and sending the card details to Telgoo5 via API

If you want to process the payments by sending card details to Telgoo5 via API. You need to ensure to setup payment gateway in Telgoo5.

 

• Authorize.net
• Cybersource
• Stripe
• Global Payments
• Payeezy
• Braintree
• Cardknox
• Affirm

1. Navigate to Payment Gateway Settings: In Telgoo5, go to the Payment Gateway (PC239) section in the settings.

 

2. Add a New Gateway: On the screen displaying default or existing payment gateways, click on the   "Add" button located at the top right corner to integrate another payment gateway.

 

 

3. Enter Gateway Details: Fill in the required details to proceed with the integration. Here are the fields you need to complete:

• • Select Payment Gateway: Choose the desired payment gateway from the drop-down menu.
  • API Login ID: Enter the API login ID provided by the chosen payment gateway.
  • Transaction Key: Input the transaction key provided by the payment gateway.
  • Currency: Specify the currency in which you want to accept payments.
  • Nickname: Assign a nickname or keyword for easy identification of the payment gateway.
  • Allow International Card: Specify whether international cards are allowed for transactions (Yes/No).
  • Payment Mode: Choose between sandbox (testing) or production mode for payment processing.
  • Status: Set the status of the payment gateway as active or inactive.
  • Allowed Card Type: Specify the types of cards allowed for transactions (e.g., Mastercard, Visa, Discover, American Express, Unipay)

 

4. Hit 'Submit'.

 

 

Processing the payments using Stripe hosted checkout pages.

In order to process payments using Strip hosted checkout page you will first need to setup checkout process in Stripe, please refer to the checkout process setup documentation in Stripe.

Stripe Checkout Documentation

 

There are two APIs which will be used to full fill this operation.

1. make_payment API: Will be used to register the payment in Telgoo5 and to save the card.
2. set_autopay API: Will be used to set the autopay on the account for the customer's opted plan on the account.

 

make_payment API

make_payment API is used to capture a payment in Telgoo5 using customer's credit/debit card; you are needed to pass the card information in the API. When you send the card information in the make_payment API, Telgoo5 sends it to the integrated payment gateway e.g. Stripe, via APIs and processes the payment.

However, when you use Stripe hosted payment page to accept the payment, the card collection and payment processing directly happens in Stripe and there is no communication between Telgoo5 and Stripe. Since the card info is also collected directly on Stripe hosted page you don't have a way to send the card info to Telgoo5 to save it.

In order to mitigate this situation and to fetch the card and customer information directly from Stripe a modified version of the make_payment API can be used.

 

make_payment API modified version

 

After collecting the payment on Stripe hosted checkout page you need to call make_payment API in Telgoo5 to record the payment transaction in Telgoo5. In this situation you will not have the card information.

Therefore,

for the payment_method you will send the value as "payment_method": "OTHER_PAYMENT_OPTION"
and for the payment_method_option you will send the value as "payment_method_option": "STRIPE"

Sending the values like explained above will tell Telgoo5 system that the card is not needed and payment is already collected outside Telgoo5 system and we only have to record the payment entry.

Now, in order to fetch the card from Stripe and save it on the customer's account in Telgoo5 for future payment we need payment_methods id from Stripe in "transaction_id" field of make_payment API.

On the basis of payment_method id from Stripe which you will send to Telgoo5 in "transaction_id" field Telgoo5 will retrieve customer information and card details directly from Stripe and will save it on the customer's account for future payments. Make sure to send save_card field as Y in the make_payment API other wise we will not save it.

 

Sample request

{
"action": "make_payment",
"enrollment_id": "WN5667",
"zip_code": "98104",
"plan_id": "117",
"billing_state": "OH",
"billing_city": "The Plains",
"billing_zip": "45780",
"billing_address1": "24 Roy Ave",
"billing_address2": "",
"payment_method": "OTHER_PAYMENT_OPTION",
"payment_method_option": "STRIPE",
"transaction_id": "pm_3P0kH6FFfIdOn123213",
"save_card": "Y",
"payment_type": "NEW_SIGNUP",
"no_of_lines": "1",
"source": "API",
"request_name": "payment",
"agent_id": "your_agent",
"vendor_id": "your_vendor"
} 

 

 

set_autopay API

This API is used to set auto pay on customer's account. Similar to make_payment API when you are using Stripe hosted checkout you will not have the card information to send to Telgoo5 to set the autopay on the card and therefore you will have to you the modified version set_autopay API to set the autopay on the account.

 

For the payment_method you will send the value as "payment_method": "OTHER_PAYMENT_OPTION"
and for the payment_method_option you will send the value as "payment_method_option": "STRIPE"

Sending the values like explained above will tell Telgoo5 system that the card is not needed.

 

Now, in order to fetch the card from Stripe and set autopay  on the customer's account in Telgoo5 for future payment we need payment_methods id from Stripe in "transaction_id" field of make_payment API.

On the basis of payment_method id from Stripe which you will send to Telgoo5 in "transaction_id" field Telgoo5 will retrieve customer information and card details directly from Stripe and will save it on the customer's account for future payments.

 

Sample request

{
"enrollment_id": "WN4339",
"plan_id": "117",
"billing_state": "LA",
"billing_city": "Lutcher",
"billing_zip": "70071",
"billing_address1": "2391 NORTH ALBERT STREET ",
"billing_address2": null,
"payment_method": "OTHER_PAYMENT_OPTION",
"payment_method_option": "STRIPE",
"transaction_id": "pm_3P0iP1FFfIdOnzHC0NX6bygw",
"action": "set_autopay",
"agent_id": "ewebsiteapi",
"source": "WEBSITE",
"autopay_type": "PLAN",
"request_name": "autopay",
"vendor_id": "your_vendor"
}