개발자

GET/v3/getbalance

계정 잔액 조회

API 계정에 저장된 잔액, 통화 및 결제 조건을 조회합니다.

이 페이지의 내용
  1. 요청
  2. 응답
  3. 오류 및 사용 시 유의 사항

API 인증 정보에 해당하는 계정의 잔액, 통화 및 결제 조건 값을 조회합니다. 이 작업은 잔액 조회이며, 금액을 충전하거나 주문을 생성하지 않습니다.

요청

서버 측 API 인증 정보를 사용하여 HTTPS로 요청하세요. 예제는 환경 변수에서 인증 정보를 읽으며, 실제로 사용할 수 있는 인증 정보는 포함하지 않습니다. 응답을 확인할 때는 status.code 값을 JSON 본문에서 확인하고 HTTP 상태도 확인하세요. 이러한 레거시 핸들러는 애플리케이션 오류가 발생해도 HTTP 오류 상태를 일관되게 설정하지는 않습니다.

curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
  "https://api.multitel.net/v3/getbalance"

경로, 쿼리 또는 본문 매개변수는 필요하지 않습니다.

응답

다음은 응답 구조를 보여 주는 예시이며, 실제 계정 데이터나 현재 가격 견적이 아닙니다.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "balance": "125.50",
    "currency": "USD",
    "terms": "prepaid"
  }
}
잔액 응답 필드
필드의미
balance저장된 계정 잔액입니다. 금액 값을 처리할 때는 소수점 정밀도를 유지하세요.
currency이 계정에 저장된 통화 값입니다.
terms계정에 저장된 결제 조건 값입니다. 이 핸들러는 해당 값의 목록을 정의하거나 값을 정규화하지 않습니다. 예제에 가능한 모든 값이 제시되어 있다고 가정하지 마세요.

오류 및 사용 시 유의 사항

인증 실패 시에는 공통 API 인증 응답을 사용합니다. 이 핸들러는 잔액이 없는 경우에 대한 별도의 오류나 페이지 나누기를 정의하지 않습니다. 반환된 잔액은 자금이 예약되었음을 의미하지 않으며, 이후 주문이 성공할 것임을 보장하지도 않습니다.