Package jp.gopay.sdk.resources

Interface MerchantsResource

public interface MerchantsResource

Resource for managing the merchant's information and history.

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<MerchantVerificationData>	createVerification(MerchantsReq dataToPost, IdempotencyKey idempotencyKey)
retrofit2.Call<PaginatedList<Transaction>>	getStoreTransactionHistory(StoreId storeId, Integer limit, CursorDirection cursorDirection, ResourceId cursor, String from, String to, TransactionStatus status, TransactionType type, ProcessingMode mode, String search, Boolean all)
retrofit2.Call<PaginatedList<Transaction>>	getTransactionHistory(Integer limit, CursorDirection cursorDirection, ResourceId cursor, String from, String to, TransactionStatus status, TransactionType type, ProcessingMode mode, String search, Boolean all)
retrofit2.Call<MerchantVerificationData>	getVerification()
retrofit2.Call<MerchantWithConfiguration>	me()
retrofit2.Call<MerchantVerificationData>	updateVerification(MerchantsReq dataToPatch, IdempotencyKey idempotencyKey)

Method Detail

getVerification

@GET("/verification")
retrofit2.Call<MerchantVerificationData> getVerification()

createVerification

@POST("/verification")
retrofit2.Call<MerchantVerificationData> createVerification(@Body
                                                            MerchantsReq dataToPost,
                                                            @Header("Idempotency-Key")
                                                            IdempotencyKey idempotencyKey)

updateVerification

@PATCH("/verification")
retrofit2.Call<MerchantVerificationData> updateVerification(@Body
                                                            MerchantsReq dataToPatch,
                                                            @Header("Idempotency-Key")
                                                            IdempotencyKey idempotencyKey)

getTransactionHistory

@GET("/transaction_history")
retrofit2.Call<PaginatedList<Transaction>> getTransactionHistory(@Query("limit") @Nullable
                                                                 Integer limit,
                                                                 @Query("cursor_direction") @Nullable
                                                                 CursorDirection cursorDirection,
                                                                 @Query("cursor") @Nullable
                                                                 ResourceId cursor,
                                                                 @Query("from") @Nullable
                                                                 String from,
                                                                 @Query("to") @Nullable
                                                                 String to,
                                                                 @Query("status") @Nullable
                                                                 TransactionStatus status,
                                                                 @Query("type") @Nullable
                                                                 TransactionType type,
                                                                 @Query("mode") @Nullable
                                                                 ProcessingMode mode,
                                                                 @Query("search") @Nullable
                                                                 String search,
                                                                 @Query("all") @Nullable
                                                                 Boolean all)

getStoreTransactionHistory

@GET("/stores/{storeId}/transaction_history")
retrofit2.Call<PaginatedList<Transaction>> getStoreTransactionHistory(@Path("storeId")
                                                                      StoreId storeId,
                                                                      @Query("limit") @Nullable
                                                                      Integer limit,
                                                                      @Query("cursor_direction") @Nullable
                                                                      CursorDirection cursorDirection,
                                                                      @Query("cursor") @Nullable
                                                                      ResourceId cursor,
                                                                      @Query("from") @Nullable
                                                                      String from,
                                                                      @Query("to") @Nullable
                                                                      String to,
                                                                      @Query("status") @Nullable
                                                                      TransactionStatus status,
                                                                      @Query("type") @Nullable
                                                                      TransactionType type,
                                                                      @Query("mode") @Nullable
                                                                      ProcessingMode mode,
                                                                      @Query("search") @Nullable
                                                                      String search,
                                                                      @Query("all") @Nullable
                                                                      Boolean all)

me

@GET("/me")
retrofit2.Call<MerchantWithConfiguration> me()