{"id":6586,"date":"2022-03-29T12:58:49","date_gmt":"2022-03-29T16:58:49","guid":{"rendered":"https:\/\/tranzpay.io\/getting-started-api\/clone-of-ach-method-2\/"},"modified":"2025-07-22T16:52:34","modified_gmt":"2025-07-22T20:52:34","slug":"hosted-payment-method","status":"publish","type":"page","link":"https:\/\/tranzpay.io\/getting-started-api\/hosted-payment-method\/","title":{"rendered":"Hosted Payment Method"},"content":{"rendered":"

Hosted Payment Method<\/h2>\n

<\/h2>\n

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

This document provides technical specifications for processing financial transactions through the Tranzpay gateway by interfacing with the Gateway API and a Hosted Payment Page. We have written this specifically for web designers and professionals who design, 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 Payment Page Solution that provides the ability to authorize and capture transactions while adhering to all PCI requirements.Summary of Steps Required<\/p>\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 payment link via API Response to prefilled payment form.<\/li>\n
  3. Using tokenized payment link, customer will enter payment information and has the option to save information for future use (rebill).<\/li>\n
  4. Payment is processed and customer is sent to provided RedirectUrl to view transaction results.<\/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<\/p>\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 the transaction.RedirectUrl<\/b> is the page the customer will be directed to to view the results of the transaction from the Postback results provided to the PostBackUrl.CancelUrl<\/b> is the page the customer will be directed to if the transaction is cancelled before completion, or the session times-out.AddVault<\/b> should be \u201cY\u201d to give customer the option to save payment information for future use in the Customer Vault. If \u201cN\u201d the option will not be displayed to customer.CustomerID<\/b> should be a minimum of 6 characters, maximum of 45 characters with no spaces.<\/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\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

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

    		<\/td>\n\n

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

    		\n

    Transaction type to process. (\u201cThirdParty\u201d)<\/p>\n<\/td>\n

    		\n

    ThirdParty<\/p>\n<\/td>\n

    		\n

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

    \n

    ResponseMessage<\/p>\n<\/td>\n

    		<\/td>\n\n

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

    		\n

    Transaction Response Message<\/p>\n<\/td>\n

    		\n

    APPROVED or DECLINED<\/p>\n<\/td>\n

    		\n

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

    \n

    ResponseCode<\/p>\n<\/td>\n

    		<\/td>\n\n

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

    		\n

    Transaction Response Code<\/p>\n<\/td>\n

    		\n

    00=Approved<\/p>\n<\/td>\n

    		\n

    ResponseMessage<\/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, American Express<\/p>\n<\/td>\n

    		\n

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

    \n

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

    		<\/td>\n\n

    String<\/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

    String<\/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

    TransactionDate<\/p>\n<\/td>\n

    		<\/td>\n\n

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

    		\n

    TransactionDate<\/p>\n<\/td>\n

    		Cell<\/td>\n\n

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

    \n

    TransactionAmount<\/p>\n<\/td>\n

    		<\/td>\n\n

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

    		\n

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

    		\n

    Float<\/p>\n<\/td>\n

    		\n

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

    \n

    BaseAmount<\/p>\n<\/td>\n

    		<\/td>\n\n

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

    		\n

    BaseAmount<\/p>\n<\/td>\n

    		\n

    Float<\/p>\n<\/td>\n

    		\n

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

    \n

    BillingNameFirst<\/p>\n<\/td>\n

    		<\/td>\n\n

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

    		\n

    Billing First Name<\/p>\n<\/td>\n

    		\n

    Enter your text here…<\/p>\n<\/td>\n

    		\n

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

    \n

    BillingNameLast<\/p>\n<\/td>\n

    		<\/td>\n\n

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

    		\n

    Billing Last Name<\/p>\n<\/td>\n

    		Cell<\/td>\n\n

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

    \n

    BillingFullName<\/p>\n<\/td>\n

    		<\/td>\n\n

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

    		\n

    Billing Full Name<\/p>\n<\/td>\n

    		Cell<\/td>\n\n

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

    \n

    BillingAddress<\/p>\n<\/td>\n

    		<\/td>\n\n

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

    		\n

    Billing Address<\/p>\n<\/td>\n

    		Cell<\/td>\n\n

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

    \n

    BillingCity<\/p>\n<\/td>\n

    		<\/td>\n\n

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

    		\n

    Billing City<\/p>\n<\/td>\n

    		Cell<\/td>\n\n

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

    \n

    BillingState<\/p>\n<\/td>\n

    		<\/td>\n\n

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

    		\n

    Billing State<\/p>\n<\/td>\n

    		Cell<\/td>\n\n

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

    \n

    BillingZip<\/p>\n<\/td>\n

    		<\/td>\n\n

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

    		\n

    Billing Zip Code<\/p>\n<\/td>\n

    		Cell<\/td>\n\n

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

    \n

    AuthCode<\/p>\n<\/td>\n

    		<\/td>\n\n

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

    		\n

    Authorization Code<\/p>\n<\/td>\n

    		\n

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

    		\n

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

    \n

    AvsRsltCode<\/p>\n<\/td>\n

    		<\/td>\n\n

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

    		\n

    AVS Result Code<\/p>\n<\/td>\n

    		\n

    \u2018Y\u2019or \u2018N\u2019<\/p>\n<\/td>\n

    		\n

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

    \n

    TransactionID<\/p>\n<\/td>\n

    		<\/td>\n\n

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

    		\n

    Id unique to transaction on the payment gateway<\/p>\n<\/td>\n

    		Cell<\/td>\n\n

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

    \n

    CVV2ResponseMessage<\/p>\n<\/td>\n

    		<\/td>\n\n

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

    		\n

    CVV2 Response Message<\/p>\n<\/td>\n

    		Cell<\/td>\n\n

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

    \n

    CVV2ResponseCode<\/p>\n<\/td>\n

    		<\/td>\n\n

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

    		\n

    CVV2 Response Code<\/p>\n<\/td>\n

    		Cell<\/td>\n\n

    CVV2ResponseCode<\/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

    AddVault<\/p>\n<\/td>\n

    		<\/td>\n\n

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

    		\n

    \u2018Y\u2019 if the payment data was saved to Vault. \u2018N\u2019 for No.<\/p>\n<\/td>\n

    		\n

    \u2018Y\u2019or \u2018N\u2019<\/p>\n<\/td>\n

    		\n

    AddVault<\/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<\/p>\n<\/td>\n

    		\n

    Min. Len (6) Max Len. (45)<\/p>\n<\/td>\n<\/tr>\n

    \n

    PolicyNum<\/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

    PolicyNum<\/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

    \n

    StatusMessage<\/p>\n<\/td>\n

    		<\/td>\n\n

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

    		\n

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

    		\n

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

    		\n

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

    \n

    BankName<\/p>\n<\/td>\n

    		<\/td>\n\n

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

    		\n

    Bank Name<\/p>\n<\/td>\n

    		\n

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

    		\n

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

    \n

    AuthOnly<\/p>\n<\/td>\n

    		<\/td>\n\n

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

    		\n

    Auth Only<\/p>\n<\/td>\n

    		\n

    Y or N<\/p>\n<\/td>\n

    		\n

    AuthOnly<\/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:<\/b>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.Even if Initial Request passes AddVault=Y, if the customer does not opt to save payment information for future use (via the checkbox to save payment information), the Postback will exclude a CustomerID and return AddVault=N. This is the same for both SUCCESS and FAILED transaction responses.<\/p>\n

    <\/h4>\n

    Methodology<\/h3>\n

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

    Voiding a transaction:<\/h3>\n

    Supply the TransactionID from the original transaction, and utilize the CreditCardVoid<\/a> or the ACHVoid<\/a> request. Transactions may only be voided before they settle. For settled transactions, please see Refunding a Transaction below.<\/p>\n

    Refunding a transaction:<\/h3>\n

    After a transaction has settled, you will need to issue a refund, rather than void. Provide a TransactionID and TransactionAmount to utilize the CreditCardCredit<\/a> or the ACHRefund<\/a> request.<\/p>\n

    Check Status:<\/h3>\n

    To check the status of a transaction, use the TransactionID and utilize the GetTransaction<\/a> request.<\/p>\n

    Rebilling a Customer:<\/h3>\n

    To rebill a 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: AddCustomerACHDebit<\/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","protected":false},"excerpt":{"rendered":"

    Hosted Payment Method Overview This document provides technical specifications for processing financial transactions through the Tranzpay gateway by interfacing with the Gateway API and a Hosted Payment Page. We have written this specifically for web designers and professionals who design, implement and support the intended systems. We use HTTPS POST to transmit and receive data. […]<\/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-6586","page","type-page","status-publish","hentry","post-wrapper","thrv_wrapper"],"_links":{"self":[{"href":"https:\/\/tranzpay.io\/getting-started-api\/wp-json\/wp\/v2\/pages\/6586","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=6586"}],"version-history":[{"count":38,"href":"https:\/\/tranzpay.io\/getting-started-api\/wp-json\/wp\/v2\/pages\/6586\/revisions"}],"predecessor-version":[{"id":1022096,"href":"https:\/\/tranzpay.io\/getting-started-api\/wp-json\/wp\/v2\/pages\/6586\/revisions\/1022096"}],"wp:attachment":[{"href":"https:\/\/tranzpay.io\/getting-started-api\/wp-json\/wp\/v2\/media?parent=6586"}],"wp:term":[{"taxonomy":"wf_page_folders","embeddable":true,"href":"https:\/\/tranzpay.io\/getting-started-api\/wp-json\/wp\/v2\/wf_page_folders?post=6586"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}