NICEPAY API
API Business Report

Settlement History API

7min

About Settlement History API





 History

uses to reconcile settlement fund report with

.

get list of settlement data up to 5,000 data for every request that match with

needed date.





Settlement History API



API End Point

Request Method application/json

GET

Description

To check settlement history with

 via


Header

Content-Type: application/json

Request Format

application/json

The available

 value and settlement fund value in this report is using Rupiah currency.

Request Parameter

Parameter

Type

Size

Description

Example / Note

mid

Required

VARCHAR2

10

iMid



IONPAYTEST

passwd

Required

VARCHAR2

100

Password gain after Whitelist IP

 successfully registered on

side

(

 contact NICEPAY Customer Service team for assistance)

123456

settlmntdt

Required

VARCHAR2

8

Transaction data date to be seen

Format: YYYYMMDD

20200113

startno

Required

NUMBER

10

The beginning of



data that will be seen

1

Default: 1

endno

Required

NUMBER

10

The last of



data that will be seen, maximum 5,000

100

Default: 100

Response Parameter

Parameter

Type

Length

Description

Example / Note

HEADER

Required

Object

-

-

"HEADER": { ... }

CODE

Required

NUMBER

4

00

MID

Required

VARCHAR2

10

iMid



IONPAYTEST

SETTLMNT_DT

Required

VARCHAR2

8

The requested

 data date

Format: YYYYMMDD

20200113

DATA

Required

Object

-

-

"DATA": [ { ... } ]

CODE

Required

NUMBER

2

10

TXID

Required

VARCHAR2

30

Transaction ID

IONPAYTEST02202001100933358310

SETTLMNT_DT

Required

VARCHAR2

8



 date, it will be shown directly if available

Format: YYYYMMDD

20200113

TRANS_STATUS

Required

NUMBER

2

0

PAY_METHOD

Required

VARCHAR2

2

02

TRANS_DT

Required

VARCHAR2

8

The requested

 data date

Format: YYYYMMDD

20200110

TRANS_AMT

Required

NUMBER

19,2

Transaction Amount

1000

SETTLMNT_AMT

Required

NUMBER

19,2



 Amount

800

FDS_FEE

Required

NUMBER

19,2

FDS fee (only applicable for

 method)

0

NICEPAY_FEE

Required

NUMBER

19,2





fee that applicable every successful paid


545

BANK_FEE

Required

NUMBER

19,2



 or

fee (only applicable for facilitator

type)

0

VAT

Required

NUMBER

19,2

PPN or

 (Value Added Tax) fee

55

ORDER_NO

Required

NUMBER

10



 Reference Number

OrdNo20200933270

BANK_CD

Required

VARCHAR2

4



 or

Code

BMRI

CUSTOMER_NO

Required

VARCHAR2

40



 Account Transaction Number

79150000090933358310

TAIL

Required

Object

-

-

"TAIL": { ... }

CODE

Required

NUMBER

4

99

MID

Required

VARCHAR2

10

iMid



IONPAYTEST

SETTLMNT_DT

Required

VARCHAR2

8

The Requested

 Data Date

Format: YYYYMMDD

20200113

APP_CNT

Required

NUMBER

10

The sum of total

 volume

5

APP_AMT

Required

NUMBER

19,2

The sum of total

 amount

14000

CC_CNT

Required

NUMBER

10

The sum of total

 amount

0

CC_AMT

Required

NUMBER

19,2

The sum of total

 refund amount

0

NICEPAY_FEE

Required

NUMBER

19,2

The sum of



fee applicable on every successful paid


2725

BANK_FEE

Required

NUMBER

19,2

The sum of total

 or

fee (only applicable for


type)

0

VAT

Required

NUMBER

19,2

The sum of total PPN or

 (Value Added Tax) fee

275

SETTLMNT_AMT

Required

NUMBER

19,2

The sum of total

 amount

11000

Sample Parameter

Request
Response