페이앱 등록, 유저생성, 계좌생성, 송금 Bank API 명세

[seungwoo1124]

TimeBank API

---

페이 앱 등록 api

• /api/v1/payapp/register/{appName} : GET
• 응답 형식 example

{
    "id":2,
    "name":"timePay",
    "appkey":"a6e107b31149759dd130564af93acfff5c3a7db0f5902ee496d2cd5821328128"
}

• python example

  • 파이썬으로 간단하게 테스트 가능한 샘플 코드입니다

  import requests
  
  app_name = "testApp"
  
  base_url = f"http://localhost:8080/api/v1/payapp/register/{app_name}"
  
  # GET 요청 보내기
  response = requests.get(base_url)
  
  print(response.status_code)
  print(response.text)

유저 등록 api

• /api/v1/users/register : POST

• requestbody

  {
      "username": "...",
      "password": "...",
      "name": "...",
      "phoneNumber": "...",
      "gender": "...",  MALE or FEMALE
      "birthday": "...",  형식은 datetime. ex) "2023-11-30"
      "authenticationType": "...",  PASSWORD or SOCIAL
  }

• 주의사항 !!

  • 계좌 개설 api가 아닙니다. bank 서버에 사용자를 등록하는 api입니다.
  • 계좌 개설은 이후 나오는 api를 따로 사용해야합니다.

• Account 데이터와, User테이블에 데이터가 생성됩니다.

  • 왜 따로있는지는 몰루..

• python example

  • 파이썬으로 간단하게 테스트 가능한 샘플 코드입니다.

  import requests
  import json
  
  # 요청할 URL
  url = 'http://localhost:8080/api/v1/users/register'
  
  # 요청 본문에 들어갈 데이터
  data = {
      'username': 'test',
      'password': '1234',
      'name': 'test',
      'phoneNumber': '01012341234',
      'gender': 'MALE',  # 또는 Gender.MALE에 해당하는 값으로 변경
      'birthday': '2023-11-30',  # 실제 데이터로 변경,
      'authenticationType': 'PASSWORD'
  }
  
  # POST 요청 보내기
  response = requests.post(url, json=data)
  
  # 응답 확인
  print(response.status_code)
  print(response.text)

계좌 개설 api

• /api/v1/bank/account : POST

• requestheader

  • userContext

  "userContext": {
      "userId": "...",
      "accountId": "...",
      "accountType": "...",  INDIVIDUAL or BRANCH
  }

  • appName

    "appName": "..."

  • 헤더에 둘 다 추가해줘야 합니다.

• requestbody

{
    "password": "..."
}

• 응답 형식 example

  {
      "balance":300,
      "accountNumber":"02-01-03-46",
      "bankAccountId":3
  }

• 주의사항

  • userId 와 accountId는 다릅니다.. 왠진모름
  • 해당 유저 컨텍스트에 맞는 데이터가 데이터베이스에 들어있어야 합니다.
  • 개설시 bank_account 테이블에 저장됩니다.

• python example

  • 파이썬으로 간단하게 테스트 가능한 샘플 코드입니다.

import requests
import json

url = "http://localhost:8080/api/v1/bank/account"

requestData = {
    "password": "test"
}

#아래 두 변수는 헤더로 들어갑니다.
userContext = {
    "userId": 1,
    "accountId": 1,
    "accountType": "INDIVIDUAL"
}
appName = "testApp"

data = {"password": requestData["password"]}
headers = {"userContext": json.dumps(userContext), "appName": appName, "Content-Type": "application/json"}

response = requests.post(url, json=data, headers=headers)

print(response.status_code)
print(response.text)

송금 api

• /api/v1/bank/account/transfer : POST

• requestheader

  • userContext

  "userContext": {
      "userId": "...",
      "accountId": "...",
      "accountType": "...",  INDIVIDUAL or BRANCH
  }

• requestbody

{
    "sendBankAccountNumber": "...",  송금자 계좌번호
    "receiverBankAccountNumber": "...",  수신자 계좌번호
    "amount": "...",
    "password": "...",
}

• 응답 형식 example

{
    "transactionAt":"2023-12-03T13:14:08.0924872",
    "amount":120,
    "balanceSnapshot":300.00,
    "status":"SUCCESS",
    "senderBankAccountNumber":"02-01-03-46",
    "receiverBankAccountNumber":"02-01-04-59"
}

• 주의사항
  • 송금자와 수신자의 계좌 정보가 bank_account 테이블에 들어있어야 합니다.
• python example
  • 파이썬으로 간단하게 테스트 가능한 샘플 코드입니다.

    
    import requests
    import json

테스트할 데이터

request_data = { 'senderBankAccountNumber': '01-01-02-90', 'receiverBankAccountNumber': '01-01-01-60', 'amount': 120, 'password': '1234' }

송금 유저 컨텍스트

userContext = { "userId": 2, "accountId": 2, "accountType": "INDIVIDUAL" }

POST 요청 보내기

url = 'http://localhost:8080/api/v1/bank/account/transfer' headers = {"userContext": json.dumps(userContext), "Content-Type": "application/json"} response = requests.post(url, headers=headers, data=json.dumps(request_data))

응답 확인

print(response.status_code) print(response.text)