com.cardpay.sdk.api

Interface RecurringsInstallmentsApi

public interface RecurringsInstallmentsApi

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<ScheduleOptionsResponse>	calculateSchedule(String currency, String requestId, BigDecimal totalAmount) Get calculation of installment payment options
retrofit2.Call<RecurringGatewayCreationResponse>	createInstallment(InstallmentSubscriptionRequest subscriptionRequest) Create installment
retrofit2.Call<AuthenticationDataResponse>	getAuthenticationData(String recurringId) Get installment payment 3DS result information
retrofit2.Call<RecurringResponse>	getInstallmentPayment(String recurringId) Get installment payment
retrofit2.Call<RecurringsList>	getInstallmentPayments(String requestId, String currency, OffsetDateTime endTime, Integer maxCount, String merchantOrderId, String paymentMethod, List<String> recurringTypes, String sortOrder, OffsetDateTime startTime, String type) Get installment payments
retrofit2.Call<RecurringResponse>	updateInstallmentPayment(String recurringId, RecurringPatchRequest recurringPatchRequest) Update installment payment

Method Detail

calculateSchedule

@GET(value="api/installments/options_calculator")
retrofit2.Call<ScheduleOptionsResponse> calculateSchedule(@Query(value="currency")
                                                                                                            String currency,
                                                                                                            @Query(value="request_id")
                                                                                                            String requestId,
                                                                                                            @Query(value="totalAmount")
                                                                                                            BigDecimal totalAmount)

Get calculation of installment payment options

Parameters:

currency - [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code (required)

requestId - Request ID (required)

totalAmount - Total amount of subscription to be calculated to options; can have dot as a decimal separator. (optional)

Returns:

Call<ScheduleOptionsResponse>

createInstallment

@Headers(value="Content-Type:application/json")
 @POST(value="api/installments")
retrofit2.Call<RecurringGatewayCreationResponse> createInstallment(@Body
                                                                                                                                                    InstallmentSubscriptionRequest subscriptionRequest)

Create installment

Parameters:

subscriptionRequest - subscriptionRequest (required)

Returns:

Call<RecurringGatewayCreationResponse>

getAuthenticationData

@GET(value="api/installments/{recurringId}/threedsecure")
retrofit2.Call<AuthenticationDataResponse> getAuthenticationData(@Path(value="recurringId")
                                                                                                                           String recurringId)

Get installment payment 3DS result information

Parameters:

recurringId - Recurring ID (required)

Returns:

Call<AuthenticationDataResponse>

getInstallmentPayment

@GET(value="api/installments/{recurringId}")
retrofit2.Call<RecurringResponse> getInstallmentPayment(@Path(value="recurringId")
                                                                                                     String recurringId)

Get installment payment

Parameters:

recurringId - Recurring ID (required)

Returns:

Call<RecurringResponse>

getInstallmentPayments

@GET(value="api/installments")
retrofit2.Call<RecurringsList> getInstallmentPayments(@Query(value="request_id")
                                                                                     String requestId,
                                                                                     @Query(value="currency")
                                                                                     String currency,
                                                                                     @Query(value="end_time")
                                                                                     OffsetDateTime endTime,
                                                                                     @Query(value="max_count")
                                                                                     Integer maxCount,
                                                                                     @Query(value="merchant_order_id")
                                                                                     String merchantOrderId,
                                                                                     @Query(value="payment_method")
                                                                                     String paymentMethod,
                                                                                     @Query(value="recurring_types")
                                                                                     List<String> recurringTypes,
                                                                                     @Query(value="sort_order")
                                                                                     String sortOrder,
                                                                                     @Query(value="start_time")
                                                                                     OffsetDateTime startTime,
                                                                                     @Query(value="type")
                                                                                     String type)

Get installment payments

Parameters:

requestId - Request ID (required)

currency - [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of transactions currency (optional)

endTime - Date and time up to milliseconds (in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format) when requested period ends (not inclusive), UTC time, must be less than 7 days after 'start_time', default is current time (format: yyyy-MM-dd'T'HH:mm:ss'Z') (optional)

maxCount - Limit number of returned transactions (must be less than 10000, default is 1000) (optional)

merchantOrderId - Merchant order number from the merchant system (optional)

paymentMethod - Used payment method type name from payment methods list (optional)

recurringTypes - (optional)

sortOrder - Sort based on order of results. `asc` for ascending order or `desc` for descending order (default value) (optional)

startTime - Date and time up to milliseconds (in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format) when requested period starts (inclusive), UTC time, default is 24 hours before 'end_time' (format: yyyy-MM-dd'T'HH:mm:ss'Z') (optional)

type - Filter recurring payments by certain type (applicable to /api/recurrings endpoint only): `SCHEDULED` for scheduled recurring payments `ONECLICK` for one-click payments `INSTALLMENT` for installment payments (optional)

Returns:

Call<RecurringsList>

updateInstallmentPayment

@Headers(value="Content-Type:application/json")
 @PATCH(value="api/installments/{recurringId}")
retrofit2.Call<RecurringResponse> updateInstallmentPayment(@Path(value="recurringId")
                                                                                                                                                           String recurringId,
                                                                                                                                                           @Body
                                                                                                                                                           RecurringPatchRequest recurringPatchRequest)

Update installment payment

Parameters:

recurringId - Recurring ID (required)

recurringPatchRequest - Recurring patch request (required)

Returns:

Call<RecurringResponse>