Response Handling
Response fields
Overall result
transactionResultindicates the overall result of the operation, unless transaction status that represent financial status of the transaction, this fields helps us to understand if the operation is successfully executed
| Value | Description |
|---|---|
| APPROVED | Transaction was successful (e.g. authorized or captured) |
| DECLINED | Transaction was not successful (e.g Transaction was declined by authorization system, issuer or scheme) |
| FAILED | Transaction was rejected by the gateway |
| WAITING | Transaction is in waiting state, e.g. in case of 3DS flow |
| PARTIAL | Transaction was partially approved |
| FRAUD | Transaction was stopped by a fraud rule |
transactionState can be used in inquiries to retrieve the exact status from a technical perspective.
| Value | Description |
|---|---|
| AUTHORIZED | Transaction was authorized but not captured or settled |
| CAPTURED | Transaction was captured |
| DECLINED | Transaction was declined by gateway, authorization system, issuer or scheme |
| CHECKED | TO BE IGNORED |
| COMPLETED_GET | Action to get transaction details via inquiry was successful |
| INITIALIZED | TO BE IGNORED |
| PENDING | TO BE IGNORED |
| READY | TO BE IGNORED |
| TEMPLATE | Payment URL was created |
| SETTLED | Transaction was settled |
| VOIDED | Transaction was reversed |
| WAITING | Transaction is in waiting state, e.g. in case of 3DS flow |
IPG Approval Code
approvalCode shows the transaction approval code created by IPG.
Format: the format is mainly prefix-based
| Scenario | Format | Example |
|---|---|---|
| approved/success | Y:<processorApprovalCode>:<transactionId>:<AVS+CVV>:<endpointTransactionId> | Y:233386:4371823690:PPXM:1134859933 |
| issuer/endpoint decline | N:<processorCode>:<message> | N:1:10002 or N:1:10002:Token is not valid |
| gateway failure | N:-<ipgErrorCode>:<message> | N:-30031:No terminal setup |
| waiting / pending / incomplete | ?:<message> | ?:waiting SOFORT ?:waiting 3dsecure ?:-49998:Communication Error |
| Payer-auth / 3DS | Y:<code>:<message> N:<code>:<message> | Y:ECI2/5:Authenticated Y:ECI9:Authenticated Y:ECI1/6:Attempt or N:ECI1/6:Attempt Y:ECI7 / N:ECI7 Y:ECI7:Card not enrolled / N:ECI7:Card not enrolled |
Processor response code
processor.responseCode contains raw endpoint/processor response code, useful for processor-specific reason handling or troubleshooting, but not the generic merchant success/failure indicator.
Authorization code
processor.authorizationCode 6-digit authorization code returned by the issuer. Only present in approval case.
Transaction Identifiers
| ID | Description |
|---|---|
clientRequestId | Echoes back the value in the request header for tracking. |
apiTraceId | Request identifier in API, can be used to request logs from the support team. |
ipgTransactionId | Unique identifier assigned by the gateway, Can be used as reference in secondary transactions. |
orderId | Order ID assigned by the gateway, if not supplied by client. One order ID can bundle multiple transaction IDs. Can be used as reference in secondary transactions. |
merchantTransactionId | This is ID can be supplied by client. It can be used as reference in secondary transactions. |
schemeTransactionId | Contains the Visa Transaction or Mastercard Banknet Reference Number. It must be included in merchant-initiated transactions as referencedSchemeTransactionId. |
transactionLinkIdentifier | The Mastercard Transaction Link ID (or TLID) is getting included in payment response. Starting from October 26th, 2026 this is must be included into merchant-initiated transactions. It must be included in merchant-initiated transactions as referencedTransactionLinkIdientifier.For all other transaction types the gateway is including the TLID into the authorization message while sending the secondary transaction. |
Updated about 5 hours ago
