Response: Previous Transaction Reference (previous_tran_ref)

Be Aware Of

This parameter behaving the same regardless of the integration type you are using.

In the dynamic realm of online transactions, ensuring seamless and efficient payment processes is crucial. PayTabs introduces the previous_tran_ref parameter, a vital component designed to enhance the follow up transactions tracking and management. This parameter allows merchants to reference their current follow up transaction to its prior/main transaction, facilitating smoother operations for follow-up actions such as captures, refunds, or voids.

By leveraging the previous_tran_ref parameter, businesses can maintain a clear and organized transaction history, ensuring that each subsequent action is accurately linked to its original transaction. This not only aids in better record-keeping but also enhances the overall transaction experience for both merchants and customers.

Understanding the key parameters such as previous_tran_ref, tran_ref, and tran_type enables businesses to effectively understand this parameter, thereby optimizing their payment processing workflows and improving customer satisfaction.

How this parameter could benefit you?

The previous_tran_ref parameter can provide a more streamlined and efficient transaction management experience, benefiting your business operations.

Enhanced Transaction Tracking: By referencing previous transactions, you can easily track and manage follow-up actions such as captures, refunds, or voids, ensuring a clear and organized transaction history.

Improved Record-Keeping: Maintaining a link to the original transaction helps in better record-keeping, making it easier to audit and review transaction histories.

Streamlined Operations: With the previous_tran_ref parameter, subsequent transactions are seamlessly connected to their original ones, reducing the complexity of managing multiple related transactions.

Versatility Across Use Cases: : Whether it’s for capturing payments, processing refunds, or handling voids, the previous_tran_ref parameter can be utilized across various transaction scenarios, making it a versatile tool for your business.

Reduced Operational Overhead: By automating the linkage between transactions, you can reduce the manual effort required to manage and reconcile transactions, leading to operational efficiencies.

Better Dispute Resolution: Having a clear reference to previous transactions aids in resolving disputes more effectively, as all related transaction details are easily accessible.

Name but a few different Businesses/Industries that can benefit from this API parameter:

E-Commerce Systems: Ensures smooth handling of returns, refunds, and exchanges.

Hospitality: Facilitates easy management of booking modifications and cancellations.

Subscription Services: Simplifies the process of handling subscription changes and refunds.

Financial Services: Enhances the accuracy and efficiency of transaction processing and dispute resolution.

Retail: Streamlines the management of post-purchase actions like refunds and exchanges.

When Will You Receive This Parameter?

Understanding the specific scenarios in which the previous_tran_ref parameter is included in the response payload can help you effectively utilize it in your transaction response handling. Here are some common situations:

Capture Transactions: As clarified in theCapture manual, when a capture transaction is processed, the previous_tran_ref parameter is included to reference the original authorization transaction. This helps in linking the capture to its corresponding authorization.

Refund Transactions: Also as clarified in theRefund manual, during a refund process, the previous_tran_ref parameter is provided to reference the original transaction being refunded. This ensures that the refund is accurately associated with the initial payment.

Void Transactions: As well as clarified in theVoid manual, when voiding a transaction, the previous_tran_ref parameter is included to reference the original transaction that is being voided. This helps in maintaining a clear transaction history.

Release Transactions: As well as clarified in theRelease manual, when releasing a partial amount from a transaction, the previous_tran_ref parameter is included to reference the original transaction that is being partially voided. This helps in maintaining a clear transaction history.

Recurring Transactions: As mentioned in theToken-Based Transactions manual, for recurring payment setups, the previous_tran_ref parameter will be included to reference the initial/main transaction that created the token in the first place, ensuring continuity and accurate tracking of subsequent payments.

How it Works?

In order for you to understand more how the previous_tran_ref parameter could benefit you, you kindly need to check the below simple steps:

Capture
Refund
Void
Release
Recurring Payments

Within the initiation of the request payload for the capture (or partially capture) follow-up transaction or what we call in Step 7, managing your transactions, you will pass the capture action/value into the parametertran_type.
```
{
    .
    .
    "tran_type":"capture",
    "cart_amount": 100,
    .
    .
}
```

Along with the request (object), you will have to pass the main/parent transaction reference, which you want to capture (or partially capture) the provided amount from, within a parameter calledtran_ref. This of-course coming along with passing the needed other information such as the amount and so, as clarified in the below sample:
```
{
    .
    .
    "tran_type":"capture",
    "cart_amount": 100,
    "tran_ref": "TST2016700000XXX"
    .
    .
}
```

Once you post your request, you will receive a response that includes the newtran_refof the new transaction created/captured, along with the previous_tran_ref of the main/parent transaction. This means the amount has been captured successfully from the old previous_tran_ref transaction within the newtran_reftransaction.

You Should Know
To know more about how you can receive this parameter, and what are the different ways you can receive this parameter with, you may need to check ourWhat are the Five (5) ways of receiving transaction response?
```
{
    .
    .
    "tran_ref": "TST2016700000XX1",
    "previous_tran_ref": "TST2016700000XXX"
    .
    .
}
```

Finally, you will be able to see this new transaction connected to the main/parent transaction as well on your merchant dashboard, whether it's accepted/authorized or not.

Within the initiation of the request payload for the refund follow-up transaction or what we call in Step 7, managing your transactions, you will pass the refund action/value into the parametertran_type.
```
{
    .
    .
    "tran_type":"refund",
    "cart_amount": 100,
    .
    .
}
```

Along with the request (object), you will have to pass the main/parent transaction reference, which you want to refund the provided amount from, within a parameter calledtran_ref. This of-course coming along with passing the needed other information such as the amount and so, as clarified in the below sample:
```
{
    .
    .
    "tran_type":"refund",
    "cart_amount": 100,
    "tran_ref": "TST2016700000XXX"
    .
    .
}
```

Once you post your request, you will receive a response that includes the newtran_refof the new transaction created/refundd, along with the previous_tran_ref of the main/parent transaction. This means the amount has been refundd successfully from the old previous_tran_ref transaction within the newtran_reftransaction.

You Should Know
To know more about how you can receive this parameter, and what are the different ways you can receive this parameter with, you may need to check ourWhat are the Five (5) ways of receiving transaction response?
```
{
    .
    .
    "tran_ref": "TST2016700000XX1",
    "previous_tran_ref": "TST2016700000XXX"
    .
    .
}
```

Finally, you will be able to see this new transaction connected to the main/parent transaction as well on your merchant dashboard, whether it's accepted/authorized or not.

Tip
Only in your merchant dashboard view, you will see the full history of the transaction. For example, if a refund has been processed on a transaction that has been captured from an auth one, both of them will be displayed in the "Previous" row.

Within the initiation of the request payload for the void follow-up transaction or what we call in Step 7, managing your transactions, you will pass the void action/value into the parametertran_type.
```
{
    .
    .
    "tran_type":"void",
    "cart_amount": 100,
    .
    .
}
```

Along with the request (object), you will have to pass the main/parent transaction reference, which you want to void, within a parameter calledtran_ref. This of-course coming along with passing the needed other information such as the amount and so, as clarified in the below sample:

Be Aware Of
To perform a void transaction you MUST pass the whole transaction amount. Any partial amount would be passed, the transaction will be considered release instead of void
```
{
    .
    .
    "tran_type":"void",
    "cart_amount": 100,
    "tran_ref": "TST2016700000XXX"
    .
    .
}
```

Once you post your request, you will receive a response that includes the newtran_refof the new transaction created/voided, along with the previous_tran_ref of the main/parent transaction. This means the amount has been voided successfully from the old previous_tran_ref transaction within the newtran_reftransaction.

You Should Know
To know more about how you can receive this parameter, and what are the different ways you can receive this parameter with, you may need to check ourWhat are the Five (5) ways of receiving transaction response?
```
{
    .
    .
    "tran_ref": "TST2016700000XX1",
    "previous_tran_ref": "TST2016700000XXX"
    .
    .
}
```

Finally, you will be able to see this new transaction connected to the main/parent transaction as well on your merchant dashboard, whether it's accepted/authorized or not.

Within the initiation of the request payload for the release follow-up transaction or what we call in Step 7, managing your transactions, you will pass the release action/value into the parametertran_type.
```
{
    .
    .
    "tran_type":"release",
    "cart_amount": 100,
    .
    .
}
```

Along with the request (object), you will have to pass the main/parent transaction reference, which you want to release the provided amount from, within a parameter calledtran_ref. This of-course coming along with passing the needed other information such as the amount and so, as clarified in the below sample:

Be Aware Of
To perform a release transaction you MUST pass a partial transaction amount. If the whole amount has been passed, the transaction will be considered void instead of release
```
{
    .
    .
    "tran_type":"release",
    "cart_amount": 100,
    "tran_ref": "TST2016700000XXX"
    .
    .
}
```

Once you post your request, you will receive a response that includes the newtran_refof the new transaction created/released, along with the previous_tran_ref of the main/parent transaction. This means the amount has been released successfully from the old previous_tran_ref transaction within the newtran_reftransaction.

You Should Know
To know more about how you can receive this parameter, and what are the different ways you can receive this parameter with, you may need to check ourWhat are the Five (5) ways of receiving transaction response?
```
{
    .
    .
    "tran_ref": "TST2016700000XX1",
    "previous_tran_ref": "TST2016700000XXX"
    .
    .
}
```

Finally, you will be able to see this new transaction connected to the main/parent transaction as well on your merchant dashboard, whether it's accepted/authorized or not.

Within the initiation of the request payload for the recurring payment in Step 3 - initiating the payment, via theToken-Based Transactions manual, you will need yo pass the recurring value in thetran_class.
```
{
    .
    .
    "tran_class":"recurring",
    .
    .
}
```

Along with the request (object), you will have to pass the main/parent transaction reference, which you want to recur the payment accordingly within a parameter calledtran_ref. This of-course coming along with passing the needed other information such as the amount and so, as clarified in the below sample:
```
{
    .
    .
    "tran_class":"recurring",
    "cart_amount": 100,
    "tran_ref": "TST2016700000XXX"
    .
    .
}
```

Once you post your request, you will receive a response that includes the newtran_refof the new transaction created/recurred, along with the previous_tran_ref of the main/parent transaction. This means the amount has been recurred/debited successfully according to the token initiated from the old previous_tran_ref transaction within the newtran_reftransaction.

You Should Know
To know more about how you can receive this parameter, and what are the different ways you can receive this parameter with, you may need to check ourWhat are the Five (5) ways of receiving transaction response?
```
{
    .
    .
    "tran_ref": "TST2016700000XX1",
    "previous_tran_ref": "TST2016700000XXX"
    .
    .
}
```

Finally, you will be able to see this new transaction connected to the main/parent transaction as well on your merchant dashboard, whether it's accepted/authorized or not.

Parameter Specifications

previous_tran_ref

Parameter	`previous_tran_ref`
Description	the previous transactions response is the parameter that indicates the prior/main transaction related to current transaction.
Data Type	String
Required	✘
Sample	`{ "previous_tran_ref": "TST2234701408XXX" }`