handlePaymentStateChangedNotificationRequest fields
field (type, required) | description |
---|---|
payment |
Type containing all payment details |
payment.merchantID |
Merchant ID |
payment.shopID |
Shop ID |
payment.paymentMethod |
key = ID of the corresponding payment method look at 2.1.3.2 Payment Methods and State Notifications |
payment.merchantTransactionID |
Merchant's transaction ID |
payment.paymentID |
Kalixa's Unique ID of the payment There can be multiple payments with Unique ID related to one merchantTransactionID. This is possible in Refunds, or payment retries from a particular customer |
payment.userID |
The customer ID |
payment.paymentProvider |
key = ID |
payment.amount |
Net amount of the transaction with currency |
payment.shopFee |
Fee amount to be paid by the customer |
payment.creationType |
It specifies who triggered the transaction 1 = User (Customer) |
payment.userIP |
The IP of the customer where the payment request came from |
payment.state |
contains all the details related to the notified state transition |
payment.state.id |
The ID of the payment state |
payment.state.definition |
key = ID of the state The merchant should react based on the meaning of these states. look at 2.1.3.2 Payment Methods and State Notifications |
payment.state.createdOn |
The date and time when the payment switched to that last state |
payment.state.paymentStateDetails |
Additional state-specific details |
payment.isExecuted |
Indicates if the payment has reached a credit/debit state indicating that the money transfer has been authorised |
payment.baseAmount |
Amount in base accounting currency which can be selected by the merchant during setup (for reporting purposes) |
payment.paymentDetails |
Additional payment method-specific details |
payment.paymentAccount |
The payment instrument (e.g. credit card) used by the customer to perform the payment |
payment.paymentAccount.paymentAccountID |
The token associated to a credit card number. It can be used to initiate CardOnFile transactions (further details look at 2.2.1 Payment Initiation - Card On File (Tokenization)) Please be aware, this token is created for any account type created in the system |
payment.paymentAccount.details |
Additional details could be received per payment account type |
handlePaymentStateChangedNotificationRequest.state.paymentStateDetails key-values
key (value type, functionality) | value |
---|---|
ProviderResponseCode |
Response code of the provider key = ProviderResponseCode see [Provider Response Codes] (Creation Types) Used for payment methods: Visa, Visa Debit, Mastercard, Mastercard Debit, Maestro Deposit |
ApprovalCode |
Approval code, when transaction gets authorized key = ApprovalCode Used for payment methods: Visa, Visa Debit, Mastercard, Mastercard Debit, Maestro Deposit |
handlePaymentStateChangedNotificationRequest.paymentDetails key-values
The below details are used for payment methods: Visa, Visa Debit, Mastercard, Mastercard Debit, Maestro, Bank Transfer, Bank Transfer Withdrawal, Multibanco, Neteller, Neteller Withdrawal, Paysafecard, Trustly, Ticket Premium.
key (value type, functionality) | value |
---|---|
ProviderExternalID |
It is the transaction ID from the provider |
ShippingName |
Name of the shipping's receiver |
ShippingStreet |
Street |
ShippingCity |
City |
ShippingState |
State or province. Applicable for U.S |
ShippingPostalCode |
Postal code |
ShippingCountryCode2 |
ISO code of the shipping country |
ShippingTelephoneNumber |
Telephone number |
handlePaymentStateChangedNotificationResponse fields
field (type, required) | description |
---|---|
resultCode |
Details representing the result after the notification handling Key = ID of the response, please see the table Result Codes (below) |
resultMessage |
A message to be attached to the result of the notification |
Result Codes
id | name | descripton | sync notification | async notification |
---|---|---|---|---|
0 |
ProcessedSuccessfully |
Notification request processed successfully |
No retry |
No retry |
3 |
RefusedByRiskManagement |
Notification request processed successfully, and the payment is refused by the merchant |
No retry |
No retry |
10 |
ErrorProcessingEvent |
Problems occurred when processing the notification request |
No retry |
Retry |
Samples
/handlePaymentStateChangedNotificationRequest/Sample notifications