잔액 변동내역 조회

Request

GET https://api.coolsms.co.kr/cash/v1/balance/history

메시지 발송, 출금등으로 변동 된 잔액 내역을 조회합니다.

Authorization 인증 필요 [?]

계정 권한

회원 권한

계정 상태

회원 상태

계정 인증

cash:read

role-cash:read

Query Params

Name

Type

Required

Allowed Operator [?]

Description

offset

number

eq

검색 시작 지점

limit

number

eq

한 페이지에 불러옥 목록 개수

startDate

string

eq

검색 날짜 시작 범위

endDate

string

eq

검색 날짜 끝 범위

type

string

eq

충전 및 차감 타입

groupId

string

eq

메시지 그룹 ID

rechargeMethod

string

eq

결제 수단 (STRIPE

ACCOUNT-TRANSFER)

serviceMethod

string

eq

사용 서비스 (MT)

balanceAmount

number

eq

사용 금액

balanceRecharge

boolean

eq

잔액 충전 여부

balanceDeduct

boolean

eq

잔액 차감 여부

pointRecharge

boolean

eq

포인트 충전 여부

pointDeduct

boolean

eq

포인트 차감 여부

Samples

getBalanceHistory.spec.js

Sample Request

http://api.coolsms.co.kr/cash/v1/balance/history

Sample Response

[
    {
        "balanceAmount": 0,
        "pointAmount": 100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 0,
        "oldPoint": 0,
        "newPoint": 100,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T10:00:00.000Z",
        "historyId": "5db728d9aa83954519463abf"
    },
    {
        "balanceAmount": 0,
        "pointAmount": 100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 0,
        "oldPoint": 0,
        "newPoint": 100,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T10:00:00.000Z",
        "historyId": "5db728d9aa83954519463ac7"
    },
    {
        "balanceAmount": 0,
        "pointAmount": 100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 0,
        "oldPoint": 0,
        "newPoint": 100,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T10:00:00.000Z",
        "historyId": "5db728d9aa83954519463ac5"
    },
    {
        "balanceAmount": 0,
        "pointAmount": 100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 0,
        "oldPoint": 0,
        "newPoint": 100,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T10:00:00.000Z",
        "historyId": "5db728d9aa83954519463ac3"
    },
    {
        "balanceAmount": 0,
        "pointAmount": 100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 0,
        "oldPoint": 0,
        "newPoint": 100,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T10:00:00.000Z",
        "historyId": "5db728d9aa83954519463ac1"
    },
    {
        "balanceAmount": 100,
        "pointAmount": -100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 100,
        "oldPoint": 300,
        "newPoint": 200,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T09:00:00.000Z",
        "historyId": "5db728d9aa83954519463aec"
    },
    {
        "balanceAmount": 100,
        "pointAmount": -100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 100,
        "oldPoint": 300,
        "newPoint": 200,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T09:00:00.000Z",
        "historyId": "5db728d9aa83954519463ae1"
    },
    {
        "balanceAmount": 100,
        "pointAmount": -100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 100,
        "oldPoint": 300,
        "newPoint": 200,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T09:00:00.000Z",
        "historyId": "5db728d9aa83954519463ae8"
    },
    {
        "balanceAmount": 100,
        "pointAmount": -100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 100,
        "oldPoint": 300,
        "newPoint": 200,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T09:00:00.000Z",
        "historyId": "5db728d9aa83954519463ade"
    },
    {
        "balanceAmount": 100,
        "pointAmount": -100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 100,
        "oldPoint": 300,
        "newPoint": 200,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T09:00:00.000Z",
        "historyId": "5db728d9aa83954519463ae4"
    },
    {
        "balanceAmount": 0,
        "pointAmount": -100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 0,
        "oldPoint": 300,
        "newPoint": 200,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T08:30:00.000Z",
        "historyId": "5db728d9aa83954519463ad7"
    },
    {
        "balanceAmount": 0,
        "pointAmount": -100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 0,
        "oldPoint": 300,
        "newPoint": 200,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T08:30:00.000Z",
        "historyId": "5db728d9aa83954519463ae3"
    },
    {
        "balanceAmount": 0,
        "pointAmount": -100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 0,
        "oldPoint": 300,
        "newPoint": 200,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T08:30:00.000Z",
        "historyId": "5db728d9aa83954519463ad5"
    },
    {
        "balanceAmount": 0,
        "pointAmount": -100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 0,
        "oldPoint": 300,
        "newPoint": 200,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T08:30:00.000Z",
        "historyId": "5db728d9aa83954519463ae7"
    },
    {
        "balanceAmount": 0,
        "pointAmount": -100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 0,
        "oldPoint": 300,
        "newPoint": 200,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T08:30:00.000Z",
        "historyId": "5db728d9aa83954519463ad9"
    },
    {
        "balanceAmount": 0,
        "pointAmount": -100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 0,
        "oldPoint": 300,
        "newPoint": 200,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T08:30:00.000Z",
        "historyId": "5db728d9aa83954519463adb"
    },
    {
        "balanceAmount": 0,
        "pointAmount": -100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 0,
        "oldPoint": 300,
        "newPoint": 200,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T08:30:00.000Z",
        "historyId": "5db728d9aa83954519463add"
    },
    {
        "balanceAmount": 0,
        "pointAmount": -100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 0,
        "oldPoint": 300,
        "newPoint": 200,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T08:30:00.000Z",
        "historyId": "5db728d9aa83954519463ad3"
    },
    {
        "balanceAmount": 0,
        "pointAmount": -100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 0,
        "oldPoint": 300,
        "newPoint": 200,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T08:30:00.000Z",
        "historyId": "5db728d9aa83954519463ae0"
    },
    {
        "balanceAmount": 0,
        "pointAmount": -100,
        "groupId": null,
        "memo": null,
        "rechargeMethod": null,
        "serviceMethod": null,
        "chargedMethod": null,
        "paymentMethod": null,
        "accountId": "19041920726336",
        "oldBalance": 0,
        "newBalance": 0,
        "oldPoint": 300,
        "newPoint": 200,
        "type": "MANUAL",
        "dateCreated": "2018-04-01T08:30:00.000Z",
        "historyId": "5db728d9aa83954519463aeb"
    }
]

Sample Code

var request = require('request');

var options = {
  headers: {
    Authorization:
      'HMAC-SHA256 apiKey=NCSAYU7YDBXYORXC, date=2019-07-01T00:41:48Z, salt=jqsba2jxjnrjor, signature=1779eac71a24cbeeadfa7263cb84b7ea0af1714f5c0270aa30ffd34600e363b4'
  },
  method: 'GET',
  json: true,
  url: 'http://api.coolsms.co.kr/cash/v1/balance/history'
};

request(options, function(error, response, body) {
  if (error) throw error;
  console.log('result :', body);
});

문서 생성일 : 2019-10-28

Last updated