뱅크알람 지원 은행 리스트
get

뱅크알람이 사용 가능한 은행 리스트

https://papi.udpay.co.kr/api/v1/bank/bankList

  • pApiToken

    STRING 필수

    연동토큰

    UDPAY 부가서비스 연동토큰

  • state

    STRING 필수

    요청 결과

    true 성공, false 실패

  • message

    STRING

    메세지

    요청 결과 메세지

  • errorMessage

    STRING

    오류 메세지

    요청 결과에 대한 오류 메세지

  • errorType

    STRING

    오류 번호

    요청 결과에 대한 오류 번호

  • result

    ARRAY

    결과 데이터

    결과 데이터 정보

    • bankInfo

      OBJECT

      은행 정보

      • bankCode

        NUMBER

        은행 코드

      • bankName

        STRING

        은행 명

      • useAuthSms

        BOOLEAN

        인증 문자 사용 여부

        뱅크알람 등록 시 인증번호가 필요한 은행 여부

코드샘플
// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.get("https://papi.udpay.co.kr/api/v1/bank/bankList")
.header("accept", "application/json")
.header("pApiToken", "") // 연동토큰
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");
뱅크알람 인증 문자 확인
get

인증 문자를 사용하는 은행에 뱅크알람 등록 시 은행에서 뱅크알람쪽으로 보내주는 인증 문자를 사용자에게 보여주는 기능

https://papi.udpay.co.kr/api/v1/bank/account/auth

  • pApiToken

    STRING 필수

    연동토큰

    UDPAY 부가서비스 연동토큰

  • bankCode

    NUMBER

    은행 코드

  • state

    STRING 필수

    요청 결과

    true 성공, false 실패

  • message

    STRING

    메세지

    요청 결과 메세지

  • errorMessage

    STRING

    오류 메세지

    요청 결과에 대한 오류 메세지

  • errorType

    STRING

    오류 번호

    요청 결과에 대한 오류 번호

  • result

    ARRAY

    결과 데이터

    • useAuthSmsInfo

      STRING

      인증 문자 정보

      • id

        STRING

        뱅크알람 ID

      • bankCode

        NUMBER

        은행 코드

      • message

        STRING

        인증 메세지

      • inTime

        NUMBER

        등록 시간

코드샘플
// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.get("https://papi.udpay.co.kr/api/v1/bank/account/auth")
.header("accept", "application/json")
.header("pApiToken", "") // 연동토큰
.routeParam("bankCode", "") // 은행 코드
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");
뱅크알람 계좌번호 등록
post

뱅크알람와 매칭되는 계좌번호 등록

https://papi.udpay.co.kr/api/v1/bank/account/add

  • pApiToken

    STRING 필수

    연동토큰

    UDPAY 부가서비스 연동토큰

  • bankCode

    NUMBER 필수

    은행 코드

  • bankNum

    STRING 필수

    은행 계좌번호

  • accountHolder

    STRING 필수

    예금주

  • feedbackUrl

    STRING 필수

    피드백 URL

  • state

    STRING 필수

    요청 결과

    true 성공, false 실패

  • message

    STRING

    메세지

    요청 결과 메세지

  • errorMessage

    STRING

    오류 메세지

    요청 결과에 대한 오류 메세지

  • errorType

    STRING

    오류 번호

    요청 결과에 대한 오류 번호

  • result

    STRING

    결과 데이터

    뱅크알람 계좌 ID

  • Feedback 뱅크알람 피드백 feedbackUrl 경로로 데이터를 전송합니다. 리턴값으로 OK와 같이 값을 보내주시면 장애 발생 시 추적에 도움이됩니다.

    • id

      STRING 필수

      수신 문자 ID

    • bankCode

      STRING 필수

      은행 코드

    • bankNum

      STRING 필수

      은행 계좌번호

    • bankName

      STRING 필수

      은행 명

    • accountName

      STRING 필수

      입금자

    • accountPrice

      STRING 필수

      입금액

    • remindPrice

      STRING

      잔액

      문자로 잔액을 보내주는 경우에만 표기

    • accountDate

      STRING 필수

      입금시간

      yyyy-MM-dd HH:mm

코드샘플
// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01

Map<String, Object> paramMap = new HashMap<> ();

paramMap.put ("bankCode", "");	// 은행 코드
paramMap.put ("bankNum", "");	// 은행 계좌번호
paramMap.put ("accountHolder", "");	// 예금주
paramMap.put ("feedbackUrl", "");	// 피드백 URL

HttpResponse response = Unirest.post("https://papi.udpay.co.kr/api/v1/bank/account/add")
.header("accept", "application/json")
.header("Content-Type", "application/json")
.header("pApiToken", "") // 연동토큰
.body(paramMap)
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");
뱅크알람 등록 계좌 리스트
post

뱅크알람에 등록한 계좌 리스트 정보

https://papi.udpay.co.kr/api/v1/bank/account/list

  • pApiToken

    STRING 필수

    연동토큰

    UDPAY 부가서비스 연동토큰

  • state

    STRING 필수

    요청 결과

    true 성공, false 실패

  • message

    STRING

    메세지

    요청 결과 메세지

  • errorMessage

    STRING

    오류 메세지

    요청 결과에 대한 오류 메세지

  • errorType

    STRING

    오류 번호

    요청 결과에 대한 오류 번호

  • result

    ARRAY

    결과 데이터

    결과 데이터 정보

    • bankInfo

      OBJECT

      뱅크알람 계좌 정보

      • id

        STRING

        뱅크알람 계좌 ID

      • bankCode

        NUMBER

        은행 코드

      • bankNum

        STRING

        은행 계좌번호

      • accountHolder

        STRING

        예금주

      • feedbackUrl

        STRING

        피드백 URL

      • regModDate

        OBJECT

        등록 수정일

        • regDate

          DATE

          등록일

        • modDate

          DATE

          수정일

코드샘플
// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.post("https://papi.udpay.co.kr/api/v1/bank/account/list")
.header("accept", "application/json")
.header("pApiToken", "") // 연동토큰
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");
뱅크알람 계좌번호 상세 조회
get

뱅크알람에 등록한 계좌정보

https://papi.udpay.co.kr/api/v1/bank/account/detail

  • pApiToken

    STRING 필수

    연동토큰

    UDPAY 부가서비스 연동토큰

  • state

    STRING 필수

    요청 결과

    true 성공, false 실패

  • message

    STRING

    메세지

    요청 결과 메세지

  • errorMessage

    STRING

    오류 메세지

    요청 결과에 대한 오류 메세지

  • errorType

    STRING

    오류 번호

    요청 결과에 대한 오류 번호

  • result

    OBJECT

    결과 데이터

    결과 데이터 정보

    • id

      STRING

      뱅크알람 계좌 ID

    • bankCode

      NUMBER

      은행 코드

    • bankNum

      STRING

      은행 계좌번호

    • accountHolder

      STRING

      예금주

    • feedbackUrl

      STRING

      피드백 URL

    • regModDate

      OBJECT

      등록 수정일

      • regDate

        DATE

        등록일

      • modDate

        DATE

        수정일

코드샘플
// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.get("https://papi.udpay.co.kr/api/v1/bank/account/detail")
.header("accept", "application/json")
.header("pApiToken", "") // 연동토큰
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");