Skip to content

Latest commit

 

History

History
94 lines (65 loc) · 3.24 KB

README.md

File metadata and controls

94 lines (65 loc) · 3.24 KB
Raw

Overview

The examples provided in this project are meant to illustrate how to use the TRACT Hosted Payment Iframe browser-based payment capture to meet your business needs.

The examples require an initial authenticated call to TRACT via a secure mechanism to retrieve a referrer token. This referrer token is short-lived and allows a developer to make calls against the TRACT Payment service in a temporarily authenticated manner from a client browser. This token can be used only once to create a temporary payment method in TRACT. A payment token is provided for this temporary payment method which is then used to add a payment method to a billing account.

Prerequisites

  • node.js is installed on your environment

  • Navigate to root /hosted-payment-iframe folder and do the following

    • npm install
    • This will install all the requirements required to run the samples.

  • A TRACT tenant

    • goTransverse Customer Support will provide the domain name for your TRACT instance, (e.g. demo.tractbilling.com for the purposes of these examples)
    • goTransverse Customer Support will provide an api account for you TRACT tenant.

    NOTE:
    A customer-defined and managed origin domain that will host the page is required. goTransverse Customer Support will need to configure a hosted payment page endpoint with this origin domain. This is required so that an X-Frame-Options header can be properly enabled for this origin domain. A single origin domain can be used for multiple tenants within a single TRACT environment, however a different domain is required per environment (eg. dev.my-domain.com versus stage.my-domain.com versus prod.my-domain.com).

Getting a Referrer Token

Using a tool like Postman, construct an HTTP post using either JSON REST API or XML REST API.

JSON REST API Example

POST https://demo.tractbilling.com/billing/2/payments/generate-token

Request Headers

Authorization: No Auth

X-api-key: Your provisioned API key

Content-Type: application/json

Request Body

{
  "error_url": "https://gotransverse.com?error",
  "cancel_url": "https://gotransverse.com?cancel",
  "complete_url": "https://gotransverse.com?complete"
}

Response Body

{
    "token": "9235d441-edf6-4a76-bcc3-48f2c3ab93cc"
}

XML REST API Example

POST https://demo.tractbilling.com/t/s/r/1.33/payments/referrerToken

Request Headers

Authorization: Basic <auth>

Content-Type: application/xml

Where <auth> is the base64 encoded <your-username>:<your-password>

Request Body

<?xml version="1.0" encoding="UTF-8"?>
<generatePaymentCollectionReferrerToken xmlns="http://www.tractbilling.com/billing/1_33/domain">
    <errorUrl>http://localhost:1111/error.html</errorUrl>
    <cancelUrl>http://localhost:1111/cancel.html</cancelUrl>
    <completeUrl>http://localhost:1111/success.html</completeUrl>
</generatePaymentCollectionReferrerToken>

Response Body

<?xml version="1.0" encoding="UTF-8"?>
<referrer xmlns="http://www.tractbilling.com/billing/1_33/domain" referrerToken="d88f9360-e192-412e-8892-9f5adb24e844"/>