fake-toss-payments-server
Version:
Fake toss-payments server for testing
55 lines (54 loc) • 2.62 kB
TypeScript
/**
* @packageDocumentation
* @module api.functional.v1.virtual_accounts
* @nestia Generated by Nestia - https://github.com/samchon/nestia
*/
import type { IConnection } from "@nestia/fetcher";
import type { ITossVirtualAccountPayment } from "../../../structures/ITossVirtualAccountPayment";
/**
* 가상 계좌로 결제 신청하기.
*
* `virtual_accounts.create` 는 고객이 결제 수단을 가상 계좌로 선택하는 경우에 호출되는
* API 함수이다. 물론 고객이 이처럼 가상 계좌를 선택한 경우, 고객이 지정된 계좌에 돈을
* 입금하기 전까지는 결제가 마무리된 것이 아니기에, {@link ITossPayment.status} 값은
* `WAITING_FOR_DEPOSIT` 이 된다.
*
* 참고로 `virtual_accounts.create` 는 클라이언트 어플리케이션이 토스 페이먼츠가
* 자체적으로 제공하는 결제 창을 사용하는 경우, 귀하의 백엔드 서버가 이를 실 서비스에서
* 호출하는 일은 없을 것이다. 다만, 고객이 가상 계좌로 결제를 진행하는 상황을
* 시뮬레이션하기 위하여, 테스트 자동화 프로그램 수준에서 사용될 수는 있다.
*
* 그리고 `virtual_accounts.create` 이후에 고객이 지정된 계좌에 금액을 입금하거든, 토스
* 페이먼츠 서버로부터 웹훅 이벤트가 발생되어 귀하의 백엔드 서버로 전송된다. 만약 연동
* 대상 토스 페이먼츠 서버가 실제가 아닌 `fake-toss-payments-server` 라면,
* {@link internal.virtual_accounts.deposit} 를 호출하여, 고객이 가상 계좌에 입금하는
* 상황을 시뮬레이션 할 수 있다.
*
* @param input 가상 결제 신청 정보.
* @returns 가상 계좌 결제 정보
* @security basic
* @author Samchon
*
* @controller FakeTossVirtualAccountsController.create
* @path POST /v1/virtual-accounts
* @nestia Generated by Nestia - https://github.com/samchon/nestia
*/
export declare function create(connection: IConnection, input: ITossVirtualAccountPayment.ICreate): Promise<create.Output>;
export declare namespace create {
type Input = ITossVirtualAccountPayment.ICreate;
type Output = ITossVirtualAccountPayment;
const METADATA: {
readonly method: "POST";
readonly path: "/v1/virtual-accounts";
readonly request: {
readonly type: "application/json";
readonly encrypted: false;
};
readonly response: {
readonly type: "application/json";
readonly encrypted: false;
};
readonly status: 201;
};
const path: () => string;
}