Class CashReceiptService

java.lang.Object

kr.paysync.sdk.cashreceipt.CashReceiptService

public final class CashReceiptService
extends Object

현금영수증 API입니다.

Constructor Summary

Constructors

Constructor	Description
CashReceiptService(HttpTransport transport)

Method Summary

Modifier and Type	Method	Description
CashReceipt	cancel(String id, String reason)	남은 금액 전체를 취소합니다.
CashReceipt	cancel(String id, String reason, long amount)	금액 일부를 취소합니다.
CompletableFuture<CashReceipt>	cancelAsync(String id, String reason, @Nullable Long amount)
CashReceipt	get(String id)	현금영수증을 조회합니다.
CompletableFuture<CashReceipt>	getAsync(String id)
CashReceipt	issue(CashReceiptIssueParams params)	현금영수증을 발급합니다.
CompletableFuture<CashReceipt>	issueAsync(CashReceiptIssueParams params)
Page<CashReceipt>	list()	현금영수증 목록의 첫 페이지를 조회합니다.
Page<CashReceipt>	list(CashReceiptListParams params)	현금영수증 목록을 조회합니다.
Page<CashReceipt>	list(CashReceiptListParams params, long offset, int limit)	offset과 limit을 따로 넣어 현금영수증 목록을 조회합니다.
Iterable<CashReceipt>	listAll()	모든 현금영수증을 조회합니다.
Iterable<CashReceipt>	listAll(CashReceiptListParams params)	조건에 맞는 현금영수증을 마지막 페이지까지 모두 조회합니다.
CompletableFuture<Page<CashReceipt>>	listAsync(CashReceiptListParams params)
CompletableFuture<Page<CashReceipt>>	listAsync(CashReceiptListParams params, long offset, int limit)
CashReceipt	reissue(String id)	발급에 실패한 현금영수증을 원본과 같은 값으로 재발급합니다.
CashReceipt	reissue(String id, CashReceiptReissueParams params)	발급에 실패한 현금영수증을 재발급합니다.
CompletableFuture<CashReceipt>	reissueAsync(String id, CashReceiptReissueParams params)
void	sendEmail(String id, String email)	현금영수증을 이메일로 보냅니다.
CompletableFuture<Void>	sendEmailAsync(String id, String email)
void	sendSms(String id, String phoneNumber)	현금영수증을 문자로 보냅니다.
CompletableFuture<Void>	sendSmsAsync(String id, String phoneNumber)
CashReceiptUrls	urls(String id)	현금영수증 문서 주소를 받습니다.
CompletableFuture<CashReceiptUrls>	urlsAsync(String id)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CashReceiptService

public CashReceiptService(HttpTransport transport)

Method Details

issue

public CashReceipt issue(CashReceiptIssueParams params)

현금영수증을 발급합니다. 발급이 거절되면 CashReceiptStatus.FAILED 상태로 돌아옵니다.

issueAsync

public CompletableFuture<CashReceipt> issueAsync(CashReceiptIssueParams params)

get

public CashReceipt get(String id)

현금영수증을 조회합니다.

getAsync

public CompletableFuture<CashReceipt> getAsync(String id)

list

public Page<CashReceipt> list()

현금영수증 목록의 첫 페이지를 조회합니다.

list

public Page<CashReceipt> list(CashReceiptListParams params)

현금영수증 목록을 조회합니다.

listAsync

public CompletableFuture<Page<CashReceipt>> listAsync(CashReceiptListParams params)

listAll

public Iterable<CashReceipt> listAll(CashReceiptListParams params)

조건에 맞는 현금영수증을 마지막 페이지까지 모두 조회합니다.

listAll

public Iterable<CashReceipt> listAll()

모든 현금영수증을 조회합니다.

list

public Page<CashReceipt> list(CashReceiptListParams params,
 long offset,
 int limit)

offset과 limit을 따로 넣어 현금영수증 목록을 조회합니다.

listAsync

public CompletableFuture<Page<CashReceipt>> listAsync(CashReceiptListParams params,
 long offset,
 int limit)

cancel

public CashReceipt cancel(String id,
 String reason)

남은 금액 전체를 취소합니다. 새로 만든 취소 영수증을 돌려줍니다.

Parameters:

reason - 취소 사유

cancel

public CashReceipt cancel(String id,
 String reason,
 long amount)

금액 일부를 취소합니다. 새로 만든 취소 영수증을 돌려줍니다.

Parameters:

reason - 취소 사유

amount - 취소할 금액

cancelAsync

public CompletableFuture<CashReceipt> cancelAsync(String id,
 String reason,
 @Nullable Long amount)

Parameters:

amount - 취소할 금액. null이면 남은 금액 전체를 취소합니다.

reissue

public CashReceipt reissue(String id)

발급에 실패한 현금영수증을 원본과 같은 값으로 재발급합니다.

reissue

public CashReceipt reissue(String id,
 CashReceiptReissueParams params)

발급에 실패한 현금영수증을 재발급합니다.

reissueAsync

public CompletableFuture<CashReceipt> reissueAsync(String id,
 CashReceiptReissueParams params)

urls

public CashReceiptUrls urls(String id)

현금영수증 문서 주소를 받습니다.

urlsAsync

public CompletableFuture<CashReceiptUrls> urlsAsync(String id)

sendEmail

public void sendEmail(String id,
 String email)

현금영수증을 이메일로 보냅니다.

sendEmailAsync

public CompletableFuture<Void> sendEmailAsync(String id,
 String email)

sendSms

public void sendSms(String id,
 String phoneNumber)

현금영수증을 문자로 보냅니다.

sendSmsAsync

public CompletableFuture<Void> sendSmsAsync(String id,
 String phoneNumber)