Package jp.gopay.sdk.resources

Interface TransactionTokensResource

public interface TransactionTokensResource

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<TransactionTokenWithData>	create(CreateReq dataToPost, IdempotencyKey idempotencyKey)
retrofit2.Call<TemporaryTokenAlias>	createAlias(TemporaryTokenAliasReq dataToPost, IdempotencyKey idempotencyKey)
retrofit2.Call<Void>	delete(StoreId storeId, TransactionTokenId tokenId)
retrofit2.Call<Void>	deleteAlias(StoreId storeId, TemporaryTokenAliasId aliasId)
retrofit2.Call<TransactionTokenWithData>	get(StoreId storeId, TransactionTokenId tokenId)
retrofit2.Call<TemporaryTokenAlias>	getAlias(StoreId storeId, TemporaryTokenAliasId aliasId)
retrofit2.Call<GoPayBinaryData>	getAliasAsImage(StoreId storeId, TemporaryTokenAliasId aliasId, String media)
retrofit2.Call<PaginatedList<TransactionToken>>	list(StoreId storeId, Integer limit, CursorDirection cursorDirection, TransactionTokenId cursor, Boolean all, String search, ProcessingMode mode, TransactionTokenType type, GopayCustomerId customerId)
retrofit2.Call<PaginatedList<TransactionToken>>	listMerchant(Integer limit, CursorDirection cursorDirection, TransactionTokenId cursor, Boolean all, String search, ProcessingMode mode, TransactionTokenType type, GopayCustomerId customerId)
retrofit2.Call<TransactionTokenWithData>	update(StoreId storeId, TransactionTokenId tokenId, UpdateReq dataToPatch, IdempotencyKey idempotencyKey)

Method Detail

create

@POST("/tokens")
retrofit2.Call<TransactionTokenWithData> create(@Body
                                                CreateReq dataToPost,
                                                @Header("Idempotency-Key")
                                                IdempotencyKey idempotencyKey)

get

@GET("/stores/{storeId}/tokens/{tokenId}")
retrofit2.Call<TransactionTokenWithData> get(@Path("storeId")
                                             StoreId storeId,
                                             @Path("tokenId")
                                             TransactionTokenId tokenId)

delete

@DELETE("/stores/{storeId}/tokens/{tokenId}")
retrofit2.Call<Void> delete(@Path("storeId")
                            StoreId storeId,
                            @Path("tokenId")
                            TransactionTokenId tokenId)

update

@PATCH("/stores/{storeId}/tokens/{tokenId}")
retrofit2.Call<TransactionTokenWithData> update(@Path("storeId")
                                                StoreId storeId,
                                                @Path("tokenId")
                                                TransactionTokenId tokenId,
                                                @Body
                                                UpdateReq dataToPatch,
                                                @Header("Idempotency-Key")
                                                IdempotencyKey idempotencyKey)

list

@GET("/stores/{storeId}/tokens")
retrofit2.Call<PaginatedList<TransactionToken>> list(@Path("storeId")
                                                     StoreId storeId,
                                                     @Query("limit") @Nullable
                                                     Integer limit,
                                                     @Query("cursor_direction") @Nullable
                                                     CursorDirection cursorDirection,
                                                     @Query("cursor") @Nullable
                                                     TransactionTokenId cursor,
                                                     @Query("all") @Nullable
                                                     Boolean all,
                                                     @Query("search") @Nullable
                                                     String search,
                                                     @Query("mode") @Nullable
                                                     ProcessingMode mode,
                                                     @Query("type") @Nullable
                                                     TransactionTokenType type,
                                                     @Query("customer_id") @Nullable
                                                     GopayCustomerId customerId)

listMerchant

@GET("/tokens")
retrofit2.Call<PaginatedList<TransactionToken>> listMerchant(@Query("limit") @Nullable
                                                             Integer limit,
                                                             @Query("cursor_direction") @Nullable
                                                             CursorDirection cursorDirection,
                                                             @Query("cursor") @Nullable
                                                             TransactionTokenId cursor,
                                                             @Query("all") @Nullable
                                                             Boolean all,
                                                             @Query("search") @Nullable
                                                             String search,
                                                             @Query("mode") @Nullable
                                                             ProcessingMode mode,
                                                             @Query("type") @Nullable
                                                             TransactionTokenType type,
                                                             @Query("customer_id") @Nullable
                                                             GopayCustomerId customerId)

createAlias

@POST("/tokens/alias")
retrofit2.Call<TemporaryTokenAlias> createAlias(@Body
                                                TemporaryTokenAliasReq dataToPost,
                                                @Header("Idempotency-Key")
                                                IdempotencyKey idempotencyKey)

getAlias

@GET("/stores/{storeId}/tokens/alias/{aliasId}")
retrofit2.Call<TemporaryTokenAlias> getAlias(@Path("storeId")
                                             StoreId storeId,
                                             @Path("aliasId")
                                             TemporaryTokenAliasId aliasId)

getAliasAsImage

@GET("/stores/{storeId}/tokens/alias/{aliasId}")
retrofit2.Call<GoPayBinaryData> getAliasAsImage(@Path("storeId")
                                                StoreId storeId,
                                                @Path("aliasId")
                                                TemporaryTokenAliasId aliasId,
                                                @Query("media") @Nullable
                                                String media)

deleteAlias

@DELETE("/stores/{storeId}/tokens/alias/{aliasId}")
retrofit2.Call<Void> deleteAlias(@Path("storeId")
                                 StoreId storeId,
                                 @Path("aliasId")
                                 TemporaryTokenAliasId aliasId)