fake-toss-payments-server
Version:
Fake toss-payments server for testing
56 lines (55 loc) • 2.59 kB
TypeScript
/**
* @packageDocumentation
* @module api.functional.v1.billing
* @nestia Generated by Nestia - https://github.com/samchon/nestia
*/
import type { IConnection } from "@nestia/fetcher";
import type { ITossBilling } from "../../../structures/ITossBilling";
import type { ITossPayment } from "../../../structures/ITossPayment";
export * as authorizations from "./authorizations";
/**
* 간편 결제에 등록한 수단으로 결제하기.
*
* `billing.pay` 는 간편 결제에 등록한 수단으로 결제를 진행하고자 할 때 호출하는 API
* 함수이다.
*
* 그리고 `billing.pay` 는 결제 수단 중 유일하게, 클라이언트 어플리케이션이 토스
* 페이먼츠가 제공하는 결제 창을 사용할 수 없어, 귀하의 백엔드 서버가 토스 페이먼츠의
* API 함수를 직접 호출해야 하는 경우에 해당한다. 따라서 간편 결제에 관련하여 토스
* 페이먼츠와 연동하는 백엔드 서버 및 프론트 어플리케이션을 개발할 때, 반드시 이 상황에
* 대한 별도의 설계 및 개발이 필요하니, 이 점을 염두에 두기 바란다.
*
* 더하여 `billing.pay` 는 철저히 귀사 백엔드 서버의 판단 아래 호출되는 API 함수인지라,
* 이를 통하여 이루어지는 결제는 일절 {@link payments.approve} 가 필요 없다. 다만
* `billing.pay` 는 이처럼 부차적인 승인 과정 필요없이 그 즉시로 결제가 완성되니, 이를
* 호출하는 상황에 대하여 세심히 주의를 기울일 필요가 있다
*
* @param billingKey 간편 결제에 등록한 수단의 {@link ITossBilling.billingKey }
* @param input 주문 정보
* @returns 결제 정보
* @security basic
* @author Samchon
*
* @controller FakeTossBillingController.pay
* @path POST /v1/billing/:billingKey
* @nestia Generated by Nestia - https://github.com/samchon/nestia
*/
export declare function pay(connection: IConnection, billingKey: string, input: ITossBilling.IPaymentStore): Promise<pay.Output>;
export declare namespace pay {
type Input = ITossBilling.IPaymentStore;
type Output = ITossPayment;
const METADATA: {
readonly method: "POST";
readonly path: "/v1/billing/:billingKey";
readonly request: {
readonly type: "application/json";
readonly encrypted: false;
};
readonly response: {
readonly type: "application/json";
readonly encrypted: false;
};
readonly status: 201;
};
const path: (billingKey: string) => string;
}