본문으로 건너뛰기
버전: 1.0.1

Transactions API

Endpoints for managing payment transactions.

Create Transaction

POST /api/transaction/create

Create a new payment transaction.

Request Body

FieldTypeRequiredDescription
amountLongYesAmount in cents
currencyStringYesISO 4217 currency code
channelIdLongYesPayment channel ID
descriptionStringNoTransaction description
metadataObjectNoCustom metadata
customerIdLongNoCustomer ID
invoiceIdLongNoInvoice ID

Response

{
"code": 200,
"message": "Transaction created",
"data": {
"id": "TXN2026081800001",
"amount": 100000,
"currency": "USD",
"status": "PENDING",
"channelId": 1,
"description": "Test payment",
"createdTime": "2026-08-18T10:00:00Z"
}
}

Retrieve Transaction

GET /api/transaction/detail

Query Parameters

ParameterTypeRequiredDescription
idStringYesTransaction ID

Response

{
"code": 200,
"data": {
"id": "TXN2026081800001",
"amount": 100000,
"currency": "USD",
"status": "SUCCESS",
"channelId": 1,
"channelName": "Stripe",
"description": "Test payment",
"createdTime": "2026-08-18T10:00:00Z",
"updatedTime": "2026-08-18T10:05:00Z"
}
}

List Transactions

GET /api/transaction/list

Query Parameters

ParameterTypeDescription
pageIntegerPage number (default: 1)
pageSizeIntegerItems per page (default: 20, max: 100)
statusStringFilter by status
channelIdLongFilter by channel
startDateStringStart date (YYYY-MM-DD)
endDateStringEnd date (YYYY-MM-DD)
userIdLongFilter by user

Response

{
"code": 200,
"data": [
{
"id": "TXN2026081800001",
"amount": 100000,
"currency": "USD",
"status": "SUCCESS",
"channelName": "Stripe",
"createdTime": "2026-08-18T10:00:00Z"
}
],
"pagination": {
"page": 1,
"pageSize": 20,
"total": 1,
"totalPages": 1
}
}

Transaction Status Codes

StatusDescription
PENDINGAwaiting processing
PROCESSINGBeing processed
SUCCESSCompleted successfully
FAILEDProcessing failed
REFUNDEDFully or partially refunded
CANCELLEDCancelled by user/system