Package jp.gopay.sdk.resources

Interface ChargesResource

public interface ChargesResource

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<Void>	capture(StoreId storeId, ChargeId id, CaptureReq requestBody, IdempotencyKey idempotencyKey)
retrofit2.Call<Charge>	createCharge(ChargesReq requestBody, IdempotencyKey idempotencyKey)
retrofit2.Call<Charge>	getStoreCharge(StoreId storeId, ChargeId id, Boolean polling)
retrofit2.Call<PaginatedList<Charge>>	listAllCharges(Integer limit, CursorDirection cursorDirection, ChargeId cursor, Map<String,String> propertySearch, String metadataSearch)
retrofit2.Call<PaginatedList<Charge>>	listAllStoreCharges(StoreId storeId, Integer limit, CursorDirection cursorDirection, ChargeId cursor, Map<String,String> propertySearch, String metadataSearch)
retrofit2.Call<Charge>	updateCharge(StoreId storeId, ChargeId id, PatchReq requestBody, IdempotencyKey idempotencyKey)

Method Detail

listAllCharges

@GET("/charges")
retrofit2.Call<PaginatedList<Charge>> listAllCharges(@Query("limit") @Nullable
                                                     Integer limit,
                                                     @Query("cursor_direction") @Nullable
                                                     CursorDirection cursorDirection,
                                                     @Query("cursor") @Nullable
                                                     ChargeId cursor,
                                                     @QueryMap @Nullable
                                                     Map<String,String> propertySearch,
                                                     @Query("metadata") @Nullable
                                                     String metadataSearch)

listAllStoreCharges

@GET("/stores/{storeId}/charges")
retrofit2.Call<PaginatedList<Charge>> listAllStoreCharges(@Path("storeId")
                                                          StoreId storeId,
                                                          @Query("limit") @Nullable
                                                          Integer limit,
                                                          @Query("cursor_direction") @Nullable
                                                          CursorDirection cursorDirection,
                                                          @Query("cursor") @Nullable
                                                          ChargeId cursor,
                                                          @QueryMap @Nullable
                                                          Map<String,String> propertySearch,
                                                          @Query("metadata") @Nullable
                                                          String metadataSearch)

getStoreCharge

@GET("/stores/{storeId}/charges/{id}")
retrofit2.Call<Charge> getStoreCharge(@Path("storeId")
                                      StoreId storeId,
                                      @Path("id")
                                      ChargeId id,
                                      @Query("polling") @Nullable
                                      Boolean polling)

createCharge

@POST("/charges")
retrofit2.Call<Charge> createCharge(@Body
                                    ChargesReq requestBody,
                                    @Header("Idempotency-Key")
                                    IdempotencyKey idempotencyKey)

updateCharge

@PATCH("/stores/{storeId}/charges/{id}")
retrofit2.Call<Charge> updateCharge(@Path("storeId")
                                    StoreId storeId,
                                    @Path("id")
                                    ChargeId id,
                                    @Body
                                    PatchReq requestBody,
                                    @Header("Idempotency-Key")
                                    IdempotencyKey idempotencyKey)

capture

@POST("/stores/{storeId}/charges/{id}/capture")
retrofit2.Call<Void> capture(@Path("storeId")
                             StoreId storeId,
                             @Path("id")
                             ChargeId id,
                             @Body
                             CaptureReq requestBody,
                             @Header("Idempotency-Key")
                             IdempotencyKey idempotencyKey)