{"id":6594,"date":"2022-03-29T13:09:06","date_gmt":"2022-03-29T17:09:06","guid":{"rendered":"https:\/\/tranzpay.io\/getting-started-api\/clone-of-hosted-payment-method\/"},"modified":"2025-07-22T16:53:20","modified_gmt":"2025-07-22T20:53:20","slug":"hosted-vault-method","status":"publish","type":"page","link":"https:\/\/tranzpay.io\/getting-started-api\/hosted-vault-method\/","title":{"rendered":"Hosted Vault Method"},"content":{"rendered":"

Hosted Vault Method<\/h2>\n

<\/h2>\n

Overview<\/a><\/h3>\n

This document provides technical specifications for adding customer information and financial data for future rebills through the Tranzpay gateway by interfacing with the Gateway API and a Hosted Vault Entry Page. We have written this specifically for web designers and professionals who implement and support the intended systems. We use HTTPS POST to transmit and receive data.<\/p>\n

Description:<\/b>To reduce your PCI DCSS requirements and liability, and eliminate sensitive card data footprints in your environment, Tranzpay provides a Hosted Vault Solution that provides the ability for customers to add their payment information for future rebills while adhering to all PCI requirements.<\/p>\n

Summary of Steps Required<\/h3>\n
    \n
  1. Send non-secure customer data in initial request to prefill Customer Name, Address, Phone, Email, Policy Number, along with your PostBack and RedirectUrl to capture and store payment results.<\/li>\n
  2. Receive encrypted link via API Response to prefilled vault entry form.<\/li>\n
  3. Using tokenized link, customer will enter payment information to store in PCI secure vault for future use (rebill).<\/li>\n
  4. Data is saved and customer is sent to provided RedirectUrl.<\/li>\n
  5. Provided PostBackUrl receives POST response and stores response in database.<\/li>\n<\/ol>\n

    <\/h2>\n

    Initial Request<\/h3>\n

    <\/h2>\n

    Sample Request<\/h3>\n

    Notes<\/h3>\n

    ThirdPartyCallID<\/b> must be unique to every transaction.PostBackUrl<\/b> is your API page set up to process a POST request containing results of saved entry.RedirectUrl<\/b> is the page the customer will be directed to to view the results of the saved entry from the Postback results provided to the PostBackUrl.CancelUrl<\/b> is the page the customer will be directed to if the vault entry is cancelled before completion, or the session times-out.<\/b>CustomerID<\/b> should be a minimum of 6 characters with no spaces, and a maximum of 45 characters.<\/p>\n

    To test and view the postback response within the page, it is recommended to usedemo.tranzpay.com\/testThirdPartyCheck.php<\/a> in the RedirectUrl field and demo.tranzpay.com\/testSilentPostBack.php<\/a> in the PostBackUrl field. These pages are for demonstration purposes only.<\/p>\n

    <\/h2>\n

    Sample Initial Response<\/h3>\n

    <\/h4>\n

    Postback Response<\/h3>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    \n

    Fieldname<\/p>\n<\/th>\n

    		\n

    Required<\/p>\n<\/th>\n

    		\n

    Type<\/p>\n<\/th>\n

    		\n

    Description<\/p>\n<\/th>\n

    		\n

    Validate<\/p>\n<\/th>\n

    		\n

    Post<\/p>\n<\/th>\n<\/tr>\n<\/thead>\n

    \n

    Status<\/p>\n<\/td>\n

    		<\/td>\n\n

    String<\/p>\n<\/td>\n

    		\n

    Transaction Status<\/p>\n<\/td>\n

    		\n

    SUCCESS or FAILED<\/p>\n<\/td>\n

    		\n

    Status<\/p>\n<\/td>\n<\/tr>\n

    \n

    CustomerID<\/p>\n<\/td>\n

    		<\/td>\n\n

    String<\/p>\n<\/td>\n

    		\n

    Token ID for Vault Entry (Saved Payment Information)<\/p>\n<\/td>\n

    		\n

    Any alphanumeric. Max Len. (45)<\/p>\n<\/td>\n

    		\n

    CustomerID<\/p>\n<\/td>\n<\/tr>\n

    \n

    TransactionType<\/p>\n<\/td>\n

    		<\/td>\n\n

    String<\/p>\n<\/td>\n

    		\n

    Transaction type. (\u201cThirdPartyAddCustomer\u201d)<\/p>\n<\/td>\n

    		\n

    ThirdPartyAddCustomer<\/p>\n<\/td>\n

    		\n

    TransactionType<\/p>\n<\/td>\n<\/tr>\n

    \n

    BankRoutingNumber<\/p>\n<\/td>\n

    		<\/td>\n\n

    String<\/p>\n<\/td>\n

    		\n

    Bank Routing Number.<\/p>\n<\/td>\n

    		\n

    9 Digit Routing Number<\/p>\n<\/td>\n

    		\n

    BankRoutingNumber<\/p>\n<\/td>\n<\/tr>\n

    \n

    AccountNumber<\/p>\n<\/td>\n

    		<\/td>\n\n

    String<\/p>\n<\/td>\n

    		\n

    Bank Account Number.<\/p>\n<\/td>\n

    		\n

    Last 4 Digits of Account Number<\/p>\n<\/td>\n

    		\n

    AccountNumber<\/p>\n<\/td>\n<\/tr>\n

    \n

    BankAccountType<\/p>\n<\/td>\n

    		<\/td>\n\n

    String<\/p>\n<\/td>\n

    		\n

    Bank Account Type.<\/p>\n<\/td>\n

    		\n

    CH = Checking SV = SAVINGS<\/p>\n<\/td>\n

    		\n

    BankAccountType<\/p>\n<\/td>\n<\/tr>\n

    \n

    CardType<\/p>\n<\/td>\n

    		<\/td>\n\n

    String<\/p>\n<\/td>\n

    		\n

    Payment method card type.<\/p>\n<\/td>\n

    		\n

    Visa, Mastercard, Discover, Amex<\/p>\n<\/td>\n

    		\n

    CardType<\/p>\n<\/td>\n<\/tr>\n

    \n

    AccountNumber<\/p>\n<\/td>\n

    		<\/td>\n\n

    Integer<\/p>\n<\/td>\n

    		\n

    Last four digits of account number.<\/p>\n<\/td>\n

    		\n

    Numeric only<\/p>\n<\/td>\n

    		\n

    AccountNumber<\/p>\n<\/td>\n<\/tr>\n

    \n

    ExpirationDateMMYY<\/p>\n<\/td>\n

    		<\/td>\n\n

    Integer<\/p>\n<\/td>\n

    		\n

    2 digit month and 2 digit year<\/p>\n<\/td>\n

    		\n

    06\/24<\/p>\n<\/td>\n

    		\n

    ExpirationDateMMYY<\/p>\n<\/td>\n<\/tr>\n

    \n

    PaymentMethod<\/p>\n<\/td>\n

    		<\/td>\n\n

    String<\/p>\n<\/td>\n

    		\n

    Transaction Payment Type (CC or ACH)<\/p>\n<\/td>\n

    		Cell<\/td>\n\n

    PaymentMethod<\/p>\n<\/td>\n<\/tr>\n

    \n

    AddDate<\/p>\n<\/td>\n

    		<\/td>\n\n

    DateTime<\/p>\n<\/td>\n

    		\n

    AddDate<\/p>\n<\/td>\n

    		Cell<\/td>\n\n

    02\/04\/2020 1:21:30 pm<\/p>\n<\/td>\n<\/tr>\n

    \n

    ThirdPartyCallID<\/p>\n<\/td>\n

    		<\/td>\n\n

    String<\/p>\n<\/td>\n

    		\n

    Unique ID assigned by merchant for transaction.<\/p>\n<\/td>\n

    		\n

    Any alphanumeric. Max Len. (45)<\/p>\n<\/td>\n

    		\n

    ThirdPartyCallID<\/p>\n<\/td>\n<\/tr>\n

    \n

    PolicyNumber<\/p>\n<\/td>\n

    		<\/td>\n\n

    String<\/p>\n<\/td>\n

    		\n

    Customer policy number or equivalent.<\/p>\n<\/td>\n

    		\n

    Any alphanumeric<\/p>\n<\/td>\n

    		\n

    PolicyNumber<\/p>\n<\/td>\n<\/tr>\n

    \n

    Error<\/p>\n<\/td>\n

    		<\/td>\n\n

    String<\/p>\n<\/td>\n

    		\n

    Returned error Message.<\/p>\n<\/td>\n

    		\n

    Any alphanumeric<\/p>\n<\/td>\n

    		\n

    Error<\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

    <\/h4>\n

    Sample Postback Success Return<\/h3>\n

    <\/h4>\n

    Sample Postback Failed Return<\/h3>\n

    Notes<\/h2>\n

    Values above can be fetched in PHP via $_POST variables. Example: on the Post Back url page just use $_POST[\u2018Status\u2019] to fetch \u201cSUCCESS\u201d or \u201cFAILED\u201d<\/span>.<\/p>\n

    <\/h4>\n

    Methodology<\/h3>\n

    Postback response contains \u2018CustomerID\u2019 if the customer\u2019s information was successfully added the vault. Using the \u2018CustomerID\u2019 the following functions are available:<\/p>\n

    Billing a Customer:<\/h3>\n

    To bill a vaulted customer that was previously added to the Customer Vault, provide the CustomerID and then utilize one the following API requests:<\/p>\n

    Credit Card: AddCustomerCCCharge<\/a>ACH: <\/span>AddCustomerACHDebit<\/span><\/a><\/p>\n

    Updating a Vault Record:<\/h3>\n

    To update a customer record in the vault, provide the CustomerID and utilize the UpdateCustomer<\/a> request.<\/p>\n

    View Vault Record:<\/h3>\n

    To view details of a previously stored Vault record, provide the CustomerID and utilize the GetCustomer<\/a> API Request.<\/p>\n

    Test transactions can be submitted with the following information:<\/p>\n\n\n\n\n\n\n\n\n\n\n
    \n

    Card Type<\/p>\n<\/th>\n

    		\n

    Card Number<\/p>\n<\/th>\n<\/tr>\n<\/thead>\n

    \n

    Visa<\/p>\n<\/td>\n

    		\n

    4747474747474747<\/p>\n<\/td>\n<\/tr>\n

    \n

    MasterCard<\/p>\n<\/td>\n

    		\n

    5431111111111111<\/p>\n<\/td>\n<\/tr>\n

    \n

    Discover<\/p>\n<\/td>\n

    		\n

    6011601160116611<\/p>\n<\/td>\n<\/tr>\n

    \n

    American Express<\/p>\n<\/td>\n

    		\n

    341111111111111<\/p>\n<\/td>\n<\/tr>\n

    \n

    Test Server<\/p>\n<\/td>\n

    		\n

    https:\/\/demo.tranzpay.com\/api\/transaction.php<\/p>\n<\/td>\n<\/tr>\n

    \n

    Production Server<\/p>\n<\/td>\n

    		\n

    https:\/\/www.tranzpay.com\/api\/transaction.php<\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n","protected":false},"excerpt":{"rendered":"

    Hosted Vault Method Overview This document provides technical specifications for adding customer information and financial data for future rebills through the Tranzpay gateway by interfacing with the Gateway API and a Hosted Vault Entry Page. We have written this specifically for web designers and professionals who implement and support the intended systems. We use HTTPS […]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":"","tve_updated_post":"","tve_custom_css":"","tve_user_custom_css":"","tve_globals":{},"tcb2_ready":1,"tcb_editor_enabled":1,"tve_landing_page":"tcb2-shapeshift-blank-page","_tve_header":"6404","_tve_footer":"0"},"wf_page_folders":[89],"class_list":["post-6594","page","type-page","status-publish","hentry","post-wrapper","thrv_wrapper"],"_links":{"self":[{"href":"https:\/\/tranzpay.io\/getting-started-api\/wp-json\/wp\/v2\/pages\/6594","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/tranzpay.io\/getting-started-api\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/tranzpay.io\/getting-started-api\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/tranzpay.io\/getting-started-api\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/tranzpay.io\/getting-started-api\/wp-json\/wp\/v2\/comments?post=6594"}],"version-history":[{"count":26,"href":"https:\/\/tranzpay.io\/getting-started-api\/wp-json\/wp\/v2\/pages\/6594\/revisions"}],"predecessor-version":[{"id":1022097,"href":"https:\/\/tranzpay.io\/getting-started-api\/wp-json\/wp\/v2\/pages\/6594\/revisions\/1022097"}],"wp:attachment":[{"href":"https:\/\/tranzpay.io\/getting-started-api\/wp-json\/wp\/v2\/media?parent=6594"}],"wp:term":[{"taxonomy":"wf_page_folders","embeddable":true,"href":"https:\/\/tranzpay.io\/getting-started-api\/wp-json\/wp\/v2\/wf_page_folders?post=6594"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}