충전 주문 상세 조회
주문 번호로 충전 주문 상세 조회
중국 본토 사용자 안내: 중국 본토 사용자는 https://api.toapis.cn 를 API 엔드포인트(Base URL)로 사용해 주세요. 본 문서의 예시에서 https://api.toapis.com 을 https://api.toapis.cn 로 바꿔 주세요.
인증, 페이지 처리 및 오류는 시작하기를 참조하세요.
동작
trade_no로 단일 충전 주문의 상세를 반환합니다. 자신의 청구를 조회할 수 있는 것은 메인 계정뿐이며 서브 계정은 HTTP 403, 메인 계정도 본 엔드포인트로 멤버 청구를 조회할 수 없습니다.
trade_no로 자신의 주문 하나를 조회하며 외부 결제 플랫폼 주문 번호는 지원하지 않습니다. 타인의 주문, 없는 주문, 별도 오프라인 환불은 404입니다. 이 엔드포인트는 결제 플랫폼 조회나 대조를 수행하지 않습니다.
planned_credits는 예정 입금액, credited_credits는 확정 입금액, refunded_credits는 환불을 별도로 기록하며 원래 입금에서 차감하지 않습니다. 성공하지 않은 주문은 credited_credits="0"입니다.
refund=null이라도 다른 환불이 없음을 보장하지 않고 로컬 환불 스냅샷은 카드 입금을 의미하지 않습니다.
인증
Authorizationstring헤더필수Bearer YOUR_SYSTEM_ACCESS_TOKEN 을 사용합니다. 모델 API 키는 사용할 수 없습니다. X-User-Id 는 필요하지 않습니다.
요청 매개변수
trade_nostring경로필수플랫폼 충전 주문 번호. 외부 결제 제공자의 주문 ID 로 대체할 수 없습니다.
제약: minLength=1; maxLength=255.
요청 예제
요청 예시
curl --request GET \
--url 'https://api.toapis.com/api/v1/billing/topups/trade_example_01' \
--header 'Authorization: Bearer YOUR_SYSTEM_ACCESS_TOKEN'import requests
response = requests.get(
"https://api.toapis.com/api/v1/billing/topups/trade_example_01",
headers={"Authorization": "Bearer YOUR_SYSTEM_ACCESS_TOKEN"},
timeout=30,
)
response.raise_for_status()
print(response.json())const url = new URL("https://api.toapis.com/api/v1/billing/topups/trade_example_01");
const response = await fetch(url, {
headers: { Authorization: "Bearer YOUR_SYSTEM_ACCESS_TOKEN" },
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) {
throw new Error(`HTTP ${response.status}: ${await response.text()}`);
}
console.log(await response.json());응답 필드
예시는 가상 데이터이며 credits_per_usd="100" 을 가정합니다. 실제 환산에는 응답 값을 사용하세요.
codeinteger결과 코드. 0 은 성공입니다.
messagestring성공 시 빈 문자열이며 오류 메시지는 현지화됩니다.
dataobject현재 조회의 결과 객체입니다.
data.idstring충전 주문의 내부 ID. 상세 조회에는 trade_no 를 사용합니다. 10 진수 ID 문자열로 반환합니다.
data.trade_nostring상세 조회용 플랫폼 충전 주문 번호이며 외부 결제 주문 ID 가 아닙니다.
data.providerstring결제 서비스 제공자입니다.
data.statusstring충전 주문 상태. 성공한 주문만 확정 입금을 나타냅니다.
data.trigger_typestring | null수동 또는 자동 등의 충전 시작 방식. 과거 값은 null 일 수 있습니다.
data.created_atstring | null생성 시각입니다. 시간대가 포함된 RFC 3339 형식입니다. 불명확하거나 해당하지 않으면 null 입니다.
data.completed_atstring | null주문 완료 시각입니다. 시간대가 포함된 RFC 3339 형식입니다. 불명확하거나 해당하지 않으면 null 입니다.
data.recorded_payment_amountstring | null로컬 주문의 원래 통화 결제 금액. 통화는 payment_currency 이며 credits 계산에 사용하지 않습니다. 정밀도를 유지하기 위해 십진수 문자열로 반환합니다. 불명확하거나 해당하지 않으면 null 입니다.
data.payment_currencystring | null주문에 기록된 원래 결제 통화입니다. 불명확하거나 해당하지 않으면 null 입니다.
data.planned_creditsstring | null예정된 credits 이며 확정 입금액과 다릅니다. 정밀도를 유지하기 위해 십진수 문자열로 반환합니다. 불명확하거나 해당하지 않으면 null 입니다.
data.credited_creditsstring | null확정 입금 credits. 성공 전 주문은 "0", 과거 금액 미확인 시 null 입니다. 정밀도를 유지하기 위해 십진수 문자열로 반환합니다.
data.refunded_creditsstring | null주문에 기록된 환불 credits 를 원래 입금에서 빼지 않고 별도로 표시합니다. 정밀도를 유지하기 위해 십진수 문자열로 반환합니다. 불명확하거나 해당하지 않으면 null 입니다.
data.refundobject | null주문의 로컬 환불 정보. null 은 독립 오프라인 환불 부재나 카드 입금을 보장하지 않습니다.
data.refund.statusstring주문에 기록된 환불 상태입니다.
data.refund.recorded_amountstring | null로컬 환불 기록의 원래 통화 금액. 통화는 currency 입니다. 정밀도를 유지하기 위해 십진수 문자열로 반환합니다. 불명확하거나 해당하지 않으면 null 입니다.
data.refund.currencystring | null금액에 사용되는 원래 통화입니다. 불명확하거나 해당하지 않으면 null 입니다.
data.refund.recorded_atstring | null로컬 환불 기록 시각입니다. 시간대가 포함된 RFC 3339 형식입니다. 불명확하거나 해당하지 않으면 null 입니다.
data.metaobject데이터 출처, 조회 범위 및 집계 기준 등의 메타데이터입니다.
data.meta.sourcestring데이터 출처입니다. 로컬 설정이나 원장 스냅샷은 실시간 Stripe 상태를 뜻하지 않습니다. 고정 값: "local_ledger".
data.meta.refund_coveragestring환불 정보의 범위이며 주문 환불 스냅샷만 포함합니다. 고정 값: "order_snapshot_only".
data.meta.standalone_offline_refunds_includedboolean독립 오프라인 환불 포함 여부이며 현재 false 입니다.
data.meta.payment_amount_basisstring결제 금액의 기준이며 로컬 주문 스냅샷을 사용합니다. 고정 값: "local_order_snapshot".
data.meta.consistencystringeventual 은 최종 일관성으로 기록이 나중에 갱신될 수 있습니다.
data.meta.payment_amount_sourcestring결제 금액 확인에 사용한 기록 출처입니다.
data.meta.credit_amount_sourcestring입금 credits 확인에 사용한 기록 출처입니다.
응답 예제
응답 예시
{
"code": 0,
"message": "",
"data": {
"id": "501",
"trade_no": "trade_example_01",
"provider": "stripe",
"status": "success",
"trigger_type": "manual",
"created_at": "2026-11-01T08:00:00Z",
"completed_at": "2026-11-01T08:01:00Z",
"recorded_payment_amount": "10",
"payment_currency": "USD",
"planned_credits": "1000",
"credited_credits": "1000",
"refunded_credits": "0",
"refund": null,
"meta": {
"source": "local_ledger",
"consistency": "eventual",
"payment_amount_basis": "local_order_snapshot",
"refund_coverage": "order_snapshot_only",
"standalone_offline_refunds_included": false,
"payment_amount_source": "paid_amount",
"credit_amount_source": "credited_credits"
}
}
}