송금인 누적액 조회/송금인 등록

참가기관이 조회시점을 기준으로 특정 송금인의 송금 누적액을 확인한다.

보안통신흐름

송금인 누적액 조회/송금인 등록 API는 POST 메소드로 호출되며, 상세 스펙 및 호출 예제는 아래와 같습니다.

요청메시지 URL
요청메시지 URL 표
HTTP URL/api/oris/v1/user-accumulated-amount
HTTP MethodPOST
Content-Typeapplication/json; charset=UTF-8
요청 메시지 명세
요청 메시지 명세
HTTP항목TYPE(길이)필수설명
HeaderAuthorizationstringYBearer <access_token>로그인 시
ORIS로부터 전송받은
access_token을
HTTP Header에 추가
[scope = inquiry]
Parameter[inquery] yearstringN2025조회년도
BodysenderType

string("내국인" | "법인" | "외국인")

Y

내국인

송금인 구분
senderName

string(100)

Y

윤조이

송금인명
senderCountryCode

string("NONE" | "A1" | "A2" | "A3" | "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AN" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "B1" | "B2" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BM" | "BN" | "BO" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "C1" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CS" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "D1" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "E1" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "EU" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "T1" | "T2" | "T3" | "T4" | "T5" | "T6" | "T7" | "T8" | "T9" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TP" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "YU" | "Z1" | "ZA" | "ZM" | "ZR" | "ZW" | "ZZ")

Y

KR

송금인 국적
senderIdentifier

object

Y

-

송금인 식별자
senderIdentifier.type

string("주민등록번호" | "사업자등록번호" | "여권번호")

Y

주민등록번호

식별자 구분
senderIdentifier.number

string(100)

Y

2501013212345

식별자 번호
senderIdentifier.issuingCountry

string(10)("NONE" | "A1" | "A2" | "A3" | "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AN" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "B1" | "B2" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BM" | "BN" | "BO" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "C1" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CS" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "D1" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "E1" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "EU" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "T1" | "T2" | "T3" | "T4" | "T5" | "T6" | "T7" | "T8" | "T9" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TP" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "YU" | "Z1" | "ZA" | "ZM" | "ZR" | "ZW" | "ZZ")

Y

KR

식별자 발급 국가
senderIdentifier.issuingAgency

string(100)

N

정부

식별자 발급 기관
요청 메시지 형태
{
  "senderType": "내국인",
  "senderName": "윤조이",
  "senderCountryCode": "KR",
  "senderIdentifier": {
    "type": "주민등록번호",
    "number": "2501013212345",
    "issuingCountry": "KR",
    "issuingAgency": "정부"
  }
}
응답 메시지 명세
요청 메시지 명세
HTTP항목TYPE(길이)필수설명
BodyuserId

string(26)

Y

01JR9JH2S5SG85EJDZK4XYXBV4

송금인ID
accountId

string(26)

Y

01JR9JHJSJQEREHWPCTB0XH2M5

송금인 누적액 계좌ID
accumulatedAmount

number

Y

10000

송금인 USD 환산 누적액(경상거래 제외)
응답 메시지 형태
{
  "userId": "01JR9JH2S5SG85EJDZK4XYXBV4",
  "accountId": "01JR9JHJSJQEREHWPCTB0XH2M5",
  "accumulatedAmount": 10000
}
에러인 경우 응답 메시지 명세
요청 메시지 명세
HTTP항목TYPE(길이)필수설명
Bodymessage

string

N

요청에 실패했습니다.

오류 메시지
code

string("ERROR" | "BAD_REQUEST" | "INVALID_REQUEST" | "UNAUTHORIZED" | "FORBIDDEN" | "ACCESS_TOKEN_REQUIRED" | "ACCESS_TOKEN_EXPIRED" | "ACCESS_TOKEN_INVALID" | "ACCESS_TOKEN_NOT_ENOUGH_PERMISSION" | "AGENCY_NOT_FOUND" | "AGENCY_NOT_ACTIVE" | "AGENCY_NOT_APPROVED" | "AGENCY_NOT_MATCH" | "AGENCY_ACCESS_DENIED" | "AGENCY_CODE_DUPLICATED" | "MEMBER_NOT_FOUND" | "MEMBER_NOT_ACTIVE" | "MEMBER_NOT_MATCH" | "MEMBER_PASSWORD_NOT_MATCH" | "MEMBER_EMAIL_DUPLICATED" | "MEMBER_PASSWORD_RESET" | "MEMBER_PASSWORD_RESET_WITH_OLD" | "MEMBER_PASSWORD_INVALID_FORMAT" | "MEMBER_PASSWORD_FAIL_LIMIT_EXCEEDED" | "MEMBER_PASSWORD_EXPIRED" | "MEMBER_ACCOUNT_LOCKED" | "MEMBER_PASSWORD_REUSED" | "MEMBER_ACCESS_DENIED" | "API_KEY_NOT_FOUND" | "USER_NOT_FOUND" | "USER_NOT_ACTIVE" | "ACCOUNT_NOT_FOUND" | "REMITTANCE_NOT_FOUND" | "REMITTANCE_ALREADY_EXISTS" | "REMITTANCE_ALREADY_CANCELED" | "REMITTANCE_ACCOUNT_YEAR_MISMATCH" | "THREAD_NOT_FOUND" | "THREAD_ACCESS_DENIED" | "POST_NOT_FOUND" | "POST_ACCESS_DENIED" | "COMMENT_NOT_FOUND" | "COMMENT_ACCESS_DENIED" | "FILE_NOT_FOUND" | "FILE_ACCESS_DENIED" | "FILE_ALREADY_ATTACHED" | "FILE_DELETE_FAILED" | "TERM_NOT_FOUND" | "TERM_CANNOT_UPDATE" | "TERM_CANNOT_DELETE" | "TERM_CANNOT_SET_INITIATION_DATE" | "TERM_CANNOT_WITHDRAW_INITIATION_DATE" | "TERM_TYPE_NOT_FOUND" | "CONSENT_REQUIRED" | "CONSENT_NOT_FOUND" | "CONSENT_NOT_MATCH" | "GROUP_NOT_FOUND" | "GROUP_UPDATE_FORBIDDEN" | "GROUP_DELETE_FORBIDDEN" | "BATCH_NOT_FOUND" | "BATCH_CHUNK_NOT_FOUND")

N

ERROR

오류 코드
요청값이 제약 조건에 위반되는 경우 응답 메시지 형태(400)
{
  "code": "BAD_REQUEST",
  "message": "Failed to convert value of type 'java.lang.String' to required type 'java.lang.Boolean'"
}
메소드 인자 타입이 일치하지 않는 경우 응답 메시지 형태(400)
{
  "code": "BAD_REQUEST",
  "message": "Failed to convert value of type 'java.lang.String' to required type 'java.lang.Boolean'"
}
메소드 인자 검증 실패한 경우 응답 메시지 형태(400)