Payment Result
Payment 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.
additionalData object
Acquirer and issuer references for the transaction, returned for card payments.
Authorisation code returned by the card issuer.
Retrieval reference number assigned by the acquirer, used when tracing the transaction with them.
System trace audit number identifying the transaction on the acquirer's network.
Additional reference. (Conditional).
Base amount of the payment is done.
Card category.
Card scheme the payment was processed on, as text. For example: MasterCard.
Card scheme the payment was processed on, as its numeric code. Pairs with cardTypeString.
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).
chargebacks object[]
All chargebacks processed on this payment.
Fee charged on Customer.
Fee charged on Merchant.
Total payment amount including the fees.
Refund/Recall date. Date Format: yyyy-MM-ddTHH:mm:ss, TimeZone: AEST (Conditional).
Reason. (Conditional).
Current Status of the refund/recall. Expected Statuses
- Pending This refund/recall is waiting be to processed
- Error - This refund/recall has encountered an Error
- Submitted - This refund/recall was successfully submitted
- Successful - This refund/recall was successful
- Failed - This refund/recall has Failed
- Cancelled - This refund/recall was Cancelled
- Suppressed - This refund/recall was Suppressed
- InProgress - This refund/recall is being processed.
TransactionReference : If a charge transaction is refunded/recalled then this is transaction reference of that transaction.(Conditional).
Unique customer code if the customer exists in the system.
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.
Reference for the merchant settlement this payment was paid out in. Empty until the payment settles.
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.
Total payment amount including the fees.
Payment card used.
Unique Payment Reference for the payment done.
Payment source of transaction.
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.
Preauth expiry in minutes.
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).
recalls object[]
All recalls processed on this payment.
Fee charged on Customer.
Fee charged on Merchant.
Total payment amount including the fees.
Refund/Recall date. Date Format: yyyy-MM-ddTHH:mm:ss, TimeZone: AEST (Conditional).
Reason. (Conditional).
Current Status of the refund/recall. Expected Statuses
- Pending This refund/recall is waiting be to processed
- Error - This refund/recall has encountered an Error
- Submitted - This refund/recall was successfully submitted
- Successful - This refund/recall was successful
- Failed - This refund/recall has Failed
- Cancelled - This refund/recall was Cancelled
- Suppressed - This refund/recall was Suppressed
- InProgress - This refund/recall is being processed.
TransactionReference : If a charge transaction is refunded/recalled then this is transaction reference of that 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).
refunds object[]
All refunds processed on this payment.
Fee charged on Customer.
Fee charged on Merchant.
Total payment amount including the fees.
Refund/Recall date. Date Format: yyyy-MM-ddTHH:mm:ss, TimeZone: AEST (Conditional).
Reason. (Conditional).
Current Status of the refund/recall. Expected Statuses
- Pending This refund/recall is waiting be to processed
- Error - This refund/recall has encountered an Error
- Submitted - This refund/recall was successfully submitted
- Successful - This refund/recall was successful
- Failed - This refund/recall has Failed
- Cancelled - This refund/recall was Cancelled
- Suppressed - This refund/recall was Suppressed
- InProgress - This refund/recall is being processed.
TransactionReference : If a charge transaction is refunded/recalled then this is transaction reference of that transaction.(Conditional).
Remaining preauth amount.
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.
How often the merchant is settled, as text. For example: Monthly.
How often the merchant is settled, as its numeric code. Pairs with settlementFrequencyString.
settlementPostPartialRefund object
Balance Payment if any is available.
Amount to be settled to the merchant.
Date payment will be settled to the merchant.
Processing date. Date Format: yyyy-MM-ddTHH:mm:ss, TimeZone: AEST.
Current Status of the balance payment. Expected Statuses
- Pending
- Error
- Submitted
- Successful
- Failed
- Cancelled
- Suppressed
- InProgress.
TransactionReference.
Reference for the settlement this payment was paid out in. Empty until the payment settles.
Whether the merchant is settled gross or net of fees. For example: Gross.
Stock keeping unit field 1.
Stock keeping unit field 2.
Sub card type.
Card sub-type where the scheme has one, as text. Empty when the scheme has none.
Card sub-type as its numeric code. Pairs with subCardTypeString.
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",
"additionalData": {
"authCode": "string",
"rrn": "string",
"stan": "string"
},
"additionalReference": "string",
"baseAmount": 0,
"cardCategory": "string",
"cardTypeString": "string",
"cardTypeValue": 0,
"chargeBackedOn": "2024-07-29T15:51:28.071Z",
"chargeBackedReason": "string",
"chargeBackedTransactionReference": "string",
"chargebacks": [
{
"customerFee": 0,
"merchantFee": 0,
"paymentAmount": 0,
"processedOn": "2024-07-29T15:51:28.071Z",
"reason": "string",
"status": "string",
"transactionReference": "string"
}
],
"customerCode": "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",
"merchantSettlementReference": "string",
"merchantUniquePaymentId": "string",
"oneOffPaymentReference": "string",
"originalTransactionReference": "string",
"paymentAccount": "string",
"paymentAmount": 0,
"paymentCard": "string",
"paymentReference": "string",
"paymentSourceDisplay": "string",
"paymentStatus": "string",
"preauthExpiryAt": "2024-07-29T15:51:28.071Z",
"processingDate": "2024-07-29T15:51:28.071Z",
"processorReference": "string",
"recalledOn": "2024-07-29T15:51:28.071Z",
"recalledReason": "string",
"recalledTransactionReference": "string",
"recalls": [
{
"customerFee": 0,
"merchantFee": 0,
"paymentAmount": 0,
"processedOn": "2024-07-29T15:51:28.071Z",
"reason": "string",
"status": "string",
"transactionReference": "string"
}
],
"redirectUrl": "string",
"refundedOn": "2024-07-29T15:51:28.071Z",
"refundedReason": "string",
"refundedTransactionReference": "string",
"refunds": [
{
"customerFee": 0,
"merchantFee": 0,
"paymentAmount": 0,
"processedOn": "2024-07-29T15:51:28.071Z",
"reason": "string",
"status": "string",
"transactionReference": "string"
}
],
"remainingPreauthAmount": 0,
"retryPaymentReference": "string",
"retryScheduledOn": "2024-07-29T15:51:28.071Z",
"settlementDate": "2024-07-29T15:51:28.071Z",
"settlementFrequencyString": "string",
"settlementFrequencyValue": 0,
"settlementPostPartialRefund": {
"fundsToMerchant": 0,
"merchantSettlementDate": "2024-07-29T15:51:28.071Z",
"processedOn": "2024-07-29T15:51:28.071Z",
"status": "string",
"transactionReference": "string"
},
"settlementReference": "string",
"settlementType": "string",
"sku1": "string",
"sku2": "string",
"subCardType": "string",
"subCardTypeString": "string",
"subCardTypeValue": 0,
"transactionType": 1,
"transactionTypeDisplay": "string"
}