Class RegisterPaymentRequest
java.lang.Object
com.skava.core.validation.InputModel
com.skava.paymentapp.model.request.RegisterPaymentRequest
- All Implemented Interfaces:
Serializable
public class RegisterPaymentRequest
extends com.skava.core.validation.InputModel
This class represents a request to register a payment in the application. It contains all the necessary
information required to register a payment, such as collection id, user id, auth token, payment option id,
locale, redirect URLs, request id, and payment details.
Field explanations:
- collectionId (Integer): A unique identifier of a collection.
- userId (String): A unique identifier of a user.
- authToken (String): A unique identifier of an authToken.
- paymentOptionId (Integer): A unique identifier for Payment Options.
- locale (String): Locale of the user.
- successRedirectUrl (String): URL to redirect to upon successful payment.
- failRedirectUrl (String): URL to redirect to upon payment failure.
- cancelRedirectUrl (String): URL to redirect to upon payment cancellation.
- pendingRedirectUrl (String): URL to redirect to upon pending payment.
- errorRedirectUrl (String): URL to redirect to upon payment error.
- requestId (String): Unique identifier for the request.
- details (Object): Details of the payment.
- amount (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.
- 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.
- properties (Object): Additional properties for the payment.
- property1 (String): The first property.
- property2 (String): The second property.
- collectionId (Integer): A unique identifier of a collection.
- userId (String): A unique identifier of a user.
- authToken (String): A unique identifier of an authToken.
- paymentOptionId (Integer): A unique identifier for Payment Options.
- locale (String): Locale of the user.
- successRedirectUrl (String): URL to redirect to upon successful payment.
- failRedirectUrl (String): URL to redirect to upon payment failure.
- cancelRedirectUrl (String): URL to redirect to upon payment cancellation.
- pendingRedirectUrl (String): URL to redirect to upon pending payment.
- errorRedirectUrl (String): URL to redirect to upon payment error.
- requestId (String): Unique identifier for the request.
- details (Object): Details of the payment.
- amount (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.
- 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.
- properties (Object): Additional properties for the payment.
- property1 (String): The first property.
- property2 (String): The second property.
Example JSON request payload:
{
"collectionId": 1,
"userId": "USER123",
"authToken": "AUTH123",
"paymentOptionId": 1,
"locale": "en_US",
"successRedirectUrl": "http://example.com/success",
"failRedirectUrl": "http://example.com/fail",
"cancelRedirectUrl": "http://example.com/cancel",
"pendingRedirectUrl": "http://example.com/pending",
"errorRedirectUrl": "http://example.com/error",
"requestId": "REQ123",
"details": {
"amount": "100.00",
"currency": "USD",
"orderInformation": {
"orderId": "ORDER123",
"orderDate": "2023-01-01T00:00:00Z"
},
"billingAddress": {
"street": "123 Main St",
"city": "Anytown",
"state": "CA",
"zip": "12345",
"country": "US"
},
"properties": {
"property1": "value1",
"property2": "value2"
}
}
}
- Author:
- Infosys Equinox
- See Also:
-
Constructor Summary
Constructors -
Method Summary
-
Constructor Details
-
RegisterPaymentRequest
public RegisterPaymentRequest()
-