Index (satim-api-core API)

A C D E F G I L O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values

A

AbstractHttpClient - Class in com.akraml.satim.http: Abstract implementation for SatimHttpClient.
AbstractHttpClient(String, String, String) - Constructor for class com.akraml.satim.http.AbstractHttpClient
AbstractReply - Class in com.akraml.satim.reply: Base class for all API response types.
AbstractReply(boolean, int, String, JsonObject) - Constructor for class com.akraml.satim.reply.AbstractReply: Constructs a new AbstractReply.
ACS_AUTH - Enum constant in enum class com.akraml.satim.util.OrderStatus: Authorization initiated via ACS (3D Secure).
amount(long) - Method in class com.akraml.satim.request.PaymentRequestBuilder: Sets the payment amount in centimes.
APPROVED - Enum constant in enum class com.akraml.satim.util.OrderStatus: Hold amount approved but not yet deposited.
ARABIC - Enum constant in enum class com.akraml.satim.util.Language: Arabic.

C

close() - Method in interface com.akraml.satim.http.SatimHttpClient: Releases resources held by this client.
close() - Method in class com.akraml.satim.SatimAPI: Closes the HTTP client and releases resources.
com.akraml.satim - package com.akraml.satim
com.akraml.satim.exceptions - package com.akraml.satim.exceptions
com.akraml.satim.http - package com.akraml.satim.http
com.akraml.satim.reply - package com.akraml.satim.reply
com.akraml.satim.request - package com.akraml.satim.request
com.akraml.satim.util - package com.akraml.satim.util
confirm(String) - Method in class com.akraml.satim.SatimAPI: Alias for SatimAPI.confirmPayment(String) to match PHP library naming.
CONFIRM - Static variable in class com.akraml.satim.http.SatimEndpoints: Endpoint for confirming/completing a payment.
confirmPayment(String) - Method in class com.akraml.satim.SatimAPI: Confirms a payment order.
currency(String) - Method in class com.akraml.satim.request.PaymentRequestBuilder: Sets the currency code.

D

DECLINED - Enum constant in enum class com.akraml.satim.util.OrderStatus: Authorization was declined.
DEPOSIT - Static variable in class com.akraml.satim.http.SatimEndpoints: Endpoint for depositing a pre-authorized payment.
DEPOSITED - Enum constant in enum class com.akraml.satim.util.OrderStatus: Payment has been successfully deposited.
description(String) - Method in class com.akraml.satim.request.PaymentRequestBuilder: Sets a description for the payment.

E

ENGLISH - Enum constant in enum class com.akraml.satim.util.Language: English.
execute() - Method in class com.akraml.satim.request.PaymentRequestBuilder: Validates and executes the payment registration request.
executeRegisterPayment(JsonObject) - Method in class com.akraml.satim.SatimAPI: Executes a payment registration request.

F

failUrl(String) - Method in class com.akraml.satim.request.PaymentRequestBuilder: Sets the fail URL for unsuccessful payments.
FRENCH - Enum constant in enum class com.akraml.satim.util.Language: French (default).
fromCode(int) - Static method in enum class com.akraml.satim.util.OrderStatus: Converts a numeric status code to an OrderStatus enum value.
fromCode(String) - Static method in enum class com.akraml.satim.util.Language: Converts a language code string to a Language enum value.
fromJson(JsonObject) - Static method in class com.akraml.satim.reply.OrderConfirmationReply: Creates an OrderConfirmationReply from a JSON response.
fromJson(JsonObject) - Static method in class com.akraml.satim.reply.OrderStatusReply: Creates an OrderStatusReply from a JSON response.
fromJson(JsonObject) - Static method in class com.akraml.satim.reply.PaymentReply: Creates a PaymentReply from a JSON response.
fromJson(JsonObject) - Static method in class com.akraml.satim.reply.RefundReply: Creates a RefundReply from a JSON response.

G

get(String, JsonObject) - Method in interface com.akraml.satim.http.SatimHttpClient: Performs a GET request.
GET_ORDER_STATUS - Static variable in class com.akraml.satim.http.SatimEndpoints: Endpoint for retrieving basic payment status.
GET_ORDER_STATUS_EXTENDED - Static variable in class com.akraml.satim.http.SatimEndpoints: Endpoint for retrieving extended payment status with full details.
getActionCode() - Method in class com.akraml.satim.reply.OrderStatusReply: Returns the action code from the payment processor.
getActionCodeDescription() - Method in class com.akraml.satim.reply.OrderStatusReply: Returns the description of the action code.
getAmount() - Method in class com.akraml.satim.reply.OrderConfirmationReply: Returns the payment amount in the smallest currency unit.
getAmount() - Method in class com.akraml.satim.reply.OrderStatusReply: Returns the payment amount in the smallest currency unit.
getApprovalCode() - Method in class com.akraml.satim.reply.OrderConfirmationReply: Returns the approval code from the payment processor.
getApprovalCode() - Method in class com.akraml.satim.reply.OrderStatusReply: Returns the approval code from the payment processor.
getBaseUrl() - Method in interface com.akraml.satim.http.SatimHttpClient: Returns the base URL based on current mode.
getCardholderName() - Method in class com.akraml.satim.reply.OrderConfirmationReply: Returns the cardholder name.
getCardholderName() - Method in class com.akraml.satim.reply.OrderStatusReply: Returns the cardholder name.
getCode() - Method in enum class com.akraml.satim.util.Language: Returns the ISO 639-1 language code.
getCode() - Method in enum class com.akraml.satim.util.OrderStatus: Returns the numeric code for this status.
getCurrency() - Method in class com.akraml.satim.reply.OrderConfirmationReply: Returns the currency code.
getCurrency() - Method in class com.akraml.satim.reply.OrderStatusReply: Returns the currency code.
getDescription() - Method in enum class com.akraml.satim.util.OrderStatus: Returns a human-readable description of this status.
getErrorCode() - Method in class com.akraml.satim.reply.AbstractReply: Returns the error code from the response.
getErrorMessage() - Method in class com.akraml.satim.reply.AbstractReply: Returns the error message from the response.
getExpiration() - Method in class com.akraml.satim.reply.OrderStatusReply: Returns the card expiration date.
getFormUrl() - Method in class com.akraml.satim.reply.PaymentReply: Alias for PaymentReply.getPaymentUrl() to match Satim API naming.
getHttpClient() - Method in class com.akraml.satim.SatimAPI: Retrieves the current instance of HTTP client that's used by this API instance.
getIp() - Method in class com.akraml.satim.reply.OrderConfirmationReply: Returns the customer's IP address.
getIp() - Method in class com.akraml.satim.reply.OrderStatusReply: Returns the customer's IP address.
getOrderId() - Method in class com.akraml.satim.reply.PaymentReply: Returns the order ID assigned by SATIM.
getOrderNumber() - Method in class com.akraml.satim.reply.OrderConfirmationReply: Returns the merchant's order number.
getOrderNumber() - Method in class com.akraml.satim.reply.OrderStatusReply: Returns the merchant's order number.
getOrderStatus() - Method in class com.akraml.satim.reply.OrderConfirmationReply: Returns the order status.
getOrderStatus() - Method in class com.akraml.satim.reply.OrderStatusReply: Returns the current order status.
getPan() - Method in class com.akraml.satim.reply.OrderConfirmationReply: Returns the masked card number (PAN).
getPan() - Method in class com.akraml.satim.reply.OrderStatusReply: Returns the masked card number (PAN).
getPassword() - Method in class com.akraml.satim.http.AbstractHttpClient
getPassword() - Method in interface com.akraml.satim.http.SatimHttpClient: Returns the API password.
getPaymentStatus(String) - Method in class com.akraml.satim.SatimAPI: Gets the current status of a payment order.
getPaymentUrl() - Method in class com.akraml.satim.reply.PaymentReply: Returns the payment URL where the customer should be redirected.
getRawResponse() - Method in class com.akraml.satim.reply.AbstractReply: Returns the raw JSON response.
getResponse() - Method in class com.akraml.satim.reply.AbstractReply: Returns the full response as a JSON string.
getSuccessMessage() - Method in class com.akraml.satim.reply.OrderConfirmationReply: Returns a success message for confirmed payments.
getTerminalId() - Method in class com.akraml.satim.http.AbstractHttpClient
getTerminalId() - Method in interface com.akraml.satim.http.SatimHttpClient: Returns the merchant terminal ID.
getUrl() - Method in class com.akraml.satim.reply.PaymentReply: Alias for PaymentReply.getPaymentUrl() to match PHP library naming.
getUsername() - Method in class com.akraml.satim.http.AbstractHttpClient
getUsername() - Method in interface com.akraml.satim.http.SatimHttpClient: Returns the API username.

I

isDeclined() - Method in class com.akraml.satim.reply.OrderStatusReply: Checks if the payment was declined or failed.
isDeposited() - Method in class com.akraml.satim.reply.OrderStatusReply: Checks if the payment was deposited (successfully completed).
isFailed() - Method in enum class com.akraml.satim.util.OrderStatus: Checks if this status represents a failed or reversed payment.
isPending() - Method in class com.akraml.satim.reply.OrderStatusReply: Checks if the payment is pending.
isPending() - Method in enum class com.akraml.satim.util.OrderStatus: Checks if this status represents a pending payment.
isRefunded() - Method in class com.akraml.satim.reply.OrderStatusReply: Checks if the payment was refunded.
isReversed() - Method in class com.akraml.satim.reply.OrderStatusReply: Checks if the payment was reversed.
isSuccess() - Method in enum class com.akraml.satim.util.OrderStatus: Checks if this status represents a successful payment.
isSuccessful() - Method in class com.akraml.satim.reply.AbstractReply: Returns whether the API call was successful.
isTestMode() - Method in class com.akraml.satim.http.AbstractHttpClient
isTestMode() - Method in interface com.akraml.satim.http.SatimHttpClient: Returns whether test mode is enabled.

L

language(Language) - Method in class com.akraml.satim.request.PaymentRequestBuilder: Sets the language for the payment page.
language(String) - Method in class com.akraml.satim.request.PaymentRequestBuilder: Sets the language for the payment page using a string code.
Language - Enum Class in com.akraml.satim.util: Supported languages for the SATIM payment page.

O

OrderConfirmationReply - Class in com.akraml.satim.reply: Response from the order confirmation endpoint.
orderNumber(long) - Method in class com.akraml.satim.request.PaymentRequestBuilder: Sets a custom order number.
OrderStatus - Enum Class in com.akraml.satim.util: Enumeration of possible order statuses returned by the SATIM API.
OrderStatusReply - Class in com.akraml.satim.reply: Response from the order status endpoint.

P

PaymentReply - Class in com.akraml.satim.reply: Response from the payment registration endpoint.
PaymentRequestBuilder - Class in com.akraml.satim.request: Builder for payment registration requests.
PaymentRequestBuilder(SatimAPI) - Constructor for class com.akraml.satim.request.PaymentRequestBuilder: Creates a new PaymentRequestBuilder.
post(String, JsonObject) - Method in interface com.akraml.satim.http.SatimHttpClient: Performs a POST request.
PRODUCTION_BASE_URL - Static variable in class com.akraml.satim.http.SatimEndpoints

R

refund(String) - Method in class com.akraml.satim.SatimAPI: Alias for SatimAPI.refundPayment(String) to match PHP library naming.
REFUND - Static variable in class com.akraml.satim.http.SatimEndpoints: Endpoint for refunding a deposited payment.
REFUNDED - Enum constant in enum class com.akraml.satim.util.OrderStatus: Transaction has been refunded.
refundPayment(String) - Method in class com.akraml.satim.SatimAPI: Requests a full refund for a completed payment.
refundPayment(String, long) - Method in class com.akraml.satim.SatimAPI: Requests a partial or full refund for a completed payment.
RefundReply - Class in com.akraml.satim.reply: Response from the refund or reverse endpoint.
register() - Method in class com.akraml.satim.request.PaymentRequestBuilder: Alias for PaymentRequestBuilder.execute() to match PHP library naming.
REGISTER - Static variable in class com.akraml.satim.http.SatimEndpoints: Endpoint for registering a new payment order.
REGISTER_PRE_AUTH - Static variable in class com.akraml.satim.http.SatimEndpoints: Endpoint for registering a pre-authorized payment.
REGISTERED - Enum constant in enum class com.akraml.satim.util.OrderStatus: Order has been registered but payment has not been made.
registerPayment() - Method in class com.akraml.satim.SatimAPI: Creates a new payment request builder.
returnUrl(String) - Method in class com.akraml.satim.request.PaymentRequestBuilder: Sets the return URL for successful payments.
reverse(String) - Method in class com.akraml.satim.SatimAPI: Alias for SatimAPI.reversePayment(String).
REVERSE - Static variable in class com.akraml.satim.http.SatimEndpoints: Endpoint for reversing/canceling a payment before deposit.
REVERSED - Enum constant in enum class com.akraml.satim.util.OrderStatus: Authorization has been reversed.
reversePayment(String) - Method in class com.akraml.satim.SatimAPI: Reverses (cancels) a payment that hasn't been deposited yet.

S

SatimAPI - Class in com.akraml.satim: Main entry point for interacting with the SATIM Payment API.
SatimAPI(SatimHttpClient) - Constructor for class com.akraml.satim.SatimAPI: Creates a new SatimAPI instance.
SatimAPIException - Class in com.akraml.satim.exceptions
SatimAPIException() - Constructor for class com.akraml.satim.exceptions.SatimAPIException
SatimAuthenticationException - Class in com.akraml.satim.exceptions
SatimAuthenticationException() - Constructor for class com.akraml.satim.exceptions.SatimAuthenticationException
SatimEndpoints - Class in com.akraml.satim.http: A static class providing HTTP endpoints to access SATIM API.
SatimException - Class in com.akraml.satim.exceptions
SatimException() - Constructor for class com.akraml.satim.exceptions.SatimException
SatimHttpClient - Interface in com.akraml.satim.http: HTTP client interface for communicating with the Satim API.
SatimThrottleException - Class in com.akraml.satim.exceptions
SatimThrottleException() - Constructor for class com.akraml.satim.exceptions.SatimThrottleException
self() - Method in interface com.akraml.satim.http.SatimHttpClient
status(String) - Method in class com.akraml.satim.SatimAPI: Alias for SatimAPI.getPaymentStatus(String) to match PHP library naming.

T

TEST_BASE_URL - Static variable in class com.akraml.satim.http.SatimEndpoints
timeout(int) - Method in class com.akraml.satim.request.PaymentRequestBuilder: Sets the payment session timeout in seconds.
toString() - Method in class com.akraml.satim.reply.AbstractReply
toString() - Method in class com.akraml.satim.reply.OrderConfirmationReply
toString() - Method in class com.akraml.satim.reply.OrderStatusReply
toString() - Method in class com.akraml.satim.reply.PaymentReply
toString() - Method in class com.akraml.satim.reply.RefundReply
toString() - Method in enum class com.akraml.satim.util.Language

U

UNKNOWN - Enum constant in enum class com.akraml.satim.util.OrderStatus: Unknown or unrecognized status.
USER_AGENT - Static variable in interface com.akraml.satim.http.SatimHttpClient
userDefinedField(String, String) - Method in class com.akraml.satim.request.PaymentRequestBuilder: Adds a single user-defined field.
userDefinedFields(JsonObject) - Method in class com.akraml.satim.request.PaymentRequestBuilder: Adds multiple user-defined fields.

V

valueOf(String) - Static method in enum class com.akraml.satim.util.Language: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.akraml.satim.util.OrderStatus: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.akraml.satim.util.Language: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.akraml.satim.util.OrderStatus: Returns an array containing the constants of this enum class, in the order they are declared.

W

withTestMode(boolean) - Method in class com.akraml.satim.http.AbstractHttpClient
withTestMode(boolean) - Method in interface com.akraml.satim.http.SatimHttpClient: Enables or disables test mode.

A C D E F G I L O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values