Package jp.gopay.sdk.resources

Interface RefundsResource

public interface RefundsResource

Resource for managing refunds.

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<Refund>	create(StoreId storeId, ChargeId chargeId, RefundCreateData dataToPost, IdempotencyKey idempotencyKey)
retrofit2.Call<Refund>	get(StoreId storeId, ChargeId chargeId, RefundId refundId, Boolean polling)
retrofit2.Call<PaginatedList<Refund>>	list(StoreId storeId, ChargeId chargeId, Integer limit, CursorDirection cursorDirection, RefundId cursor, String metadataSearch)

Method Detail

list

@GET("/stores/{storeId}/charges/{chargeId}/refunds")
retrofit2.Call<PaginatedList<Refund>> list(@Path("storeId")
                                           StoreId storeId,
                                           @Path("chargeId")
                                           ChargeId chargeId,
                                           @Query("limit") @Nullable
                                           Integer limit,
                                           @Query("cursor_direction") @Nullable
                                           CursorDirection cursorDirection,
                                           @Query("cursor") @Nullable
                                           RefundId cursor,
                                           @Query("metadata") @Nullable
                                           String metadataSearch)

get

@GET("/stores/{storeId}/charges/{chargeId}/refunds/{refundId}")
retrofit2.Call<Refund> get(@Path("storeId")
                           StoreId storeId,
                           @Path("chargeId")
                           ChargeId chargeId,
                           @Path("refundId")
                           RefundId refundId,
                           @Query("polling") @Nullable
                           Boolean polling)

create

@POST("/stores/{storeId}/charges/{chargeId}/refunds")
retrofit2.Call<Refund> create(@Path("storeId")
                              StoreId storeId,
                              @Path("chargeId")
                              ChargeId chargeId,
                              @Body
                              RefundCreateData dataToPost,
                              @Header("Idempotency-Key")
                              IdempotencyKey idempotencyKey)