Package com.skava.apppaymentplugin.model.request

Class AppCommonPaymentRequest

java.lang.Object
com.skava.core.validation.InputModel
com.skava.apppaymentplugin.model.request.AppCommonPaymentRequest
All Implemented Interfaces:
Serializable
public class AppCommonPaymentRequest extends com.skava.core.validation.InputModel implements Serializable
This class represents a common payment request in the application. It contains all the necessary information required to process a payment, such as customer details, card details, billing address, amount, order information, and more. Field explanations:
- pspTransactionId (String): A unique identifier for the PSP transaction.
- pspCustomerId (String): A unique identifier for the PSP customer.
- parentTransactionId (String): A unique identifier for the parent transaction.
- clientTokenId (String): A unique identifier for the client token.
- customer (Object): Information about the customer.
  - firstName (String): The first name of the customer.
  - lastName (String): The last name of the customer.
  - email (String): The email address of the customer.
- card (Object): Information about the card.
  - cardNumber (String): The card number.
  - expiryMonth (String): The expiry month of the card.
  - expiryYear (String): The expiry year of the card.
  - cvv (String): The CVV of the card.
- currency (String): The currency of the payment (e.g., USD).
- tokenId (String): A unique identifier for the token.
- billingAddress (Object): The billing address for the payment.
  - street (String): The street of the billing address.
  - city (String): The city of the billing address.
  - state (String): The state of the billing address.
  - zip (String): The zip code of the billing address.
  - country (String): The country of the billing address.
- amount (Object): The amount to be paid.
  - total (String): The total amount to be paid.
  - currency (String): The currency of the payment (e.g., USD).
- orderInformation (Object): Information about the order.
  - orderId (String): A unique identifier for the order.
  - orderDate (String): The date of the order in ISO 8601 format.
- profileId (String): A unique identifier for the profile.
- orderDetails (Object): Details of the order.
  - items (Array of Objects): The items included in the order.
    - itemId (String): A unique identifier for the item.
    - quantity (Integer): The quantity of the item.
    - price (String): The price of the item.
  - shipping (String): The shipping cost.
  - tax (String): The tax amount.
  - total (String): The total cost including items, shipping, and tax.
- properties (Object): Additional properties for the payment.
  - property1 (String): The first property.
  - property2 (String): The second property.
- providerURLs (Object): URLs provided by the provider.
  - successURL (String): URL to redirect to upon successful payment.
  - failureURL (String): URL to redirect to upon payment failure.
  - cancelURL (String): URL to redirect to upon payment cancellation.

Example JSON request payload: 

 {
   "pspTransactionId": "123456789",
   "pspCustomerId": "CUST123",
   "parentTransactionId": "TRANS123",
   "clientTokenId": "TOKEN123",
   "customer": {
     "firstName": "John",
     "lastName": "Doe",
     "email": "john.doe@example.com"
   },
   "card": {
     "cardNumber": "4111111111111111",
     "expiryMonth": "12",
     "expiryYear": "2025",
     "cvv": "123"
   },
   "currency": "USD",
   "tokenId": "TOKEN123",
   "billingAddress": {
     "street": "123 Main St",
     "city": "Anytown",
     "state": "CA",
     "zip": "12345",
     "country": "US"
   },
   "amount": {
     "total": "100.00",
     "currency": "USD"
   },
   "orderInformation": {
     "orderId": "ORDER123",
     "orderDate": "2023-01-01T00:00:00Z"
   },
   "profileId": "PROFILE123",
   "orderDetails": {
     "items": [
       {
         "itemId": "ITEM123",
         "quantity": 1,
         "price": "100.00"
       }
     ],
     "shipping": "10.00",
     "tax": "8.00",
     "total": "118.00"
   },
   "properties": {
     "property1": "value1",
     "property2": "value2"
   },
   "providerURLs": {
     "successURL": "http://example.com/success",
     "failureURL": "http://example.com/failure",
     "cancelURL": "http://example.com/cancel"
   }
 }

Author:
Infosys Equinox
See Also:

  • Constructor Details

    • AppCommonPaymentRequest

      public AppCommonPaymentRequest()