TossPaymentsApi

README

Toss Payments Api Wrapper

Toss Payments Api Wrapper, based on version 1.4

Documentation

Index

• type ApprovePaymentOption
• type CancelPaymentOption
• type Client
  • func NewClient(apiKey string) *Client
  • func (c *Client) ApprovePayment(paymentKey string, option *ApprovePaymentOption) (*Payment, error)
  • func (c *Client) CancelPayment(paymentKey string, option *CancelPaymentOption) (*Payment, error)
  • func (c *Client) InquiryPaymentByOrderId(orderId string) (*Payment, error)
  • func (c *Client) InquiryPaymentByPaymentKey(paymentKey string) (*Payment, error)
  • func (c *Client) KeyinPaymentRequest(option *KeyinPaymentOption) (*Payment, error)
• type Error
• type KeyinPaymentOption
• type Payment
• type RefundReceiveAccount

Types

type ApprovePaymentOption

type ApprovePaymentOption struct {
	OrderId string `json:"orderId"`
	Amount  int64  `json:"amount"`
}

type CancelPaymentOption

type CancelPaymentOption struct {
	CancelReason         string                `json:"cancelReason"`
	CancelAmount         *int64                `json:"cancelAmount"`
	RefundReceiveAccount *RefundReceiveAccount `json:"refundReceiveAccount"`
	TaxFreeAmount        *int64                `json:"taxFreeAmount"`
	RefundableAmount     *int64                `json:"refundableAmount"`
}

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(apiKey string) *Client

func (*Client) ApprovePayment

func (c *Client) ApprovePayment(paymentKey string, option *ApprovePaymentOption) (*Payment, error)

func (*Client) CancelPayment

func (c *Client) CancelPayment(paymentKey string, option *CancelPaymentOption) (*Payment, error)

func (*Client) InquiryPaymentByOrderId

func (c *Client) InquiryPaymentByOrderId(orderId string) (*Payment, error)

func (*Client) InquiryPaymentByPaymentKey

func (c *Client) InquiryPaymentByPaymentKey(paymentKey string) (*Payment, error)

func (*Client) KeyinPaymentRequest

func (c *Client) KeyinPaymentRequest(option *KeyinPaymentOption) (*Payment, error)

type Error

type Error struct {
	Code    string `json:"code"`    // Error code
	Message string `json:"message"` // An error message which describe error
}

type KeyinPaymentOption

type KeyinPaymentOption struct {
	Amount                 int64   `json:"amount"`
	OrderId                string  `json:"orderId"`
	CardNumber             string  `json:"cardNumber"`
	CardExpirationYear     string  `json:"cardExpirationYear"`
	CardExpirationMonth    string  `json:"cardExpirationMonth"`
	OrderName              *string `json:"orderName"`
	CardPassword           *string `json:"cardPassword"`
	CustomerIdentityNumber *string `json:"customerIdentityNumber"`
	CardInstallmentPlan    *int    `json:"cardInstallmentPlan"`
	TaxFreeAmount          *int    `json:"taxFreeAmount"`
	CustomerEmail          *string `json:"customerEmail"`
	VBV                    *struct {
		CAVV string `json:"cavv"` // Cardholder Authentication Verification Value
		XID  string `json:"xid"`  // Transaction ID
		ECI  string `json:"eci"`  // Electronic Commerce Indicator
	} `json:"vbv"`
}

type Payment

type Payment struct {
	Version        string `json:"version"`        // Version of the payment object
	PaymentKey     string `json:"paymentKey"`     // Unique key of transaction
	OrderId        string `json:"orderId"`        // Unique ID issued by the merchant of order
	OrderName      string `json:"orderName"`      // Name of the order
	Type           string `json:"type"`           // Payment type information [ Possible Values : "NORMAL", "BILLING", "CONNECTPAY" ]
	Method         string `json:"method"`         // Payment method [ Possible Values : "카드", "가상계좌", "휴대폰", "계좌이체", "상품권(문화상품권, 도서문화상품권, 게임문화상품권)" ]
	MemberId       string `json:"mid"`            // Merchant ID
	Currency       string `json:"currency"`       // Currency of the payment, MUST be "KRW"
	TotalAmount    int64  `json:"totalAmount"`    // Total payment amount
	BalanceAmount  int64  `json:"balanceAmount"`  // Cancelable Amount (current balance)
	Status         string `json:"status"`         // Payment status [ Possible Values : "READY", "IN_PROGRESS", "WAITING_FOR_DEPOSIT", "DONE", "CANCELED", "PARTIAL_CANCELLED", "ABORTED", "EXPIRED" ]
	RequestedAt    string `json:"requestedAt"`    // Requested time, [ISO 8601 format]
	ApprovedAt     string `json:"approvedAt"`     // Approved time, [ISO 8601 format]
	UseEscrow      bool   `json:"useEscrow"`      // Whether to use escrow service
	TransactionKey string `json:"transactionKey"` // Unique key of transaction
	SuppliedAmount int64  `json:"suppliedAmount"` // Supplied amount
	Vat            int64  `json:"vat"`            // VAT amount
	CultureExpense bool   `json:"cultureExpense"` // Whether to use culture expense
	TaxFreeAmount  int64  `json:"taxFreeAmount"`  // Tax-free amount
	// Payment Cancellation History, NULLABLE
	Cancels *[]struct {
		CancelAmount     int64  `json:"cancelAmount"`     // Canceled amount
		CancelReason     string `json:"cancelReason"`     // Canceled reason
		TaxFreeAmount    int64  `json:"taxFreeAmount"`    // Tax-free amount
		TaxAmount        *int64 `json:"taxAmount"`        // Tax amount, NULLABLE
		RefundableAmount int64  `json:"refundableAmount"` // Refundable amount
		CancelAt         string `json:"cancelAt"`         // Canceled time, [ISO 8601 format]
	} `json:"cancels"`
	IsPartialCancelable bool `json:"isPartialCancelable"` // Whether partial cancellation is available
	// Card information, NULLABLE
	Card *struct {
		Company               string `json:"company"`               // Card company code
		Number                string `json:"number"`                // Card number, Partial masked
		InstallmentPlanMonths int    `json:"installmentPlanMonths"` // Installment month, 0 if lump sum payment
		IsInterestFree        bool   `json:"isInterestFree"`        // Whether interest free is available
		InterestPayer         string `json:"interestPayer"`         // Interest fee payer if interest free is available, [ Possible Values : "CUSTOMER", "MERCHANT", "CARD_COMPANY" ]
		ApproveNo             string `json:"approveNo"`             // Approval number of card company
		UseCardPoint          bool   `json:"useCardPoint"`          // Whether to use card point
		CardType              string `json:"cardType"`              // Card type, [ Possible Values : "신용","체크","기프트" ]
		OwnerType             string `json:"ownerType"`             // Card owner type, [ Possible Values : "개인","법인" ]
		AcquireStatus         string `json:"acquireStatus"`         // Acquire status, [ Possible Values : "READY", "REQUESTED", "COMPLETED", "CANCEL_REQUESTED", "CANCELED" ]
		ReceiptURL            string `json:"receiptUrl"`            // Card sales slip URL
	} `json:"card"`
	VirtualAccount struct {
		AccountNumber    string `json:"accountNumber"`    // Virtual account number
		AccountType      string `json:"accountType"`      // Virtual account type, [ Possible Values : "일반", "고정" ]
		Bank             string `json:"bank"`             // Virtual account bank
		CustomerName     string `json:"customerName"`     // Owner name who issued virtual account
		DueDate          string `json:"dueDate"`          // Due date of virtual account
		Expired          bool   `json:"expired"`          // Whether virtual account is expired
		SettlementStatus string `json:"settlementStatus"` // Settlement status of virtual account, [ Possible Values : "INCOMPLETE", "COMPLETE" ]
		RefundStatus     string `json:"refundStatus"`     // Refund status of virtual account, [ Possible Values : "NONE", "FAILED", "PENDING", "PARTIAL_FAILED", "COMPLETED" ]
	} `json:"virtualAccount"`
	Secret      *string `json:"secret"` // Secret which is using for validate virtual account payment callback, NULLABLE
	MobilePhone *struct {
		Carrier             string `json:"carrier"`             // Carrier name of mobile purchase device
		CustomerMobilePhone string `json:"customerMobilePhone"` // Mobile phone number which used for mobile purchase
		SettlementStatus    string `json:"settlementStatus"`    // Settlement status of mobile phone payment, [ Possible Values : "INCOMPLETE", "COMPLETE" ]
		ReceiptUrl          string `json:"receiptUrl"`          // Mobile phone payment receipt URL
	}
	GiftCertificate *struct {
		ApproveNo        string `json:"approveNo"`        // Approval number of gift certificate company
		SettlementStatus string `json:"settlementStatus"` // Settlement status of gift certificate payment, [ Possible Values : "INCOMPLETE", "COMPLETE" ]
	}
	Transfer *struct {
		Bank             string `json:"bank"`             // Bank name of transfer payment
		SettlementStatus string `json:"settlementStatus"` // Settlement status of transfer payment, [ Possible Values : "INCOMPLETE", "COMPLETE" ]
	}
	EasyPay     *string `json:"easyPay"` // EasyPay name information of payment, NULLABLE
	Country     string  `json:"country"` // Country Information Paid
	CashReceipt *struct {
		Type          string `json:"type"`          // Cash receipt type, [ Possible Values : "소득공제", "지출증빙" ]
		Amount        int64  `json:"amount"`        // Cash receipt amount
		TaxFreeAmount int64  `json:"taxFreeAmount"` // Tax-free
		IssueNumber   string `json:"issueNumber"`   // Cash receipt issue number
		ReceiptUrl    string `json:"receiptUrl"`    // Cash receipt receipt URL
	}
	Discount *struct {
		Amount int64 `json:"amount"` // Discount amount
	}
}

Payment Object containing payment information Definition : https://docs.tosspayments.com/reference#payment-%EA%B0%9D%EC%B2%B4

type RefundReceiveAccount

type RefundReceiveAccount struct {
	Bank          string `json:"bank"`          // Bank code
	AccountNumber string `json:"accountNumber"` // Account number
	HolderName    string `json:"holderName"`    // Account holder name
}