Preauthorization Result
Preauthorization response including status, amounts, fees, and settlement details. Fields marked as conditional are only returned under certain conditions.
ABN for the transaction.
Payment Card No.
Additional reference. (Conditional).
Base amount of the payment is done.
Card category.
Recalled date. Date Format: yyyy-MM-ddTHH:mm:ss, TimeZone: AEST (Conditional).
Reason. (Conditional).
ChargedBackedTransactionReference : If a charge transaction is charged back then this is transaction reference of charged back transaction.(Conditional).
Fee charged on customer card.
Customer who paid the payment.
Reference of the Customer who paid the payment.
Failure code if the payment failed. Please refer: http://tinyurl.com/y6lkmpsv for more details. (Conditional).
Failure reason if the payment failed. (Conditional).
Funds to Merchant.
Payment Charge Backed.
Payment recalled.
Payment refunded.
Whether a retry payment is pending. Based on Program/Merchant settings, a failed payment will be retried.
Whether the payment has been settled to the merchant.
Merchant code.
Fee charged on Merchant.
Merchant trading name.
Unique payment id provided by the merchant. (Conditional).
One Off Payment Reference.
OriginalTransactionReference : For a Recall / Refund transaction, it is the transaction reference of original transaction.
Payment Account by which the payment is done.
Payment card used.
Payment source of transaction.
Total payment amount including the fees.
Preauth Expires at.
Unique Payment Reference for the payment done.
Current Status of the payment. Expected Statuses
- Pending This Payment is waiting be to processed
- Error - This Payment has encountered an Error
- Submitted - This Payment was successfully submitted
- Successful - This Payment was successful
- Successful(Recalled) - This Payment was Recalled
- Successful(Refunded) - This Payment was Refunded
- Successful (Refunded) (Recalled) - This Payment was Refunded and Recalled
- Failed - This Payment has Failed
- Cancelled - This Payment was Cancelled
- Suppressed - This Payment was Suppressed
- InProgress - This Payment is being processed.
Processing Date for the payment. Date Format: yyyy-MM-ddTHH:mm:ss, TimeZone: AEST.
Processor reference for the payment done.
Recalled date. Date Format: yyyy-MM-ddTHH:mm:ss, TimeZone: AEST (Conditional).
Reason. (Conditional).
RecalledTransactionReference : If a charge transaction is recalled then this is transaction reference of recall transaction.(Conditional).
3DSecure redirect url to complete the 3DSecure challege if required by the scheme.
Refunded date. Date Format: yyyy-MM-ddTHH:mm:ss, TimeZone: AEST (Conditional).
Reason. (Conditional).
RefundedTransactionReference : If a charge transaction is refunded then this is transaction reference of refunded transaction.(Conditional).
Remaining preauth amount after one or more captures.
Retry payment reference. (Conditional).
Retry payment scheduled date. Date Format: yyyy-MM-ddTHH:mm:ss, TimeZone: AEST (Conditional).
Settlement Date for the payment. This is a calculated date and may change until the payment been settled. Date Format: yyyy-MM-ddTHH:mm:ss, TimeZone: AEST.
Transaction type numeric code.
| Enum Value | Description |
|---|---|
| 1 | Charge |
| 2 | InvoicePayment |
| 3 | Refund |
| 4 | Chargeback |
| 5 | Recall |
| 6 | FixedTermSettlement |
| 7 | SponsorInvoicePayment |
| 8 | MerchantSettlementAdjustmentPayment |
| 9 | Preauthorization |
| 10 | Credit |
Transaction Type. Possible values:
- Charge
- Invoice
- Refund
- Chargeback
- Recall
- Fixed Term Settlement.
{
"abn": "string",
"accountOrCardNo": "string",
"additionalReference": "string",
"baseAmount": 0,
"cardCategory": "string",
"chargeBackedOn": "2024-07-29T15:51:28.071Z",
"chargeBackedReason": "string",
"chargeBackedTransactionReference": "string",
"customerFee": 0,
"customerName": "string",
"customerReference": "string",
"failureCode": "string",
"failureReason": "string",
"fundsToMerchant": 0,
"isPaymentChargeBacked": true,
"isPaymentRecalled": true,
"isPaymentRefunded": true,
"isPaymentRetryScheduled": true,
"isPaymentSettledToMerchant": true,
"merchantCode": "string",
"merchantFee": 0,
"merchantName": "string",
"merchantUniquePaymentId": "string",
"oneOffPaymentReference": "string",
"originalTransactionReference": "string",
"paymentAccount": "string",
"paymentCard": "string",
"paymentSourceDisplay": "string",
"preauthAmount": 0,
"preauthExpiryAt": "2024-07-29T15:51:28.071Z",
"preauthReference": "string",
"preauthStatus": "string",
"processingDate": "2024-07-29T15:51:28.071Z",
"processorReference": "string",
"recalledOn": "2024-07-29T15:51:28.071Z",
"recalledReason": "string",
"recalledTransactionReference": "string",
"redirectUrl": "string",
"refundedOn": "2024-07-29T15:51:28.071Z",
"refundedReason": "string",
"refundedTransactionReference": "string",
"remainingPreauthAmount": 0,
"retryPaymentReference": "string",
"retryScheduledOn": "2024-07-29T15:51:28.071Z",
"settlementDate": "2024-07-29T15:51:28.071Z",
"transactionType": 1,
"transactionTypeDisplay": "string"
}