MitBatchResultRow
Outcome for a single entry in a MIT batch request. Only one of transaction or error is populated.
The transaction.reference value sent in the request for the transaction. This can be used to link the returned result to the original transaction request in the batch. If you do not send the transaction.reference field in the request, this will be null.
Created MIT transaction when the entry is accepted. Null when validation or ownership checks fail. For error reason see error which will always be present when transaction is null.
The ID of the transaction
"LDG7M4WW44G"The ID of the associated subscription
uuid"0197c07b-3f6d-7be2-b848-702b08958128"The ID of any associated subscription billing charge. Will be null if the transaction was not an automatic charge made on a billing agreement.
uuid"019a727b-987f-7768-a59e-71af920ef81f"The current state of the transaction. See our Core Concepts page.
"PENDING""PROCESSING""SUCCESS""FAILED"If the transaction has failed, this contains the associated error code explaining what went wrong.
A nullable object containing any known external status codes, such as the status code from the acquirer or the network. This can be useful for merchants who want to be able to react to very specific rejection reasons.
The status code from the terminal. The possible values depend on the terminal provider such as SoftPay. The key is only present if the value is known to ePay, and processed on a physical in-person terminal.
The status code from the acquirer. The possible values depend on processing acquirer. The key is only present if the value is known to ePay.
The status code from the scheme network. The field is only used for card based payments but stays consistent between acquirers. The key is only present if the value is known to ePay.
A unified status code representing the result of the Strong Customer Authentication (SCA) flow, such as 3DS.
The code is built by concatenating the challenge status (transStatus) and reason code (transStatusReason) from the two steps of the 3DS protocol.
| Code | Meaning |
|---|---|
| C | Transaction was challenged |
| N | Transaction was rejected |
| Y | Transaction was approved |
| U | Technical issues |
| I | Informational Only (No authentication performed) |
The reason code (transStatusReason) is appended if present, e.g., 07.
Examples:
Y- Frictionless approvalCY- Challenged then approvedCN07- Challenged then rejected due to reason07N07- Rejected without a challenge due to reason07
The time of creation
date-timeThe ID of the associated session. This will be null for any MIT transactions.
The ID of the associated payment method
uuidThe type of the payment method.
"CARD""VIPPS_MOBILEPAY""MOBILEPAY_ONLINE""APPLE_PAY""GOOGLE_PAY""SWISH""VIABILL""ANYDAY""KLARNA""CARD"The sub type of the associated payment method. For card based payments, this will contain the name of the scheme, such as Visa or Mastercard. The card scheme name formatted with a uppercase starting character. For non-card based payments the field vary depending on the requirements of the payment method.
"Visa""Mastercard""Maestro""Dankort""VisaDankort""Discover""UnionPay""Electron""Amex""JCB""Visa"The expiration date of the associated payment method.
Although payment cards are specified by a month and year (MM/YY), this value is returned as a full date (YYYY-MM-DD) representing the last day of the expiration month.
Example: "2030-05-31" for a card expiring in May 2030.
dateA cardholder friendly text to help them identify the payment method. For cards this will be a masked version of the card number.
Contains the entered cardholder name of the optional "name" field. Will be null if the field is not rendered.
The SCA mode of the transaction.
"SKIP""NORMAL""FORCE"The merchant customer id of the transaction. This field is required to enable advanced features such as storing a card for later reuse. Do not use any "guest" customer ids. Customer ids must be unique for each customer and must be protected by authentication.
The transaction amount in minor units (e.g., 1095 = 10.95 DKK)
The applied transaction fee in minor units. The fee is included in the amount field. To get the original amount you must subtract fee from amount. Fees are only applied if surcharge is configured in the ePay backoffice.
Fees are calculated during transaction processing and as such is always 0 when initially created during MIT transactions.
The currency of the transaction in ISO 4217 alpha-3. DKK for danish kroner.
The instant capture mode.
"OFF""VOID""NO_VOID"The URL to receive webhook notifications of any transaction attempts. May contain templating variables.
urilength <= 1024The ID of the associated point of sale
uuidThe merchant reference of the transaction, this is often used for the order id.
The text to show on the cardholder bank statement
1 <= length <= 39The list of exemptions to apply when possible. Note that exemptions may shift liability from the issuer to the merchant.
Array [
string
]
A list of pass-through parameters that will be sent back to the merchant for following any webhooks
The ip (ipv4/ipv6) of the cardholder making the transaction. The IP is captured by ePay at the initialization of the transaction client-side. Can be empty.
"52.212.176.122"The detected origin country (Alpha-2) based on the clientIp property. Can be empty.
- Data derived from GeoLite2 by MaxMind.
"DK"The type of transaction.
"PAYMENT""PAYOUT""MOTO"Error payload explaining why the batch entry could not be created. Is always null when transaction is not null and is always not-null when transaction is null.
Indicates that the batch entry failed; always false when present.
falseMachine-readable error code for the failure reason.
"MODEL_NOT_FOUND"Human-readable description of the failure reason.
"The requested model was not found."{ "reference": "string", "transaction": { "id": "LDG7M4WW44G", "subscriptionId": "0197c07b-3f6d-7be2-b848-702b08958128", "billingAgreementChargeId": "019a727b-987f-7768-a59e-71af920ef81f", "state": "PENDING", "errorCode": "string", "externalStatusCodes": { "terminal": "string", "acquirer": "string", "network": "string", "sca": "string" }, "createdAt": "2019-08-24T14:15:22Z", "sessionId": "string", "paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011", "paymentMethodType": "CARD", "paymentMethodSubType": "Visa", "paymentMethodExpiry": "2019-08-24", "paymentMethodDisplayText": "string", "paymentMethodHolderName": "string", "scaMode": "SKIP", "customerId": "string", "amount": 0, "fee": 0, "currency": "string", "instantCapture": "OFF", "notificationUrl": "http://example.com", "pointOfSaleId": "be6bff4f-7fac-43c0-9f6b-cf2cd45ed7d1", "reference": "string", "textOnStatement": "string", "exemptions": [ "LVT", "TRA" ], "attributes": { "property1": null, "property2": null }, "clientIp": "52.212.176.122", "clientCountry": "DK", "type": "PAYMENT" }, "error": { "success": false, "errorCode": "MODEL_NOT_FOUND", "message": "The requested model was not found." }}