public interface RecurringsApi
| Modifier and Type | Method and Description |
|---|---|
retrofit2.Call<PaymentCreationResponse> |
createFiling(FilingRequest filingRequest)
Create filing
|
retrofit2.Call<RecurringPlanResponse> |
createPlan(RecurringPlanRequest recurringPlanRequest)
Create recurring plan
|
retrofit2.Call<RecurringCreationResponse> |
createRecurring(RecurringCreationRequest recurringRequest)
Create recurring
|
retrofit2.Call<Void> |
deletePlan(String planId)
Delete plan
|
retrofit2.Call<ChangeSubscriptionStatusClaimResponse> |
getChangeStatusClaim(String claimId,
String subscriptionId)
Get information about Change subscription status claim
|
retrofit2.Call<RecurringResponse> |
getFiling(String filingId)
Get filing order information
|
retrofit2.Call<RecurringPlanResponse> |
getPlan(String planId)
Get plan information
|
retrofit2.Call<PlanDataList> |
getPlans(String requestId,
Integer maxCount,
Integer offset,
String sortOrder)
Get plans information
|
retrofit2.Call<RecurringResponse> |
getRecurring(String recurringId)
Get recurring information
|
retrofit2.Call<RecurringsList> |
getRecurrings(String requestId,
String currency,
OffsetDateTime endTime,
Integer maxCount,
String merchantOrderId,
String paymentMethod,
String sortOrder,
OffsetDateTime startTime,
String type)
Get recurring list information
|
retrofit2.Call<SubscriptionGetResponse> |
getSubscription(String subscriptionId)
Get subscription information
|
retrofit2.Call<SubscriptionList> |
getSubscriptions(String requestId,
String accountId,
String currency,
OffsetDateTime endTime,
Integer maxCount,
Integer offset,
String planId,
String sortOrder,
OffsetDateTime startTime,
String status,
String type)
Get subscription information
|
retrofit2.Call<PlanUpdateResponse> |
updatePlan(String planId,
PlanUpdateRequest planUpdateRequest)
Update plan
|
retrofit2.Call<RecurringUpdateResponse> |
updateRecurring(String recurringId,
RecurringPatchRequest recurringPatchRequest)
Update recurring
|
retrofit2.Call<SubscriptionUpdateResponse> |
updateSubscription(String subscriptionId,
SubscriptionUpdateRequest subscriptionUpdateRequest)
Update subscription
|
@Headers(value="Content-Type:application/json") @POST(value="api/recurring_filings") retrofit2.Call<PaymentCreationResponse> createFiling(@Body FilingRequest filingRequest)
filingRequest - Filing request parameters (optional)@Headers(value="Content-Type:application/json") @POST(value="api/recurring_plans") retrofit2.Call<RecurringPlanResponse> createPlan(@Body RecurringPlanRequest recurringPlanRequest)
recurringPlanRequest - recurringPlanRequest (required)@Headers(value="Content-Type:application/json") @POST(value="api/recurrings") retrofit2.Call<RecurringCreationResponse> createRecurring(@Body RecurringCreationRequest recurringRequest)
recurringRequest - Recurring Request (required)@DELETE(value="api/recurring_plans/{plan_id}")
retrofit2.Call<Void> deletePlan(@Path(value="plan_id")
String planId)
planId - Plan ID (required)@GET(value="api/recurring_subscriptions/{subscriptionId}/change_status_claims/{claimId}")
retrofit2.Call<ChangeSubscriptionStatusClaimResponse> getChangeStatusClaim(@Path(value="claimId")
String claimId,
@Path(value="subscriptionId")
String subscriptionId)
claimId - claimId (required)subscriptionId - subscription id (required)@GET(value="api/recurring_filings/{filingId}")
retrofit2.Call<RecurringResponse> getFiling(@Path(value="filingId")
String filingId)
filingId - filing order id (required)@GET(value="api/recurring_plans/{plan_id}")
retrofit2.Call<RecurringPlanResponse> getPlan(@Path(value="plan_id")
String planId)
planId - Plan ID (required)@GET(value="api/recurring_plans") retrofit2.Call<PlanDataList> getPlans(@Query(value="request_id") String requestId, @Query(value="max_count") Integer maxCount, @Query(value="offset") Integer offset, @Query(value="sort_order") String sortOrder)
requestId - Request ID (required)maxCount - Limit number of returned plans (must be less than 10000, default is 1000) (optional)offset - Offset (must be less than 10000) (optional)sortOrder - Sort based on order of results. 'asc' for ascending order or 'desc' for descending order (default value) (optional)@GET(value="api/recurrings/{recurringId}")
retrofit2.Call<RecurringResponse> getRecurring(@Path(value="recurringId")
String recurringId)
recurringId - Recurring ID (required)@GET(value="api/recurrings") retrofit2.Call<RecurringsList> getRecurrings(@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="sort_order") String sortOrder, @Query(value="start_time") OffsetDateTime startTime, @Query(value="type") String type)
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)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)@GET(value="api/recurring_subscriptions/{subscriptionId}")
retrofit2.Call<SubscriptionGetResponse> getSubscription(@Path(value="subscriptionId")
String subscriptionId)
subscriptionId - subscription id (required)@GET(value="api/recurring_subscriptions") retrofit2.Call<SubscriptionList> getSubscriptions(@Query(value="request_id") String requestId, @Query(value="account_id") String accountId, @Query(value="currency") String currency, @Query(value="end_time") OffsetDateTime endTime, @Query(value="max_count") Integer maxCount, @Query(value="offset") Integer offset, @Query(value="plan_id") String planId, @Query(value="sort_order") String sortOrder, @Query(value="start_time") OffsetDateTime startTime, @Query(value="status") String status, @Query(value="type") String type)
requestId - Request ID (required)accountId - Merchant identifier of customer account (optional)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 subscriptions (must be less than 10000, default is 1000) (optional)offset - Offset (must be less than 10000) (optional)planId - Id of plan. Use for searching scheduled subscriptions by plan (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)status - Status of subscription (optional)type - Type of subscription. 'ONECLICK' type will be ignored. (optional)@Headers(value="Content-Type:application/json")
@PATCH(value="api/recurring_plans/{plan_id}")
retrofit2.Call<PlanUpdateResponse> updatePlan(@Path(value="plan_id")
String planId,
@Body
PlanUpdateRequest planUpdateRequest)
planId - Plan ID (required)planUpdateRequest - planUpdateRequest (required)@Headers(value="Content-Type:application/json")
@PATCH(value="api/recurrings/{recurringId}")
retrofit2.Call<RecurringUpdateResponse> updateRecurring(@Path(value="recurringId")
String recurringId,
@Body
RecurringPatchRequest recurringPatchRequest)
recurringId - Recurring ID (required)recurringPatchRequest - recurringPatchRequest (required)@Headers(value="Content-Type:application/json")
@PATCH(value="api/recurring_subscriptions/{subscriptionId}")
retrofit2.Call<SubscriptionUpdateResponse> updateSubscription(@Path(value="subscriptionId")
String subscriptionId,
@Body
SubscriptionUpdateRequest subscriptionUpdateRequest)
subscriptionId - Subscription ID (required)subscriptionUpdateRequest - subscriptionUpdateRequest (required)Copyright © 2019. All rights reserved.