Package jp.gopay.sdk.resources

Interface CancelResource

public interface CancelResource

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<Cancel>	create(StoreId storeId, ChargeId chargeId, CancelCreateData requestBody, IdempotencyKey idempotencyKey)
retrofit2.Call<Cancel>	get(StoreId storeId, ChargeId chargeId, CancelId cancelId, Boolean polling)
retrofit2.Call<PaginatedList<Cancel>>	list(StoreId storeId, ChargeId chargeId, Integer limit, CursorDirection cursorDirection, CancelId cursor)
retrofit2.Call<Cancel>	update(StoreId storeId, ChargeId chargeId, CancelId cancelId, CancelPatchData requestBody, IdempotencyKey idempotencyKey)

Method Detail

list

@GET("/stores/{storeId}/charges/{chargeId}/cancels")
retrofit2.Call<PaginatedList<Cancel>> list(@Path("storeId")
                                           StoreId storeId,
                                           @Path("chargeId")
                                           ChargeId chargeId,
                                           @Query("limit") @Nullable
                                           Integer limit,
                                           @Query("cursor_direction") @Nullable
                                           CursorDirection cursorDirection,
                                           @Query("cursor") @Nullable
                                           CancelId cursor)

get

@GET("/stores/{storeId}/charges/{chargeId}/cancels/{cancelId}")
retrofit2.Call<Cancel> get(@Path("storeId")
                           StoreId storeId,
                           @Path("chargeId")
                           ChargeId chargeId,
                           @Path("cancelId")
                           CancelId cancelId,
                           @Query("polling") @Nullable
                           Boolean polling)

create

@POST("/stores/{storeId}/charges/{chargeId}/cancels")
retrofit2.Call<Cancel> create(@Path("storeId")
                              StoreId storeId,
                              @Path("chargeId")
                              ChargeId chargeId,
                              @Body
                              CancelCreateData requestBody,
                              @Header("Idempotency-Key")
                              IdempotencyKey idempotencyKey)

update

@PATCH("/stores/{storeId}/charges/{chargeId}/cancels/{cancelId}")
retrofit2.Call<Cancel> update(@Path("storeId")
                              StoreId storeId,
                              @Path("chargeId")
                              ChargeId chargeId,
                              @Path("cancelId")
                              CancelId cancelId,
                              @Body
                              CancelPatchData requestBody,
                              @Header("Idempotency-Key")
                              IdempotencyKey idempotencyKey)