SNAP StandarDataSpesifikasiTeknis

Standar Nasional Open API Pembayaran
(Standar Data dan Spesifikasi Teknis)

Versi 1.0
Agustus 2021
PERNYATAAN
Standar Nasional Open API Pembayaran (Standar Data dan Spesifikasi

Teknis) atau disebut “Standar Nasional Open API Pembayaran - Standar Data
dan Spesifikasi Teknis” disusun oleh ASPI dengan mempertimbangkan dan
memperhatikan masukan dari pelaku industri sistem pembayaran melalui
wakilnya yang berpartisipasi dalam sub-working group nasional Open API
Pembayaran yang dibentuk oleh ASPI bersama dengan Bank Indonesia.
Setiap pihak yang akan menggunakan Standar Nasional Open API

Pembayaran - Standar Data dan Spesifikasi Teknis ini sepenuhnya
bertanggung jawab untuk memastikan apakah kegiatannya atau
pengembangannya memerlukan persetujuan dari pihak ketiga atau
memerlukan konsultasi dengan konsultan yang berkompeten sebelum
menerapkan Standar Nasional Open API Pembayaran - Standar Data dan
Spesifikasi Teknis termasuk namun tidak terbatas pada penggunaan
teknologi yang mungkin digunakan secara bersamaan.
Standar Nasional Open API Pembayaran - Standar Data dan Spesifikasi

Teknis ini dapat diubah dan/atau disesuaikan sewaktu-waktu, bila
diperlukan dan setiap perubahannya dituangkan dalam dokumen
perubahan Standar Nasional Open API Pembayaran - Standar Data dan
Spesifikasi Teknis terkini.
ii
LEMBAR VERSI DOKUMEN
Versi Tanggal Penyusun Keterangan

v.0.8.5 13-08-2021 ASPI Disusun dengan dukungan
perwakilan industri sistem
pembayaran-Sub Working Group
Nasional Open API Pembayaran,
yang terdiri dari:
- PT Bank Central Asia Tbk
- PT Bank Mandiri Tbk
- PT Bank Nationalnobu Tbk
- PT Bank Negara Indonesia Tbk
- PT Bank Rakyat Indonesi Tbk
- PT Bukalapak.com Tbk
- PT Dompet Anak Bangsa
- PT Espay Debit Indonesia Koe
- PT Fintek Karya Nusantara
- PT Midtrans
- PT Mitra Transaksi Indonesia
- PT Multi Adiprakarsa Manunggal
- PT Nusa Satu Inti Artha
- PT Shopee International Indonesia
- PT Tokopedia
- PT Visionet Internasional
v.1.0 16-08-2021 ASPI Berdasarkan dokumen versi 0.8.5
dari ASPI yang telah di-review oleh
Bank Indonesia.
ii
i
DAFTAR ISI
PERNYATAAN......................................................................................................................ii
LEMBAR VERSI DOKUMEN.....................................................................................iii
DAFTAR ISI.................................................................................................................. iv
1. KATEGORI I: REGISTRASI............................................................................1
1.1. SKENARIO PENGGUNAAN API REGISTRATION...................................1
1.2. SPESIFIKASI API REGISTRATION............................................................5
1.2.1. API Card Registration............................................................................5
1.2.2. API Card Registration – Set Limit...............................................13
1.2.3. API Card Registration Inquiry..........................................................17
1.2.4. API Verify OTP (Direct Integration)...............................................20
1.2.5. API Card Registration Unbinding....................................................27
1.2.6. API Account Creation......................................................................34
1.2.7. API Account Binding............................................................................44
1.2.8. API Account Binding Inquiry............................................................54
1.2.9. API Account Unbinding.......................................................................58
1.2.11. API Get OAuth URL...........................................................................62
2. KATEGORI II: INFORMASI SALDO...............................................................68
2.1. SKENARIO PENGGUNAAN API BALANCE INQUIRY..........................68
2.2. SPESIFIKASI API BALANCE INQUIRY.......................................................69
2.2.1. API Balance Inquiry......................................................................................69
3. KATEGORI III: RIWAYAT TRANSAKSI........................................................76
3.1. SKENARIO PENGGUNAAN API TRANSACTION HISTORY...............76
3.2. SPESIFIKASI API TRANSACTION HISTORY........................................79
3.2.1. API Transaction History List.............................................................79
3.2.2. API Transaction History Detail........................................................85
3.2.3. API Bank Statement.........................................................................91
4. KATEGORI IV: TRANSFER KREDIT...........................................................102
4.1. SKENARIO PENGGUNAAN API TRANSFER KREDIT.......................102
4.2. SPESIFIKASI API TRANSFER KREDIT BANK...................................108
iv
4.2.1. API Account Inquiry...........................................................................108
4.2.1.1. Internal Account Inquiry..................................................................108
4.2.1.2. Eksternal Account Inquiry...............................................................113
4.2.2. API Trigger Transfer..........................................................................117
4.2.2.1. Intrabank Transfer.............................................................................117
4.2.2.2. Interbank Transfer.............................................................................123
4.2.2.3. Request for Payment..........................................................................130
4.2.2.4. Interbank Transfer - Bulk................................................................136
4.2.2.5. RTGS Transfer.......................................................................................149
4.2.2.6. SKNBI Transfer.....................................................................................160
4.2.2.7 Virtual Account................................................................................171
4.2.3. API Transaction Status Inquiry......................................................296
4.3. SPESIFIKASI API TRANSFER KREDIT LEMBAGA SELAIN BANK
304
4.3.1. API Customer Top Up........................................................................304
4.3.2. API Bulk Cashin..............................................................................323
4.3.3. API Transfer to Bank.........................................................................334
4.3.4. API Transfer to OTC...........................................................................346
4.3.5. API QR MPM..........................................................................................365
4.3.6. API Transaction Status Inquiry......................................................397
5. BAGIAN V: API TRANSFER DEBIT.............................................................405
5.1. SKENARIO PENGGUNAAN API TRANSFER DEBIT..........................405
5.2. SPESIFIKASI API TRANSFER DEBIT...................................................409
5.2.1. API Direct Debit...................................................................................409
5.2.2. API QR CPM............................................................................................441
5.2.3. API Auth Payment...............................................................................462
5.2.4. API Direct Debit BI-FAST.............................................................498
6. Bagian VI: Response Code.................................................................................515
v
1. KATEGORI I: REGISTRASI
API Registration (Registrasi) diperlukan agar Konsumen dapat melakukan
pengaitan datanya untuk melakukan layanan transaksi pembayaran atau
mengakses data miliknya. Data-data yang dikaitkan ini dapat beragam
tergantung kebutuhan, seperti data kartu debit, kartu kredit, atau rekening.
1.1. SKENARIO PENGGUNAAN API REGISTRATION
Use Case Diagram API Card Registration (via PJP PIAS)
Use Case Diagram API Card Registration (Direct Integration)
1
Use Case Diagram API Account Registration
Merujuk pada use case diagram, Konsumen sebagai pemilik rekening atau
kartu, dapat melakukan penautan rekening atau kartunya pada Non-PJP
Pengguna Layanan, PJP AIns, dan/atau PJP PIAS untuk digunakan sebagai
sumber dana dalam bertransaksi dan/atau untuk mengakses layanan
lainnya seperti pengecekan saldo dan/atau pengecekan histori transaksi.
API Registrasi dapat digunakan dalam sejumlah skema sebagai berikut:

Skema 1: Indirect Integration (Konsumen – Non-PJP Pengguna Layanan
/ PJP AIns / PJP PIAS – PJP AIS)
Pada skema indirect integration, proses card registration dilakukan dengan
cara PJP PIAS menginisiasi pembayaran sejumlah nominal tertentu. Apabila
proses otorisasi yang dilakukan PJP AIS kepada Konsumen berhasil maka
dapat diyakini kebenaran informasi detail kartu dan pemiliknya, sehingga
dapat dilakukan card registration pada Non-PJP Pengguna Layanan, PJP
AIns, dan/atau PJP PIAS. Selanjutnya, PJP PIAS menginisiasi pengembalian
dana atas pembayaran (refund).
Skema 2: Direct Integration (Konsumen – Non-PJP Pengguna Layanan /

PJP AIns / PJP PIAS – PJP AIS)
Pada skema direct integration, proses card registration dan account
registration dilakukan dengan cara Non-PJP Pengguna Layanan, PJP AIns,
2
atau PJP PIAS melakukan inisiasi validasi atas informasi kartu/rekening dan
pemiliknya ke PJP AIS selaku penerbit kartu dan/atau rekening. Apabila
proses validasi dan otorisasi yang dilakukan PJP AIS pada Konsumen
berhasil, maka dapat diyakini kebenaran informasi detail kartu/rekening dan
pemiliknya, sehingga dapat dilakukan card registration atau account
registration pada Non-PJP Pengguna Layanan, PJP AIns, atau PJP PIAS.
Sejumlah API yang digunakan dalam skema-skema tersebut antara lain:

 API Card Registration adalah layanan yang digunakan untuk
mendaftarkan data kartu milik Konsumen pada Non-PJP Pengguna
Layanan, PJP AIns, atau PJP PIAS. Kartu milik Konsumen tersebut
diterbitkan oleh PJP AIS dan menjadi sumber dana Konsumen dalam
bertransaksi dan/atau untuk mengakses layanan lainnya. API ini dapat
disediakan oleh PJP yang melakukan registrasi kartu. Dalam hubungan
bisnis B2C diperlukan proses verifikasi untuk memastikan kebenaran
data konsumen.
Dalam rangka melakukan validasi, dapat menggunakan mekanisme 3D
Secure atau mekanisme validasi lainnya yang ditetapkan oleh penerbit
kartu.
 API Card Registration Inquiry dapat digunakan untuk menampilkan data

kartu yang sudah diregistrasikan pada Non-PJP Pengguna Layanan, PJP
AIns, atau PJP PIAS. Inquiry dapat dilakukan dengan memberikan
informasi pengenal Konsumen.
 API Verify OTP merupakan API yang digunakan untuk melakukan

verifikasi OTP baik untuk registrasi kartu. Verifikasi OTP ini dilakukan
khususnya untuk hubungan yang melibatkan Konsumen untuk
memastikan kebenaran data Konsumen yang melakukan registrasi. API
ini dapat disediakan oleh PJP AIS yang menerbitkan kartu.
 API Card Registration Unbinding digunakan untuk melakukan

penghapusan data kartu milik Konsumen yang telah diregistrasikan
3
pada Non-PJP Pengguna Layanan, PJP AIns, atau PJP PIAS.
Penghapusan data kartu dilakukan dengan memasukkan data kartu
yang akan dihapuskan penautannya.
 API Account Creation dapat digunakan oleh Konsumen untuk

pembuatan akun pada PJP AIS melalui PJP AIns, PJP PIAS, dan/atau
Non-PJP Pengguna Layanan. API ini digunakan dalam hubungan B2C
(Business to Customer).
 API Account Binding adalah layanan yang digunakan untuk

mendaftarkan data akun yang diterbitkan oleh PJP AIS yang menjadi
sumber dana transaksi atau dalam rangka mengakses layanan lainnya
oleh Konsumen pada PJP AIns dan/atau PJP PIAS. API ini digunakan
dalam B2C (Business to Customer). Dalam hubungan bisnis B2C
diperlukan proses verifikasi/otentikasi untuk memastikan kebenaran
data Konsumen.
 API Account Binding Inquiry dapat digunakan untuk menampilkan data

rekening yang sudah diregistrasikan pada Non-PJP Pengguna Layanan,
PJP AIns, dan/atau PJP PIAS. Inquiry dapat dilakukan dengan
memberikan informasi pengenal konsumen.
 API Account Unbinding digunakan untuk melakukan penghapusan data

rekening milik Konsumen yang telah diregistrasikan pada Non-PJP
Pengguna Layanan, PJP AIns, atau PJP PIAS. Penghapusan data
rekening dilakukan dengan memasukkan data rekening yang akan
dihapuskan penautannya.
Penyelenggaraan layanan pembayaran berbasis kartu termasuk pengelolaan
datanya tunduk pada ketentuan yang diberlakukan oleh Penerbit/Prinsipal
Kartu (seperti PCIDSS).
4
1.2. SPESIFIKASI API REGISTRATION
1.2.1. API Card Registration
Sequence Diagram
Sequence Diagram API Card Registration (via PJP PIAS)
5
Sequence Diagram API Card Registration (Direct Integration)
Informasi Umum
Service Code 01
Name API Card Registration
Version 1.0
HTTP Method POST
Path …/{version}/registration-card-bind
Request Body
Data
Parameter Mandatory Length Description Example
Type
partnerRefe Transaction 2020102
String M 64
renceNo identifier on 9000000
6
Data
Type
partner 0000000
system 1
accountNa Customer’s
String O 128 John Doe
me full name.
Refer to
Standard
Symmetric
Encry Encryption
cardData pted on Security
Object Standard
Document
section
2.1.9
bankAccou Account 9380293
String O 32
ntNo number 8408123
3984029
bankCardN Card
String M 19 3840239
o number
84
Type of the
bankCardT card (D –
String M 2 D
ype Debit, C –
Credit).
Customer’s
date of birth 1990052
dateOfBirth String O 8
(YYYYMMD 4
D).
RFC 3696
john.doe
Length 254
email String O 254 @email.c
after “<” and
om
“>”
7
Data
Type
2021-12-
Format:
expiredDat Dateti 03T12:08
O ISO Expiry date
etime me :56+07:0
8601
0
Card expiry
date.
expiryDate String O 4 1022
Format:
MMYY
2849238
identificatio Customer’s
String M 64 4090293
nNo ID number
8402
Type of ID
(01 -
passport, 02
–
eKTP&KTP,
identificatio
String M 2 03-TKTP, 02
nType
04-
SIM (Driver
License), 99
–
Others)
custIdMerc Merchant’s 0012345
String M 18
hant customer ID 679504
Daily
decim
limit O 17,3 transaction 1000000
al
limit
Merchant’s https://b
merchantL
String O 300 logo URL for ilba.test.
ogoUrl
webview com/dist
8
Data
Type
/img/me
rchant-
logo.png
Customer’s
phone
number 0823874
phoneNo String O 16
Format: 8728423
62xxxxxxxx
xxxxx
"YES" or
sendOtpFla "NO" to use
String O 3 YES
g OTP from
PJSP
subscrib
type String O 20 Action type
e
{"deviceId
":
"1234567
additionalI Additional 9237",
Object O
nfo information "channel"
:
"mobilep
hone"}
Response Body
Data
Type
Response
responseCode String M 7 2000000
code
9
Data
Type
Request
has been
responseMessa Response processe
String M 150
ge description d
successf
ully
Transaction
identifier on
service
2020102
provider
9777700
referenceNo String C 64 system.
0000000
Must be
9
filled upon
successful
transaction
Transaction
2020102
identifier on
partnerReferen 9000000
String O 64 service
ceNo 0000000
consumer
1
system
6d79636
bankCardToke Card token
String O 128 1726474
n for payment.
6f6b656e
string code
abcd6361
for
chargeToken String O 40 7264746f
verification
6b656e
OTP
Random
g4BoEz4
randomString String O 16 String to
3jfjVvAvN
generate
10
Data
Type
validation
for webview
Time when
the token
will be
expired. 2020-12-
tokenExpiryTi Time when 17T11:55
String O 25 :06+07:0
me the token 0
will
be expired.
Format:
ISO-8601
{"deviceId
":
"1234567
Additional 9237",
additionalInfo Object O
information "channel"
:
"mobilep
hone"}
Contoh Request
POST …/1.0/registration-card-bind HTTP/1.2
Content-type: application/json
Authorization: Bearer
gp9HjjEj813Y9JGoqwOeOPWbnt4CUpvIJbU1mMU4a11MNDZ7Sg5u9a"
X-TIMESTAMP: 2020-12-17T10:55:00+07:00
X-SIGNATURE:
85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c8625
61b19a5
ORIGIN: www.hostname.com
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
X-DEVICE-ID: 09864ADCASA
11
X-LATITUDE: -6.1617169
X-LONGITUDE: 106.6643946
CHANNEL-ID: 95221
{
"partnerReferenceNo": "2020102900000000000001",
"accountName": "John Doe",
"cardData":"{
"bankAccountNo": "93802938408123",
"bankCardNo": "3984029384023984",
"bankCardType": "D",
"dateOfBirth": "19900524",
"email": "john.doe@email.com",
"expiredDatetime": "2021-12-03T12:08:56+07:00",
"expiryDate": "1022",
"identificationNo": "284923840902938402",
"identificationType": "02"
},
"custIdMerchant": "0012345679504",
"limit": "1000000",
"merchantLogoUrl":
"https://bilba.test.com/dist/img/merchant-logo.png",
"phoneNo": "08238748728423",
"sendOtpFlag": "YES",
"type": "subcribe",
"additionalInfo": {
"deviceId": "12345679237",
"channel": "mobilephone"
}
}
Contoh Response
X-TIMESTAMP: 2020-12-17T10:55:06+07:00
{
"responseCode": "2000000",
"responseMessage": "Request has been processed
successfully",
"referenceNo": "2020102977770000000009",
"bankCardToken": "6d7963617264746f6b656e",
"chargeToken": "abcd63617264746f6b656e",
"randomString": "g4BoEz43jfjVvAvN",
"tokenExpiryTime": "2020-12-17T11:00:00+07:00",
"transactionId": "2020102020202000011001",
"additionalInfo": {
"deviceId": "12345679237",
}
12
}
1.2.2. API Card Registration – Set Limit

Informasi Umum
Service Code 02
Name API Card Registration – Set Limit
Version 1.0
HTTP Method POST
Path …/{version}/registration/card-bind-limit
Request Body
Data
Type
Transaction 2020102
partnerRefe identifier on 9000000
String M 64
renceNo partner 0000000
system 1
bankAccou Account 9380293
String O 32
ntNo number 8408123
3984029
bankCardN Card
String M 19 3840239
o number
84
Daily
decim
limit O 17,3 transaction 1000000
al
limit
6d79636
bankCardT Card token
String O 128 1726474
oken for payment.
6f6b656e
{"deviceId
":
additionalI Additional "1234567
Object O
nfo information 9237",
"channel"
:
13
Data
Type
"mobilep
hone"}
Response Body
Data
Type
Response
code
Request
has been
responseMessa Response processe
String M 150
ge description d
successf
ully
Transaction
identifier on
service
2020102
provider
9777700
0000000
Must be
9
filled upon
successful
transaction
Transaction
2020102
identifier on
String O 64 service
ceNo 0000000
consumer
1
system
Additional {"deviceId
information ":
14
Data
Type
"1234567
9237",
"channel"
:
"mobilep
hone"}
Contoh Request
POST …/1.0/registration-card-inquiry HTTP/1.2
X-TIMESTAMP: 2020-12-17T10:55:00+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"bankAccountNo": "93802938408123",
"bankCardNo": "3984029384023984",
"limit": "1000000",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-17T10:55:06+07:00
15
successfully",
"referenceNo": "2020102977770000000009",
"additionalInfo": {
"deviceId": "12345679237",
}
}
16
1.2.3. API Card Registration Inquiry
Sequence Diagram
Sequence Diagram API Card Registration Inquiry
Informasi Umum
Service Code 03
Name API Card Registration Inquiry
Version 1.0
HTTP Method GET
Path …/{version}/registration-card-inquiry
Request Parameter
Para
Data
Parameter meter Mandatory Length Description Example
Type
Type
8a95f002
custIdMerc Path Merchant’s
String M 18 6d2860f3
hant param customer ID
01
Response Body
Data
Type
Response
code
responseMessa Response Request
String M 150
ge description has been
17
Data
Type
processe
d
successf
ully
Array
accountList of -
Objects
accountData Object -
F8FP2W
accountId String O 16 Account ID QWEATX
FP8K
2020-12-
Creation 17T10:55
createdDate String O 26
date :06+07:0
0
Credential **********
credentialNo String O 16
number **0750
Credential
credentialType String O 2 DC
type
Maximum
maxLimit String O 6 800000
limit
status String O 4 status ACT
{"deviceId
":
"1234567
Additional 9237",
:
"mobilep
hone"}
18
Contoh Request
GET …/1.0/registration-card-
inquiry/custIdMerchant/8a95f0026d2860f301 HTTP/1.2
X-TIMESTAMP: 2020-12-17T11:43:00+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
Contoh Response
X-TIMESTAMP: 2020-12-17T11:43:03+07:00
{
successfully",
"accountList": [
"account_data": {
"accountId": "F8FP2WQWEATXFP8K",
"createdDate": "2018-12-
17T11:59:06+07:00",
"credentialNo": "************0750",
"credentialType": "DC",
"maxLimit": "800000",
"status": "ACT"
}
],
"additionalInfo": {
"deviceId": "12345679237",
}
}
19
1.2.4. API Verify OTP (Direct Integration)
Sequence Diagram
Sequence Diagram API OTP Validation (Direct Integration)
Informasi Umum
Service Code 04
Name API Verify OTP (Direct Integration)
Version 1.0
HTTP Method POST
Path …/{version}/otp-verification
Request Body
Data
Type
Transaction
identifier on 20201029
partnerReferen
String M 64 service 00000000
ceNo
consumer 000001
system
Transaction
referenceNo String M 64 service 77770000
provider 000009
system
otpLinkag
action String O 10 action
e
20
Data
Type
mid String O 5 Merchant ID 00001
OTP Code /
otp String O 8 12345678
Passcode
OTP string
code that is TOK_TKN
to be CPPPHUV
registrationTok verified with L3IJVAXZ
String O 40
en the I5GG4WB
passcode EC77YZ6:
obtained by :ADVQ
the user
type String O 20 Action type Subscribe
{"deviceId"
:
"1234567
Additional
additionalInfo Object O 9237",
information
"channel":
"mobileph
one"}
Response Body
Data
Type
Response
code
Request
has been
responseMessa Response
String M 150 processed
ge description
successfu
lly
21
Data
Type
Transaction
identifier on
service
provider 20201029
referenceNo String C 64 system. 77770000
Must be 000009
filled upon
successful
transaction
Transaction
partnerReferen
String O 64 service 00000000
ceNo
consumer 000001
system
Customer’s
12345678
accountNo String O 11 account
910
number
6d796361
bankCardToke Card token
String O 128 7264746f
n for payment
6b656e
Card 21231231
cardPan String O 16
number 23125356
afhw6d79
63617264
Customer’s
746f6b65
customerId String O 45 identificatio
6e963617
n
264746f6
b656e
RFC 3696 john.doe@
email String O 254
Length 254 email.com
22
Data
Type
after “<” and
“>”
2019-02-
expiredDatetim Expired 24T14:12:
String O 25
e time 25.871+0
7:00
Card expiry
date.
expiryDate String O 4 1219
Format:
MMYY
registered
national id 20201020
identificationN
String O 64 number on 20202000
o
bank 011001
account
Token used
for
linkageToken String O 204 PIN xswe56
redirection
API
Customer’s
phone
number. 08993456
phoneNo String O 16
Format: 78864332
62xxxxxxxx
xxxxx
Webview https://w
URL to set ww.hostn
qParamsURL String O 100
PIN ame.com/
process setPin
23
Data
Type
Params
used to
qParams Object O - set PIN
identificatio
n
Action type otpLinkag
action String O 10
OTP e
Flag of
using
PJSP’s OTP
sendOtpFlag String O 3 YES
or not.
(“YES” or
“NO”)
2017-02-
subscribeDatet Subscriptio 24T14:12:
String O 25
ime n time 25.871+0
7:00
Time when
2017-02-
tokenExpiryTi the token
String O 25 24T14:12:
me will
25.871+0
be expired.
7:00
Random
String to
transactionTim g4BoEz43
String O 25 generate
estamp jfjVvAvN
validation
for webview
{"deviceId"
Additional
additionalInfo Object O :
information
"1234567
24
Data
Type
9237",
"channel":
"mobileph
one"}
Contoh Request
POST …/1.0/otp-verification HTTP/1.2
X-TIMESTAMP: 2020-12-17T13:20:00+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"referenceNo": "2020102977770000000009",
"action": "otpLinkage",
"mid": "00001",
"otp": "12345678",
"registrationToken":
"TOK_TKNCPPPHUVL3IJVAXZI5GG4WBEC77YZ6::ADVQ",
"type": "Subscribe",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-17T13:20:04+07:00
25
successfully",
"referenceNo": "2020102977770000000009",
"accountNo": "12345678910",
"cardPan": "2123123123125356",
"customerId":
"afhw6d7963617264746f6b656e963617264746f6b656e",
"expiryDate": "1219",
"identificationNo": "2020102020202000011001",
"linkageToken": "xswe56",
"phoneNo": "0899345678864332",
"qParamsURL": "https://setPin",
"qParams": {
"action": "otpLinkage"
},
"sendOtpFlag": "YES",
"subscribeDatetime": "2017-02-
24T14:12:25.871+07:00",
"tokenExpiryTime": "2017-02-24T14:12:25.871+07:00",
"transactionTimestamp": "g4BoEz43jfjVvAvN",
"additionalInfo": {
"deviceId": "12345679237",
}
}
26
1.2.5. API Card Registration Unbinding
Sequence Diagram
Sequence Diagram API Card Registration Unbinding
Informasi Umum
Service Code 05
Name API Card Registration Unbinding
Version 1.0
HTTP Method POST
Path …/{version}/registrasion-card-unbind
Request Body
Data
Type
Transaction
partnerReferen
ceNo
consumer 000001
system
27
Data
Type
This is an
alphanumer
ic field
which
contains the g4JeIz43jf
payment jVvAvNxs
token used we56g4Je
in a Iz43jfjVvA
transaction. vNxswe56
This field is g4JeIz43jf
used during jVvAvNxs
token String M 128 setting we56g4Je
token daily Iz43jfjVvA
limit, vNxswe56
purchase, g4JeIz43jf
and delete jVvAvNxs
token. we56g4Jg
This token 4JeIz43jfd
represent sEga
token
number of
card or
token.
Card
number of 21231231
bankCardNo String O 19
the 23125356
cardholder
Request
Unsubscri
type String O 20 type.
be
Example:
28
Data
Type
subscribe,
unsubscribe
, check OTP
Merchant
identifier
that is 00007100
part String O 64
unique per 010926
each
merchant
Merchant
identifier
that is 00007100
merchantId String O 64
unique per 010926
each
merchant
Sub 31092892
subMerchantId String O 32
merchant ID 4949487
identifier
that is
terminalId String O 8 unique per 72001126
each
merchant
An identifier
71274253
to uniquely
tokenRequesto 27776087
String O 15 identify the
rId 32491522
token
8
requestor.
An identifier 20190329
journeyID String O 32 to uniquly 175623M
identify a TISTORE
29
Data
Type
journey. On
the first
request of
the journey,
this must be
equal to the
X-
EXTERNAL-
ID.
date of
2020-12-
transactionDat transaction.
Int O 8 17T13:50:
e Format:
00+07:00
YYYYMMDD
{"deviceId"
:
"1234567
Additional
information
"channel":
"mobileph
one"}
Response Body
Data
Type
Response
code
Request
responseMessa Response has been
String M 150
ge description processe
d
30
Data
Type
successf
ully
Transaction
identifier on
service
2020102
provider
9777700
0000000
Must be
9
filled upon
successful
transaction
Transaction
2020102
identifier on
String O 64 service
ceNo 0000000
consumer
1
system
Berhasil
Response menonak
message String O 255
message tifkan
biller
ae75e364
134cdb2
c7a4159
Customer
customerId String O 45 106e38ca
ID
6b76198
3859dbv
1
unsubscribeDa Dateti Unsubscribe 2020-12-
O
te me date. 17T13:50
31
Data
Type
Format: ISO :04+07:0
8601 0
{"deviceId
":
"1234567
Additional 9237",
:
"mobilep
hone"}
Contoh Request
POST …/1.0/registrasion-card-unbind HTTP/1.2
X-TIMESTAMP: 2020-12-17T13:50:00+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"token":
"g4JeIz43jfjVvAvNxswe56g4JeIz43jfjVvAvNxswe56g4JeIz4
3jfjVvAvNxswe56g4JeIz43jfjVvAvNxswe56g4JeIz43jfjVvAv
Nxswe56g4Jg4JeIz43jfdsEga",
"bankCardNo":”2123123123125356”,
"type": "Unsubscribe",
"part": ”00007100010926",
"merchantId": "23489182303312",
"subMerchantId": "23489182303312",
"terminalId": "72001126",
32
"tokenRequestorId": "7127425327776087324915228",
"journeyID": "20190329175623MTISTORE",
"transactionDate": "2020-12-17T13:50:00+07:00",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-17T13:50:04+07:00
{
successfully",
"referenceNo": "2020102977770000000009",
"customerId":
"ae75e364134cdb2c7a4159106e38ca6b761983859dbv1",
"unsubscribeDate": "2020-12-17T13:50:04+07:00"
},
"additionalInfo": {
"deviceId": "12345679237",
}
}
33
1.2.6. API Account Creation
Sequence Diagram
Sequence Diagram API Account Creation
Informasi Umum
Service Code 06
Name API Account Creation
Version 1.0
HTTP Method POST
Path .../{version}/registration-account-creation
Request Body
Data
Type
Transaction
partnerReferen
ceNo
consumer 01
system
Requestor’s
countryCode String O 2 country ID
code
34
Data
Type
00-
account ID abcdefghijkl
customerId String O 45 of the mnopqrstuv
customer wxyz012345
6789-11
deviceInfo Object O -
os String O 40 Device’s OS IOS
Device’s OS
osVersion String O 40 1
version
Device’s
model String O 40 Iphone
model
Device’s
manufacturer String O 40 manufactur Apple
er
RFC 3696
Length 254 john.doe@em
email String O 254
after “<” and ail.com
“>”
language
lang String O 8 support ID
parameter
Locale and
language
that
locale String O 5 en_ID
customer
selected in
app
name String O 128 User’s name John doe
onboardingPar Onboarding
String O 8 GOJEKXXX
tner partner of
35
Data
Type
the
customer
User’s
phone
number. 0899345678
phoneNo String O 16
Format: 864332
62xxxxxxxx
xxxxx
Merchant https://merc
redirectUrl String O 2048 call back hant.site.co
URL m/apptoken
The scopes
QUERY_BAL
of the
scopes String O 256 ANCE,QUER
authorizatio
Y_PROFILE
n
{
“mobile”:
the “62-
structure for 882345678”,
the mobile “verifiedTime
and ”: “2001-07-
verification 04T12:08:56
seamlessData String O 512
information +05:30”,
，the value “externalUid”
should be :
URLencoded “TIXxxxxxUI
. D”,
“reqTime”:
“2001-07-
36
Data
Type
04T12:08:56
+05:30”,
“riskData”: “{
\
“fuzzyDeviceI
d\”=\”k+OrC
qw7QMNxlrT
3qU2m0TRY
Tucd+nrMH2
izjtltJgLqNI2
XZgEAAA==\
”, \
“terminalTyp
e\”=\”APP\”,
\
“riskFlag\”=\
”00110\”, \
“realIp\”=\”1
23.23.12.111
\”
}
the URLEncode(
signature BASE64(sigi
data for the n({
seamleassD “mobile”:
seamlessSign String O 512
ata, the “62-
value 882345678”,
should be “verifiedTime
URLencoded ”: “2001-07-
37
Data
Type
04T12:08:56
+05:30”,
“externalUid”
:
“TIXxxxxxUI
D”,
“reqTime”:
“2001-07-
04T12:08:56
+05:30”,
“riskData”:
“{
\”fuzzyDevic
eId\”=\”k+Or
Cqw7QMNxlr
T3qU2m0TR
YTucd+nrMH
2izjtltJgLqNI
2XZgEAAA==
\”,
\”terminalTy
pe\”=\”APP\
”,\
“riskFlag\”=\
”00110\”, \”
realIp\”=\”1
23.23.12.111
\” } “
})))
38
Data
Type
1234555666
state String O 32 state
6
Merchant
identifier
that is 0000710001
unique per 0926
each
merchant
subMerchantI Sub 3109289249
String O 32
d merchant ID 49487
Indicates
the source
terminal
type and SYSTEM
terminalType Object O 32
how the
redirect will
happen
{"deviceId":
"1234567923
Additional 7",
information "channel":
"mobilephon
e"}
Response Body
Data
Type
Response
code
39
Data
Type
Request has
responseMessa Response been
String M 150
ge description processed
successfully
Transaction
identifier on
service
provider 2020102977
Must be 09
filled upon
successful
transaction
Transaction
partnerReferen
ceNo
consumer 01
system
g4JeIz43jfjV
vAvNxswe56
g4JeIz43jfjV
the auth
vAvNxswe56
code used to
g4JeIz43jfjV
get
vAvNxswe56
authCode String O 64 accessToken
g4JeIz43jfjV
and
vAvNxswe56
agreementTo
g4JeIz43jfjV
ken
vAvNxswe56
g4Jg4JeIz43
jfdsEga
40
Data
Type
AB12-CD34-
Numeri
apiKey O N/A Customer ID EFGHIJ567
c
890
ABCD1234-
EF56-GH78-
User’s
accountId String O 32 IJ90-
account id
KLMNOP123
456
1234555666
state String O 32 state
6
{"deviceId":
"123456792
Additional 37",
"mobilephon
e"}
Contoh Request
POST …/1.0/registration-account-creation HTTP/1.2
X-TIMESTAMP: 2020-12-17T14:49:00+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"partnerReferenceNo": "2020102900000000000001";
"countryCode": "ID",
41
"customerId": "00-
abcdefghijklmnopqrstuvwxyz0123456789-11",
" deviceInfo": {
"os": "IOS",
"osVersion": "1",
"model": "Iphone",
"manufacture": "Apple"
},
"lang": "ID",
"locale": "en_ID",
"name": "John doe",
"onboardingPartner": "GOJEKXXX",
"phoneNo": "0899345678864332",
"redirectUrl": "https://merchant.site.com/apptoken",
"scopes": "QUERY_BALANCE,QUERY_PROFILE",
"seamlessData": {
“mobile”: “62-882345678”,
“verifiedTime”: “2001-07-04T12:08:56+05:30”,
“externalUid”: “TIXxxxxxUID”, “reqTime”: “2001-07-
04T12:08:56+05:30”,
“riskData”: “{ \
“fuzzyDeviceId\”=\”k+OrCqw7QMNxlrT3qU2m0TRYTucd+nrMH2izjt
ltJgLqNI2XZgEAAA==\”, \ “terminalType\”=\”APP\”,\
“riskFlag\”=\”00110\”, \ “realIp\”=\”123.23.12.111\”}
},
"seamlessSign": "URLEncode(BASE64(sigin({ ",
“mobile”: “62-882345678”,
“verifiedTime”: “2001-07-04T12:08:56+05:30”,
“externalUid”: “TIXxxxxxUID”,
“reqTime”: “2001-07-04T12:08:56+05:30”,
“riskData”: “{
\”fuzzyDeviceId\”=\”k+OrCqw7QMNxlrT3qU2m0TRYTucd+nrMH2izj
tltJgLqNI2XZgEAAA==\”, \”terminalType\”=\”APP\”,\
“riskFlag\”=\”00110\”, \” realIp\”=\”123.23.12.111\” } “
",
})))",
"state": "12345556666",
"merchantId": "23489182303312",
"subMerchantId": "23489182303312",
"terminalType": "SYSTEM",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-17T13:50:04+07:00
42
{
successfully",
"referenceNo": "2020102977770000000009",
"authCode":
"g4JeIz43jfjVvAvNxswe56g4JeIz43jfjVvAvNxswe56g4JeIz43jfjV
vAvNxswe56g4JeIz43jfjVvAvNxswe56g4JeIz43jfjVvAvNxswe56g4J
g4JeIz43jfdsEga",
"apiKey": "AB12-CD34-EFGHIJ567890",
"accountId": "ABCD1234-EF56-GH78-IJ90-KLMNOP123456",
"state": "12345556666",
"additionalInfo": {
"deviceId": "12345679237",
}
}
43
1.2.7. API Account Binding
Sequence Diagram
Sequence Diagram API Account Binding
Informasi Umum
Service Code 07
Name API Account Binding
Version 1.0
HTTP Method POST
Path .../{version}/registration-account-binding
Request Body
Data
Type
Transaction
partnerReferen
ceNo
consumer 000001
system
Action type
action String O 10 otpLinkage
for OTP
additionalData Object O -
44
Data
Type
User ID of
userId String O 20 the card John Doe
holder
RFC 3696
Length 254 john.doe@
email String O 254
after “<” and email.com
“>”
Postal
postalAddress String O 99 address of 134346
the user
An
authorizatio
n code
4b203fe6c
which the
11548bcab
authCode String O 64 caller can
d8da5bb0
used to
87a83b
obtain an
access
token.
The
accessToken
could be AUTHORIZ
grantType String O 64 granted by ATION_CO
authCode or DE
refreshToke
n.
Landing
Page this
isBindAndPay String O 1 N
value is
always ‘N’
45
Data
Type
Initiate
lang String O 8 EN
language
Locale and
language
that
locale String O 5 en_ID
customer
selected in
app
Merchant
identifier
that is 00007100
merchantId String M 64
unique per 010926
each
merchant
String O 32
d merchant ID 4949487
Phone
+6281234
msisdn String O 15 number to
5678901
be binded
otp String O 8 OTP Value 34564367
User’s
phone
number. 08993456
phoneNo String O 16
Format: 78864332
62xxxxxxxx
xxxxx
Merchant
platform
platformType String O 4 app
type
(App, PC, or
46
Data
Type
mobile web)
Redirect
https://w
URL
ww.merch
For
redirectUrl String O 2048 antapp.co
Agreement
m/main_p
page or PIN
age
page
Reference Id
08400000
from
814-
referenceId String O 36 previous
08400000
Generate
814
OTP
Refresh
token, 20120813
which is 4b203fe6c
refreshToken String O 64 used to 11548bcab
refresh the d8da5bb0
access 87a83b
token.
successParam
Object O -
s
ABCD1234
-EF56-
account ID
GH78-
accountId string O 36 given to
IJ90-
the user
KLMNOP1
23456
Terminal
terminalId String O 8 ID
identifier
47
Data
Type
Token e-
tokenRequesto
String O 15 Requestor commerce
rId
ID A
{"deviceId":
"12345679
Additional 237",
"mobilepho
ne"}
Response Body
Data
Type
Response
code
Request has
responseMessag Response been
String M 150
e description processed
successfully
Transaction
identifier on
service
provider 2020102977
Must be 09
filled upon
successful
transaction
48
Data
Type
Transaction
partnerReferenc
eNo
consumer 01
system
accessTokenInfo Object O -
ublicpBa869
cad0990e4e
accessToken String O 32 Access token
17a57ecf7c5
469a4b2
Datetime of
token 2021-07-
expiresIn String O 25 expiration. 04T12:08:56
Format: ISO +05:30
8601
Refresh
token, which 201208134b
is used to 203fe6c1154
refreshToken String O 64
refresh the 8bcabd8da5
access bb087a83b
token.
Datetime of
refresh
2051-07-
token
reExpiresIn String O 25 04T12:08:56
expiration.
+05:30
Format: ISO
8601
Status of
tokenStatus String O 25 ACTIVE
token
49
Data
Type
Identifier
abcd1234efg
provided at
id String O 24 h5678ijkl90
the time of
12
linking
redirect the https://gop
user to this ayapi.com/v
nextAction String O 255 url alidate/otp/
forauthentic abcd123456
ation 789
Token used
for
linkageToken String O 204 PIN xswe56
redirection
API
Params used
for
params Object O - set PIN
identificatio
n
Action type
action String O 10 otpLinkage
OTP
https://ww
URL for set
w.merchant.
pinWebViewUrl String O 100 PIN
com/setPin
process
redirect the https://ww

user to this w.merchant
redirectToDeepli
String O 255 deeplink in api.com/redi
nk
app for rect/abcd12
authenticati 3456789
50
Data
Type
on. This is
only valid in
case of App
Redirection
Flow
Redirect
https://ww
URL
w.merchant
for
redirectUrl String O 2048 api.com/redi
Agreement
rect/abcd12
page or PIN
3456789
page
userInfo Object O -
2018062611
1215830192
publicUserId String O 20 User ID DANAW3ID9
6520006063
0
{"deviceId":
"123456792
Additional 37",
"mobilephon
e"}
Contoh Request
POST …/1.0/registration-account-binding HTTP/1.2
X-TIMESTAMP: 2020-12-18T13:43:31+07:00
X-SIGNATURE:
61b19a5
51
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"additionalData": {
"userId": "John Doe",
"postalAddress": "134346"
},
"authCode": "4b203fe6c11548bcabd8da5bb087a83b",
"grantType": "AUTHORIZATION_CODE",
"isBindAndPay": "N",
"lang": "EN",
"locale": "en_ID",
"merchantId": "23489182303312",
"subMerchantId": "23489182303312",
"msisdn": "+62812345678901",
"otp": "34564367",
"phoneNo": "0899345678864332",
"platformType": "app",
"redirectUrl": "merchantapp://main_page",
"referenceId": "08400000814-08400000814",
"refreshToken":
"201208134b203fe6c11548bcabd8da5bb087a83b ",
"successParams": {
"accountId": "ABCD1234-EF56-GH78-IJ90-
KLMNOP123456"
},
"terminalId": "ID",
"tokenRequestorId": "e-commerceA",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-18T13:43:37+07:00
X-SIGNATURE:
85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19
a5
52
{
successfully",
"referenceNo": "2020102977770000000009",
"accessTokenInfo": {
"accessToken":
"ublicpBa869cad0990e4e17a57ecf7c5469a4b2",
"expiresIn": "2021-07-04T12:08:56+05:30",
"refreshToken":
"201510BB0c409dd5758b4d939d4008a525463X62",
"reExpiresIn": "2051-07-04T12:08:56+05:30",
"tokenStatus": "ACTIVE"
},
"id": "abcd1234efgh5678ijkl9012",
"nextAction":
"https://gopayapi.com/validate/otp/abcd123456789",
"linkageToken": "xswe56",
"params": {
"pinWebViewUrl": "https://setPin",
"redirectToDeeplink":
"https://gopayapi.com/redirect/gopay/abcd123456789"
},
"redirectUrl": "https://redirectUrl",
"userInfo": {
"publicUserId":
"20180626111215830192DANAW3ID965200060630"
},
"additionalInfo": {
"deviceId": "12345679237",
}
}
53
1.2.8. API Account Binding Inquiry
Sequence Diagram
Sequence Diagram API Account binding inquiry
Informasi Umum
Service Code 08
Name API Account Binding Inquiry
Version 1.0
HTTP Method POST
Path .../{version}/registration-account-inquiry
Request Body
Data
Type
Transaction
identifier on
String M 64 service
ceNo 0000000001
consumer
system
{"deviceId":
Additional "12345679237
information ", "channel":
"mobilephone"}
54
Response Body
Data
Type
Response
code
Request has
String M 150
successfully
Transaction
identifier on
service
provider
20201029777
70000000009
Must be
filled upon
successful
transaction
Transaction
identifier on
String O 64 service
ceNo 00000000001
consumer
system
Currency of
accountCurren
String O 3 registered IDR
cy
Account
Registered
accountName String O 50 account Alen Mjucic
name
Registered
11231271284
140
number
55
Data
Type
accountTransa Numer Max debit
O 19,2 1000000
ctionLimit ic amount
Binding end
period.
endDatePeriod String O 10 Format: 2022-05-21
YYYY-MM-
DD
Binding
start period.
startDatePeriod String O 10 Format: 2020-05-21
YYYY-MM-
DD
{"deviceId":
"1234567923
Additional
additionalInfo Object O 7", "channel":
information
"mobilephone"
}
Contoh Request
POST …/1.0/registration-account-inquiry HTTP/1.2
X-TIMESTAMP: 2020-12-18T14:39:21+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
X-LONGITUDE: 106.6643946CHANNEL-ID: 95221
{
56
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-18T14:39:30+07:00
{
successfully",
"referenceNo": "2020102977770000000009",
"accountCurrency": "IDR",
"accountName": "Alen Miucic",
"accountNo": "11231271284140",
"accountTransactionLimit": "1000000",
"endDatePeriod": "2022-05-21",
"startDatePeriod": "2020-05-21",
"additionalInfo": {
"deviceId": "12345679237",
}
}
57
1.2.9. API Account Unbinding
Sequence Diagram
Sequence Diagram API Account Unbinding
Informasi Umum
Service Code 09
Name API Account Unbinding
Version 1.0
HTTP Method POST
Path .../{version}/registration-account-unbinding
Request Body
Data
Type
Transaction
identifier on
partnerRefere 20201029000
String M 64 service
nceNo 00000000001
consumer
system
58
Data
Type
Identifier
provided at abcd1234efgh
linkId String O 24
the time of 5678ijkl9012
linking
Merchant
identifier
that is 00007100010
unique per 926
each
merchant
String O 32
d merchant ID 9487
Access
Aeox320xvijw
tokenId String O 128 Token
efop10
ID
{"deviceId":
"1234567923
Additional
information
"mobilephone
"}
Response Body
Data
Type
Response
code
Request has
responseMess Response
String M 150 been processed
age description
successfully
59
Data
Type
Transaction
identifier on
service
provider
202010297777
0000000009
Must be
filled upon
successful
transaction
Transaction
identifier on
String O 64 service
nceNo 0000000001
consumer
system
Merchant
identifier
that is 000071000109
unique per 26
each
merchant
String O 32
d merchant ID 487
Identifier
provided at abcd1234efgh5
linkId String O 24
the time of 678ijkl9012
linking
Result of
unlinkResult String O 64 unlinking success
process
60
Data
Type
{"deviceId":
Additional "12345679237"
information , "channel":
"mobilephone"}
Contoh Request
POST …/1.0/registration-account-unbinding HTTP/1.2
X-TIMESTAMP: 2020-12-18T14:48:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"linkId": "abcd1234efgh5678ijkl9012",
"merchantId": "23489182303312",
"subMerchantId": "23489182303312",
"tokenId": "Aeox320xvijwefop10",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-18T14:48:30+07:00
{
successfully",
61
"referenceNo": "2020102977770000000009",
"merchantId": "23489182303312",
"subMerchantId": "23489182303312",
"linkId": "abcd1234efgh5678ijkl9012",
"unlinkResult": "success",
"additionalInfo": {
"deviceId": "12345679237",
}
}
1.2.11.API Get OAuth URL

Informasi Umum
Service Code 10
Name API Get OAuth URL
Version 1.0
HTTP Method GET
Path ../{version}/get-auth-code
Request Parameter
Data Mandato Lengt
Parameter Description Example
Type ry h
URL yang
digunakan
sebagai https://dom
Strin callback ain.com/aut
redirectUrl M 256
g setelah hSuccess.js
proses on
getAuthCode
berhasil.
Scope akses
List< dari QUERY_BAL
scopes Strin M 256 authorizatio ANCE,QUER
g> n yang di Y_PROFILE
inginkan.
62
Data Mandato Lengt
Type ry h
Random
string untuk
Strin keperluan WOdkkwijS
state M 32
g perlindunga Ds
n terhadap
CSRF
Merchant
identifier
Strin that is 0000710001
merchantId O 64
g unique per 0926
each
merchant
subMerchantI Strin Sub 3109289249
O 32
d g merchant ID 49487
Kode
Bahasa
Strin
lang O 2 yang id
g
layanan.
ISO 639-1
If value
equals true,
provider
may enable
allowRegistrat Boole registration
O true
ion an process
during
binding.
Default true.
63
Data Mandato Lengt
Type ry h
Data yang
diperuntuka
Strin n untuk
seamlessData O 512
g mempercepa
t proses
otentikasi
Nomor
telpon
pengguna,
apabila field
ini terisi
mobileNumbe Strin 6282299999
O 18 maka user
r g 9
wajin login
dengan
nomor yang
sudah
disertakan
Value yang
menyatakan
bahwa
nomor
ponsel yang
sudah 2051-07-
Strin ISO-
verifiedTime O disertakan 04T12:08:56
g 8601
dalam +05:30
seamless
data sudah
diverifikasi
kepemilikan
nya dan
64
Data Mandato Lengt
Type ry h
tidak
memerlukan
verifikasi
OTP oleh
pihak
penyedia.
Validitas
dari
verifikasi ini
hanya 10
menit.
ID milik
Strin user pada 3134535445
externalUid O 32
g aplikasi 3
partner
Strin Device ID
deviceId O 32
g milik User
Signature
dari
Strin
seamlessSign C 512 seamless
g
data yang
disertakan.
Cara menyertakan seamless data:
seamlessData = URLEncode({“mobileNumber”=”62822999999”})
Cara menyertakan seamlessSign
seamlessSign = URLEncode(sign(seamlessData))
65
- Partner menggukan private key untuk membuat seamless sign,
sedangakan pihak penyedia akan menggukan publick key milik
partner untuk proses verifikasi.
- Jika proses verifikasi gagal, maka seamless data akan diabaikan.
- Charset dari URL Encode menggunakan UTF-8
Konstruksi URL
../{version}/get-authcode?
Response Body
state=<RANDOM_UNIQUE>&scopes=QUERY_BALANCE,PUBLIC_ID&r
Data Mandato Lengt
edirectUrl=<MERCHANT_OAUTH_CALLBACK_URL>&seamlessData=<SEA
Type ry h
MLESS_DATA>&seamlessSign=<SIGNATURE>
Strin Response
responseCode M 7 2000000
g code
Request has
responseMess Strin Response been
M 150
age g description processed
successfully
Authcode
yang dapat
ditukarkan
a4sd5a4fsaf
dengan
authCode S M 32 5d5f4df66ad
access token
85f4
pada API
account
binding
Strin Random WOdkkwijS
state ME 32
g string untuk Ds
66
Data Mandato Lengt
Type ry h
keperluan
perlindunga
n terhadap
CSRF
Contoh Request
GET .../1.0/get-auth-code?state=WOdkkwijSDs
&scopes=QUERY_BALANCE,PUBLIC_ID&redirectUrl=https://domai
n.com/authSuccess.htm&seamlessData=%7B%22mobileNumber%22% 3A
%2262822999999999%22%7D&seamlessSign=gsfIUuC%2Bzs101rRF
Uhzz9753s9dJ4wg0EtwLwr8fMhZmCFybaCcwvAXGZ0RDxqzb9fJuFre%2
Bmsi9JcwHICVx%2FB1onruQNldI4Y%2BUZqVQLgUVz1ynAa1qyyaTKliX Ofy3t
%2FbOhXd0QfZ3e1zbQT5
Authorization-Customer: Bearer
fa8sjjEj813Y9JGoqwOeOPWbnt4CUpvIJbU1mMU4a11MNDZ7Sg5u9a"
X-TIMESTAMP: 2020-12-23T09:10:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
Contoh Response
X-TIMESTAMP: 2020-12-23T09:10:18+07:00
{
successfully",
"authCode": "a4sd5a4fsaf5d5f4df66ad85f4",
"state": "WOdkkwijSDs"
}
67
2. KATEGORI II: INFORMASI SALDO
API Balance Inquiry (Informasi Saldo) diperlukan agar Konsumen, Non-PJP
Pengguna Layanan, PJP AIns, maupun PJP PIAS dapat mengakses informasi
saldo terkini dari rekening yang dimiliki secara real time, sesuai dengan
layanan yang disediakan oleh PJP AIS.
2.1. SKENARIO PENGGUNAAN API BALANCE INQUIRY
Use Case Diagram API Balance Inquiry
Merujuk pada use case diagram, pemilik akun yaitu Konsumen, Non-PJP
Pengguna Layanan, PJP AIns, serta PJP PIAS, dapat mengakses informasi
saldo atas rekeningnya menggunakan API Balance Inquiry yang disediakan
oleh PJP AIS.
API Balance Inquiry dapat digunakan dalam sejumlah skema sebagai berikut:
Skema 1: Konsumen – Non-PJP Pengguna Layanan / PJP AIns / PJP PIAS
– PJP AIS
Dalam skema ini, Konsumen mengakses informasi saldo rekeningnya melalui
Non-PJP Pengguna Layanan, PJP AIns, atau PJP PIAS yang terhubung ke PJP
AIS dimana rekening Konsumen terdaftar. Mekanisme ini dapat dilakukan
menggunakan authorization code yang didapat dari proses card registration
atau account binding dengan melalui proses otorisasi/otentikasi untuk
memastikan kebenaran informasi Konsumen dengan menggunakan
mekanisme OAuth 2.0.
Skema 2: Non-PJP Pengguna Layanan / PJP AIns / PJP PIAS – PJP AIS
Dalam skema ini, Non-PJP Pengguna Layanan, PJP AIns, atau PJP PIAS
mengakses informasi saldo rekeningnya pada PJP AIS dimana rekening Non-
PJP Pengguna Layanan, PJP AIns, atau PJP PIAS terdaftar.
68
2.2. SPESIFIKASI API BALANCE INQUIRY
2.2.1. API Balance Inquiry
Sequence Diagram
Sequence Diagram API Balance Inquiry
Informasi Umum
Service Code 11
Name API Balance Inquiry
Version 1.0
HTTP Method POST
Path .../{version}/balance-inquiry
Request Body
Data
Type
Transaction
identifier on
partnerRefer 20201029000
String M 64 service
enceNo 00000000001
consumer
system
Registered
11231271284
140
number
69
Data
Type
{"deviceId":
"1234567923
additionalInf Additional
Object O 7", "channel":
o information
"mobilephone
"}
Response Body
Manda
Parameter Value Length Description Example
tory
responseCo Response
String M 7 2000000
de code
Request has
responseMe Response been
String M 150
ssage description processed
successfully
Transaction
identifier on
service
2020102977
provider
referenceNo String C 64 7700000000
system. Must
09
be filled upon
successful
transaction
Transaction
partnerRefer
enceNo
consumer 01
system
70
Manda
tory
Registered
accountNo String O 32 account 115471119
number
Balance, Ovo
Account type
accountType String O 70 Cash, Shopee
name
Coins
Customer
name String M 140 account JONOMADE
name
Account
Object O
Type
Net amount
of the
transaction.
{
If it’s IDR
then value
“value”:“1000
includes 2
Decima 0.00”,
amount M 18, 3 decimal
l
digits.
“currency”:”I
e.g. IDR
DR”
10.000,- will
}
be placed
with
10000.00
Amount of
deposit that {
Decima is not
floatAmount M 18, 3
l effective yet “value”:“5000
(due to 0.00”,
holiday, etc.).
71
Manda
tory
If it’s IDR
then value “currency”:”I
includes 2 DR”
decimal }
digits.
e.g. IDR
50.000,- will
be placed
with
50000.00
Hold amount
that cannot
be used.
{
If it’s IDR
then value
“value”:“2000
includes 2
Decima 0.00”,
holdAmount M 18, 3 decimal
l
digits.
“currency”:”I
e.g. IDR
DR”
20.000,- will
}
be placed
with
20000.00
Account
balance that
availableBal 1673276594
String O 18 can be used
ance 9981
for financial
transaction
ledgerBalan Decima Account 1673276594
O (18,2)
ce l balance at 9981,2
72
Manda
tory
the beginning
of each day
Credit limit of
currentMulti
String O 18 the account / 0
lateralLimit
plafon
Currency of
currency String O 3 IDR
the account
Customer
registration
String O 4 registration 1
StatusCode
status
Account
Status
1 = Active
Account
2 = Closed
Account
4 = New
status String O 4 Account 0001
6=
Restricted
Account
7 = Frozen
Account
9 = Dormant
Account
{"deviceId":
"1234567923
additionalInf Additional
Object O 7", "channel":
o information
"mobilephone
"}
73
Contoh Request
POST …/1.0/balance-inquiry HTTP/1.2
X-TIMESTAMP: 2020-12-18T15:06:00+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"accountNo": "11231271284140",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-18T15:06:07+07:00
{
successfully",
"referenceNo": "2020102977770000000009",
"accountNo": "115471119",
"accountType": "Shopee Coins",
"name": "JONOMADE",
"accountType": {
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"floatAmount": {
"value": "50000.00",
74
"currency": "IDR"
},
"holdAmount": {
"value": "20000.00",
"currency": "IDR"
},
"availableBalance": "16732765949981",
"ledgerBalance": "16732765949981,2",
"currentMultilateralLimit": "0",
"currency": "IDR",
"registrationStatusCode": "1",
"status": "0001"
},
"additionalInfo": {
"deviceId": "12345679237",
}
}
75
3. KATEGORI III: RIWAYAT TRANSAKSI
API Transaction History (Riwayat Transaksi) diperlukan agar Konsumen,
Non-PJP Pengguna Layanan, atau PJP PIAS dapat mengakses informasi
riwayat transaksi dari rekening yang dimiliki secara real time, sesuai dengan
layanan yang disediakan oleh PJP AIS. Informasi riwayat transaksi berisi
rincian mengenai transaksi kredit maupun debit, saldo rekening, dan
beberapa informasi lainnya.
API Bank Statement merupakan API yang digunakan untuk mengakses

riwayat transaksi keuangan secara menyeluruh dari sebuah rekening Bank,
baik rekening milik individu pemilik rekening. Konsumen dapat
memanfaatkan platform dari Non-PJP Pengguna Layanan, atau PJP PIAS
yang telah disertifikasi oleh PJP AIS untuk mengakses API ini sehingga dapat
dengan mudah melihat rincian keuangannya dalam satu aplikasi.
3.1. SKENARIO PENGGUNAAN API TRANSACTION HISTORY
Use Case Diagram API Transaction History
Merujuk pada use case diagram, pemilik akun yaitu Konsumen, Non-PJP
Pengguna Layanan, PJP PIAS, PJP AIS Lembaga Selain Bank dapat
mengakses informasi riwayat transaksi (transaction history list) dan/atau
rincian dari riwayat transaksi (transaction history detail) atas rekeningnya
menggunakan API Riwayat Transaksi yang disediakan oleh PJP PIAS atau
PJP AIS. Konsumen, PJP PIAS, atau PJP AIS Lembaga Selain Bank dapat
76
menggunakan API Bank Statement yang disediakan oleh PJP AIS melalui
pihak yang sudah tersertifikasi untuk mengakses API ini.
API Transaction History dapat digunakan dalam sejumlah skema sebagai

berikut:
Skema 1: Konsumen – Non-PJP Pengguna Layanan – PJP AIS Lembaga
Selain Bank
Dalam skema ini, Konsumen mengakses riwayat transaksi yang tercatat pada
PJP AIS Lembaga Selain Bank yang dilakukan melalui Non-PJP Pengguna
Layanan sebagai kanal pembayaran. Mekanisme ini dapat dilakukan setelah
dilakukan proses card registration/account binding. Pada saat pengaksesan
riwayat transaksi, diperlukan permintaan persetujuan Konsumen
(otorisasi/otentikasi) secara eksplisit menggunakan mekanisme OAuth 2.0
untuk memastikan kebenaran informasi Konsumen serta agar tidak ada
penyalahgunaan data dan hak dari Konsumen. Setelah mendapatkan
persetujuan dari Konsumen, Non-PJP Pengguna Layanan akan mendapatkan
access token sebagai credential dari PJP AIS Lembaga Selain Bank untuk
mengakses data Konsumen tersebut.
Dalam skema ini, Konsumen dapat mengakses riwayat transaksi yang

transaksinya dilakukan melalui PJP AIS Lembaga Selain Bank dan Non-PJP
Pengguna Layanan tersebut saja. Dalam hal ini, PJP AIS Lembaga Selain
Bank tidak menyertakan riwayat transaksi yang dilakukan melalui kanal
pembayaran lain.
API yang dapat digunakan dalam skema ini adalah API Transaction History
List dan Transaction History Detail. API Transaction History List
mengembalikan daftar riwayat transaksi, sedangkan API Transaction History
Detail mengembalikan informasi lengkap dari 1 riwayat transaksi.
Skema 2: Konsumen – Non-PJP Pengguna Layanan – PJP PIAS

Dalam skema ini, Konsumen mengakses riwayat transaksi yang tercatat pada
PJP PIAS yang dilakukan melalui suatu Non-PJP Pengguna Layanan sebagai
77
kanal pembayaran. PJP PIAS pada umumnya menyediakan beberapa kanal
pembayaran seperti kartu kredit/debit, transfer ke virtual account, hingga
pembayaran offline pada tempat tertentu seperti minimarket.
Konsumen tidak memiliki akun khusus pada PJP PIAS dan Konsumen
memasukkan beberapa informasi setiap kali melakukan transaksi.
Konsumen dapat mengakses riwayat transaksi yang dilakukan pada Non-PJP
Pengguna Layanan tersebut dengan menggunakan API Transaction History
List dan Transaction History Detail. Non-PJP Pengguna Layanan cukup
menggunakan credentials yang telah disediakan oleh PJP PIAS.
Skema 3: Konsumen – PJP PIAS – PJP AIS Bank

Dalam skema ini, Konsumen mengakses riwayat transaksi melalui layanan
rekening koran pada PJP AIS Bank yang dilakukan melalui PJP PIAS sebagai
kanal pembayaran. Konsumen dapat mengakses riwayat transaksi yang
dilakukan dengan menggunakan API Bank Statement.
API ini hanya bisa digunakan oleh pihak yang sudah tersertifikasi dan lolos
pemeriksaan oleh PJP AIS Bank sebagai penyedia layanan karena
mengandung data pribadi dan rahasia.
Pada saat pengaksesan riwayat transaksi, diperlukan permintaan
persetujuan Konsumen (otorisasi/otentikasi) secara eksplisit menggunakan
mekanisme OAuth 2.0 untuk memastikan kebenaran informasi pengguna
serta agar tidak ada penyalahgunaan data.
Setelah mendapatkan persetujuan dari Konsumen, PJP PIAS akan
mendapatkan access token sebagai credential dari PJP AIS Bank untuk
mengakses data.
Skema 4: PJP AIS Lembaga Selain Bank/PJP PIAS – PJP AIS Bank
Dalam skema ini, PJP AIS Lembaga Selain Bank/PJP PIAS dapat mengakses
riwayat transaksi rekeningnya melalui layanan rekening koran pada PJP AIS
Bank dengan menggunakan API Bank Statement.
78
3.2. SPESIFIKASI API TRANSACTION HISTORY
3.2.1. API Transaction History List
Ketentuan dan Keterbatasan API
Pengurutan DESC
pageSize Maksimal 50
Rentang Waktu Maksimal 1 bulan
Riwayat Transaksi Tertua 1 tahun
Sequence Diagram
Sequence Diagram untuk API Transaction History List
Informasi Umum
Service Code 12
Name API Transaction History List
Version 1.0
HTTP Method POST
Path .../{version}/transaction-history-list
Request Body
Data
Type
partnerRefer Transaction 20201029000
String M 64
enceNo identifier on 00000000001
79
Data
Type
service
consumer
system
Starting
time range.
ISODa
Default:
teTim 2019-07-
fromDateTi NOW
e O 25 03T12:08:56-
me (DESC)
ISO- 07:00
or NOW – 3
860
months
1
(ASC)
Ending time
range.
ISODa
Default:
teTim 2019-07-
NOW – 3
toDateTime e O 25 03T12:08:56-
months
ISO- 07:00
(DESC)
860
or NOW
1
(ASC)
Maximum
number of
transaction
pageSize int O 2 returned in 10
one
pagination.
Default: 10
Current
page
pageNumber int O 2 2
number.
Default: 0
80
Data
Type
{"deviceId":
additionalInf Additional "12345679237
Object O
o information ", "channel":
"mobilephone"}
Response Body
Data
Type
Response
code
Request has
responseMess Response been
String M 150
age description processed
successfully
Transaction
identifier on
service
provider
20201029777
70000000009
Must be
filled upon
successful
transaction
Transaction
identifier on
String O 64 service
nceNo 00000000001
consumer
system
81
Data
Type
Array
detailData of
object
Net amount
of the
transaction.
{
Active If it’s IDR
Curren then value
“value”:“1000
cyAnd includes 2
0.00”,
amount Amoun M decimal
t digits.
“currency”:”I
ISO- e.g. IDR
DR”
4217 10.000,- will
}
be placed
with
10000.00
Payment to
Transaction
remark String O 256 Warung Ikan
remark.
Bakar
[{"source":
List<S
"BALANCE",
ourceO
Source of "amount":
fFund>
sourceOfFund funds used {"value":
See O N/A
s for this "10000.00","c
object
transaction. urrency":
definiti
"IDR"}
on.
}]
Transaction
status String M 32 SUCCESS
status.
82
Data
Type
INIT,
SUCCESS,
CLOSED,
CANCELLE
D
Transaction
type.
PAYMENT,
REFUND,
type String M 32 TOP_UP, PAYMENT
SEND_MON
EY,
RECEIVE_M
ONEY
{"deviceId":
"1234567923
Additional
information
"mobilephone
"}
Contoh Request
POST …/1.0/transaction-history-list HTTP/1.2
X-TIMESTAMP: 2020-12-18T15:34:40+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
83
CHANNEL-ID: 95221
{
"fromDateTime": "2019-07-03T12:08:56-07:00",
"toDateTime": "2019-07-03T12:08:56-07:00",
"pageSize": "10",
"pageNumber": "2",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-18T15:34:44+07:00
{
successfully",
"referenceNo": "2020102977770000000009",
"detailData": [
{
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"remark": "Payment to Warung Ikan Bakar",
"sourceOfFunds": [{
"source": "BALANCE",
"amount": {
"value": "10000.00",
"currency": "IDR"
}
}],
"status": "SUCCESS",
"type": "PAYMENT"
}
],
"additionalInfo": {
"deviceId": "12345679237",
}
}
84
3.2.2. API Transaction History Detail
Riwayat Transaksi 1 tahun
Tertua
Sequence Diagram
Sequence Diagram untuk API Transaction History Detail
Informasi Umum
Service Code 13
Name API Transaction History Detail
Version 1.0
HTTP Method POST
Path .../{version}/transaction-history-detail
Request Body
Data
Type
Transaction
identifier on
partnerRefer 20201029000
String M 64 service
enceNo 00000000001
consumer
system
85
Data
Type
{"deviceId":
additionalInf Additional "12345679237
Object O
o information ", "channel":
"mobilephone"}
Response Body
Data
Type
Response
code
Request has
String M 150
successfully
Transaction
identifier on
service
provider 2020102977
Must be 09
filled upon
successful
transaction
Transaction
partnerReferen
ceNo
consumer 01
system
86
Data
Type
Net amount
of the
transaction.
Active If it’s IDR
{
Curre then value
“value”:“100
ncyAn includes 2
00.00”,
amount dAmo M 18, 3 decimal
“currency”:”I
unt digits.
DR”
ISO- e.g. IDR
}
4217 10.000,- will
be placed
with
10000.00
ISODa
Transaction 2009-07-
teTime
cancelledTime O 25 cancelled 03T12:08:56
ISO-
time. -07:00
8601
ISODa
Transaction 2009-07-
teTime
dateTime M 25 created 03T12:08:56
ISO-
time. -07:00
8601
Refund
Active amount of
{
Curre the
“value”:“100
ncyAn transaction.
00.00”,
refundAmount dAmo O 18, 3 If it’s IDR
“currency”:”I
unt then value
DR”
ISO- includes 2
}
4217 decimal
digits.
87
Data
Type
e.g. IDR
10.000,- will
be placed
with
10000.00
Payment to
Transaction
remark String O 256 Warung
remark.
Ikan Bakar
List<S
[{"source":
ource
"BALANCE",
OfFun
Source of "amount":
d>
sourceOfFund funds used {"value":
See O N/A
s for this "10000.00","
object
transaction. currency":
definit
"IDR"}
ion.
}]
Transaction
status.
INIT,
status String M 32 SUCCESS, SUCCESS
CLOSED,
CANCELLE
D
Transaction
type.
PAYMENT,
type String M 32 PAYMENT
REFUND,
TOP_UP,
SEND_MON
88
Data
Type
EY,
RECEIVE_M
ONEY
{"deviceId":
"123456792
Additional 37",
"mobilephon
e"}
Contoh Request
POST …/1.0/transaction-history-detail HTTP/1.2
X-TIMESTAMP: 2020-12-18T15:55:40+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
X-LONGITUDE: 106.6643946CHANNEL-ID: 95221
{
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-18T15:55:47+07:00
89
successfully",
"referenceNo": "2020102977770000000009",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"cancelledTime": "2020-12-18T15:55:47+07:00",
"dateTime": "2020-12-18T15:55:47+07:00",
"refundAmount": {
"value": "10000.00",
"currency": "IDR"
},
"sourceOfFunds": [{
"source": "BALANCE",
"amount": {
"value": "10000.00",
"currency": "IDR"
}
}],
"status": "SUCCESS",
"type": "PAYMENT",
"additionalInfo": {
"deviceId": "12345679237",
}
}
90
3.2.3. API Bank Statement
Pengurutan DESC
Rentang Waktu 1 bulan
Maksimal
Riwayat Transaksi 1 tahun
Tertua
Sequence Diagram
Sequence Diagram untuk API Bank Statement
Informasi Umum
Service Code 14
Name API Bank Statement
Version 1.0
HTTP Method POST
Path .../{version}/bank-statement
91
Request Body
Data
Type
Transaction
partnerReferen
ceNo
consumer 01
system
Bank
7382382957
accountNo String M 16 account
893840
number.
Starting time
range.
ISODa
Default: 2019-07-
teTime
fromDateTime O 25 NOW (DESC) 03T12:08:56
ISO-
or NOW – 3 -07:00
8601
months
(ASC)
Ending time
range.
ISODa Default:
2019-07-
teTime NOW – 3
toDateTime O 25 03T12:08:56
ISO- months
-07:00
8601 (DESC)
or NOW
(ASC)
{"deviceId":
"1234567923
Additional 7",
"mobilephon
e"}
92
Response Body
Data
Type
responseCod Response
String M 7 2000000
e code
Request has
responseMes Response been
String M 150
sage description processed
successfully
Transaction
identifier on
service
provider 2020102977
Must be 09
filled upon
successful
transaction
Transaction
partnerRefer
enceNo
consumer 01
system
[{"amount": {
List<Ca Starting and "value":
shBala ending "10000.00","
nce8> balance currency":
balance See O N/A before the "IDR"},
object first/last "dateTime":
definiti transaction. "2020-12-
on 18T16:03:45
+07:00"}]
93
Data
Type
{
DebitA “numberOfE
ndCred ntries”: “10”,
Total
itEntrie “amount”: {
transaction
totalCreditEn s "value":
O N/A amount
tries See "10000.00",
with type =
object "currency":
CREDIT.
definiti "IDR"
on }
}
{
DebitA “numberOfE
ndCred ntries”: “10”,
Total
itEntrie “amount”: {
transaction
totalDebitEnt s "value":
O N/A amount
ries See "10000.00",
with type =
object "currency":
DEBIT.
definiti "IDR"
on }
}
Array
detailData of
object
List<De Starting and
[{"amount": {
tailBal ending
"value":
ance> balance
"10000.00",
detailBalance See O N/A before and
"currency":
object after
"IDR"}}]
definiti transaction.
on.
94
Data
Type
Net amount
of the
transaction.
ActiveC If it’s IDR
{
urrenc then value
“value”:“100
yAnd includes 2
00.00”,
amount Amoun M decimal
“currency”:”I
t digits.
DR”
ISO- e.g. IDR
}
4217 10.000,- will
be placed
with
10000.00
Origin net
amount of
the
transaction.
ActiveC If it’s IDR {
urrenc then value “value”:“100
originAmoun yAndA includes 2 00.00”,
O
t mount decimal “currency”:”I
ISO- digits. DR”
4217 e.g. IDR }
10.000,- will
be placed
with
10000.00
Timestamp 2009-07-
transactionTi ISODat
M 25 of the 03T12:08:56-
me eTime
Transaction. 07:00
95
Data
Type
ISO-
8601
Payment to
Transaction
remark String M 256 Warung Ikan
remark.
Bakar
Internal
transaction
2020080119
identifier
transactionId String O 35 8230912830
from
091123
publisher
perspective.
Transaction
type.
type String M 6 CREDIT
CREDIT/DE
BIT
Transaction
detail
indicator
(original
transactionD transaction
String O 20 SUCCESS
etailStatus or error
correction)
SUCCESS/
ERROR
CORECTION
Additional
information
detailInfo Object O
of detail
transaction
96
Data
Type
{"deviceId":
"1234567923
additionalInf Additional 7",
Object O
o information "channel":
"mobilephon
e"}
Contoh Request
POST …/1.0/bank-statement HTTP/1.2
X-TIMESTAMP: 2020-12-18T16:03:40+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"accountNo": "7382382957893840",
"fromDateTime": "2019-07-03T12:08:56-07:00",
"toDateTime": "2019-07-03T12:08:56-07:00",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-18T16:03:45+07:00
97
{
successfully",
"referenceNo": "2020102977770000000009",
"balance": [
{
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"dateTime": "2020-12-18T16:03:45+07:00"
}
],
"totalCreditEntries": {
"numberOfEntries": "10",
"amount": {
"value": "10000.00",
"currency": "IDR"
}
},
"totalDebitEntries": {
"numberOfEntries": "10",
"amount": {
"value": "10000.00",
"currency": "IDR"
}
},
"detailData": [
{
"detailBalance": [
{
"amount": {
"value": "10000.00",
"currency": "IDR"
}
}
],
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"originAmount": {
"value": "10000.00",
"currency": "IDR"
},
"transactionId": "20200801198230912830091123",
98
"type": "CREDIT",
"transactionDetailStatus":"SUCCESS"
}
],
"additionalInfo": {
"deviceId": "12345679237",
}
}
Definisi Tipe
ResultInfo
Data
Type
Result code
resultCodeId String M 8 unique 00000000
identifier.
resultCode String M 64 Result code. SUCCESS
Result
resultStatus String M 1 status. S
S/F/U
Result
message, can
Successfully
resultMsg String O 256 be filled with
processed.
the reason of
error.
SourceOfFund
Data
Type
Source of
fund.
source String M 32 BALANCE
BALANCE/et
c.
Net amount
of the
Active transaction.
{
Curre If it’s IDR
“value”:“1000
ncyAn then value
0.00”,
amount dAmo M 18, 3 includes 2
“currency”:”ID
unt decimal
R”
ISO- digits.
}
4217 e.g. IDR
10.000,- will
be placed
99
Data
Parameter Type Mandatory Length Description Example
with
10000.00
CashBalance8
Data
Type
Amount of
balance.
Active If it’s IDR then
{
Curre value includes
“value”:“100
ncyAn 2 decimal
00.00”,
amount dAmo M 18, 3 digits.
“currency”:”I
unt e.g. IDR
DR”
ISO- 10.000,- will
}
4217 be placed
with
10000.00
ISODa
2009-07-
teTime Timestamp of
date M 25 03T12:08:56-
ISO- the balance.
07:00
8601
DetailBalance
Data
Amount of
balance.
Active If it’s IDR then
{
Curre value includes
“value”:“100
ncyAn 2 decimal
00.00”,
amount dAmo M 18, 3 digits.
“currency”:”I
unt e.g. IDR
DR”
ISO- 10.000,- will
}
4217 be placed
with
10000.00
ActiveCurrencyAndAmount
Data
Value of the
String amount.
value ISO- M 18 10000.00
If it’s IDR
4217 then value
10
Data
includes 2
decimal
digits.
e.g. IDR
10.000,- will
be placed
with
10000.00
String
currency ISO- M 3 Currency. IDR
4217
DebitAndCreditEntries
Data
numberOfEntr Number of 10
int O 5
ies entries
amount Object
Value of the
amount.
If it’s IDR
then value
includes 2
String
decimal
value ISO- M 18 10000.00
digits.
4217
e.g. IDR
10.000,- will
be placed
with
10000.00
String
currency ISO- M 3 Currency. IDR
4217
10
4. KATEGORI IV: TRANSFER KREDIT
API Transfer Kredit digunakan untuk melakukan pemindahbukuan dana
dari satu rekening ke rekening lain baik dalam PJP AIS yang sama maupun
PJP AIS yang berbeda yang diinisiasi oleh pihak pengirim (pihak terdebit).
4.1. SKENARIO PENGGUNAAN API TRANSFER KREDIT
Use Case Diagram API Transfer Credit
Merujuk pada use case diagram, pemilik rekening yaitu Non-PJP Pengguna
Layanan, atau PJP PIAS dapat melakukan pemindahanbukuan dana atas
rekeningnya menggunakan:
 API internal account inquiry, external account inquiry, intrabank transfer,
interbank transfer, transfer RTGS, transfer SKNBI, dan transaction status
inquiry yang disediakan oleh PJP AIS Bank; dan
 API inquiry transaction, customer top up, bulk cashin, transfer to bank,
transfer to OTC, CPM, MPM, transaction status inquiry, auth payment
yang disediakan oleh PJP AIS Lembaga Selain Bank.
10
Pemilik rekening yaitu Konsumen, dapat melakukan pemindahanbukuan
dana atas rekeningnya menggunakan:
 API Transfer to Bank, API Transfer to OTC, CPM, dan MPM yang
disediakan oleh PJP AIS Lembaga Selain Bank.
API Transfer Kredit dapat digunakan dalam sejumlah skema sebagai berikut:
Skema 1: Non-PJP Pengguna Layanan / PJP PIAS / PJP AIS Lembaga
Selain Bank – PJP AIS Bank
Dalam skema ini, Non-PJP Pengguna Layanan, PJP PIAS, atau PJP AIS
Lembaga Selain Bank dapat melakukan pemindabukuan dana yang
bersumber dari rekeningnya (skema B2B) melalui layanan transfer kredit
pada PJP AIS Bank menggunakan API intrabank transfer, interbank transfer,
request for payment, interbank transfer (bulk), transfer RTGS, dan transfer
SKNBI.
Dalam skema ini, Non-PJP Pengguna Layanan dapat terhubung langsung ke

PJP AIS maupun melalui PJP PIAS/PJP AIS Lembaga Selain Bank.
 Intrabank transfer:
API Intrabank Transfer digunakan untuk melakukan pemindahbukuan
dana dari rekening Non-PJP Pengguna Layanan, PJP PIAS, atau PJP AIS
Lembaga Selain Bank ke rekening tujuan pada satu PJP AIS Bank.
 Interbank Transfer:
API Interbank Transfer digunakan untuk melakukan pemindahbukuan
dana dari satu rekening Non-PJP Pengguna Layanan, PJP PIAS, atau PJP
AIS Lembaga Selain Bank, pada PJP AIS Bank ke rekening tujuan pada
PJP AIS Bank lain melalui perantaraan Penyelenggara Infrastruktur
Pembayaran (PIP) seperti GPN atau BI-FAST.
 Request for Payment:

API Request for Payment digunakan untuk melakukan penagihan oleh
Non-PJP Pengguna Layanan, PJP PIAS, atau PJP AIS Lembaga Selain
10
Bank. Apabila pihak tertagih menyetujui tagihan, proses pembayaran
tagihan dilakukan menggunakan API Intrabank atau API Interbank.
 Interbank Transfer - Bulk:

API Interbank Transfer - Bulk digunakan untuk melakukan
pemindahbukuan dana dari 1 (satu) rekening dengan tujuan lebih dari 1
(satu) rekening pada 1 (satu) atau lebih bank. Proses transaksi ini dapat
diinisiasi oleh Non-PJP Pengguna Layanan atau PJP PIAS, dalam bentuk
instruksi bulk. Transaksi kemudian diteruskan oleh PJP AIS Bank
pengirim ke BI-FAST untuk dilakukan de-bulking dan diteruskan ke PJP
AIS Bank penerima dalam bentuk instruksi individual.
 Transfer RTGS:
API Transfer RTGS digunakan untuk melakukan pemindahbukuan dana
dari satu rekening Non-PJP Pengguna Layanan, PJP PIAS, atau PJP AIS
Lembaga Selain Bank, pada PJP AIS Bank ke rekening tujuan pada PJP
AIS Bank lain melalui perantaraan Penyelenggara Infrastruktur
Pembayaran (PIP) BI-RTGS.
 Transfer SKNBI:
API Transfer SKNBI digunakan untuk melakukan pemindahbukuan dana
dari satu rekening Non-PJP Pengguna Layanan, PJP PIAS, atau PJP AIS
Lembaga Selain Bank, pada PJP AIS Bank ke rekening tujuan pada PJP
AIS Bank lain melalui perantaraan Penyelenggara Infrastruktur
Pembayaran (PIP) SKNBI.
 Transfer Virtual Account:

Pembayaran menggunakan virtual account pada dasarnya adalah
melakukan transfer ke suatu nomor rekening yang bersifat virtual dan
ketika dilakukan pemindahbukuan ke dalam nomor rekening tersebut,
akan langsung masuk ke nomor rekening asli yang terhubung ke virtual
account tersebut. Dengan memanfaatkan virtual account, Pengguna
Layanan dapat mengidentifikasi tujuan pembayaran dari setiap transfer
10
yang diterima. Informasi pembayaran beserta nomor virtual account akan
tercantum pada mutasi di rekening koran Pengguna Layanan.
Skenario penggunaan virtual account terbagi menjadi:

 Create VA
Pada skenario ini, nomor virtual account dikelola oleh Penyedia
Layanan. Permintaan pembuatan nomor virtual account dilakukan oleh
Non-PJP Pengguna Layanan kepada Penyedia Layanan melalui API.
 Inquiry payment
Pada skenario ini, nomor virtual account dikelola oleh Non-PJP
Pengguna Layanan. Setiap kali terdapat pembayaran maka Penyedia
Layanan akan melakukan inquiry ke Non-PJP Pengguna Layanan
untuk mendapatkan detail dari pembayaran/tagihan. Penyedia
Layanan memberikan notifikasi secara realtime kepada Non-PJP
Pengguna Layanan melalui API setiap kali terjadi pembayaran.
 Fund Transfer to VA
Pada skenario ini, Pengguna Layanan bekerja sama dengan Penyedia
Layanan untuk menjadi antarmuka proses pembayaran virtual account
dari Pengguna Layanan lainnya.
Nomor virtual account dapat dihasilkan untuk menerima satu pembayaran
maupun digunakan secara berulang. Pembayaran menggunakan virtual
account dimungkinkan juga untuk dilakukan antar PJP melalui
infrastruktur pembayaran (GPN atau BI-FAST).
Sebelum melakukan pemindahbukuan Intrabank, dilakukan validasi nomor

dan nama rekening tujuan menggunakan API Internal Account Inquiry.
Sebelum melakukan pemindahbukuan Interbank, RTGS, atau SKNBI,
dilakukan validasi nomor dan nama rekening tujuan menggunakan API
External Account Inquiry.
Apabila terjadi gangguan pada sistem, time out, atau hal-hal lain yang dapat
menyebabkan perbedaan interpretasi atas penyelesaian suatu transaksi,
maka pihak yang menginisiasi transaksi ( Non-PJP Pengguna Layanan, PJP
10
PIAS, atau PJP AIS Lembaga Selain Bank) dapat mengakses API Transaction
Status Inquiry yang disediakan oleh PJP AIS Bank.
Skema 2: Non-PJP Pengguna Layanan – PJP AIS Lembaga Selain Bank

Dalam skema ini, Non-PJP Pengguna Layanan dapat melakukan
pemindahbukuan atas dana pada rekeningnya kepada rekening Konsumen
melalui layanan transfer kredit pada PJP AIS Lembaga Selain Bank
menggunakan API bulk cashin. PJP AIS Lembaga Selain Bank
menginformasikan status transaksi bulk cashin ke Non-PJP Pengguna
Layanan menggunakan API notify bulk.
Skema 3: Konsumen - Non-PJP Pengguna Layanan/PJP PIAS – PJP AIS

Lembaga Selain Bank
Dalam skema ini, konsumen dapat melakukan top up saldo uang elektronik,
transfer to OTC, dan transfer to bank, pada PJP AIS Lembaga Selain Bank
melalui Non-PJP Pengguna Layanan menggunakan API Customer Top Up,
Transfer to OTC, dan Transfer to Bank.
 Top up saldo uang elektronik
API customer top up digunakan untuk pemindabukuan dana dari
rekening Non-PJP Pengguna Layanan ke rekening konsumen. Sebelum
pemindahbukuan, Non-PJP Pengguna Layanan melakukan validasi
rekening konsumen menggunakan API Account Inquiry.
 Transfer to OTC
API Transfer to OTC digunakan untuk pemindabukuan dana dari
rekening Konsumen ke rekening Non-PJP Pengguna Layanan. Sebelum
pemindahbukuan, Konsumen melakukan inisiasi transaksi OTC untuk
mendapatkan token dari PJP AIS Lembaga Selain Bank pengelola
rekeningnya.
 Transfer to bank
API Transfer to bank digunakan untuk pemindahbukuan dari rekening
konsumen pada PJP AIS Lembaga Selain Bank ke rekening konsumen
pada PJP AIS Bank, yang diinisiasi oleh konsumen melalui Non-PJP
Pengguna Layanan. Sebelum pemindahbukuan, Non-PJP Pengguna
10
Layanan melakukan validasi akun konsumen menggunakan API inquiry
transaction.
maka pihak yang menginisiasi transaksi (Non-PJP Pengguna Layanan, atau
PJP PIAS) dapat mengakses API transaction status inquiry yang disediakan
oleh PJP AIS Lembaga Selain Bank.
Skema 4: QR MPM (Konsumen – Non-PJP Pengguna Layanan – PJP PIAS

– PIP (Switching) – PJP AIS)
Skema ini merupakan transaksi sesuai standar MPM. Konsumen dapat
melakukan pembayaran kepada Non-PJP Pengguna Layanan menggunakan
dana yang berasal dari rekening konsumen pada PJP AIS Bank atau PJP AIS
Lembaga Selain Bank, menggunakan API MPM Payment.
Transaksi pembayaran ini dilakukan menggunakan QR yang dihasilkan dari
API Generate QR dengan alternatif sebagai berikut:
 Pada mode redirection, konsumen akan diarahkan ke halaman web
checkout Non-PJP Pengguna Layanan. PJP PIAS meminta PJP AIS Bank
atau PJP AIS Lembaga Selain Bank untuk melakukan decode QR
menggunakan API Decode QR. PJP PIAS melakukan request OTT untuk
mendapatkan otorisasi menggunakan API Apply OTT, selanjutnya OTT
disertakan pada redirect URL.
 Pada mode statis, konsumen diarahkan pada halaman web PJP AIS untuk
memasukkan nominal.
Apabila terjadi kesalahan dalam transaksi, konsumen dapat melakukan

pembatalan menggunakan API Cancel Payment.
maka:
10
 Pihak yang menginisiasi transaksi mengkonfirmasi status transaksi
dengan mengakses API Query Payment yang disediakan oleh PJP AIS.
 Pihak yang menyelesaikan transaksi (PJP AIS) menyampaikan status
transaksi menggunakan API Payment Notify.
4.2. SPESIFIKASI API TRANSFER KREDIT BANK

4.2.1. API Account Inquiry
4.2.1.1. Internal Account Inquiry
Sequence Diagram
Sequence Diagram API Internal Account Inquiry
Informasi Umum
Service Code 15
Name API Internal Account Inquiry
Version 1.0
HTTP Method POST
Path .../{version}/account-inquiry-internal
Request Body
Data
Type
Transaction
String M 64 identifier on
ceNo 00000000001
service
10
Data
Type
consumer
system
Beneficiary
beneficiaryAcco 88880100015
String M 34 Account
untNo 7508
Number
{"deviceId":
"1234567923
Additional
information
"mobilephone
",}
Response Body
Data
Type
Response
code
Request has
String M 150
successfully
Transaction
identifier on
service
provider 2020102977
Must be 09
filled upon
successful
transaction
10
Data
Type
Transaction
partnerRefere
nceNo
consumer 01
system
Beneficiary
beneficiaryAcc Yories
String M 100 Account
ountName Yolanda
Name
Beneficiary
beneficiaryAcc 8888010001
String M 34 Account
ountNo 57508
Number
Beneficiary
beneficiaryAcc Rekening
String O 16 Account
ountStatus aktif
Status
Beneficiary
Account Type
beneficiaryAcc “D” for

String O 1 D
ountType Current
Account
“S” for Saving
Account
Currency
Type
{"deviceId":
information 37",
"channel":
11
Data
Type
"mobilephon
e",}
Contoh Request
POST …/1.0/account-inquiry-internal HTTP/1.2
X-TIMESTAMP: 2020-12-21T10:11:40+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"beneficiaryAccountNo ": "888801000157508",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-21T10:11:44+07:00
{
successfully",
"referenceNo": "2020102977770000000009",
"beneficiaryAccountName": "Yories Yolanda",
"beneficiaryAccountNo": "888801000157508",
11
"beneficiaryAccountStatus": "Rekening aktif",
"beneficiaryAccountType": "D",
"currency": "IDR",
"additionalInfo": {
"deviceId": "12345679237",
}
}
11
4.2.1.2. Eksternal Account Inquiry
Sequence Diagram
Sequence Diagram API External Account Inquiry
Informasi Umum
Service Code 16
Name API External Account Inquiry
Version 1.0
HTTP Method POST
Path .../{version}/account-inquiry-external
Request Body
Data
Type
beneficiaryAcc Beneficiary
String M 8 002
ountCode Bank Code
Beneficiary
String M 34 Account
ountNo 57508
Number
Transaction
partnerReferen
ceNo
consumer 01
system
11
Data
Type
{"deviceId":
"123456792
37",
Additional
additionalInfo Object O "channel":
information
"mobilephon
e",}
Response Body
Data
Type
Response
code
Request has
String M 150
successfully
Transaction
identifier on
service
provider
20201029777
70000000009
Must be
filled upon
successful
transaction
Transaction
String O 64 identifier on
nceNo 00000000001
service
11
Data
Type
consumer
system
Beneficiary
ountName Yolanda
Name
Beneficiary
String M 34 Account
ountNo 7508
Number
beneficiaryBa Beneficiary
String O 8 002
nkCode Bank Code
beneficiaryBa Beneficiary
String O 50 Bank BRI
nkName Bank Name
Currency
Type
{"deviceId":
"1234567923
Additional 7", "channel":
information "mobilephone
",}
Contoh Request
POST …/1.0/account-inquiry-external HTTP/1.2
X-TIMESTAMP: 2020-12-21T10:21:34+07:00
X-SIGNATURE:
61b19a5
11
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"beneficiaryAccountCode": "002",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-21T10:21:40+07:00
{
successfully",
"referenceNo": "2020102977770000000009",
"beneficiaryBankCode": "002",
"beneficiaryBankName": "Bank BRI",
"currency": "IDR",
"additionalInfo": {
"deviceId": "12345679237",
}
}
11
4.2.2. API Trigger Transfer
4.2.2.1. Intrabank Transfer
Sequence Diagram
Sequence Diagram API Trigger Intrabank Transfer
Informasi Umum
Service Code 17
Name API Trigger Intrabank Transfer
Version 1.0
HTTP Method POST
Path .../{version}/transfer-intrabank
Request Body
Data
Type
Transaction
identifier on
String M 64 service
nceNo 0000000001
consumer
system
{
Net amount
amount Decimal M 18, 3 of the
“value”:“10000.
transaction.
00”,
11
Data
Type
If it’s IDR
then value “currency”:”IDR
includes 2 ”
decimal }
digits.
e.g. IDR
10.000,- will
be placed
with
10000.00
Beneficiary 888801000003
beneficiaryAcc
String M 34 Account 301
ountNo
Number
Currency
Type
Reference
Number / No
customerRefer
String M 30 Referral / 10052019
ence
Transaction
ID
1. OUR
Fee is charged
to the sender
to whom
(default)
feeType String O 25 the fee will
2. BEN
be charged
Fee is charged
to the recipient
3. SHA|1000
11
Data
Type
Fee is shared
between sender
and recipient,
with sender is
charged Rp
1.000,00 and
the recipient
will be charged
the rest
Remark/tran
remark String O 50 saction remark test
description
Source
sourceAccoun 888801000157
String M 19 Account
tNo 508
Number
transaction
date : 12-02-2018
transactionDa dd-MM-yyyy (mandatory)
String M 25
te (Mandatory) 10:18:00
HH:mm:ss (optional)
(Optional)
{"deviceId":
Additional "12345679237"
information , "channel":
"mobilephone"}
11
Response Body
Data
Type
Response
code
Request has
String M 150
successfully
Transaction
identifier on
service
provider 20201029777
referenceNo String C 64
system. Must 70000000009
be filled upon
successful
transaction
Transaction
identifier on
String O 64 service
ceNo 00000000001
consumer
system
Net amount
of the {
transaction.
If it’s IDR then “value”:“10000
value includes .00”,
amount Decimal M 18, 3
2 decimal
digits. “currency”:”ID
e.g. IDR R”
10.000,- will }
be placed with
12
Data
Type
10000.00
beneficiaryAcco Beneficiary 88880100000

String M 34
untNo Account 3301
currency String O 3 Currency Type IDR
Reference
customerRefere
String M 30 Number / No 10052019
nce
Referral
sourceAccount Source 88880100015

String O 19
No Account 7508
transaction
date : 12-02-2018
transactionDat dd-MM-yyyy (mandatory)
String M 25
e (Mandatory) 10:18:00
HH:mm:ss (optional)
(Optional)
{"deviceId":
information ", "channel":
"mobilephone"}
Contoh Request
POST …/1.0/transfer-intrabank HTTP/1.2
X-TIMESTAMP: 2020-12-21T10:30:24+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
12
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"currency": "IDR",
"customerReference": "10052019",
"feeType": "BEN",
"remark": "remark test",
"sourceAccountNo": "888801000157508",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-21T10:30:34+07:00
{
successfully",
"referenceNo": "2020102977770000000009",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"currency": "IDR",
"customerReference": "Yories Yolanda",
“sourceAccount”: "Bank BRI",
"additionalInfo": {
"deviceId": "12345679237",
}
}
12
4.2.2.2. Interbank Transfer
Sequence Diagram
Sequence Diagram API Trigger Interbank Transfer
Informasi Umum
Service Code 18
Name API Trigger Interbank Transfer
Version 1.0
HTTP Method POST
Path .../{version}/transfer-interbank
Request Body
Data
Type
Transaction
partnerReferenc
eNo
consumer 0001
system
Net amount
{
of the
Deci
amount M 18, 3 transaction.
mal “value”:“10
If it’s IDR
000.00”,
then value
12
Data
Type
includes 2
decimal “currency”:”
digits. IDR”
e.g. IDR }
10.000,- will
be placed
with
10000.00
Beneficiary
beneficiaryAcco Yories
untName Yolanda
Name
888801000
beneficiaryAcco Beneficiary
String M 34 003301
untNo Account
beneficiaryAddr Beneficiary
String O 100 Palembang
ess Address
beneficiaryBan Beneficiary
String M 8 002
kCode Bank Code
kName Bank Name
yories.yolan
beneficiaryEmai Beneficiary
String O 50 da@work.br
l Email
i.co.id
Currency
Type
Reference
customerRefere Number /
String M 30 10052019
nce No Referral
/
12
Data
Type
Transaction
ID
Source
sourceAccount 888801000
String M 19 Account
No 157508
Number
transaction
12-02-2018
date :
(mandatory
dd-MM-yyyy
transactionDate String M 25 )
(Mandatory)
10:18:00
HH:mm:ss
(optional)
(Optional)
1. OUR
Fee is
charged to
the sender
(default)
2. BEN
Fee is
charged to
to whom the
feeType String O 25 the fee will recipient
be charged 3. SHA|
1000 Fee
is shared
between
sender and
recipient,
with sender
is charged
12
Data
Type
Rp
1.000,00
and the
recipient
will be
charged the
rest
{"deviceId":
"12345679
Objec Additional 237",
additionalInfo O
t information "channel":
"mobilepho
ne"}
Response Body
Data
Type
Response
code
Request
has been
ge description
successfull
y
Transaction
identifier on
202010297
service
provider
0009
system.
Must be
12
Data
Type
filled upon
successful
transaction
Transaction
partnerReferen
ceNo
consumer 0001
system
Net amount
of the
transaction.
{
If it’s IDR
then value
“value”:“10
includes 2
000.00”,
amount Decimal M 18, 3 decimal
digits.
“currency”:”
e.g. IDR
IDR”
10.000,- will
}
be placed
with
10000.00
Beneficiary
beneficiaryAcco 888801000
String M 19 Account
untNo 003301
Number
String O 8 002
kCode Bank Code
Source
String O 19 Account
No 157508
Number
12
Data
Type
Number for
tracking to
traceNo String O 16 10052019
destination
bank
{"deviceId":
"12345679
Additional 237",
"mobilepho
ne"}
Contoh Request
POST …/1.0/transfer-interbank HTTP/1.2
X-TIMESTAMP: 2020-12-21T13:59:21+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"beneficiaryAddress": "Palembang",
12
"beneficiaryEmail": "yories.yolanda@work.bri.co.id",
"currency": "IDR",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-21T13:59:40+07:00
{
successfully",
"referenceNo": "2020102977770000000009",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"sourceAccountNo": "Bank BRI",
"traceNo": "10052019",
"additionalInfo": {
"deviceId": "12345679237",
}
}
12
4.2.2.3. Request for Payment
Sequence Diagram
Sequence Diagram API Request for Payment
Informasi Umum
Service Code 19
Name API Request for Payment
Version 1.0
HTTP Method POST
Path .../{version}/transfer-request-for-payment
Request Body
Data
Type
Transaction
partnerRefere
nceNo
consumer 000001
system
Beneficiary
bankCode String M 3 014
bank code
13
Data
Type
based on
Bank
Indonesia
Code
beneficiaryAcc
ountNo
Number
Beneficiary
ountName Yolanda
Name
Remark/tra
remark
remark String O 50 nsaction
test
description
DateTime
with
RFP
Follows timezone,
expiredDateti Dateti expiration
M ISO- which
me me date and
8601 follows the
time
ISO-8601
standard
Source
sourceAccoun 88880100
String M 19 Account
tNo 0157508
Number
Source
sourceAccoun Yories
tName Yolanda
Name
Currency
Type
13
Data
Type
Net amount
of the
transaction.
{
If it’s IDR
then value
“value”:“10
includes 2
Decim 000.00”,
al
digits.
“currency”:
e.g. IDR
”IDR”
10.000,- will
}
be placed
with
10000.00
1. OUR
Fee is
charged to
the sender
(default)
2. BEN
Fee is
to whom charged to
feeType String O 25 the fee will the
be charged recipient
3. SHA|
1000 Fee
is shared
between
sender and
recipient,
13
Data
Type
with
sender is
charged
Rp
1.000,00
and the
recipient
will be
charged
the rest
{"deviceId":
"12345679
Additional 237",
"mobilepho
ne"}
Response Body
Data
Type
Response
code
Request
has been
responseMessag Response
e description
successfull
y
Transaction 202010297
referenceNo String C 64 identifier on 777000000
service 0009
13
Data
Type
provider
system.
Must be
filled upon
successful
transaction
Transaction
partnerReferenc
eNo
consumer 0001
system
{"deviceId":
"12345679
Additional 237",
additionalInfo Object O …
"mobilepho
ne"}
Contoh Request
POST …/1.0/transfer-request-for-payment HTTP/1.2
X-TIMESTAMP: 2020-12-22T08:01:16+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
13
{
"bankCode": "014",
"sourceAccountName": "Yories Yolanda",
"currency": "IDR",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-22T07:45:11+07:00
{
successfully",
"referenceNo": "2020102977770000000009",
"additionalInfo": {
"deviceId": "12345679237",
}
}
13
4.2.2.4. Interbank Transfer - Bulk
a. Trigger Interbank Bulk Transfer
Sequence Diagram
Sequence Diagram API Trigger Interbank Bulk Transfer
Informasi Umum
Service Code 20
Name API Trigger Interbank Bulk Transfer
Version 1.0
HTTP Method POST
Path .../{version}/transfer-interbank-bulk
Request Body
Data
Type
Bulk
transaction
20201029
identifier on
partnerBulkId String M 64 00000000
service
000001
consumer
(bulk
13
Data
Type
transaction
sender)
system
Currency
Type
Reference
Number /
customerReferenc No Referral
String M 30 10052019
e /
Transaction
ID
1. OUR
Fee is
charged
to the
sender
(default)
2. BEN
Fee is
to whom charged
feeType String O 25 the fee will to the
be charged recipient
3. SHA|
100 0
Fee is
shared
between
sender
and
13
Data
Type
recipient,
with
sender is
charged
Rp
1.000,00
and the
recipient
will be
charged
the rest
Remark/tra
remark
test
description
sourceAccountNo String M 19
Bank Code 0157508
transaction 12-02-
date : 2018
dd-MM-yyyy (mandator
transactionDate String M 25
(Mandatory) y)
HH:mm:ss 10:18:00
(Optional) (optional)
Object
bulkObject
Array
Individual
transaction 20201029
partnerReference
String M 64 identifier on 00000000
No
service 000990
consumer
13
Data
Type
(bulk
transaction
sender)
system
Bank code
based on
bankCode String M 3 Bank 014
Indonesia
Code
beneficiaryAccou
ntNo
Number
Beneficiary
beneficiaryAccou Yories
ntName Yolanda
Name
Net amount
of the
transaction.
{
If it’s IDR
then value
“value”:“1
includes 2
Decim 0000.00”,
al
digits.
“currency
e.g. IDR
”:”IDR”
10.000,- will
}
be placed
with
10000.00
13
Data
Type
{"deviceId"
:
"1234567
Objec Additional
additionalInfo O 9237",
t information
"channel":
"mobileph
one"}
Response Body
Data
Type
Response
code
Request
has been
responseMessag Response
e description
successfu
lly
Transaction
identifier on
service
provider
(bulk
20201029
transaction
bulkID String C 64 77770000
processing)
000009
system.
Must be
filled upon
successful
transaction
14
Data
Type
Transaction
identifier on
service
20201029
consumer
partnerBulkId String O 64 00000000
(bulk
000001
transaction
sender)
system
{"deviceId"
:
"1234567
Additional
information
"channel":
"mobileph
one"}
Contoh Request
POST …/1.0/transfer-interbank-bulk HTTP/1.2
X-TIMESTAMP: 2020-12-22T07:41:11+07:00
X-SIGNATURE:
85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19
a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"partnerBulkId": "2020102900000000000001",
14
"currency": "IDR",
"feeType": "BEN",
"bulkObject": {
"bankCode": "014",
"amount": {
"value": "10000.00",
"currency": "IDR"
}
},
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-22T07:45:11+07:00
X-SIGNATURE:
85be8171923ac135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19
a5
{
successfully",
"bulkID": "2020102977770000000009",
"partnerBulkId ": "2020102900000000000001",
"additionalInfo": {
"deviceId": "12345679237",
}
}
14
b. Notify
Sequence Diagram
Sequence Diagram API Trigger Interbank Bulk Transfer - Notify
Informasi Umum
Service Code 21
Name API Trigger Interbank Bulk Transfer - Notify
Version 1.0
HTTP Method POST
Path .../{version}/transfer-interbank-bulk/notify
Request Body
Data
Type
Transaction
identifier on
20201029
bulk
bulkId String M 64 77770000
transaction
000009
processing
system
14
Data
Type
Transaction
identifier on
20201029
bulk
transaction
000001
sender
system
Object
bulkObject
Array
Individual
transaction
identifier on
bulk
transaction 20201029
originalReferenc
String C 64 processing 77770000
eNo
system. 000009
Must be
filled upon
successful
transaction
Individual
transaction
originalPartnerR
String O 64 bulk 00000000
eferenceNo
transaction 000990
sender
system
Response
Code
String M 150 Sukses
ge description
14
Data
Type
Net amount
of the
transaction.
{
If it’s IDR
then value
“value”:“10
includes 2
000.00”,
digits.
“currency”:
e.g. IDR
”IDR”
10.000,- will
}
be placed
with
10000.00

String M 19
untNo Account 0003301
String O 8 002
kCode Bank Code
Source
String M 19 Account
No 0157508
Number
Number for
tracking to
destination
bank
{"deviceId":
information 237",
"channel":
14
Data
Type
"mobilepho
ne"}
Response Body
Data Manda Descriptio
Parameter Length Example
Type tory n
Response
code
Request has
String M 150
successfully
Transaction
identifier on
2020102977
bulk
transaction
09
processing
system
Transaction
identifier on
2020102900
bulk
transaction
01
sender
system
{"deviceId":
"123456792
Additional 37",
"mobilephon
e"}
14
Contoh Request
POST …/1.0/transfer-interbank-bulk/notify HTTP/1.2
X-TIMESTAMP: 2020-12-22T07:53:16+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"bulkId": "2020102977770000000009",
"partnerBulkId": "2020102900000000000001",
"bulkObject": {
"originalReferenceNo":
"2020102977770000000009",
"originalPartnerReferenceNo":
"2020102900000000000001",
successfully",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"traceNo": "10052019",
},
"additionalInfo": {
"deviceId": "12345679237",
}
}
14
Contoh Response
X-TIMESTAMP: 2020-12-22T07:53:21+07:00
{
successfully",
"bulkId": "2020102977770000000009",
"partnerBulkId": "2020102900000000000001",
"additionalInfo": {
"deviceId": "12345679237",
}
}
14
4.2.2.5. RTGS Transfer
Sequence Diagram
Sequence Diagram API Transfer RTGS
Informasi Umum
Service Code 22
Name API Transfer RTGS
Version 1.0
HTTP Method POST
Path .../{version}/transfer-rtgs
Request Body
Data
Type
Transaction
partnerReferen
ceNo
consumer 000001
system
{
Net amount
amount Decimal M 18, 3 of the
“value”:“1
transaction.
0000.00”,
14
Data
Type
If it’s IDR
then value “currency
includes 2 ”:”IDR”
decimal }
digits.
e.g. IDR
10.000,- will
be placed
with
10000.00
Beneficiary
ountName Yolanda
Name
88880100
beneficiaryAcc Beneficiary
String M 34 0003301
ountNo Account
beneficiaryAdd Beneficiary Palemban

String O 100
ress Address g
String M 8 002
kCode Bank Code
kName Bank Name
Beneficiary
Customer
beneficiaryCus
Residence
tomerResidenc String M 1 1
1.Indonesia
e
2. Non
Indonesia
15
Data
Type
Beneficiary
Customer
Type
1.
beneficiaryCus Individual
String M 1 1
tomerType 2.
corporation
3.
Governmen
t
yories.yol
beneficiaryEm Beneficiary
String O 50 anda@wor
ail Email
k.bri.co.id
Currency
Type
Reference
Number /
customerRefer No Referral
String M 30 10052019
ence /
Transaction
ID
1. OUR
Fee is
to whom charged
feeType String O 25 the fee will to the
be charged sender
(default)
2. BEN
15
Data
Type
Fee is
charged
to the
recipient
3.
SHA|100
0
Fee is
shared
between
sender
and
recipient,
with
sender is
charged
Rp
1.000,00
and the
recipient
will be
charged
the rest
Sender City
kodepos String O 10 12550
(kodepos)
Beneficiary
08090102
receiverPhone String O 20 Customer
0304
Phone
15
Data
Type
Remark/tra
remark
test
description
Beneficiary
Customer
senderCustom Residence
String O 1 1
erResidence 1.Indonesia
2. Non
Indonesia
Beneficiary
Customer
Type
1.
senderCustom Individual
String O 1 1
erType 2.
corporation
3.
Governmen
t
Source
08090102
senderPhone String O 20 Customer
0304
Phone
sourceAccount Beneficiary 88880100

String M 19
No Bank Code 0157508
transaction 12-02-
transactionDat date : 2018
String M 25
e dd-MM-yyyy (mandator
(Mandatory) y)
15
Data
Type
HH:mm:ss 10:18:00
{"deviceId"
:
"1234567
Additional
information
"channel":
"mobileph
one"}
Response Body
Data
Type
Response
code
Request
has been
responseMess Response
age description
successfull
y
Transaction
identifier on
service
20201029
provider
system. Must
000009
be filled upon
successful
transaction
15
Data
Type
Transaction
partnerReferen
ceNo
consumer 000001
system
Net amount
of the
transaction.
{
If it’s IDR
then value
“value”:“10
includes 2
Decim 000.00”,
al
digits.
“currency”:
e.g. IDR
”IDR”
10.000,- will
}
be placed
with
10000.00
Beneficiary
untName Yolanda
Name
88880100
String M 34 0003301
untNo Account
Beneficiary
Account Type
beneficiaryAcco
String O 1 D
untType “D” for
Current
Account
15
Data
Type
“S” for
Saving
Account
String O 8 002
kCode Bank Code
Currency
Type
Reference
Number / No
customerRefere
String M 30 Referral / 10052019
nce
Transaction
ID
sourceAccount Beneficiary 88880100

String M 19
No Bank Code 0157508
Number for
tracking to
destination
bank
transaction 12-02-
date : 2018
(Mandatory) y)
HH:mm:ss 10:18:00
0 - Success
01 - Initiated
transactionStat
String M 2 02 - Paying 00
us
03 - Pending
04 - Refunded
15
Data
Type
05 - Canceled
06 - Failed
07 - Not found
Description
transactionStat
String O 50 status success
usDesc
transaction
{"deviceId":
"12345679
Additional 237",
"mobilepho
ne"}
Contoh Request
POST …/1.0/transfer-rtgsHTTP/1.2
X-TIMESTAMP: 2020-12-21T14:06:21+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X- EXTERNAL-ID: 41807553358950093184162180797837
X- IP-ADDRESS: 172.24.281.24
X- DEVICE-ID: 09864ADCASA
X- LATITUDE: -6.1617169
X- LONGITUDE: 106.6643946
CHANNEL-ID: 95221
{
"amount": {
"value": "10000.00",
"currency": "IDR"
},
15
"beneficiaryCustomerResidence": "1",
"beneficiaryCustomerType": "1",
"currency": "IDR",
"feeType": "BEN",
"kodepos": "12250",
"receiverPhone": "080901020300",
"senderCustomerResidence": "1",
"senderCustomerType": "1",
"senderPhone": "080901020304",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-21T14:06:31+07:00
X-SIGNATURE:
85be8171923ac135157c7e89f52499bf0c25ad6eeebe04a986e8c8625
61b19a5
{
successfully",
"referenceNo": "2020102977770000000009",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"beneficiaryAccountType": "1",
"currency": "IDR",
"traceNo": "10052019",
15
"transactionStatus": "00",
"transactionStatusDesc": "success",
"additionalInfo": {
"deviceId": "12345679237",
}
}
15
4.2.2.6. SKNBI Transfer
Sequence Diagram
Sequence Diagram API Transfer SKNBI
Informasi Umum
Service Code 23
Name API Transfer SKNBI
Version 1.0
HTTP Method POST
Path .../{version}/transfer-skn
Request Body
Data
Type
Transaction
partnerReferenc
eNo
consumer 000001
system
Net amount
{
of the
amount Decimal M 18, 3 transaction.
“value”:“1
If it’s IDR
0000.00”,
then value
16
Data
Type
includes 2
decimal “currency
digits. ”:”IDR”
e.g. IDR }
10.000,- will
be placed
with
10000.00
Beneficiary
untName Yolanda
Name
88880100
String M 34 0003301
untNo Account
beneficiaryAddre Beneficiary Palemban

String O 100
ss Address g
beneficiaryBank Beneficiary
String M 8 002
Code Bank Code
Name Bank Name
Beneficiary
Customer
beneficiaryCusto Residence
String M 1 1
merResidence 1.Indonesia
2. Non
Indonesia
Beneficiary
beneficiaryCusto
String M 1 Customer 1
merType
Type
16
Data
Type
1.
Individual
2.
corporation
3.
Governmen
t
yories.yol
Beneficiary
beneficiaryEmail String O 50 anda@wor
Email
k.bri.co.id
Currency
Type
Reference
Number /
customerRefere No Referral
String M 30 10052019
nce /
Transaction
ID
1. OUR
Fee is
charged
to the
to whom sender
feeType String O 25 the fee will (default)
be charged 2. BEN
Fee is
charged
to the
recipient
16
Data
Type
3. SHA|
100 0
Fee is
shared
between
sender
and
recipient,
with
sender is
charged
Rp
1.000,00
and the
recipient
will be
charged
the rest
Sender City
kodepos String O 10 12550
(kodepos)
Beneficiary
08090102
receiverPhone String O 20 Customer
0304
Phone
Remark/tra
remark
test
description
senderCustomer Beneficiary
String O 1 1
Residence Customer
16
Data
Type
Residence
1.Indonesia
2. Non
Indonesia
Beneficiary
Customer
Type
1.
senderCustomer Individual
String O 1 1
Type 2.
corporation
3.
Governmen
t
Source
08090102
senderPhone String O 20 Customer
0304
Phone
sourceAccountN Beneficiary 88880100

String M 19
o Bank Code 0157508
transaction 12-02-
date : 2018
(Mandatory) y)
HH:mm:ss 10:18:00
{"deviceId"
Additional :
information "1234567
9237",
16
Data
Type
"channel":
"mobileph
one"}
Response Body
Data
Type
Response
code
Request has
responseMessag Response been
String M 150
e description processed
successfully
Transaction
identifier on
service
provider 2020102977
Must be 09
filled upon
successful
transaction
Transaction
partnerReferenc
eNo
consumer 01
system
Net amount
Decima
amount M 18, 3 of the {
l
transaction.
16
Data
Type
If it’s IDR
then value “value”:“100
includes 2 00.00”,
decimal
digits. “currency”:”I
e.g. IDR DR”
10.000,- will }
be placed
with
10000.00
Beneficiary
beneficiaryAccou Yories
ntName Yolanda
Name
8888010000
beneficiaryAccou Beneficiary
String M 34 03301
ntNo Account
Beneficiary
Account
Type
beneficiaryAccou “D” for

String O 1 D
ntType Current
Account
“S” for
Saving
Account
String O 8 002
Code Bank Code
16
Data
Type
Currency
Type
Reference
Number /
customerReferen No Referral
String M 30 10052019
ce /
Transaction
ID
sourceAccountNo String M 19
Bank Code 57508
Number for
tracking to
destination
bank
transaction
date : 12-02-2018
dd-MM-yyyy (mandatory)
(Mandatory) 10:18:00
HH:mm:ss (optional)
(Optional)
0 - Success
01 - Initiated
02 - Paying
transactionStat 03 - Pending
String M 2 00
us 04 -
Refunded
05 - Canceled
06 - Failed
16
Data
Type
07 - Not
found
Description
transactionStat
usDesc
transaction
{"deviceId":
"123456792
Additional 37",
"mobilephon
e"}
Contoh Request
POST …/1.0/transfer-skn HTTP/1.2
X-TIMESTAMP: 2020-12-21T14:36:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"amount": {
"value": "10000.00",
"currency": "IDR"
},
16
"beneficiaryCustomerResidence": "1",
"beneficiaryCustomerType": "1",
"currency": "IDR",
"feeType": "BEN",
"kodepos": "12250",
"receiverPhone": "080901020300",
"senderCustomerResidence": "1",
"senderCustomerType": "1",
"senderPhone": "080901020304",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-21T14:36:19+07:00
{
successfully",
"referenceNo": "2020102977770000000009",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"beneficiaryAccountType": "1",
"currency": "IDR",
"traceNo": "10052019",
"additionalInfo": {
16
"deviceId": "12345679237",
}
}
17
4.2.2.7 Virtual Account
Sequence Diagram
Sequence Diagram Inquiry Payment – Virtual Account
17
Sequence Diagram Create Virtual Account
17
Fund Transfer to Virtual Account
a. Inquiry
Informasi Umum
Service Code 24
Name API Virtual Account - Inquiry
Version 1.0
HTTP Method POST
Path .../{version}/transfer-va/inquiry
Request Body
Data Mandato Lengt
Type ry h
Derivative of
X-
PARTNER-
ID, similar
partnerServic Strin M
8 to company 00088899
eId g
code,
8 digit left
padding 0.
partnerServi
17
Data Mandato Lengt
Type ry h
ceId +
customerNo
or
virtualAccou
ntNo
Unique
number
(up to 20
digits).
Strin M partnerServi 1234567890
customerNo 20
g ceId + 1234567890
customerNo
or
virtualAccou
ntNo
partnerServi
ceId (8 digit
left padding
0) +
customerNo
(up to 20
0008889912
virtualAccoun M digits).
Strin 28 3456789012
tNo partnerServi
g 34567890
ceId +
customerNo
or
virtualAccou
ntNo
17
Data Mandato Lengt
Type ry h
O PJP internal
system
datetime
with
20201231T2
trxDateInit Date 25 timezone,
35959Z
which
follows the
ISO-8601
standard
O Channel
Num code based
channelCode 4 6011
ber on ISO
18245
O Language
Strin code based
language 2 ID
g on ISO 639-
1
O Nominal
inputted by
Deci
amount 18,2 Customer 50000.00
mal
with 2
decimal
O Currency of
Strin amount
currency 3 IDR
g based on
ISO 4217
O Source
abcdefghijkl
hashedSourc Strin account
32 mnopqrstuv
eAccountNo g number in
wxyz123456
hash
17
Data Mandato Lengt
Type ry h
O Source
sourceBankC Strin account
3 008
ode g bank code
based on
O Key for 3rd
party to abcdefghijkl
Strin
passApp 64 access API mnopqrstuv
g
like client wxyz
secret
O Unique
identifier for abcdef-
inquiryReque Strin
128 this Inquiry. 123456-
stId g
Generated abcdef
by PJP.
{"deviceId":
Obje Information 37",
additionalInfo O
ct for custom "channel":
use "mobilephon
e"}
Response Body
Data Mandato Lengt
Type ry h
Strin Response
g Code
responseMess Strin Response
M 150 Success
age g Description
virtualAccoun Obje M
tData ct
17
Data Mandato Lengt
Type ry h
Strin O Status of
inquiryStatus 2 00
g inquiry
O Reason for
inquiryReaso Obje Inquiry
n ct Status multi
language
O Reason for
Strin Inquiry
>>english 64 Success
g Status in
English
O Reason for
Strin Inquiry
>>indonesia 64 Sukses
g Status in
Bahasa
Derivative of
X-
PARTNER-
ID , similar
to company
code,
partnerServic Strin M 8 digit left
8 00088899
eId g padding 0.
partnerServi
ceId +
customerNo
or
virtualAccou
ntNo
Strin M Unique 1234567890
customerNo 20
g number 1234567890
17
Data Mandato Lengt
Type ry h
(up to 20
digits).
partnerServi
ceId +
customerNo
or
virtualAccou
ntNo
partnerServi
ceId (8 digit
left padding
0) +
customerNo
(up to 20 0008889912
virtualAccoun M
Strin 28 digits). 3456789012
tNo
g partnerServi 34567890
ceId +
customerNo
or
virtualAccou
ntNo
virtualAccoun Strin M Customer
255 Jokul Doe
tName g name
virtualAccoun Strin O Customer john@email.
255
tEmail g email com
O Customer’s
virtualAccoun Strin phone 6281828384
30
tPhone g number 858
Format:
17
Data Mandato Lengt
Type ry h
62xxxxxxxxx
xxxx
From abcdef-
inquiryReque Strin
O 128 Inquiry 123456-
stId g
Request abcdef
Currency of
Strin amount
currency O 3 IDR
g based on
ISO 4217
M Total
Deci Amount
totalAmount 18.2 88000.00
mal with 2
decimal
O Sub
Company
Strin
subCompany 5 code 12345
g
generated by
Partner
Array O
Array with
of
billDetails maximum
Obje
24 Objects
cts
O Bill code for
Strin
billCode 2 Customer 01
g
choose
Strin O Bill number 1234567890
billNo 18
g from Partner 12345678
Strin O Bill A for
billName 20 Bill Name
g Jan
17
Data Mandato Lengt
Type ry h
billShortNam Strin O Bill Name to
10 Bill A
e g shown to
billDescriptio Obje O Bill
n ct Description
O Bill
Strin Maintenanc
>>>english 18 Description
g e
in English
O Bill
Strin Pemeliharaa
>>>indonesia 18 Description
g n
in Bahasa
C Partner’s
product
billSubComp Strin code.
5 00001
any g Mandatory if
subCompan
y sent
O Nominal
inputted by
Deci
billAmount 18,2 Customer 50000.00
mal
with 2
decimal
billAmountLa Strin O Label for Total
?
bel g billAmount Tagihan
O Value that
billAmountVa Strin will be
? Rp. 50.000,-
lue g shown for
billAmount
O Additional
Obje unlimi
additionalInfo Information
ct ted
for custom
18
Data Mandato Lengt
Type ry h
use for each
bill
Array O
Array with
of
freeTexts maximum 9
Obje
Objects
cts
O Will be
Strin
>>>english 32 shown in Free text
g
Channel
O Will be
Strin Tulisan
>>>indonesia 32 shown in
g bebas
Channel
O 1. Closed
Payment (C)
2. Open
Payment (O)
3. Partial (I)
Type of 4. Minimum
virtualAccoun Strin
1 Virtual (M)
tTrxType g
Account 5. Open
Minimum
(N)
6. Open
Maximum
(X)
O Nominal
inputted by
Deci
feeAmount 18,2 Customer 5000.00
mal
with 2
decimal
18
Data Mandato Lengt
Type ry h
{"deviceId":
additionalInfo O
use "mobilephon
e"}
Contoh Request
POST .../1.0/transfer-va/inquiry HTTP/1.2
X-TIMESTAMP: 2020-12-21T14:56:11+07:00
X-SIGNATURE:
61b19a5
X-ORIGIN: www.hostname.com
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
“partnerServiceId”: “00088899”,
“customerNo”: “12345678901234567890”,
“virtualAccountNo”: “0008889912345678901234567890”,
“txnDateInit”: “20201231T235959Z”,
“channelCode”: 6011,
“language”: “ID”,
“amount”: “50000.00”,
“currency”: “IDR”,
“hashedSourceAccountNo”: “
abcdefghijklmnopqrstuvwxyz123456”,
“sourceBankCode”: “008”,
“passApp”: ”abcdefghijklmnopqrstuvwxyz”,
“inquiryRequestId”: “abcdef-123456-abcdef”,
“additionalInfo”: {
“deviceId”: “12345679237”,
18
“channel”: “mobilephone”
}
Contoh Response
X-TIMESTAMP: 2020-12-21T14:36:19+07:00
{
“responseCode”: 2000000,
“responseMessage”: “Success”,
“virtualAccountData”: {
“inquiryStatus”: “00”,
“inquiryReason”: {
“english”: “Success”,
“indonesia”: “Sukses”,
},
“customerNo”: “12345678901234567890”,
“virtualAccountNo”:
“0008889912345678901234567890”,
“virtualAccountName”: “Jokul Doe”,
“virtualAccountEmail”: “john@email.com”,
“virtualAccountPhone”: “6281828384858”,
“totalAmount”: “88000.00”,
“billDetails”: [
{
“billCode”: “01”,
“billNo”: “123456789012345678”,
“billName”: “Bill A for Jan”,
“billShortName”: “Bill A”,
“billDescription”: {
“english”: “Maintenance”,
“indonesia”: “Pemeliharaan”
},
“billSubCompany”: “00001”,
“billAmount”: “50000.00”,
“billAmountLabel”: “Total Tagihan”,
“billAmountValue”: “Rp. 50.000,-”,
“additionalInfo”: {},
},
],
“freeTexts”: [
“english”: “Free text”,
“indonesia”: “Tulisan bebas”,
],
“virtualAccountTrxType”: “1”,
18
“feeAmount”: “5000.00”,
“deviceId”: “12345679237”,
}
}
}
b. Payment
Informasi Umum
Service Code 25
Name API Virtual Account - Payment
Version 1.0
HTTP Method POST
Path .../{version}/transfer-va/payment
Request Body
Data Mandato Lengt
Type ry h
Derivative of
X-
PARTNER-
ID , similar
to company
code,
partnerServic Strin M 8 digit left
8 00088899
eId g padding 0.
partnerServi
ceId +
customerNo
or
virtualAccou
ntNo
Strin M Unique 1234567890
customerNo 20
g number 1234567890
18
Data Mandato Lengt
Type ry h
(up to 20
digits) .
partnerServi
ceId +
customerNo
or
virtualAccou
ntNo
partnerServi
ceId (8 digit
left padding
0) +
customerNo
(up to 20
0008889912
virtualAccoun M digits).
Strin 28 3456789012
tNo partnerServi
g 34567890
ceId +
customerNo
or
virtualAccou
ntNo

255 Jokul Doe
tName g name
virtualAccoun Strin O Customer jokul@email.
255
tEmail g email com
O Customer’s
virtualAccoun Strin phone 6281828384
30
tPhone g number 858
Format:
18
Data Mandato Lengt
Type ry h
62xxxxxxxxx
xxxx
Unique
identifier
generated by
Partner
Strin Mandatory if abcdefgh123
trxId C 64
g Payment 4
comes from
the
Create VA
Request
M Unique
identifier
generated by
PJP.
If Payment
comes from abcdef-
paymentRequ Strin
128 the Inquiry 123456-
estId g
process, this abcdef
value must
be the same
with
inquiryRequ
estId.
O Channel
Num code based
channelCode 4 6011
ber on ISO
18245
18
Data Mandato Lengt
Type ry h
O Source
abcdefghijkl
hashedSourc Strin account
32 mnopqrstuv
eAccountNo g number in
wxyz123456
hash
O Source
sourceBankC Strin account
3 008
ode g bank code
based on
From
Strin
currency O 3 Inquiry IDR
g
Response
M Paid
Deci Amount
paidAmount 18.2 55000.00
mal with 2
decimal
O Cumulative
Amount
cumulativePa from
Deci
ymentAmoun 18.2 virtualAccou 1000000.00
mal
t ntNo paid
multiple
times
O If have 24
bills, and
Hexadecimal
paid bills
format of
Strin number 1,
paidBills 6 binary of
g 4, 6, and 8,
flag of paid
will be
bills
written in
binary
18
Data Mandato Lengt
Type ry h
1001010100
0000000000
0000 and
converted in
Hexa 95000
O Total
amount
Deci
totalAmount 18.2 from Inquiry 88000.00
mal
with 2
decimal
O PJP internal
system
datetime
with
20201231T2
trxDateTime Date 25 timezone,
35959Z
which
follows the
ISO-8601
standard
O Payment
Strin auth code 1234567890
referenceNo 15
g generated by 12345
PJP
O Sequence
journal
Strin
journalNum 6 number in 123456
g
PJP Core
System
Strin O Type of 1 = Cash
paymentType 1
g payment 2 = Transfer
18
Data Mandato Lengt
Type ry h
O Y = retry
Status is
Strin notification
flagAdvise 1 this a retry
g N = new
notification
notification
O Sub
Company
Strin
subCompany 5 code 12345
g
generated by
Partner
Array O
Array with
of
billDetails maximum
Obje
24 Objects
cts
O From
Strin
billCode 2 Inquiry 01
g
Response
O From
Strin 1234567890
billNo 18 Inquiry
g 12345678
Response
O From
Strin Bill A for
billName 20 Inquiry
g Jan
Response
O From
billShortNam Strin
10 Inquiry Bill A
e g
Response
O From
billDescriptio Obje
Inquiry
n ct
Response
18
Data Mandato Lengt
Type ry h
O From
Strin Maintenanc
>>>english 18 Inquiry
g e
Response
O From
Strin Pemeliharaa
>>>indonesia 18 Inquiry
g n
Response
O From
billSubComp Strin
5 Inquiry 00001
any g
Response
O From
Deci
billAmount 18,2 Inquiry 50000.00
mal
Response
O From
Obje unlimi
additionalInfo Inquiry
ct ted
Response
O Bill auth
billReference Num code 1234567890
15
No ber generated by 12345
PJP
Array O
Array with
of
freeTexts maximum 9
Obje
Objects
cts
O Will be
Strin
g
Channel
O Will be
Strin Tulisan
g bebas
Channel
19
Response Body
Data Mandato Lengt
Type ry h
Strin M Response
responseCode 7 2000000
g Code
M 150 Success
age g Description
virtualAccoun Obje M
tData ct
O Reason for
paymentFlag Obje Payment
Reason ct Status multi
language
O 200 Reason for
Strin Payment
>>indonesia Success
g Status in
English
O 200 Reason for
Strin
>>english inquiryStatu Sukses
g
s in Bahasa
Derivative of
X-
PARTNER-
ID , similar
to company
partnerServic Strin M code,
8 00088899
eId g 8 digit left
padding 0.
partnerServi
ceId +
customerNo
or
19
Data Mandato Lengt
Type ry h
virtualAccou
ntNo
Unique
number
(up to 20
digits).
Strin M partnerServi 1234567890
customerNo 20
g ceId + 1234567890
customerNo
or
virtualAccou
ntNo
partnerServi
ceId (8 digit
left padding
0) +
customerNo
(up to 20 0008889912
virtualAccoun M
Strin 28 digits). 3456789012
tNo
ceId +
customerNo
or
virtualAccou
ntNo
255 Jokul Doe
tName g name
virtualAccoun Strin O Customer jokul@email.
255
tEmail g email com
19
Data Mandato Lengt
Type ry h
O Customer’s
phone
virtualAccoun Strin number 6281828384
30
tPhone g Format: 858
62xxxxxxxxx
xxxx
From
Strin abcdefgh123
trxId O 32 Payment
g 4
Request
M From abcdef-
paymentRequ Strin
128 Payment 123456-
estId g
Request abcdef
From
Strin
currency O 3 Payment IDR
g
Request
M From
Deci
paidAmount 18.2 Payment 55000.00
mal
Request
O If have 24
bills, and
paid bills
number 1,
From 4, 6, and 8,
Strin
paidBills 6 Payment will be
g
Request written in
binary
1001010100
0000000000
0000 and
19
Data Mandato Lengt
Type ry h
converted in
Hexa 95000
O From
Deci
totalAmount 18.2 Payment 88000.00
mal
Request
O From
20201231T2
trxDateTime Date 25 Payment
35959Z
Request
O From
Strin 1234567890
referenceNo 15 Payment
g 12345
Request
O From
Strin
journalNum 6 Payment 123456
g
Request
O From
Strin 1 = Cash
paymentType 1 Payment
g 2 = Transfer
Request
O Y = retry
From
Strin notification
flagAdvise 1 Payment
g N = new
Request
notification
O Status for
paymentFlag Strin Payment
2 00
Status g Flag from
Partner
Array O
Array with
of
billDetails maximum
Obje
24 Objects
cts
19
Data Mandato Lengt
Type ry h
O From
Strin
billCode 2 Inquiry 01
g
Response
O From
Strin 1234567890
billNo 18 Inquiry
g 12345678
Response
O From
Strin Bill A for
billName 20 Inquiry
g Jan
Response
O From
billShortNam Strin
10 Inquiry Bill A
e g
Response
O From
billDescriptio Obje
Inquiry
n ct
Response
O From
Strin Maintenanc
>>>english 18 Inquiry
g e
Response
O From
Strin Pemeliharaa
>>>indonesia 18 Inquiry
g n
Response
O From
billSubComp Strin
5 Inquiry 00001
any g
Response
O From
Deci
billAmount 18,2 Inquiry 50000.00
mal
Response
O From
unlimi
additionalInfo Obje Inquiry
ted
ct Response
19
Data Mandato Lengt
Type ry h
O Payment
Strin
status 2 status for 00
g
specific Bill
O Reason for
Payment
Status for
reason Obje
specific Bill
ct
multi
language
O Reason for
Payment
Strin
>>>english 64 Status for Success
g
specific Bill
in English
O Reason for
Payment
Strin
>>>indonesia 64 Status for Sukses
g
specific Bill
in Bahasa
Array O
Array with
of
freeTexts maximum 9
Obje
Objects
cts
O Will be
Strin
g
Channel
O Will be
Strin Tulisan
g bebas
Channel
19
Contoh Request
POST .../1.0/transfer-va/payment HTTP/1.2
X-TIMESTAMP: 2020-12-21T14:56:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
“customerNo”: “12345678901234567890”,
“trxId”: “abcdefgh1234”,
“paymentRequestId”: “abcdef-123456-abcdef”,
“hashedSourceAccountNo”:
“abcdefghijklmnopqrstuvwxyz123456”,
“sourceBankCode”: “008”,
“paidAmount”: “55000.00”,
“cumulativePaymentAmount”: “100101010000000000000000”,
“trxDateTime”: “20201231T235959Z”,
“hashedSourceAccountNo”:
“abcdefghijklmnopqrstuvwxyz123456”,
“referenceNo”: “123456789012345”,
“journalNum”: “123456”,
“paymentType”: 1,
“flagAdvise”: Y,
{
“billNo”: “123456789012345678”,
19
“indonesia”: “Pemeliharaan”,
}
“billReferenceNo”: “123456789012345”
}
],
“freeTexts”: [
]
}
Contoh Response
X-TIMESTAMP: 2020-12-21T14:36:19+07:00
{
“paymentFlagReason”: {
},
“partnerServiceId”: 00088899,
“customerNo”: “12345678901234567890”,
“0008889912345678901234567890”,
“paidBills”: “100101010000000000000000”,
“trxDateTime”: “20201231T235959Z”,
“referenceNo”: “123456789012345”,
“paymentFlagStatus”: “00”
19
{
“billNo”: “123456789012345678”,
},
“status”: “00”,
“reason”: {
“indonesia”: “Sukses”
}
},
],
“freeTexts”: [
]
}
}
c. Inquiry Status
Informasi Umum
Service Code 26
Name API Virtual Account – Inquiry Status
Version 1.0
HTTP Method GET
Path .../{version}/transfer-va/status
Request Body
Data Mandato Lengt
Type ry h
Derivative of
X-
partnerServic Strin
M 8 PARTNER- 00088899
eId g
ID , similar
to company
19
Data Mandato Lengt
Type ry h
code.
partnerServi
ceId +
customerNo
or
virtualAccou
ntNo
Unique
number (up
to 20 digits).
partnerServi
Strin 1234567890
customerNo M 20 ceId +
g 1234567890
customerNo
or
virtualAccou
ntNo
partnerServi
ceId (8 digit
left padding
0) +
customerNo
(up to 20 0008889912
virtualAccoun Strin M
28 digits). 3456789012
tNo g
partnerServi 34567890
ceId +
customerNo
or
virtualAccou
ntNo
20
Data Mandato Lengt
Type ry h
Unique
identifier
from
Inquiry.
For use case
Bill stored in
abcdef-
inquiryReque Strin Partner.
M 128 123456-
stId g If not send,
abcdef
will return
array of
transaction
based on
virtualAccou
ntNo
Unique
identifier
from abcdef-
paymentRequ Strin O
128 Payment 123456-
estId g
was abcdef
generated by
PJP.
Response Body
Data Mandato Lengt
Type ry h
Strin Response
g Code
M 150 Success
age g Description
20
Data Mandato Lengt
Type ry h
virtualAccoun Obje
M
tData ct
Reason for
paymentFlag Payment
Obje O
Reason Status multi
ct
language
Reason for
Strin Payment
>>english O 200 Success
g Status in
English
Reason for
Strin
>>indonesia O 200 inquiryStatu Sukses
g
s in Bahasa
Derivative of
M
X-
partnerSe
PARTNER-
rviceId +
partnerServic Strin ID , similar
customer 8 00088899
eId g to company
No or
code,
virtualAcc
8 digit left
ountNo
padding 0
M
partnerSe
Unique
rviceId +
Strin number 1234567890
customerNo customer 20
g (up to 20 1234567890
No or
digits)
virtualAcc
ountNo
virtualAccoun partnerServi
M 28
tNo ceId (8 digit
20
Data Mandato Lengt
Type ry h
Strin partnerSe left padding 0008889912
g rviceId + 0) + 3456789012
customer customerNo 34567890
No or (up to 20
virtualAcc digits)
ountNo
Unique abcdef-
inquiryReque Strin
M 128 identifier 123456-
stId g
from Inquiry abcdef
Unique
identifier for
this
abcdef-
paymentRequ Strin Payment
C 128 123456-
estId g from PJP.
abcdef
Mandatory if
Payment
happened.
Currency of
Strin amount
currency O 3 IDR
g based on
ISO 4217
Paid
Deci Amount
paidAmount M 18.2 55000.00
mal with 2
decimal
Hexadecimal If have 24
format of bills, and
Strin
paidBills O 6 binary of paid bills
g
flag of paid number 1,
bills 4, 6, and 8,
20
Data Mandato Lengt
Type ry h
will be
written in
binary
1001010100
0000000000
0000 and
converted in
Hexa 95000
Total
amount
Deci
totalAmount O 18.2 from Inquiry 88000.00
mal
with 2
decimal
PJP internal
system
datetime
with
20201231T2
trxDateTime Date O 25 timezone,
35959Z
which
follows the
ISO-8601
standard
Payment
datetime
transactionD 20201230T2
Date O 25 when the
ate 35959Z
payment
happened
Strin Payment 1234567890
referenceNo O 15
g auth code 12345
20
Data Mandato Lengt
Type ry h
generated by
PJP
Strin Type of 1 = Cash
paymentType O 1
Y = retry
Status is
Strin notification
flagAdvise O 1 this a retry
g N = new
notification
notification
Status for
paymentFlag Strin
O 2 Payment 00
Status g
Flag
Array
Array with
of
billDetails O maximum
Obje
24 Objects
cts
Bill code for
Strin
billCode O 2 Customer 01
g
choose
Strin Bill number 1234567890
billNo O 18
Strin Bill A for
billName O 20 Bill Name
g Jan
billShortNam Strin Bill Name to
O 10 Bill A
e g shown to
billDescriptio Bill
Obje O
n Description
ct
Bill
Strin Maintenanc
>>>english O 18 Description
g e
in English
20
Data Mandato Lengt
Type ry h
Bill
Strin Pemeliharaa
>>>indonesia O 18 Description
g n
in Bahasa
Partner’s
billSubComp Strin
O 5 product 00001
any g
code
Nominal
inputted by
Deci
billAmount O 18,2 Customer 50000.00
mal
with 2
decimal
Additional
Information
unlimi
additionalInfo Obje O for custom
ted
ct use for each
bill
Bill auth
O 15
PJP
Payment
Strin
status O 2 status for
g
specific Bill
Reason for
Payment
Status for
reason Obje O 2
specific Bill
ct
multi
language
20
Data Mandato Lengt
Type ry h
Reason for
Payment
Strin
>>>english O 64 Status for Success
g
specific Bill
in English
Reason for
Payment
Strin
>>>indonesia O 64 Status for Sukses
g
specific Bill
in Bahasa
Array
Array with
of
freeTexts O maximum 9
Obje
Objects
cts
Will be
Strin
>>>english O 32 shown in Free text
g
Channel
Will be
Strin Tulisan
>>>indonesia O 32 shown in
g bebas
Channel
Contoh Request
POST .../1.0/transfer-va/status HTTP/1.2
X-TIMESTAMP: 2020-12-21T14:56:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
20
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
“customerNo”: 12345678901234567890,
“paymentRequestId”: “abcdef-123456-abcdef”
}
Contoh Response
X-TIMESTAMP: 2020-12-21T14:36:19+07:00
{
},
“customerNo”: “12345678901234567890”,
“0008889912345678901234567890”,
“paidBills”: “100101010000000000000000”,
“trxDateTime”: “20201231T235959Z”,
“referenceNo”: “123456789012345”,
“paymentFlagStatus”: “00”
{
20
“billNo”: “123456789012345678”,
},
“reason”: {
}
},
],
“freeTexts”: [
],
}
}
d. Create VA
Informasi Umum
Service Code 27
Name API Virtual Account – Create VA
Version 1.0
HTTP Method POST
Path .../{version}/transfer-va/create-va
Request Body
Data Mandato Lengt
Type ry h
Derivative of
X-
PARTNER-
8 ID , similar 00088899
eId g
to company
code.
partnerServi
20
Data Mandato Lengt
Type ry h
ceId +
customerNo
or
virtualAccou
ntNo
Unique
number (up
to 20 digits).
partnerServi
Strin M 1234567890
customerNo 20 ceId +
g 1234567890
customerNo
or
virtualAccou
ntNo
partnerServi
ceId (8 digit
left padding
0) +
customerNo
(up to 20 0008889912
28 digits). 3456789012
tNo g
ceId +
customerNo
or
virtualAccou
ntNo
virtualAccoun Strin Customer
M 255 Jokul Doe
tName g name
21
Data Mandato Lengt
Type ry h
virtualAccoun Strin Customer jokul@email.
O 255
tEmail g email com
Customer’s
phone
O 30
62xxxxxxxxx
xxxx
Transaction
Strin ID in abcdefgh123
trxId M 64
g Partner 4
system
Currency of
Strin amount
currency O 3 IDR
g based on
ISO 4217
Total
Deci Amount
totalAmount O 18.2 88000.00
mal with 2
decimal
Array
Array with
of
Obje
24 Objects
cts
Bill code for
Strin
g
choose
billNo O 18
21
Data Mandato Lengt
Type ry h
Strin Bill A for
g Jan
O 10 Bill A
e g shown to
billDescriptio Bill
Obje O
n Description
ct
Bill
Strin Maintenanc
g e
in English
Bill
Strin Pemeliharaa
g n
in Bahasa
Partner’s
billSubComp Strin
O 5 product 00001
any g
code
Nominal
inputted by
Deci
mal
with 2
decimal
Additional
Information
unlimi
ted
ct use for each
bill
Array
Array with
of
Obje
Objects
cts
21
Data Mandato Lengt
Type ry h
Will be
Strin
g
Channel
Will be
Strin Tulisan
g bebas
Channel
1. Closed
Payment (C)
2. Open
Payment (O)
3. Partial
4. Minimum
(only can be
paid once
with
minimum
amount)
Type of
virtualAccoun Strin 5. Open
O 1 Virtual
tTrxType g Minimum
Account
(can be paid
multiple
with
minimum
amount)
6. Open
Maximum
(can be paid
multiple
with
cumulative
21
Data Mandato Lengt
Type ry h
maximum
amount)
Nominal
inputted by
Deci
feeAmount O 18,2 Customer 5000.00
mal
with 2
decimal
Expiration
date for 2020-12-
Strin
expiredDate O 25 Virtual 31T23:59:59
g
Account. -07:00
ISO-8601
{"deviceId":
additionalInfo O
use "mobilephon
e"}
Response Body
Data Mandato Lengt
Type ry h
Strin Response
g Code
M 150 Success
age g Description
virtualAccoun JObj
M
tData ect
partnerServic Strin M Derivative of
8 00088899
eId g partnerSe X-
21
Data Mandato Lengt
Type ry h
rviceId + PARTNER-
customerN ID , similar
o or to company
virtualAcc code
ountNo
Unique
number (up
to 20 digits).
partnerServi
Strin M 1234567890
g 1234567890
customerNo
or
virtualAccou
ntNo
partnerServi
ceId (8 digit
left padding
0) +
customerNo
(up to 20 0008889912
28 digits). 3456789012
tNo g
ceId +
customerNo
or
virtualAccou
ntNo
Custo
virtualAccoun
M 255 mer Jokul Doe M
tName
name
21
Data Mandato Lengt
Type ry h
Custo
virtualAccoun jokul@email.
O 255 mer O
tEmail com
email
Custo
mer’s
phone
numb
virtualAccoun er 6281828384
O 30 O
tPhone Forma 858
t:
62xxx
xxxxx
xxxxx
Strin M from Create abcdefgh123
trxId 32
g VA Request 4
Currency of
Strin amount
currency O 3 IDR
g based on
ISO 4217
Total
Deci O Amount
mal with 2
decimal
Array
Array with
of
Obje
24 Objects
cts
Bill code for
Strin
g
choose
21
Data Mandato Lengt
Type ry h
billNo O 18
Strin Bill A for
g Jan
O 10 Bill A
e g shown to
billDescriptio Bill
Obje O
n Description
ct
Bill
Strin Maintenanc
g e
in English
Bill
Strin Pemeliharaa
g n
in Bahasa
Partner’s
billSubComp Strin
O 5 product 00001
any g
code
Nominal
inputted by
Deci
mal
with 2
decimal
Additional
Information
unlimi
ted
ct use for each
bill
21
Data Mandato Lengt
Type ry h
Array
Array with
of
Obje
Objects
cts
Will be
Strin
g
Channel
Will be
Strin Tulisan
g bebas
Channel
1. Closed
Payment (C)
2. Open
Payment (O)
Type of
virtualAccoun Strin 3. Partial
O 1 Virtual
tTrxType g 4. Minimum
Account
5. Open
Minimum
6. Open
Maximum
Nominal
inputted by
Deci
mal
with 2
decimal
Expiration
date for 2020-12-
Strin
g
Account. -07:00
ISO-8601
21
Data Mandato Lengt
Type ry h
{"deviceId":
additionalInfo O
use "mobilephon
e"}
Contoh Request
POST .../1.0/transfer-va/inquiry HTTP/1.2
X-TIMESTAMP: 2020-12-21T14:56:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
“customerNo”: “12345678901234567890”,
“trxId”: “abcdefgh1234”, “currency”: “IDR”,
{
“billNo”: “123456789012345678”,
21
},
“additionalInfo”: ,
},
],
“freeTexts”: [
],
“feeAmount”: “5000.00”,
“deviceId”: “12345679237”,
}
}
Contoh Response
X-TIMESTAMP: 2020-12-21T14:36:19+07:00
{
“customerNo”: “12345678901234567890”,
“0008889912345678901234567890”,
{
“billNo”: “123456789012345678”,
},
22
},
],
“freeTexts”: [
],
“feeAmount”: “5000.00”,
“expiredDate”: “2020-12-31T23:59:59-07:00”,
“deviceId”: “12345679237”,
}
}
}
e. Update VA
Informasi Umum
Service Code 28
Name API Virtual Account – Update VA
Version 1.0
HTTP Method PUT
Path .../{version}/transfer-va/update-va
Request Body
Data Mandato Lengt
Type ry h
Derivative of
X-
PARTNER-
ID , similar
partnerServic Strin to company
M 8 00088899
eId g code.
partnerServi
ceId +
customerNo
or
22
Data Mandato Lengt
Type ry h
virtualAccou
ntNo
Unique
number (up
to 20 digits).
partnerServi
Strin 1234567890
customerNo M 20 ceId +
g 1234567890
customerNo
or
virtualAccou
ntNo
partnerServi
ceId (8 digit
left padding
0) +
customerNo
(up to 20 0008889912
virtualAccoun Strin
M 28 digits). 3456789012
tNo g
ceId +
customerNo
or
virtualAccou
ntNo
M 255 Jokul Doe
tName g name
O 255
tEmail g email com
virtualAccoun Strin Customer’s 6281828384
O 30
tPhone g phone 858
22
Data Mandato Lengt
Type ry h
number
Format:
62xxxxxxxxx
xxxx
Transaction
trxId M 64
g Partner 4
system
Currency of
Strin amount
currency O 3 IDR
g based on
ISO 4217
Total
Deci O Amount
mal with 2
decimal
Array
Array with
of
Obje
24 Objects
cts
Bill code for
Strin
g
choose
billNo O 18
Strin Bill A for
g Jan
O 10 Bill A
e g shown to
22
Data Mandato Lengt
Type ry h
billDescriptio Bill
Obje O
n Description
ct
Bill
Strin Maintenanc
g e
in English
Bill
Strin Pemeliharaa
g n
in Bahasa
Partner’s
billSubComp Strin
O 5 product 00001
any g
code
Nominal
inputted by
Deci
mal
with 2
decimal
Additional
Information
unlimi
ted
ct use for each
bill
Array
Array with
of
Obje
Objects
cts
Will be
Strin
g
Channel
22
Data Mandato Lengt
Type ry h
Will be
Strin Tulisan
g bebas
Channel
1. Closed
Payment (C)
2. Open
Payment (O)
Type of
O 1 Virtual
Account
5. Open
Minimum
6. Open
Maximum
Nominal
inputted by
Deci
mal
with 2
decimal
Expiration
date for 2020-12-
Strin
g
Account. -07:00
ISO-8601
{"deviceId":
additionalInfo O
use "mobilephon
e"}
22
Response Body
Data Mandato Lengt
Type ry h
Strin Response
g Code
M 150 Success
age g Description
virtualAccoun Obje
M
tData ct
Derivative of
X-
PARTNER-
ID , similar
to company
partnerServic Strin M code.
8 00088899
eId g partnerServi
ceId +
customerNo
or
virtualAccou
ntNo
Unique
number (up
to 20 digits).
partnerServi
Strin M 1234567890
g 1234567890
customerNo
or
virtualAccou
ntNo
22
Data Mandato Lengt
Type ry h
partnerServi
ceId (8 digit
left padding
0) +
customerNo
(up to 20 0008889912
28 digits). 3456789012
tNo g
ceId +
customerNo
or
virtualAccou
ntNo
Custo
virtualAccoun
tName
name
Custo
O 255 mer O
tEmail com
email
Custo
mer’s
phone
numb
O 30 O
tPhone Forma 858
t:
62xxx
xxxxx
xxxxx
22
Data Mandato Lengt
Type ry h
Transaction
Strin M ID in abcdefgh123
trxId 32
g Partner 4
system
Currency of
Strin amount
currency O 3 IDR
g based on
ISO 4217
Bill Amount
Deci O
totalAmount 18.2 with 2 88000.00
mal
decimal
Array
Array with
of
Obje
24 Objects
cts
Bill code for
Strin
g
choose
billNo O 18
Strin Bill A for
g Jan
O 10 Bill A
e g shown to
billDescriptio Bill
Obje O
n Description
ct
Bill
Strin Maintenanc
g e
in English
22
Data Mandato Lengt
Type ry h
Bill
Strin Pemeliharaa
g n
in Bahasa
Partner’s
billSubComp Strin
O 5 product 00001
any g
code
Nominal
inputted by
Deci
mal
with 2
decimal
Additional
Information
unlimi
ted
ct use for each
bill
1. Closed
Payment (C)
2. Open
Payment (O)
Type of
O 1 Virtual
Account
5. Open
Minimum
6. Open
Maximum
Nominal
Deci
feeAmount O 18,2 inputted by 5000.00
mal
Customer
22
Data Mandato Lengt
Type ry h
with 2
decimal
Expiration
date for 2020-12-
Strin
g
Account. -07:00
ISO-8601
Last update
date for 2020-12-
lastUpdateDa Strin
O 25 Virtual 31T23:59:59
te g
Account. -07:00
ISO-8601
Payment
date for 2020-12-
Strin
paymentDate O 25 Virtual 31T23:59:59
g
Account. -07:00
ISO-8601
{"deviceId":
additionalInfo O
use "mobilephon
e"}
Contoh Request
POST .../1.0/transfer-va/update-va HTTP/1.2
X-TIMESTAMP: 2020-12-21T14:56:11+07:00
23
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
“customerNo”: “12345678901234567890”,
“totalAmount”: “88000.00”, “billDetails”: [
{
“billNo”: “123456789012345678”,
},
“billSubCompany”: “00001”, “billAmount”:
“50000.00”,
},
],
“freeTexts”: [
],
“feeAmount”: “5000.00”,
“expiredDate”: “2020-12-31T23:59:59-07:00”,
“lastUpdateDate”: “2020-12-31T23:59:59-07:00”,
“paymentDate”: “2020-12-31T23:59:59-07:00”,
“deviceId”: “12345679237”,
}
}
23
Contoh Response
X-TIMESTAMP: 2020-12-21T14:36:19+07:00
{
“customerNo”: “12345678901234567890”,
“0008889912345678901234567890”,
{
“billNo”: “123456789012345678”,
},
},
],
“freeTexts”: [
],
“feeAmount”: “5000.00”,
“expiredDate”: “2020-12-31T23:59:59-07:00”,
“paymentDate”: “2020-12-31T23:59:59-07:00”,
“deviceId”: “12345679237”,
}
}
23
f. Update Status VA
Informasi Umum
Service Code 29
Name API Virtual Account – Update Status VA
Version 1.0
HTTP Method PUT
Path .../{version}/tranfer-va/update-status
Request Body
Data Mandato Lengt
Type ry h
Derivative of
X-
PARTNER-
ID , similar
to company
8 00088899
eId g partnerServi
ceId +
customerNo
or
virtualAccou
ntNo
Unique
number (up
to 20 digits).
partnerServi
Strin M 1234567890
g 1234567890
customerNo
or
virtualAccou
ntNo
23
Data Mandato Lengt
Type ry h
partnerServi
ceId (8 digit
left padding
0) +
customerNo
(up to 20 0008889912
28 digits). 3456789012
tNo g
ceId +
customerNo
or
virtualAccou
ntNo
Transaction
Strin
trxId M 64 ID in abcdefgh123
g
Partner 4
system
Strin Y = Paid
paidStatus M 1 Y
g N = Not Paid
Response Body
Data Mandato Lengt
Type ry h
Strin Response
g Code
M 150 Success
age g Description
virtualAccoun Obje
M
tData ct
23
Data Mandato Lengt
Type ry h
Derivative of
X-
PARTNER-
ID , similar
to company
8 00088899
eId g partnerServi
ceId +
customerNo
or
virtualAccou
ntNo
Unique
number (up
to 20 digits).
partnerServi
Strin M 1234567890
g 1234567890
customerNo
or
virtualAccou
ntNo
partnerServi
ceId (8 digit
left padding
0) + 0008889912
28 customerNo 3456789012
tNo g
(up to 20 34567890
digits).
partnerServi
ceId +
23
Data Mandato Lengt
Type ry h
customerNo
or
virtualAccou
ntNo
Custo
virtualAccoun
tName
name
Custo
O 255 mer O
tEmail com
email
Custo
mer’s
phone
numb
O 30 O
tPhone Forma 858
t:
62xxx
xxxxx
xxxxx
Transaction
Strin
g
Partner 4
system
Currency of
Strin amount
currency O 3 IDR
g based on
ISO 4217
23
Data Mandato Lengt
Type ry h
Bill Amount
Deci
totalAmount M 18.2 with 2 88000.00
mal
decimal
1. Closed
Payment (C)
2. Open
Payment (O)
Type of
O 1 Virtual
Account
5. Open
Minimum
6. Open
Maximum
Nominal
inputted by
Deci
mal
with 2
decimal
Expiration
date for 2020-12-
Strin
g
Account. -07:00
ISO-8601
Last update
date for 2020-12-
lastUpdateDa Strin
O 25 Virtual 31T23:59:59
te g
Account. -07:00
ISO-8601
23
Data Mandato Lengt
Type ry h
Payment
date for 2020-12-
Strin
g
Account. -07:00
ISO-8601
{"deviceId":
additionalInfo O
use "mobilephon
e"}
Contoh Request
POST .../1.0/transfer-va/update-status HTTP/1.2
X-TIMESTAMP: 2020-12-21T14:56:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
“customerNo”: “12345678901234567890”,
“paidStatus”: “Y”
}
23
Contoh Response
X-TIMESTAMP: 2020-12-21T14:36:19+07:00
{
“customerNo”: “12345678901234567890”,
“0008889912345678901234567890”,
“feeAmount”: “5000.00”,
“expiredDate”: “2020-12-31T23:59:59-07:00”,
“paymentDate”: “2020-12-31T23:59:59-07:00”,
“deviceId”: “12345679237”,
}
}
}
g. Inquiry VA
Informasi Umum
Service Code 30
Name API Virtual Account – Inquiry VA
Version 1.0
HTTP Method GET
Path .../{version}/transfer-va/inquiry-va
23
Request Body
Data Mandato Lengt
Type ry h
Derivative of
X-
PARTNER-
ID , similar
to company
8 00088899
eId g partnerServi
ceId +
customerNo
or
virtualAccou
ntNo
Unique
number (up
to 20 digits).
partnerServi
Strin M 1234567890
g 1234567890
customerNo
or
virtualAccou
ntNo
partnerServi
ceId (8 digit
left padding
0008889912
virtualAccoun Strin M 0) +
28 3456789012
tNo g customerNo
34567890
(up to 20
digits).
partnerServi
24
Data Mandato Lengt
Type ry h
ceId +
customerNo
or
virtualAccou
ntNo
Transaction
Strin
g
Partner 4
system
Response Body
Data Mandato Lengt
Type ry h
Strin Response
g Code
M 150 Success
age g Description
virtualAccoun Obje
M
tData cts
Derivative of
X-
PARTNER-
ID , similar
partnerServic Strin M to company
8 00088899
eId g code.
partnerServi
ceId +
customerNo
or
24
Data Mandato Lengt
Type ry h
virtualAccou
ntNo
Unique
number (up
to 20 digits).
partnerServi
Strin M 1234567890
g 1234567890
customerNo
or
virtualAccou
ntNo
partnerServi
ceId (8 digit
left padding
0) +
customerNo
(up to 20 0008889912
28 digits). 3456789012
tNo g
ceId +
customerNo
or
virtualAccou
ntNo
Custo
virtualAccoun
tName
name
Custo
O 255 mer O
tEmail com
email
24
Data Mandato Lengt
Type ry h
Custo
mer’s
phone
numb
O 30 O
tPhone Forma 858
t:62xx
xxxxx
xxxxx
x
Transaction
Strin M ID in abcdefgh123
trxId 32
g Partner 4
system
Currency of
Strin amount
currency O 3 IDR
g based on
ISO 4217
Bill Amount
Deci O
totalAmount 18.2 with 2 88000.00
mal
decimal
Array
Array with
of
Obje
24 Objects
cts
Bill code for
Strin
g
choose
billNo O 18
24
Data Mandato Lengt
Type ry h
Strin Bill A for
g Jan
O 10 Bill A
e g shown to
billDescriptio Bill
Obje O
n Description
ct
Bill
Strin Maintenanc
g e
in English
Bill
Strin Pemeliharaa
g n
in Bahasa
Partner’s
billSubComp Strin
O 5 product 00001
any g
code
Nominal
inputted by
Deci
mal
with 2
decimal
Additional
Information
unlimi
ted
ct use for each
bill
Array
Array with
of
Obje
Objects
cts
24
Data Mandato Lengt
Type ry h
Will be
Strin
g
Channel
Will be
Strin Tulisan
g bebas
Channel
1. Closed
Payment (C)
2. Open
Payment (O)
Type of
O 1 Virtual
Account
5. Open
Minimum
6. Open
Maximum
Nominal
inputted
Deci
feeAmount O 18,2 byCustomer 5000.00
mal
with 2
decimal
Expiration
date for 2020-12-
Strin
g
Account. -07:00
ISO-8601
Last update 2020-12-
lastUpdateDa Strin
O 25 date for 31T23:59:59
te g
Virtual -07:00
24
Data Mandato Lengt
Type ry h
Account.
ISO-8601
Payment
date for 2020-12-
Strin
g
Account. -07:00
ISO-8601
{"deviceId":
additionalInfo O
use "mobilephon
e"}
Contoh Request
POST .../1.0/transfer-va/inquiry-va HTTP/1.2
X-TIMESTAMP: 2020-12-21T14:56:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
“customerNo”: “12345678901234567890”,
“trxId”: “abcdefgh1234”
24
}
Contoh Response
X-TIMESTAMP: 2020-12-21T14:36:19+07:00
{
“customerNo”: “12345678901234567890”,
“0008889912345678901234567890”,
{
“billNo”: “123456789012345678”,
},
},
],
“freeTexts”: [
],
“feeAmount”: “5000.00”,
“deviceId”: “12345679237”,
}
}
}
24
h. Delete VA
Informasi Umum
Service Code 31
Name API Virtual Account – Delete VA
Version 1.0
HTTP Method DELETE
Path .../{version}/transfer-va/delete-va
Request Body
Data Mandato Lengt
Type ry h
Derivative of
X-
PARTNER-
ID , similar
to company
8 00088899
eId g partnerServi
ceId +
customerNo
or
virtualAccou
ntNo
Unique
number (up
to 20 digits).
partnerServi
Strin M 1234567890
g 1234567890
customerNo
or
virtualAccou
ntNo
24
Data Mandato Lengt
Type ry h
partnerServi
ceId (8 digit
left padding
0) +
customerNo
(up to 20 0008889912
28 digits). 3456789012
tNo g
ceId +
customerNo
or
virtualAccou
ntNo
Transaction
trxId O 64
g Partner 4
system
Response Body
Data Mandato Lengt
Type ry h
Strin Response
g Code
M 150 Success
age g Description
virtualAccoun Obje
M
tData ct
Derivative of
8 X- 00088899
eId g
PARTNER-
24
Data Mandato Lengt
Type ry h
ID , similar
to company
code.
partnerServi
ceId +
customerNo
or
virtualAccou
ntNo
Unique
number (up
to 20 digits).
partnerServi
Strin M 1234567890
g 1234567890
customerNo
or
virtualAccou
ntNo
partnerServi
ceId (8 digit
left padding
0) +
customerNo 0008889912
28 (up to 20 3456789012
tNo g
digits). 34567890
partnerServi
ceId +
customerNo
or
25
Data Mandato Lengt
Type ry h
virtualAccou
ntNo
Transaction
trxId O 12
g Partner 4
system
Contoh Request
POST .../1.0/transfer-va/delete-va HTTP/1.2
X-TIMESTAMP: 2020-12-21T14:56:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
“customerNo”: “12345678901234567890”,
}
Contoh Response
X-TIMESTAMP: 2020-12-21T14:36:19+07:00
{
25
“customerNo”: “12345678901234567890”,
“0008889912345678901234567890”,
}
}
25
i. Inquiry Payment to VA from Intra Bank
Informasi Umum
Service Code 32
API Virtual Account – Inquiry Payment to VA from
Name Intra Bank
Version 1.0
HTTP Method GET
Path .../{version}/transfer-va/inquiry-intrabank
Request Body
Data Mandato Lengt
Type ry h
Derivative of
X-
PARTNER-
ID , similar
to company
8 00088899
eId g partnerServi
ceId +
customerNo
or
virtualAccou
ntNo
Unique
number (up
to 20 digits).
partnerServi
Strin M 1234567890
g 1234567890
customerNo
or
virtualAccou
ntNo
25
Data Mandato Lengt
Type ry h
partnerServi
ceId (8 digit
left padding 0008889912
28 0) + 3456789012
tNo g
customerNo 34567890
(up to 20
digits)
PJP internal
system
datetime
with
20201231T2
txnDateInit Date O 25 timezone,
35959Z
which
follows the
ISO-8601
standard
Channel
Num code based
channelCode O 4 6011
ber on ISO
18245
Language
Strin code based
language O 2 ID
g on ISO 639-
1
Nominal
inputted by
Deci
amount O 18,2 Customer 50000.00
mal
with 2
decimal
25
Data Mandato Lengt
Type ry h
Currency of
Strin amount
currency O 3 IDR
g based on
ISO 4217
Source
sourceAccoun Strin
O 32 account 1234567890
tNo g
number
D = Current
sourceAccoun Strin Account
O 1 S
tType g S = Saving
Account
Response Body
Data Mandato Lengt
Type ry h
Strin Response
g Code
M 150 Success
age g Description
virtualAccoun Obje
M
tData ct
Strin Status of
inquiryStatus O 2 00
g inquiry
Reason for
inquiryReaso Inquiry
Obje O
n Status multi
ct
language
Strin Reason for
g Inquiry
25
Data Mandato Lengt
Type ry h
Status in
English
Reason for
Strin Inquiry
>>indonesia O 64 Sukses
g Status in
Bahasa
Derivative of
X-
PARTNER-
ID , similar
to company
8 00088899
eId g partnerServi
ceId +
customerNo
or
virtualAccou
ntNo
Unique
number (up
to 20 digits).
partnerServi
Strin M 1234567890
g 1234567890
customerNo
or
virtualAccou
ntNo
28 ceId (8 digit 3456789012
tNo g
left padding 34567890
25
Data Mandato Lengt
Type ry h
0) +
customerNo
(up to 20
digits).
partnerServi
ceId +
customerNo
or
virtualAccou
ntNo
M 255 Jokul Doe
tName g name
virtualAccoun Strin Customer john@email.
O 255
tEmail g email com
Customer’s
phone
O 30
62xxxxxxxxx
xxxx
Source
sourceAccoun Strin
O 32 account 1234567890
tNo g
number
D = Current
O 1 S
tType g S = Saving
Account
Inquiry abcdef-
inquiryReque Strin
O 128 identifier for 123456-
stId g
Inquiry. abcdef
25
Data Mandato Lengt
Type ry h
Generated
by PJP.
Currency of
Strin amount
currency O 3 IDR
g based on
ISO 4217
Total
Deci Amount
totalAmount M 18.2 88000.00
mal with 2
decimal
Array
Array with
of
Obje
24 Objects
cts
Bill code for
Strin
g
choose
billNo O 18
Strin Bill A for
g Jan
O 10 Bill A
e g shown to
billDescriptio Bill
Obje O
n Description
ct
Bill
Strin Maintenanc
g e
in English
25
Data Mandato Lengt
Type ry h
Bill
Strin Pemeliharaa
g n
in Bahasa
Partner’s
billSubComp Strin
O 5 product 00001
any g
code
Nominal
inputted by
Deci
mal
with 2
decimal
billAmountLa Strin Label for Total
O ?
bel g billAmount Tagihan
Value that
billAmountVa Strin will be
O ? Rp. 50.000,-
lue g shown for
billAmount
Additional
Information
unlimi
ted
ct use for each
bill
Array
Array with
of
Obje
Objects
cts
Will be
Strin
g
Channel
25
Data Mandato Lengt
Type ry h
Will be
Strin Tulisan
g bebas
Channel
1. Closed
Payment (C)
2. Open
Payment (O)
3. Partial (I)
4. Minimum
(M)
4. Maximum
Type of (L)
virtualAccoun Strin
O 1 Virtual 5. Open
tTrxType g
Account Minimum
(N)
6. Open
Maximum
(X)
7. Bill
Variable (V)
9. Multi Bill
Variable (W)
Nominal
inputted by
Deci
mal
with 2
decimal
Strin Product
productName O 30 Pendidikan
g Category
26
Data Mandato Lengt
Type ry h
{"deviceId":
additionalInfo O
use "mobilephon
e"}
Contoh Request
POST .../1.0/transfer-va/inquiry-intrabank HTTP/1.2
X-TIMESTAMP: 2020-12-21T14:56:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
“customerNo”: 12345678901234567890,
“txnDateInit”: “20201231T235959Z”,
“channelCode”: 6011,
“language”: “ID”,
“amount”: “50000.00”,
“sourceAccountNo”: “1234567890”,
“sourceAccountType”: “S”
}
26
Contoh Response
X-TIMESTAMP: 2020-12-21T14:36:19+07:00
{
“virtualAccountdata”: {
“inquiryStatus”: “00”,
“inquiryReason”: {
},
“customerNo”: “12345678901234567890”,
“0008889912345678901234567890”,
“sourceAccountType”: “S”,
{
“billNo”: “123456789012345678”,
},
},
],
“freeTexts”: [
],
“feeAmount”: “5000.00”,
“deviceId”: “12345679237”,
26
}
}
}
j. Payment to VA from Intra Bank

Informasi Umum
Service Code 33
API Virtual Account – Payment to VA from Intra
Name Bank
Version 1.0
HTTP Method POST
Path .../{version}/transfer-va/payment-intrabank
Request Body
Data Mandato Lengt
Type ry h
Derivative of
X-
PARTNER-
ID , similar
to company
8 00088899
eId g partnerServi
ceId +
customerNo
or
virtualAccou
ntNo
Unique
number (up
Strin M to 20 digits). 1234567890
customerNo 20
ceId +
customerNo
26
Data Mandato Lengt
Type ry h
or
virtualAccou
ntNo
partnerServi
ceId (8 digit
left padding
0) +
customerNo
(up to 20 0008889912
28 digits). 3456789012
tNo g
ceId +
customerNo
or
virtualAccou
ntNo
M 255 Jokul Doe
tName g name
O 255
tEmail g email com
Customer’s
phone
O 30
62xxxxxxxxx
xxxx
Source
sourceAccoun Strin
O 32 account 1234567890
tNo g
number
26
Data Mandato Lengt
Type ry h
D = Current
O 1 S
tType g S = Saving
Account
From abcdef-
inquiryReque Strin O
128 Inquiry 123456-
stId g
Request abcdef
Unique
identifier for
partnerRefere Strin abcdef-
M 128 this
nceNumber g 123456-
Payment.
abcdef
Generated
by Partner.
From
Strin
currency O 3 Inquiry IDR
g
Response
Paid
Deci Amount
paidAmount M 18.2 55000.00
mal with 2
decimal
Cumulative
Amount
cumulativePa from
Deci
ymentAmoun O 18.2 virtualAccou 1000000.00
mal
t ntNo paid
multiple
times
Hexadecimal If have 24
Strin
paidBills O 6 format of bills, and
g
binary of paid bills
26
Data Mandato Lengt
Type ry h
flag of paid number 1,
bills 4, 6, and 8,
will be
written in
binary
1001010100
0000000000
0000 and
converted in
Hexa
950000
Total
amount
Deci
totalAmount O 18.2 from Inquiry 88000.00
mal
with 2
decimal
PJP internal
system
datetime
with
20201231T2
35959Z
which
follows the
ISO-8601
standard
Sequence
journal
Strin
journalNum O 6 number in 123456
g
PJP Core
System
26
Data Mandato Lengt
Type ry h
Strin Type of 1 = Cash
paymentType O 1
Y = retry
Status is
Strin notification
flagAdvise O 1 this a retry
g N = new
notification
notification
Status of
paymentStat Strin 20
O payment In Progress
us g
request
Array
Array with
of
Obje
24 Objects
cts
From
Strin
billCode O 2 Inquiry 01
g
Response
From
Strin 1234567890
billNo O 18 Inquiry
g 12345678
Response
From
Strin Bill A for
billName O 20 Inquiry
g Jan
Response
From
billShortNam Strin
O 10 Inquiry Bill A
e g
Response
From
billDescriptio
Obje O Inquiry
n
ct Response
26
Data Mandato Lengt
Type ry h
From
Strin Maintenanc
>>>english O 18 Inquiry
g e
Response
From
Strin Pemeliharaa
>>>indonesia O 18 Inquiry
g n
Response
From
billSubComp Strin
O 5 Inquiry 00001
any g
Response
From
Deci
billAmount O 18,2 Inquiry 50000.00
mal
Response
From
unlimi
additionalInfo Obje O Inquiry
ted
ct Response
Bill auth
O 15
PJP
Array
Array with
of
Obje
Objects
cts
Will be
Strin
g
Channel
Will be
Strin Tulisan
g bebas
Channel
26
Data Mandato Lengt
Type ry h
Nominal
inputted by
Deci
mal
with 2
decimal
Response Body
Data Mandato Lengt
Type ry h
Strin Response
g Code
M 150 Success
age g Description
virtualAccoun Obje
M
tdata ct
Reason for
paymentFlag Payment
Obje O
Reason Status multi
ct
language
Reason for
Strin Payment
g Status in
English
Reason for
Strin
g
s in Bahasa
Derivative of
partnerServic Strin M X-
8 00088899
eId g PARTNER-
ID , similar
26
Data Mandato Lengt
Type ry h
to company
code.
partnerServi
ceId +
customerNo
or
virtualAccou
ntNo
Unique
number (up
to 20 digits).
partnerServi
Strin M 1234567890
g 1234567890
customerNo
or
virtualAccou
ntNo
partnerServi
ceId (8 digit
left padding
0) +
customerNo
(up to 20 0008889912
28 digits). 3456789012
tNo g
ceId +
customerNo
or
virtualAccou
ntNo
27
Data Mandato Lengt
Type ry h
M 255 Jokul Doe
tName g name
O 255
tEmail g email com
Customer’s
phone
O 30
62xxxxxxxxx
xxxx
Source
sourceAccoun Strin
O 32 account 1234567890
tNo g
number
D = Current
O 1 S
tType g S = Saving
Account
From abcdef-
inquiryReque Strin
O 128 Payment 123456-
stId g
Request abcdef
Unique
Identifier for
Payment.
Generated
abcdef-
paymentRequ Strin O by PJP and
128 123456-
estId g has the
abcdef
value with
generated
paymentReq
uestId to
27
Data Mandato Lengt
Type ry h
Partner
Bille.
partnerRefere Strin From abcdef-
M 128
nceNumber g Payment 123456-
Request. abcdef
referenceNum Strin Generated abcdef-
O 128
ber g by PJP. 123456-
abcdef
From
Strin
g
Request
From
Deci
paidAmount M 18.2 Payment 55000.00
mal
Request
If have 24
bills, and
paid bills
number 1,
4, 6, and 8,
From will be
Strin
paidBills O 6 Payment written in
g
Request binary
1001010100
0000000000
0000 and
converted in
Hexa 95000
From
Deci
totalAmount O 18.2 Payment 88000.00
mal
Request
27
Data Mandato Lengt
Type ry h
From
20201231T2
trxDateTime Date O 25 Payment
35959Z
Request
From
Strin 1234567890
referenceNo O 15 Payment
g 12345
Request
Sequence
journal
Strin
g
PJP Core
System
From
Strin 1 = Cash
paymentType O 1 Payment
g 2 = Transfer
Request
Y = retry
From
Strin notification
flagAdvise O 1 Payment
g N = new
Request
notification
Array
Array with
of
Obje
24 Objects
cts
From
Strin
g
Response
From
Strin 1234567890
billNo O 18 Inquiry
g 12345678
Response
27
Data Mandato Lengt
Type ry h
From
Strin Bill A for
g Jan
Response
From
billShortNam Strin
O 10 Inquiry Bill A
e g
Response
From
billDescriptio
Obje O Inquiry
n
ct Response
From
Strin Maintenanc
g e
Response
From
Strin Pemeliharaa
g n
Response
From
billSubComp Strin
O 5 Inquiry 00001
any g
Response
From
Deci
mal
Response
From
unlimi
ted
ct Response
Payment
Strin
g
specific Bill
Reason for
Strin
reason O 2 Payment
g
Status for
27
Data Mandato Lengt
Type ry h
specific Bill
multi
language
Reason for
Payment
Strin
>>>indonesia O 64 Status for Success
g
specific Bill
in English
Reason for
Payment
Strin
>>>english O 64 Status for Sukses
g
specific Bill
in Bahasa
Array
Array with
of
Obje
Objects
cts
Will be
Strin
g
Channel
Will be
Strin Tulisan
g bebas
Channel
Nominal
inputted by
Deci
mal
with 2
decimal
Strin Product
productName O 30 Pendidikan
g Category
27
Contoh Request
POST .../1.0/transfer-va/payment-intrabank HTTP/1.2
X-TIMESTAMP: 2020-12-21T14:56:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
“customerNo”: 12345678901234567890,
“cumulativePaymentAmount”:
“100101010000000000000000”,
“paidBills”: “950000”,
“trxDateTime”: “20201231T235959Z”,
“referenceNo”: “123456789012345”,
{
“billNo”: “123456789012345678”,
27
“indonesia”: “Pemeliharaan”,
}
“billReferenceNo”: “123456789012345”
}
],
“freeTexts”: [
],
“feeAmount”: “5000.00”
}
Contoh Response
X-TIMESTAMP: 2020-12-21T14:36:19+07:00
{
},
“customerNo”: “12345678901234567890”,
“0008889912345678901234567890”,
“paidBills”: “100101010000000000000000”,
“trxDateTime”: “20201231T235959Z”,
“referenceNo”: “123456789012345”,
27
{
“billNo”: “123456789012345678”,
},
“reason”: {
}
},
],
“freeTexts”: [
],
“feeAmount”: “5000.00”
}
}
k. Notification for Payment to VA from Intra Bank

Informasi Umum
Service Code 34
API Virtual Account – Notification for Payment to
Name VA from Intra Bank
Version 1.0
HTTP Method POST
.../{version}/transfer-va/notify-payment-
Path intrabank
27
Request Body
Data Mandato Lengt
Type ry h
Derivative
of X-
PARTNER-
ID , similar
to company
code, 0008889988
Strin
partnerServic M 8 digit left 899
gNu 8
eId padding 0.
mber
partnerServ
iceId +
customerNo
or
virtualAcco
untNo
Unique
number
1234567890
(up to 20
1234567890
digits).
Strin
M partnerServ
customerNo gNu 20
iceId +
mber
customerNo
or
virtualAcco
untNo
partnerServ 0008889912
iceId (8 digit 3456789012
28 left padding 345678900
tNo g
0) +
customerNo
27
Data Mandato Lengt
Type ry h
(up to 20
digits).
partnerServ
iceId +
customerNo
or
virtualAcco
untNo
abcdef-
From 123456-
inquiryReque Strin
O 128 Inquiry abcdef
stId g
Request
Unique
abcdef-
identifier for
123456-
partnerRefere Strin this
M 128 abcdef
nceNumber g Payment.
Generated
by Partner.
PJP internal
system
datetime
20201231T2
with
35959Z
which
follows the
ISO-8601
standard
28
Data Mandato Lengt
Type ry h
Status of
paymentStatu Strin
O 20 payment Success
s g
request
Reason for
Payment
paymentFlag
Obje O Status
Reason
ct multi
language
Reason for
Success
Strin Payment
>>english O 200
g Status in
English
Reason for
Strin inquiryStat Sukses
>>indonesia O 200
g us in
Bahasa
Response Body
Data Mandato Lengt
Type ry h
Strin Response
g Code
M 150 Success
age g Description
virtualAccoun Obje
O
tdata ct
Reason for
Strin Payment
g Status in
English
28
Data Mandato Lengt
Type ry h
Reason for
Strin
g
s in Bahasa
Derivative of
X-
PARTNER-
ID , similar
to company
partnerServic Strin code.
M 8 00088899
eId g partnerServi
ceId +
customerNo
or
virtualAccou
ntNo
Unique
number (up
to 20 digits).
partnerServi
Strin M 1234567890
g 1234567890
customerNo
or
virtualAccou
ntNo
partnerServi
ceId (8 digit
0008889912
virtualAccoun Strin M left padding
28 3456789012
tNo g 0) +
34567890
customerNo
(up to 20
28
Data Mandato Lengt
Type ry h
digits).
partnerServi
ceId +
customerNo
or
virtualAccou
ntNo
From abcdef-
inquiryReque Strin
O 128 Inquiry 123456-
stId g
Request abcdef
Unique
identifier for
abcdef-
partnerRefere Strin this
M 128 123456-
nceNumber g Payment.
abcdef
Generated
by Partner.
PJP internal
system
datetime
with
20201231T2
35959Z
which
follows the
ISO-8601
standard
Status of
paymentStat Strin
O 20 payment In Progress
us g
request
28
Contoh Request
POST .../1.0/transfer-va/notify-payment-intrabank
HTTP/1.2
X-TIMESTAMP: 2020-12-21T14:56:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
“customerNo”: 12345678901234567890,
“partnerReferenceNumber”: “abcdef-123456-abcdef”,
“trxDateTime”: “20201231T235959Z”,
“paymentStatus”: “Success”,
“paymentFlagReason”: [
]
}
Contoh Response
X-TIMESTAMP: 2020-12-21T14:36:19+07:00
X-SIGNATURE:
61b19a5
{
},
28
“customerNo”: 12345678901234567890,
“0008889912345678901234567890”,
“partnerReferenceNumber”: “abcdef-123456-
abcdef”,
“trxDateTime”: “20201231T235959Z”,
“paymentStatus”: “Success”,
“paymentFlagReason”: [
]
}
}
l. Get Report
Informasi Umum
Service Code 35
Name API Virtual Account – Get Report
Version 1.0
HTTP Method GET
Path .../{version}/transfer-va/report
Request Body
Data Mandato Lengt
Type ry h
From
partnerServic Num
M 8 Payment 88899
eId ber
Request
Start Date
Strin
startDate O 10 for Report 2020-12-31
g
yyyy-MM-dd
Start Time
for Report.
HH:mm
Strin
startTime O 5 If used, 00:00
g
must send
startDate
If startDate
28
Data Mandato Lengt
Type ry h
exists
without
startTime,
default
startTime =
00:00
End Date for
Report
Strin yyyy-MM-dd
endDate O 10 2021-12-31
g If used,
must send
startDate
Start Time
for Report.
HH:mm
If used,
must send
endDate.
Strin
endTime O 5 If endDate 23:59
g
exists
without
endTime,
default
endTime =
23:59
28
Response Body
Data Mandato Lengt
Type ry h
Strin Response
g Code
M 150 Success
age g Description
virtualAccoun Obje
M
tdata cts
Reason for
paymentFlag Payment
Obje O
Reason Status multi
ct
language
Reason for
Strin Payment
g Status in
English
Reason for
Strin
g
s in Bahasa
Derivative of
X-
PARTNER-
ID , similar
to company
partnerServic Strin M code,
8
eId g partnerServi
ceId +
customerNo
or
virtualAccou
ntNo
28
Data Mandato Lengt
Type ry h
8 digit left
padding 0
Unique
number
(up to 20
digits).
partnerServi
ceId + 1234567890
Strin M
customerNo 20 customerNo 1234567890
g
or
virtualAccou
ntNo
partnerServi
ceId (8 digit
left padding
0) +
customerNo
(up to 20 0008889912
28 digits). 3456789012
tNo g
ceId +
customerNo
or
virtualAccou
ntNo
M 255 Jokul Doe
tName g name
28
Data Mandato Lengt
Type ry h
O 255
tEmail g email com
Customer’s
phone
O 30
62xxxxxxxxx
xxxx
Source
sourceAccoun Strin
O 32 account 1234567890
tNo g
number
D = Current
O 1 S
tType g S = Saving
Account
From
Strin abcdefgh123
trxId O 64 Payment
g 4
Request
From abcdef-
inquiryReque Strin
O 128 Payment 123456-
stId g
Request abcdef
From abcdef-
paymentRequ Strin
O 128 Payment 123456-
estId g
Request abcdef
From
Strin
g
Request
From
Deci
paidAmount M 18.2 Payment 55000.00
mal
Request
28
Data Mandato Lengt
Type ry h
If have 24
bills, and
paid bills
number 1,
4, 6, and 8,
From will be
Strin
paidBills O 6 Payment written in
g
Request binary
1001010100
0000000000
0000 and
converted in
Hexa 95000
From
Deci
totalAmount O 18.2 Payment 88000.00
mal
Request
From
20201231T2
trxDateTime Date O 25 Payment
35959Z
Request
From
Strin 1234567890
referenceNo O 15 Payment
g 12345
Request
Sequence
journal
Strin
g
PJP Core
System
From
Strin 1 = Cash
paymentType O 1 Payment
g 2 = Transfer
Request
29
Data Mandato Lengt
Type ry h
Y = retry
From
Strin notification
flagAdvise O 1 Payment
g N = new
Request
notification
Array
Array with
of
Obje
24 Objects
cts
From
Strin
g
Response
From
Strin 1234567890
billNo O 18 Inquiry
g 12345678
Response
From
Strin Bill A for
g Jan
Response
From
billShortNam Strin
O 10 Inquiry Bill A
e g
Response
From
billDescriptio
Obje O Inquiry
n
ct Response
From
Strin Maintenanc
g e
Response
From
Strin Pemeliharaa
g n
Response
29
Data Mandato Lengt
Type ry h
From
billSubComp Strin
O 5 Inquiry 00001
any g
Response
From
Deci
mal
Response
From
unlimi
ted
ct Response
Payment
Strin
g
specific Bill
Reason for
Payment
Strin Status for
reason O 2
g specific Bill
multi
language
Reason for
Payment
Strin
>>>indonesia O 64 Status for Success
g
specific Bill
in English
Reason for
Payment
Strin
>>>english O 64 Status for Sukses
g
specific Bill
in Bahasa
29
Data Mandato Lengt
Type ry h
Array
From
of
freeTexts O Inquiry
Obje
Response
cts
From
Strin
>>>english O 32 Inquiry Free text
g
Response
From
Strin Tulisan
g bebas
Response
Contoh Request
POST .../1.0/transfer-va/report HTTP/1.2
X-TIMESTAMP: 2020-12-21T14:56:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
“startDate”: ”2020-12-31”,
“startTime”: “00:00”,
“endDate”: “2021-12-31”,
“endTime”: “23:59”,
}
29
Contoh Response
X-TIMESTAMP: 2020-12-21T14:36:19+07:00
X-SIGNATURE:
61b19a5
{
},
“customerNo”: “12345678901234567890”,
“0008889912345678901234567890”,
“paidBills”: “100101010000000000000000”,
“trxDateTime”: “20201231T235959Z”,
“referenceNo”: “123456789012345”,
{
“billNo”: “123456789012345678”,
},
29
“reason”: {
}
},
],
“freeTexts”: [
],
}
}
29
4.2.3. API Transaction Status Inquiry
Sequence Diagram
Sequence Diagram API Transaction Status Inquiry
Informasi Umum
Service Code 36
Name API Transaction Status Inquiry
Version 1.0
HTTP Method POST
Path .../{version}/transfer/status
Request Body
Data
Type
Original 2020102
originalPartnerR transaction 9000000
String M 64
eferenceNo identifier on 0000000
service 1
29
Data
Type
consumer
system
Original
transaction 2020102
originalReferenc identifier on 9777700
String O 64
eNo service 0000000
provider 9
system
Original 3044378
External-ID 6930722
originalExternalI
String O 32 on header 7264632
d
message 8009792
0912
Transaction
type
indicator
(service code
serviceCode String M 2 17
of the
original
transaction
request)
transaction 12-02-
date : 2018
dd-MM-yyyy (mandato
transactionDate String O 25
(Mandatory) ry)
HH:mm:ss 10:18:00
29
Data
Type
Net amount
of the
transaction. {
If it’s IDR
then value “value”:“
includes 2 10000.00
Decima
amount O 18, 3 decimal ”,
l
digits.
e.g. IDR “currency
10.000,- will ”:”IDR”
be placed }
with
10000.00
{"deviceId
":
"1234567
Additional 9237",
:
"mobilep
hone"}
Response Body
Data
Type
Response
code
Request
String M 150 has been
ge description
processed
29
Data
Type
successfu
lly
Original
transaction
identifier on
service
20201029
originalReferen provider
String C 64 77770000
ceNo system.
000009
Must be
filled upon
successful
transaction
Original
transaction
20201029
originalPartner identifier on
String O 64 00000000
ReferenceNo service
000001
consumer
system
Original
30443786
External-ID
originalExterna 93072272
String O 32 on header
lId 64632800
message
97920912
Transaction
type
indicator
(service code
of the
original
29
Data
Type
transaction
request)
transaction 12-02-
date : 2018
transactionDat dd-MM-yyyy (mandator
String O 25
e (Mandatory) y)
HH:mm:ss 10:18:00
Net amount
of the
transaction.
{
If it’s IDR
then value
“value”:“1
includes 2
0000.00”,
digits.
“currency
e.g. IDR
”:”IDR”
10.000,- will
}
be placed
with
10000.00

String M 34
untNo Account 0003301
String O 8 002
kCode Bank Code
Currency
Type
previousRespon Previous
String O 7 2000000
seCode Response
30
Data
Type
Code
Transaction
Status
Reference
referenceNumb
String M 30 Number dari 10052019
er
Sistem
sourceAccount Source 88880100

String M 19
No Account 0157508
Transaction
ID unique
per 90 days
(using
transactionId String O 8 UTC+07 10052019
Time Zone).
Format:
Must be 8
in length.
0 - Success
01 - Initiated
02 - Paying
03 - Pending
latestTransactio
04 -
nStatus String M 2 00
Refunded
05 - Canceled
06 - Failed
07 - Not
found
30
Data
Type
Description
transactionStat
usDesc
transaction
{"deviceId"
:
"1234567
Additional
information
"channel":
"mobileph
one"}
Contoh Request
POST …/1.0/transfer/status HTTP/1.2
X-TIMESTAMP: 2020-12-21T14:56:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"2020102900000000000001",
"original]ReferenceNo": "2020102977770000000009",
"originalExternalId":
"30443786930722726463280097920912",
"serviceCode": "17",
"transactionDate": "2020-12-21T14:56:11+07:00”,
"amount": {
30
“value”:“10000.00”,
“currency”:”IDR”
}
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-21T14:36:19+07:00
X-SIGNATURE:
61b19a5
{
successfully",
"originalReferenceNo": "2020102977770000000009",
"2020102900000000000001",
"30443786930722726463280097920912",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"currency": "IDR",
"previousResponseCode": "2000000",
"referenceNumber": "10052019",
"transactionId": "10052019",
"latestTransactionStatus": "00",
"additionalInfo": {
"deviceId": "12345679237",
}
}
30
4.3. SPESIFIKASI API TRANSFER KREDIT LEMBAGA SELAIN BANK
4.3.1. API Customer Top Up
a. Account
Inquiry Sequence
Diagram
Sequence Diagram API Account Inquiry - Customer Top Up
Informasi Umum
Service Code 37
Name API Account Inquiry - Customer Top Up
Version 1.0
HTTP Method POST
Path .../{version}/emoney/account-inquiry
Request Body
Data
Type
Transaction
partnerReferen
ceNo
consumer 000001
system
30
Data
Type
Customer
customerNumb 62813883
String O 32 Account
er 70001
Number
Net amount
of the
transaction.
{
If it’s IDR
then value
“value”:“10
includes 2
Decim 000.00”,
al
digits.
“currency”:
e.g. IDR
”IDR”
10.000,- will
}
be placed
with
10000.00
transaction
yyyyM date :
2020-12-
transactionDat Mddh dd-MM-yyyy
O 25 21T14:56:
e hmms (Mandatory)
11+07:00
s HH:mm:ss
(Optional)
currency string O 3 currency IDR
{"deviceId":
"12345679
Additional 237",
"mobilepho
ne"}
30
Response Body
Data
Type
Response
code
Request
has been
ge description
successfull
y
Transaction
identifier on
service
20201029
provider
system. ust
000009
be filled upon
successful
transaction
Transaction
partnerReferen
ceNo
consumer 000001
system
Session ID 883737GH
sessionId String O 25
transaction Y8839
Customer
Account
Number 62873773
customerNumb
String O 64 Rule of mask 88272
er
for UI
XXXXXXXXX1
857
30
Data
Type
Customer
account name
Rule of mask
for UI:
- 1 char = A John Doe
customerName string M 255 - 2 char = AA Mask:
- 3 char = A** Jo** D**
- 4 char =
AA**
- >=5 char =
AA**A
Customer
customerMonth
numeric O 17 monthly 10000000
lyInLimit
cashin limit
Net amount
of the
{
transaction.
If it’s IDR then
“value”:“10
value includes
000.00”,
minAmount Decimal M 18, 3 2 decimal
digits.
“currency”:
e.g. IDR
”IDR”
10.000,- will
}
be placed with
10000.00
Net amount
{
of the
maxAmount Decimal M 18, 3 transaction.
“value”:“10
If it’s IDR then
000.00”,
value includes
30
Data
Type
2 decimal
digits. “currency”:
e.g. IDR ”IDR”
10.000,- will }
be placed with
10000.00
Net amount
of the
{
transaction.
If it’s IDR then
“value”:“10
value includes
000.00”,
amount Decimal M 18, 3 2 decimal
digits.
“currency”:
e.g. IDR
”IDR”
10.000,- will
}
be placed with
10000.00
Net amount
of the
{
transaction.
If it’s IDR then
“value”:“10
value includes
000.00”,
feeAmount Decimal M 18, 3 2 decimal
digits.
“currency”:
e.g. IDR
”IDR”
10.000,- will
}
be placed with
10000.00
feeType string O 25 Fee type Admin fee
30
Data
Type
{"deviceId":
"12345679
Additional 237",
"mobilepho
ne"}
Contoh Request
POST …/1.0/emoney/account-inquiry HTTP/1.2
X-TIMESTAMP: 2020-12-21T17:02:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"partnerReferenceNo": " 2020102900000000000001",
"customerNumber": "6281388370001",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"transactionDate": "2020-12-21T14:56:11+07:00,
"additionalInfo": {
"deviceId": "12345679237",
}
}
30
Contoh Response
X-TIMESTAMP: 2020-12-21T17:02:18+07:00
{
successfully",
"referenceNo": "2020102977770000000009",
"sessionId": "883737GHY8839",
"customerName": "John Doe",
"customerMonthlyInLimit": "10000000",
"minAmount": {
"value": "10000.00",
"currency": "IDR"
},
"maxAmount": {
"value": "10000.00",
"currency": "IDR"
},
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"feeAmount": {
"value": "10000.00",
"currency": "IDR"
},
"feeType": "Admin fee",
"additionalInfo": {
"deviceId": "12345679237",
}
}
31
b. Customer Top Up
Sequence Diagram
Sequence Diagram API Customer Top Up
Informasi Umum
Service Code 38
Name API Customer Top Up
Version 1.0
HTTP Method POST
Path .../{version}/emoney/topup
Request Body
Data
Type
Transaction
partnerReferenc
eNo
consumer 0001
system
Customer
String M 32 Account
er 8883
number
31
Data
Type
Customer
customerName String O 255 Account John Doe
name
Net amount
of the
transaction.
{
If it’s IDR
then value
“value”:“10
includes 2
Decima 000.00”,
l
digits.
“currency”:”
e.g. IDR
IDR”
10.000,- will
}
be placed
with
10000.00
{
“value”:“10
Decima Transaction 000.00”,
feeAmount M 18, 3
l fee
“currency”:”
IDR”
}
currency string O 3 currency IDR
yyyyM 2020-12-
Transaction
transactionDate Mddhh O … 21T17:01:1
date
mmss 1+07:00
31
Data
Type
Invoice
883737GH
sessionId string O 25 transaction
Y8839
ID
numeri
categoryId O 10 Category ID 6
c
Transaction
notes string O 255 notes test
noted
{"deviceId":
"12345679
Additional 237",
"mobilepho
ne"}
Response Body
Data
Type
Response
code
Request
has been
ge description
successfull
y
Transaction
identifier on
20201029
service
provider
000009
system.
Must be
31
Data
Type
filled upon
successful
transaction
Transaction
partnerReferen
ceNo
consumer 000001
system
Transaction 883737GH
invoice ID Y8839
Customer
String O 64 account
er 6363
number
referenceNumb Reference REF99388

string O 25
er number 3
Net amount
of the
transaction.
{
If it’s IDR
then value
“value”:“10
includes 2
000.00”,
digits.
“currency”:
e.g. IDR
”IDR”
10.000,- will
}
be placed
with
10000.00
31
Data
Type
{"deviceId":
"12345679
Additional 237",
"mobilepho
ne"}
Contoh Request
POST …/1.0/emoney/topup HTTP/1.2
X-TIMESTAMP: 2020-12-21T17:07:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"customerName": "John Doe",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"feeAmount": {
"value": "10000.00",
"currency": "IDR"
},
"currency": "IDR",
"transactionDate": "2020-12-21T14:56:11+07:00,
"categoryId": "6",
31
"notes": "notes test",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-21T14:36:19+07:00
{
successfully",
"referenceNo": "2020102977770000000009",
"referenceNumber": "REF993883",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"additionalInfo": {
"deviceId": "12345679237",
}
}
31
c. Customer Top Up Inquiry
Status Sequence Diagram
Sequence Diagram API Customer Top Up Inquiry Status
Informasi Umum
Service Code 39
Name API Customer Top Up Inquiry Status
Version 1.0
HTTP Method POST
Path .../{version}/emoney/topup-status
Request Body
Data
Type
Transaction
identifier/ref 202107234
originalPartner
String M 64 erence 235808947
ReferenceNo
generated 5892734
by partner.
Transaction
202107234
originalReferenc identifier/ref
String O 64 235808947
eNo erence
5892091
generated
31
Data
Type
by PJP AIS
Selain Bank.
Original X- 2ads-2da-
EXTERNAL- d23dasd-
originalExternal
String O 64 ID from top 21dadjoiq-
Id
up request. 23ij4oinfoe
n
To identify
which
transaction
40
serviceCode String M 2 that needs
to be
checked.
{"deviceId":
"12345679
Additional 237",
"mobilepho
ne"}
Response Body
Data
Type
Response
code
Request
String M 150 has been
ge description
processed
31
Data
Type
successfull
y
Transaction
20210723
identifier/ref
originalPartner 42358089
String O 64 erence
ReferenceNo 47589273
generated
4
by partner.
Transaction
identifier/ref 20210723
originalReferen erence 42358089
String C 64
ceNo generated 47589209
by PJP AIS 1
Selain Bank.
Original X- 2ads-2da-
EXTERNAL- d23dasd-
originalExternal
String O 64 ID from top 21dadjoiq-
Id
up request. 23ij4oinfoe
n
To identify
which
transaction 40
serviceCode String M 2
that needs to
be checked.
Net amount
of the {
transaction.
amount Decimal C 18, 3
If it’s IDR “value”:“10
then value 000.00”,
includes 2
31
Data
Type
decimal
digits. “currency”:
e.g. IDR ”IDR”
10.000,- will }
be placed
with
10000.00
0 - Success
01 - Initiated
02 - Paying
03 - Pending
latestTransactio
04 -
nStatus String M 2 00
Refunded
05 - Canceled
06 - Failed
07 -
Not
found
Description
transactionStat
usDesc
transaction
{"deviceId":
"12345679
Additional 237",
"mobilepho
ne"}
32
Contoh Request
POST …/1.0/emoney/topup HTTP/1.2
X-TIMESTAMP: 2020-12-21T17:07:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
" originalPartnerReferenceNo":
"2021072342358089475892734",
"originalExternalId": "2ads-2da-d23dasd-21dadjoiq-
23ij4oinfoen",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-21T14:36:19+07:00
{
successfully",
" originalPartnerReferenceNo":
"2021072342358089475892734",
" originalExternalId": "2ads-2da-d23dasd-21dadjoiq-
23ij4oinfoen",
"amount": {
32
"value": "40000.00",
"currency": "IDR"
},
"latestTransactionStatus": "00"
" transactionStatusDesc": "success",
"additionalInfo": {
"deviceId": "12345679237",
}
}
32
4.3.2. API Bulk Cashin
a. Submit Bulk
Sequence Diagram
Sequence Diagram API Submit Bulk Cash In
Informasi Umum
Service Code 40
Name API Submit Bulk Cash In
Version 1.0
HTTP Method POST
Path .../{version}/emoney/bulk-cashin-payment
Request Body
Data Mandato Lengt Descripti
Parameter Example
Type ry h on
Bulk
transactio
2020102900
partnerBulkI Strin n
M 64 0000000000
d g identifier
01
on service
consumer
32
Parameter Example
Type ry h on
(bulk
transactio
n sender)
system
transactio
n date :
dd-MM-
yyyy 2020-12-
transactionD Strin
M 25 (Mandator 21T17:01:11
ate g
y) +07:00
HH:mm:s s
(Optional)
strin
currency O 3 currency IDR
g
Obje
bulkObject ct
Array
Customer
accountNumb Strin 6281388370
M 64 Account
er g 001
Number
Strin Customer
accountName O 30 Kades
g Name
Net {
amount of
the “value”:“100
Deci
amount M 18, 3 transactio 00.00”,
mal
n.
If it’s IDR “currency”:”I
then DR”
32
Parameter Example
Type ry h on
value }
includes 2
decimal
digits.
e.g. IDR
10.000,-
will be
placed
with
10000.00
Individual
transactio
n
identifier
2020102900
partnerRefere Strin on service
M 64 0000000009
nceNo g consumer
90
(bulk
transactio
n sender)
system
1. OUR
Fee is
charged to
to whom
the sender
Strin the fee
feeType O 25 (default)
g will be
2. BEN
charged
Fee is
charged to
the recipient
32
Parameter Example
Type ry h on
3.
SHA|1000
Fee is
shared
between
sender and
recipient,
with sender
is charged
Rp 1.000,00
and the
recipient will
be charged
the rest
{"deviceId":
"123456792
Additional
37",
additionalInfo Object O informatio
"channel":
n
"mobilephon
e"}
Response Body
Parameter Example
Type ry h on
Strin Response
g code
Request has
Response
responseMess Strin been
M 150 descriptio
age g processed
n
successfully
32
Parameter Example
Type ry h on
Transactio
n
identifier
on service
2020102977
Strin provider
bulkID M 64 7700000000
g (bulk
09
transactio
n
processin
g) system
Transactio
n
identifier
on service 2020102900
partnerBulkI Strin
M 64 consumer 0000000000
d g
(bulk 01
transactio
n sender)
system
{"deviceId":
"123456792
Additional
37",
"channel":
n
"mobilephon
e"}
Contoh Request
POST …/1.0/emoney/bulk-cashin-payment HTTP/1.2
32
X-TIMESTAMP: 2020-12-21T17:01:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
" partnerBulkId": "2020102900000000000001",
"currency": "IDR",
“bulkObject” : {
"accountNumber": "6281388370001",
"accountName": "Kades",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"partnerReferenceNo": "2020102900000000000001"
},
"feeType": "OUR",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-21T17:01:17+07:00
{
successfully",
"bulkId": " 2020102977770000000009",
"partnerBulkId ": "2020102900000000000001",
"additionalInfo": {
"deviceId": "12345679237",
}
}
32
b. Notify Bulk
Informasi Umum
Service Code 41
Name API Notify Bulk Cash In
Version 1.0
HTTP Method POST
Path .../{version}/emoney/bulk-cashin-notify
Request Body
Parameter Example
Type ry h on
Transaction
identifier
2020102977
on bulk
transaction
09
processing
system
Transaction
identifier
2020102900
on bulk
transaction
01
sender
system
Customer
customerNu Strin 6281388370
M 64 Account
mber g 001
Number
Obje
bulkObject ct
Array
customerNam Strin Customer
O 30
e g Name
32
Parameter Example
Type ry h on
Net {
amount of
transactio 00.00”,
n.
then DR”
value }
Deci
amount M 18, 3 includes 2
mal
decimal
digits.
e.g. IDR
10.000,-
will be
placed
with
10000.00
Individual
transactio
n
identifier 2020102977
Strin
referenceNo M 64 on bulk 7700000000
g
transactio 09
n
processin
g system
Individual
2020102900
partnerRefere Strin transactio
M 64 0000000009
nceNo g n
90
identifier
33
Parameter Example
Type ry h on
on bulk
transactio
n sender
system
Strin Response
g Code
Response
responseMess Strin
M 150 descriptio Sukses
age g
n
{"deviceId":
"123456792
Additional
37",
"channel":
n
"mobilephon
e"}
Response Body
Type tory n
responseCo Response
String M 7 2000000
de code
Request has
responseM Response been
String M 150
essage description processed
successfully
Transaction
2020102977
identifier on
bulk
09
transaction
33
Type tory n
processing
system
Transaction
identifier on
2020102900
partnerBul bulk
String M 64 0000000000
kId transaction
01
sender
system
{"deviceId":
"123456792
additionalIn Additional 37",
Object O
fo information "channel":
"mobilephon
e"}
Contoh Request
POST …/1.0/emoney/bulk-cashin-notify HTTP/1.2
X-TIMESTAMP: 2020-12-21T17:07:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"bulkId": "2020102977770000000009",
"partnerBulkId ": "2020102900000000000001",
33
"bulkObject":{
"customerName": "Kades",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"referenceNo": "2020102977770000000009",
successfully",
},
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-21T17:07:18+07:00
{
successfully",
"bulkId": "2020102977770000000009",
"partnerBulkId": "2020102900000000000001",
"additionalInfo": {
"deviceId": "12345679237",
}
}
33
4.3.3. API Transfer to Bank
a. Account
Inquiry Sequence
Diagram
Sequence Diagram API Transfer to Bank-Account Inquiry
Informasi Umum
Service Code 42
Name API Transfer to Bank-Account Inquiry
Version 1.0
HTTP Method POST
Path .../{version}/emoney/bank-account-inquiry
Request Body
Parameter Example
Type ry h on
Transactio
n
2020102900
partnerRefere Strin identifier
M 64 0000000000
nceNo g on service
01
consumer
system
33
Parameter Example
Type ry h on
Customer
M 32 Account
mber g 001
Number
Net {
amount of
n.
then DR”
value }
Deci
mal
decimal
digits.
e.g. IDR
10.000,-
will be
placed
with
10000.00
Destinatio
beneficiaryAc strin
O 32 n account 8377388292
countNumber g
number
{"deviceId":
"123456792
Additional
37",
"channel":
n
"mobilephon
e"}
33
Response Body
Parameter Example
Type ry h on
Strin Response
g code
Request has
Response
M 150 descriptio
age g processed
n
successfully
Transactio
n
identifier
on service
provider 2020102977
Strin
referenceNo C 64 system. 7700000000
g
Must be 09
filled upon
successful
transactio
n
Transactio
n
2020102900
O 64 0000000000
nceNo g on service
01
consumer
system
Account
accountType String O 25 tabungan
type
Beneficiary
beneficiaryAcc
String M 32 account 2452451341
ountNumber
number
33
Parameter Example
Type ry h on
Beneficiary
beneficiaryAcc
String M 64 account John Doe
ountName
name
beneficiaryBa
string O 8 003
nkCode Bank code
beneficiaryBa Bank short

string O 25 BMRI
nkShortName name
beneficiaryBa
string O 25 Mandiri
nkName Bank name
Net {
amount of
transaction 00.00”,
.
then value DR”
Decim
amount M 18, 3 includes 2 }
al
decimal
digits.
e.g. IDR
10.000,-
will be
placed with
10000.00
0UYEB7732
sessionId string O 25
sessionID 9002HY
Additional {"deviceId":
additionalInfo Object O informatio "123456792
n 37",
33
Parameter Example
Type ry h on
"channel":
"mobilephon
e"}
Contoh Request
POST …/1.0/emoney/bank-account-inquiry HTTP/1.2
X-TIMESTAMP: 2020-12-21T17:21:41+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"beneficiaryAccountNumber": "8377388292"
"additionalInfo": {
"deviceId": "12345679237",
}
}
33
Contoh Response
X-TIMESTAMP: 2020-12-21T17:07:18+07:00
{
successfully",
"referenceNo": "2020102977770000000009",
"accountType": "tabungan",
"beneficiaryAccountNumber": "2452451341",
"beneficiaryAccountName": "John Doe",
"beneficiaryBankShortName": "BMRI",
"beneficiaryBankName": "Mandiri",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"sessionId": "0UYEB77329002HY",
"additionalInfo": {
"deviceId": "12345679237",
}
}
33
b. Payment Transaction
Sequence Diagram
Sequence Diagram API Transfer to Bank-Payment Transaction
Informasi Umum
Service Code 43
Name API Transfer to Bank-Payment Transaction
Version 1.0
HTTP Method POST
Path .../{version}/emoney/transfer-bank
34
Request Body
Parameter Example
Type ry h on
Transactio
n
2020102900
M 64 0000000000
nceNo g on service
01
consumer
system
Customer
M 32 Account
mber g 001
Number
strin Account
accountType O 25 tabungan
g type
Destinatio
beneficiaryAc strin
M 32 n account 8377388292
countNumber g
number
beneficiaryBa strin
O 8 Bank code 002
nkCode g
Net {
amount of
n.
Deci
amount M 18, 3 then DR”
mal
value }
includes 2
decimal
digits.
e.g. IDR
10.000,-
34
Parameter Example
Type ry h on
will be
placed
with
10000.00
strin 0UYEB7732
sessionId O 25 Session id
g 9002HY
strin
g
1. OUR
Fee is
charged to
the sender
(default)
2. BEN
Fee is
charged to
the recipient
to whom
3.
Strin the fee
feeType O 25 SHA|1000
g will be
Fee is
charged
shared
between
sender and
recipient,
with sender
is charged
Rp 1.000,00
and the
recipient will
34
Parameter Example
Type ry h on
be charged
the rest
{"deviceId":
"123456792
Additional
37",
"channel":
n
"mobilephon
e"}
Response Body
Parameter Example
Type ry h on
Strin Response
g code
Request has
Response
M 150 descriptio
age g processed
n
successfully
Transactio
n
identifier
on service
provider 2020102977
Strin
g
Must be 09
filled upon
successful
transactio
n
34
Parameter Example
Type ry h on
Transactio
n
2020102900
O 64 0000000000
nceNo g on service
01
consumer
system
yyyyM
2020-12-
transactionDa Mddh
O 25 21T17:48:41
te hmms Transaction
+07:00
s date
referenceNum Reference
string M 64 REF993883
ber number
{"deviceId":
"123456792
Additional
37",
"channel":
n
"mobilephon
e"}
Contoh Request
POST …/1.0/emoney/transfer-bank HTTP/1.2
X-TIMESTAMP: 2020-12-21T17:48:41+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
34
CHANNEL-ID: 95221
{
"beneficiaryAccountNumber": "8377388292",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"sessionId": "0UYEB77329002HY",
"currency": "IDR",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-21T17:48:45+07:00
{
successfully",
"referenceNo": "2020102977770000000009",
"additionalInfo": {
"deviceId": "12345679237",
}
}
34
4.3.4. API Transfer to OTC
Sequence Diagram
Sequence Diagram API Transfer to OTC
a. Create Payment
Informasi Umum
Service Code 44
Name API Transfer to OTC – Create Payment
Version 1.0
HTTP Method POST
Path .../{version}/emoney/otc-cashout
34
Request Body
Parameter Example
Type ry h on
Transactio
n
2020102900
M 64 0000000000
nceNo g on service
01
consumer
system
Customer
M 32 Account
mber g 001
Number
strin
otp M 8 otp 12345766
g
Net {
amount of
n.
then DR”
value }
Deci
mal
decimal
digits.
e.g. IDR
10.000,-
will be
placed
with
10000.00
34
Parameter Example
Type ry h on
strin
g
1. OUR
Fee is
charged to
the sender
(default)
2. BEN
Fee is
charged to
the recipient
3.
to whom
SHA|1000
Strin the fee
feeType O 25 Fee is
g will be
shared
charged
between
sender and
recipient,
with sender
is charged
Rp 1.000,00
and the
recipient will
be charged
the rest
{"deviceId":
Additional
"123456792
37",
n
"channel":
34
Parameter Example
Type ry h on
"mobilephon
e"}
Response Body
Parameter Example
Type ry h on
Strin Response
g code
Request has
Response
M 150 descriptio
age g processed
n
successfully
Transactio
n
identifier
on service
provider 2020102977
Strin
g
Must be 09
filled upon
successful
transactio
n
Transactio
n
2020102900
O 64 0000000000
nceNo g on service
01
consumer
system
34
Parameter Example
Type ry h on
yyyyM
transactionDat MddH 2020-10-20
O 255
e Hmms Transaction 17:56:57
s date
{"deviceId":
"123456792
Additional
37",
"channel":
n
"mobilephon
e"}
Contoh Request
POST …/1.0/emoney/otc-cashout HTTP/1.2
X-TIMESTAMP: 2020-12-21T17:55:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"partnerReferenceNo": "2020102900000000000001", "
"otp": "12345678",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"currency": "IDR",
35
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-21T17:55:21+07:00
{
successfully",
"referenceNo": "2020102977770000000009",
"additionalInfo": {
"deviceId": "12345679237",
}
}
b. Transfer Status
Informasi Umum
Service Code 45
Name API Transfer to OTC – Transfer Status
Version 1.0
HTTP Method POST
Path .../{version}/emoney/otc-status
Request Body
Parameter Example
Type ry h on
Original
transactio 2020102900
originalPartne Strin
M 64 n 0000000000
rReferenceNo g
identifier 01
on service
35
Parameter Example
Type ry h on
consumer
system
Original
transactio
n 2020102977
originalRefere Strin
O 64 identifier 7700000000
nceNo g
on service 09
provider
system
Original
External- 3044378693
originalExter Strin ID on 0722726463
O 32
nalId g header 2800979209
message 12
Transactio
n type
indicator
(service
Strin
serviceCode M 2 code of 17
g
the
original
transactio
n request)
Customer
M 32 Account
mber g 001
Number
transactionD Strin transactio 12-02-2018
O 25
ate g n date : (mandatory)
35
Parameter Example
Type ry h on
dd-MM- 10:18:00
yyyy (optional)
(Mandator
y)
HH:mm:s
s
(Optional)
Net {
amount of
n.
then DR”
value }
Deci
mal
decimal
digits.
e.g. IDR
10.000,-
will be
placed
with
10000.00
strin
g
{"deviceId":
Additional
"123456792
37",
n
"channel":
35
Parameter Example
Type ry h on
"mobilephon
e"}
Response Body
Parameter Example
Type ry h on
Strin Response
g code
Request has
Response
M 150 descriptio
age g processed
n
successfully
Original
transactio
n
identifier
on service
2020102977
originalRefere Strin provider
C 64 7700000000
nceNo g system.
09
Must be
filled upon
successful
transactio
n
Original
O 64 n 0000000000
rReferenceNo g
identifier 01
on service
35
Parameter Example
Type ry h on
consumer
system
Original
O 32
message 12
Transactio
n type
indicator
(service
Strin
serviceCode M 2 code of 17
g
the
original
transactio
n request)
00 -
Success
01 -
Initiated
02 -
latestTransac Strin Paying
M 2 00
tionStatus g 03 -
Pending
04 -
Refunded
05 -
Canceled
35
Parameter Example
Type ry h on
06 -
Failed
07 - Not
found
Descripti
on of
transactionSt Strin
O 50 latest Success
atusDesc g
transacti
on status
yyyyM
O 255
s date
Net
amount of
the
transaction
{
.
If it’s IDR
“value”:“100
then value
Decim 00.00”,
amount O 18, 3 includes 2
al
decimal
“currency”:”I
digits.
DR”
e.g. IDR
}
10.000,-
will be
placed with
10000.00
informatio "123456792
35
Parameter Example
Type ry h on
n 37",
"channel":
"mobilephon
e"}
Contoh Request
POST …/1.0/emoney/otc-status HTTP/1.2
X-TIMESTAMP: 2020-12-21T17:55:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"2020102900000000000001",
"30443786930722726463280097920912",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"currency": "IDR",
"additionalInfo": {
"deviceId": "12345679237",
}
}
35
Contoh Response
X-TIMESTAMP: 2020-12-21T17:55:21+07:00
{
successfully",
"2020102900000000000001",
"30443786930722726463280097920912",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"additionalInfo": {
"deviceId": "12345679237",
}
}
c. Cancel Payment
Informasi Umum
Service Code 46
Name API Transfer to OTC – Cancel Payment
Version 1.0
HTTP Method POST
Path .../{version}/emoney/otc-cancel
Request Body
Parameter Example
Type ry h on
Original
2020102977
originalRefere Strin transactio
C 64 7700000000
nceNo g n
09
identifier
35
Parameter Example
Type ry h on
on service
provider
system to
be
cancelled.
Must be
filled upon
successful
original
transactio
n
Kaluu ada
txnnya
Original
transactio
n
M 64 on service 0000000000
rReferenceNo g
consumer 01
system to
be
cancelled
Original
O 32
message 12
35
Parameter Example
Type ry h on
Customer
M 32 Account
mber g 001
Number
Reason
strin cancel
reason M 512 cancellatio
g reason
n
{"deviceId":
"123456792
Additional
37",
"channel":
n
"mobilephon
e"}
Response Body
Parameter Example
Type ry h on
Strin Response
g code
Request has
Response
M 150 descriptio
age g processed
n
successfully
Original
transactio
n 2020102977
M 64 identifier 7700000000
nceNo g
on service 09
provider
system to
36
Parameter Example
Type ry h on
be
cancelled
Original
transactio
n
O 64 on service 0000000000
rReferenceNo g
consumer 01
system to
be
cancelled
Original
O 32
message 12
cancelTime Strin C 25 Cancel

g time
ISO-8601.
Must be 2020-10-
filled if 20T17:56:57
cancelled
transactio
n success
yyyyM
O 255
s date
36
Parameter Example
Type ry h on
{"deviceId":
"123456792
Additional
37",
"channel":
n
"mobilephon
e"}
36
Contoh Request
POST …/1.0/otc/cashout/cancel HTTP/1.2
X-TIMESTAMP: 2020-12-21T17:55:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"2020102900000000000001",
"30443786930722726463280097920912",
"reason": "timeout",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-21T17:55:21+07:00
{
successfully",
"2020102900000000000001",
"30443786930722726463280097920912",
"cancelTime": "2020-12-21T17:07:25+07:00",
36
"additionalInfo": {
"deviceId": "12345679237",
}
}
36
4.3.5. API QR MPM
Sequence Diagram
Sequence Diagram API QR MPM - Payment Redirect
36
Sequence Diagram API QR MPM – Host to Host
a. Generate QR
Informasi Umum
Service Code 47
Name API Generate QR MPM
Version 1.0
HTTP Method POST
Path .../{version}/qr/qr-mpm-generate
Request Body
Parameter Example
Type ry h on
Transactio 2020102900
partnerRefere Strin
M 64 n 0000000000
nceNo g
identifier 01
36
Parameter Example
Type ry h on
on service
consumer
system
Net {
amount of
n.
then DR”
value }
Deci
mal
decimal
digits.
e.g. IDR
10.000,-
will be
placed
with
10000.00
{
“value”:“100
Deci Transacti 00.00”,
feeAmount O 18, 3
mal on fee
“currency”:”I
DR”
}
strin Currency
currency O 3 IDR
g format
36
Parameter Example
Type ry h on
Merchant
identifier
merchantId O 64
g unique 0926
per each
merchant
Sub
subMerchantI Strin 3109289249
O 32 merchant
d g 49487
ID
unique
Strin shop id in
storeId O 64 abcd
g merchant
side.
Terminal 2131412511
Strin
terminalId O 16 Identificat 24
g
ion
The time 2009-07-
Strin
validityPeriod O 25 when the 03T12:08:56
g
QRIS valid -07:00
{"deviceId":
"123456792
Additional
37",
"channel":
n
"mobilephon
e"}
36
Response Body
Parameter Example
Type ry h on
Strin Response
g code
Request has
Response
M 150 descriptio
age g processed
n
successfully
Transactio
n
identifier
on service
provider 2020102977
Strin
g
Must be 09
filled upon
successful
transactio
n
Transactio
n
2020102900
O 64 0000000000
nceNo g on service
01
consumer
system
QR String xxxxxxxxxxx
qrContent String M 512
MPM xx
Conditional Redirect https://test.

, URL to go psjp.id/redir
redirectUrl String 512
mandatory to PJSP ect/qris?
if redirect page to x=23849032
36
Parameter Example
Type ry h on
mode process the 4092
payment.
Conditional
,
merchantNam Baso Malang
String mandatory 25
e
if host Reference
mode number
unique
shop id in
storeId String O 64 abcd
merchant
side.
Terminal 2131412511
terminalId String O 16 Identificati 24
on
{"deviceId":
"123456792
Additional
37",
"channel":
n
"mobilephon
e"}
Contoh Request
POST …/1.0/qr/qr-mpm-generate HTTP/1.2
X-TIMESTAMP: 2020-01-15T17:01:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
37
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"amount": {
"value": "100000.00",
"currency": "IDR"
},
"feeAmount": {
"value": "100000.00",
"currency": "IDR"
},
"currency": "IDR",
"merchantId": "23489182303312",
"subMerchantId": "23489182303312",
"storeId": "abcd",
"terminalId": "213141251124",
"validityPeriod": "2009-07-03T12:08:56-07:00 ",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-01-15T17:01:18+07:00
{
successfully",
"referenceNo": "2020102977770000000009",
"qrContent": "xxxxxxxxxxxxxxxx",
"redirectUrl": "https://test.psjp.id/redirect/qris?
x=238490324092",
"merchantName": "Baso Malang",
"storeId": "abcd",
"terminalId": "213141251124",
"additionalInfo": {
"deviceId": "12345679237",
}
}
37
b. Decode QR
Informasi Umum
Service Code 48
Name API Decode QR MPM
Version 1.0
HTTP Method POST
Path .../{version}/qr/qr-mpm-decode
Request Body
Parameter Example
Type ry h on
Transactio
n
2020102900
M 64 0000000000
nceNo g on service
01
consumer
system
Strin QR String xxxxxxxxxxx
qrContent M 512
g CPM xx
Net {
amount of
n.
Deci then DR”
amount M 18, 3
mal value }
includes 2
decimal
digits.
e.g. IDR
10.000,-
will be
37
Parameter Example
Type ry h on
placed
with
10000.00
Merchant
identifier
merchantId O 64
g unique 0926
per each
merchant
Sub
O 32 merchant
d g 49487
ID
The time
when the
2009-07-
Strin QRIS
scanTime M 25 03T12:08:56
g scanned
-07:00
by the
User
{"deviceId":
"123456792
Additional
37",
"channel":
n
"mobilephon
e"}
37
Response Body
Parameter Example
Type ry h on
Strin Response
g code
Request has
Response
M 150 descriptio
age g processed
n
successfully
Transactio
n
identifier
on service
provider 2020102977
Strin
g
Must be 09
filled upon
successful
transactio
n
Transactio
n
2020102900
O 64 0000000000
nceNo g on service
01
consumer
system
Redirect
Conditional https://test.
URL to go
, psjp.id/redir
to PJSP
redirectUrl String mandatory 512 ect/qris?
page to
if redirect x=23849032
process the
mode 4092
payment.
37
Parameter Example
Type ry h on
Conditional
,
merchantNam Baso Malang
String mandatory 25
e
if host Reference
mode number
Conditional
,
merchantCateg Food &
String mandatory 32
ory Beverage
if host Merchant
mode category
Conditional
,
merchantLocat
String mandatory 25 Jakarta
ion
if host Merchant
mode location
Conditional
,
currency string mandatory 3 360
if host Currency
mode format
{"deviceId":
"123456792
Additional
37",
"channel":
n
"mobilephon
e"}
37
Contoh Request
POST …/1.0/qr/qr-mpm-decode HTTP/1.2
X-TIMESTAMP: 2020-12-23T08:27:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"qrContent": "00020101....",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"merchantId": "23489182303312",
"subMerchantId": "23489182303312",
"scanTime": "2020-12-23T08:27:11+07:00",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-23T08:27:18+07:00
{
successfully",
"referenceNo": "2020102977770000000009",
"redirectUrl": "https://test.psjp.id/redirect/qris?
x=238490324092 ",
37
"merchantName": "Baso Malang",
"merchantCategory": "Food & Beverage",
"merchantLocation": "Jakarta",
"currency": "360",
"additionalInfo": {
"deviceId": "12345679237",
}
}
c. Payment Redirect
Informasi Umum
Service Code 49
Name API Payment Redirect
Version 1.0
HTTP Method POST
Path .../{version}/qr/apply-ott
Request Body
Parameter Example
Type ry h on
Strin
userResource g One time
M 64 [“OTT”]
s Arra token
y
{"deviceId":
"123456792
Additional
37",
"channel":
n
"mobilephon
e"}
37
Response Body
Parameter Example
Type ry h on
Strin Response
g code
Request has
Response
M 150 descriptio
age g processed
n
successfully
List of
resourcesType String M 32 resources OTT
retrieved.
jadoijasod98
7984712094
value String M 64 value
7201ifh0afh
q08hd1038
{"deviceId":
"123456792
Additional
37",
"channel":
n
"mobilephon
e"}
Contoh Request
POST …/1.0/qr/apply-ott HTTP/1.2
X-TIMESTAMP: 2020-12-23T08:31:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
37
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"userResources": ["OTT"],
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-23T08:31:18+07:00
{
successfully",
"resourceType": "OTT",
"value":
"jadoijasod9879847120947201ifh0afhq08hd1038",
"additionalInfo": {
"deviceId": "12345679237",
}
}
d. Apply OTT
Apply OTT merujuk pada Get Auth URL pada bagian I – Registrasi.
e. Payment – Host to Host

Informasi Umum
Service Code 50
Name API Payment – Host to Host
Version 1.0
HTTP Method POST
Path .../{version}/qr/qr-mpm-payment
37
Request Body
Parameter Example
Type ry h on
Transactio
n
2020102900
M 64 0000000000
nceNo g on service
01
consumer
system
Merchant
identifier
merchantId O 64
g unique 0926
per each
merchant
Sub
O 32 merchant
d g 49487
ID
nume Transactio
amount M 18,3 50000
ric n amount
Fee
nume
feeAmount M 18,3 Transactio 500
ric
n amount
Strin One-time
otp C 8 12345678
g password
{"deviceId":
"123456792
Additional
37",
"channel":
n
"mobilephon
e"}
38
Response Body
Parameter Example
Type ry h on
Strin Response
g code
Request has
Response
M 150 descriptio
age g processed
n
successfully
Transactio
n
identifier
on service
provider 2020102977
Strin
g
Must be 09
filled upon
successful
transactio
n
Transactio
n
2020102900
O 64 0000000000
nceNo g on service
01
consumer
system
yyyyM
2020-12-
transactionDat MddH Transaction
O 255 23T08:37:11
e Hmms date
+07:00
s ISO-8601
Deci Net {
amount M 18, 3
mal amount of
38
Parameter Example
Type ry h on
the
transactio “value”:“100
n. 00.00”,
If it’s IDR
then “currency”:”I
value DR”
includes 2 }
decimal
digits.
e.g. IDR
10.000,-
will be
placed
with
10000.00
Net {
amount of
n.
then DR”
Deci
feeAmount M 18, 3 value }
mal
includes 2
decimal
digits.
e.g. IDR
10.000,-
will be
placed
38
Parameter Example
Type ry h on
with
10000.00
Verification 8921840jfas
identifier, if 0dfjasd09dj
verificationId String O 64
verification 1129jd0921
is required d
{"deviceId":
"123456792
Additional
37",
"channel":
n
"mobilephon
e"}
Contoh Request
POST …/1.0/qr/qr-mpm-payment HTTP/1.2
X-TIMESTAMP: 2020-12-23T08:37:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"merchantId": "23489182303312",
"subMerchantId": "23489182303312",
"amount": {
"value": "50000.00",
38
"currency": "IDR"
},
"feeAmount": {
"value": "500.00",
"currency": "IDR"
},
"otp": "12345678",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-23T08:37:21+07:00
{
successfully",
"referenceNo": "2020102977770000000009",
"amount": {
"value": "50000.00",
"currency": "IDR"
},
"feeAmount": {
"value": "500.00",
"currency": "IDR"
},
"verificationId":
"8921840jfas0dfjasd09dj1129jd0921d",
"additionalInfo": {
"deviceId": "12345679237",
}
}
f. Query Payment
Informasi Umum
Service Code 51
Name API Query Payment
Version 1.0
HTTP Method POST
Path .../{version}/qr/qr-mpm-query
38
Request Body
Parameter Example
Type ry h on
Original
transactio
n 2020102977
nceNo g
on service 09
provider
system
Original
transactio
n 2020102900
rReferenceNo g
on service 01
consumer
system
Original
O 32
message 12
Transactio
n type
indicator
Strin
serviceCode M 2 (service 17
g
code of
the
original
38
Parameter Example
Type ry h on
transactio
n request)
Merchant
identifier
merchantId O 64
g unique 0926
per each
merchant
Sub
O 32 merchant
d g 49487
ID
{"deviceId":
"123456792
Additional
37",
"channel":
n
"mobilephon
e"}
Response Body
Parameter Example
Type ry h on
Strin Response
g code
Request has
Response
M 150 descriptio
age g processed
n
successfully
Original 2020102977
C 64 transactio 7700000000
nceNo g
n 09
38
Parameter Example
Type ry h on
identifier
on service
provider
system.
Must be
filled upon
successful
transactio
n
Original
transactio
n 2020102900
rReferenceNo g
on service 01
consumer
system
Original
External-ID
originalExtern
String O 32 on header
alId
message
Transaction
type
indicator
(service
code of the
original
transaction
request)
38
Parameter Example
Type ry h on
00 -
Success
01 -
Initiated
02 - Paying
03 -
latestTransact
Pending
ionStatus String M 2 00
04 -
Refunded
05 -
Canceled
06 - Failed
07 - Not
found
Description
transactionSta
tusDesc
transaction
yyyyM
MddH Transaction 2020-10-
O 255
Hmms date 20T17:56:57
paidTime s ISO-8601
Net {
amount of
Deci
amount M 18, 3 n.
mal
then DR”
value }
includes 2
38
Parameter Example
Type ry h on
decimal
digits.
e.g. IDR
10.000,-
will be
placed
with
10000.00
Net {
amount of
n.
then DR”
value }
Deci
feeAmount M 18, 3 includes 2
mal
decimal
digits.
e.g. IDR
10.000,-
will be
placed
with
10000.00
Terminal 2131412511
Strin
terminalId O 16 Identificat 24
g
ion
informatio "123456792
38
Parameter Example
Type ry h on
n 37",
"channel":
"mobilephon
e"}
Contoh Request
POST …/1.0/qr/qr-mpm-query HTTP/1.2
X-TIMESTAMP: 2020-12-23T08:43:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"2020102900000000000001",
"30443786930722726463280097920912",
"merchantId": "23489182303312",
"subMerchantId": "23489182303312",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-23T08:43:16+07:00
39
{
"originalPartnerReferenceNo": "2020102900000000000001",
"30443786930722726463280097920912",
"paidTime": "2020-12-23T08:43:11+07:00",
"amount": {
"value": "50000.00",
"currency": "IDR"
},
"feeAmount": {
"value": "500.00",
"currency": "IDR"
},
“terminalId”: “213141251124”,
"additionalInfo": {
"deviceId": "12345679237",
}
}
g. Payment Notify
Informasi Umum
Service Code 52
Name API Payment Notify
Version 1.0
HTTP Method POST
Path .../{version}/qr/qr-mpm-notify
Request Body
Parameter Example
Type ry h on
Transactio
2020102977
Strin n
referenceNo M 64 7700000000
g identifier
09
on service
39
Parameter Example
Type ry h on
provider
system
Transactio
n
2020102900
M 64 0000000000
nceNo g on service
01
consumer
system
00 -
Success
01 -
Initiated
02 -
Paying
03 -
latestTransa
Strin Pending
ctionStatus O 2 00
g 04 -
Refunded
05 -
Canceled
06 -
Failed
07 - Not
found
Descriptio
transactionSt Strin n status
O 50 success
atusDesc g transactio
n
39
Parameter Example
Type ry h on
Customer
M 64 Account
mber g 001
Number
strin Account
accountType O 25 tabungan
g type
Destinatio
destinationNu strin
O 25 n account 8377388292
mber g
number
Destinatio
destinationAc strin
O 25 n account John doe
countName g
name
Net {
amount of
n.
then DR”
value }
Deci
mal
decimal
digits.
e.g. IDR
10.000,-
will be
placed
with
10000.00
strin 0UYEB7732
sessionID O 25 Session id
g 9002HY
39
Parameter Example
Type ry h on
strin
bankCode O 8 Bank code 002
g
strin
g
{"deviceId":
"123456792
Additional
37",
"channel":
n
"mobilephon
e"}
Response Body
Parameter Example
Type ry h on
Strin Response
g code
Request has
Response
M 150 descriptio
age g processed
n
successfully
{"deviceId":
"123456792
Additional
37",
"channel":
n
"mobilephon
e"}
Contoh Request
POST …/1.0/qr/qr-mpm-notify HTTP/1.2
39
X-TIMESTAMP: 2020-12-23T08:46:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"referenceNo": "2020102977770000000009",
"destinationNumber": "8377388292",
"destinationAccountName": "John Doe",
"amount": {
"value": "50000.00",
"currency": "IDR"
},
"sessionID": "0UYEB77329002HY",
"bankCode": "002",
"currency": "IDR"
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-23T08:46:16+07:00
{
successfully",
"additionalInfo": {
"deviceId": "12345679237",
39
}
}
39
4.3.6. API Transaction Status Inquiry
Sequence Diagram
Sequence Diagram API Transaction Status Inquiry
Informasi Umum
Service Code 53
Name API Transaction Status Inquiry
Version 1.0
HTTP Method POST
Path .../{version}/qr/qr-mpm-status
Request Body
Descripti
Parameter Data Type Mandatory Length Example
on
Original
transactio
originalPar 202010290
n identifier
tnerRefere String M 64 000000000
on service
nceNo 0001
consumer
system
Original
202010297
originalRef transactio
String O 64 777000000
erenceNo n identifier
0009
on service
39
Descripti
on
provider
system
Original
External- 304437869
originalExt ID on 307227264
String O 32
ernalId header 632800979
message 20912
Transactio
n type
indicator
serviceCod (service
String M 2 17
e code of the
original
transactio
n request)
transactio
n date : 12-02-
dd-MM- 2018
transaction yyyy (mandator
String O 25
Date (Mandator y)
y) 10:18:00
HH:mm:ss (optional)
(Optional)
Net
{
amount of
amount Decimal O 18, 3 the
“value”:“10
transactio
000.00”,
n.
39
Descripti
on
If it’s IDR
then value “currency”:
includes 2 ”IDR”
decimal }
digits.
e.g. IDR
10.000,-
will be
placed
with
10000.00
{"deviceId":
"12345679
Additional
additionalI 237",
Object O informatio
nfo "channel":
n
"mobilepho
ne"}
Response Body
Parameter Example
Type ry h on
Strin Response
g code
Request has
Response
M 150 descriptio
age g processed
n
successfully
Original 2020102977
nceNo g
n 09
39
Parameter Example
Type ry h on
identifier
on service
provider
system.
Must be
filled upon
successful
transactio
n
Original
transactio
n 2020102900
rReferenceNo g
on service 01
consumer
system
Original
O 32
message 12
Transactio
n type
indicator
Strin
g
code of
the
original
40
Parameter Example
Type ry h on
transactio
n request)
00 -
Success
01 -
Initiated
02 -
Paying
03 -
latestTransa
Strin Pending
ctionStatus M 2 00
g 04 -
Refunded
05 -
Canceled
06 -
Failed
07 - Not
found
Descriptio
O 50 success
n
originalRespo Response
String O 7 2000000
nseCode code
Request has
originalRespo Response been
String O 150
nseMessage description processed
successfully
Transaction 883737GHY
invoice ID 8839
40
Parameter Example
Type ry h on
Transaction
requestID String O 25 3763773
request ID
transaction
date :
dd-MM- 12-02-2018
transactionDa yyyy (mandatory)
String O 25
te (Mandatory 10:18:00
) (optional)
HH:mm:ss
(Optional)
Net
amount of
the
transaction
{
.
If it’s IDR
“value”:“100
then value
Decim 00.00”,
amount O 18, 3 includes 2
al
decimal
“currency”:”I
digits.
DR”
e.g. IDR
}
10.000,-
will be
placed with
10000.00
{"deviceId":
Additional
"123456792
37",
n
"channel":
40
Parameter Example
Type ry h on
"mobilephon
e"}
Contoh Request
POST …/1.0/qr/qr-mpm-status HTTP/1.2
X-TIMESTAMP: 2020-12-21T18:02:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"2020102900000000000001",
"30443786930722726463280097920912",
"amount": {
“value”:“10000.00”,
}
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-21T17:55:21+07:00
40
{
successfully",
"2020102900000000000001",
"30443786930722726463280097920912",
"originalResponseCode": "2000000",
"originalResponseMessage": "Request has been
processed successfully",
"requestID": "3763773",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"additionalInfo": {
"deviceId": "12345679237",
}
}
40
5. BAGIAN V: API TRANSFER DEBIT
API Transfer Debit digunakan untuk melakukan pemindahanbukuan dana
dari satu rekening ke rekening lain baik dalam PJP AIS yang sama maupun
PJP AIS yang berbeda yang diinisiasi oleh pihak penerima (pihak terkredit).
5.1. SKENARIO PENGGUNAAN API TRANSFER DEBIT
Use Case Diagram API Transfer Debit
Merujuk pada use case diagram, pemilik rekening yaitu Konsumen, Non-PJP
Pengguna Layanan, serta PJP PIAS, dapat melakukan pemindahan dana atas
rekeningnya pada PJP AIS Bank menggunakan API Direct Debit dan API CPM.
Sedangkan pemindahbukuan dana pada rekening PJP AIS Lembaga Selain
Bank menggunakan API Direct Debit, API CPM, dan API Auth Payment.
40
API Transfer Debit dapat digunakan dalam sejumlah skema sebagai berikut:
Skema 1: Konsumen – Non-PJP Pengguna Layanan / PJP PIAS – PJP AIS

Lembaga Selain Bank
Dalam skema ini, konsumen dapat melakukan pembayaran kepada Non-PJP
Pengguna Layanan menggunakan dana yang berasal dari rekening
Konsumen pada PJP AIS Lembaga Selain Bank, menggunakan API Direct
Debit Payment atau API Auth Payment. Sebelum pendebitan dapat
dilakukan, Konsumen melakukan account binding antara rekeningnya pada
PJP AIS Lembaga Selain Bank dengan akun pada Non-PJP Pengguna
Layanan (merujuk pada Bagian I untuk account binding).
 Untuk transaksi direct debit, Non-PJP Pengguna Layanan atau PJP PIAS
mendapatkan persetujuan dari Konsumen untuk dilakukan pendebitan
(proses binding) atas kartu/rekeningnya menggunakan API enable direct
debit. Non-PJP Pengguna Layanan dapat menggunakan API disable direct
debit apabila konsumen mencabut persetujuan pendebitan
kartu/rekeningnya (proses unbinding).
 Untuk transaksi auth payment, Non-PJP Pengguna Layanan maupun PJP
PIAS dapat meminta PJP AIS untuk menahan sejumlah nominal tertentu
untuk keperluan pembelian barang dan/atau jasa yang nilainya belum
ditentukan menggunakan API Auth Payment sesuai dengan otorisasi yang
diberikan Konsumen. Pada penyelesaian transaksi, pendebitan dilakukan
sejumlah nilai transaksi menggunakan API Auth Capture, sedangkan
kelebihan nominal yang ditahan dikembalikan menggunakan API Auth
Void. Apabila terdapat kendala pada transaksi tersebut, dana yang
ditahan dapat dikembalikan menggunakan API Auth Refund.
Skema 2: Konsumen – Non-PJP Pengguna Layanan / PJP PIAS – PJP AIS

Bank
Dalam skema ini, konsumen dapat melakukan pembayaran kepada Non-PJP
Pengguna Layanan menggunakan dana yang berasal dari rekening
Konsumen pada PJP AIS Bank, menggunakan API Direct Debit Payment.
40
Sebelum pendebitan dapat dilakukan, Konsumen melakukan card
registration atau account binding antara kartu atau rekeningnya pada PJP
AIS Bank dengan akun pada Non-PJP Pengguna Layanan (merujuk pada
Bagian I untuk card registration atau account binding).
 Untuk transaksi direct debit, Non-PJP Pengguna Layanan, atau PJP PIAS
mendapatkan persetujuan dari Konsumen untuk dilakukan pendebitan
(proses binding) atas kartu/rekeningnya menggunakan API enable direct
debit. Non-PJP Pengguna Layanan dapat menggunakan API disable direct
debit apabila konsumen mencabut persetujuan pendebitan
kartu/rekeningnya (proses unbinding).
Skema 3: Konsumen – Non-PJP Pengguna Layanan – PJP AIns/PJP PIAS

– PIP (Switching) – PJP AIS Bank/PJP AIS Lembaga Selain Bank
 Skema ini merupakan transaksi menggunakan QR CPM. Konsumen dapat
melakukan pembayaran kepada Non-PJP Pengguna Layanan
menggunakan dana yang berasal dari rekening konsumen pada PJP AIS
Bank atau PJP AIS Lembaga Selain Bank, menggunakan API CPM
Payment.
 Sebelum pendebitan dapat dilakukan, konsumen memberikan otorisasi
kepada PJP AIS Bank atau PJP AIS Lembaga Selain Bank sebagai
penatausaha rekening menggunakan API Binding.
 Transaksi pembayaran ini dilakukan menggunakan QR yang dihasilkan
dari API Generate QR.
 Apabila terjadi gangguan atau kesalahan dalam bertransaksi, Non-PJP
Pengguna Layanan dapat melakukan pengecekan status transaksi
mengggunakan API Query Payment.
 Non-PJP Pengguna Layanan dapat membatalkan transaksi menggunakan
API Cancel Payment atas permintaan Konsumen.
40
Skema 4: Non-PJP Pengguna Layanan / PJP PIAS / PJP AIS Lembaga
Selain Bank – PJP AIS Bank – PIP (BI-FAST)
 Skema ini digunakan pada layanan Direct Debit BI-FAST yaitu pendebitan
secara berkala rekening nasabah tertagih oleh biller, umumnya dalam
rangka pembayaran atas penggunaan layanan (listrik, telepon, dll).
Nasabah memberikan consent pendebitan rekeningnya dalam bentuk e-
mandate.
 Registrasi e-Mandate dilakukan nasabah tertagih, dengan memberikan
informasi tagihan yang akan dibayar secara berkala. Informasi ini
diteruskan ke bank penagih untuk dilakukan validasi terkait informasi
biller.
 Direct Debit Transfer diinisiasi oleh biller dengan mengirimkan daftar
billing kepada bank. Selanjutnya bank menginisiasi debit transfer ke
bank nasabah melalui BI-Fast.
 Notify Direct Debit Transfer digunakan untuk menginformasikan status
seluruh transfer individual yang terdapat dalam direct debit message.
40
5.2. SPESIFIKASI API TRANSFER DEBIT
5.2.1. API Direct Debit
Sequence Diagram
Redirect (web check out with otp)
Sequence Diagram Redirect (web check out with otp)
40
Redirect (web check out without otp)
Sequence Diagram Redirect (web check out without otp)
41
Host to Host
Sequence Diagram API Direct Debit-Payment Host to Host
41
App Link
Sequence Diagram API Direct Debit-App Link
a. Direct Debit Payment

Informasi Umum
Service Code 54
Name API Direct Debit Payment
Version 1.0
HTTP Method POST
Path .../{version}/debit/payment-host-to-host
Request Body
Parameter Example
Type ry h on
partnerRefere Strin
M 64 n 0000000000
nceNo g
identifier 01
41
Parameter Example
Type ry h on
on service
consumer
system
Merchant
identifier
merchantId O 64
g unique 0926
per each
merchant
Sub
O 32 merchant
d g 49487
ID
Net {
amount of
n.
then DR”
value }
Deci
amount M 18,3 includes 2
mal
decimal
digits.
e.g. IDR
10.000,-
will be
placed
with
10000.00
41
Parameter Example
Type ry h on
strin
g
URL for https://part
strin
2048 payment ner.com/pa
notifyUrl g O yment/notif
notify. y
Store ID
to
indicate
externalStoreI strin to which
O 2398401982
d g 64 store 40795109
this
payment
belongs
to.
The time
when the
payment
strin 2020-12-
validUpTo will be 21T17:21:41
g O 25
automatic +07:00
ally
expired.
ISO 8601
Indicates
the URL https://part
strin of the ner.com/pa
returnUrl
g O 2048 Client’s yment/retur
app to n
redirect
back to
41
Parameter Example
Type ry h on
once
payment
has been
completed
in PJP
AIS.
used for
getting
more info
pointOfInitiati
String O 20 regarding Mobile app
on
source of
request of
the user
1. OUR
Fee is
charged to
the sender
(default)
2. BEN
Fee is
to whom charged to
feeType String O 25 the fee will the recipient
be charged 3.
SHA|1000
Fee is
shared
between
sender and
recipient,
with sender
41
Parameter Example
Type ry h on
is charged
Rp 1.000,00
and the
recipient will
be charged
the rest
{"deviceId":
"123456792
Additional
37",
"channel":
n
"mobilephon
e"}
Response Body
Parameter Example
Type ry h on
Strin Response
g code
Request has
Response
M 150 descriptio
age g processed
n
successfully
Transactio
n
identifier
2020102977
Strin on service
referenceNo C 64 7700000000
g provider
09
system.
Must be
filled upon
41
Parameter Example
Type ry h on
successful
transactio
n
Transactio
n
2020102900
O 64 0000000000
nceNo g on service
01
consumer
system
Returns
an URL
scheme to https://pjp
appRedirectUr PJP AIS ais.com/pa
string
l O 2048 payment yment/app
page in ?xxx=xxx
native
app.
Returns a
universal
link to
PJP AIS https://pjp
payment ais.com/pa
webRedirectU
page. This yment/univ
rl
link is ersal?xxx=x
recommen xx
ded when
the Client
is unable
to
41
Parameter Example
Type ry h on
implement
a
check for
whether
PJP AIS
app is
installed
on the
user’s
device
before
redirect.
{"deviceId":
"12345679
Additional
237",
"channel":
n
"mobilepho
ne"}
Contoh Request
POST …/1.0/debit/payment-host-to-host HTTP/1.2
X-TIMESTAMP: 2020-12-23T07:44:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
41
CHANNEL-ID: 95221
{
"partnerReferenceNo": "2020102900000000000001",L
"merchantId": "23489182303312",
"subMerchantId": "23489182303312",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"externalStoreId": "43980923840",
"validUpTo": "2020-12-23T07:44:11+07:00",
"currency": "IDR",
"returnUrl": "https://partner.com/payment/return",
"notifyUrl": "https://partner.com/payment/notify",
"currency": "IDR",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-23T07:44:16+07:00
{
successfully",
"referenceNo": "2020102977770000000009",
"partnerReferenceNo": "2020102900000000000001
"appRedirectUrl":
“https://pjsp.com/app?bizNo=REF993883&...
"webRedirectUrl": https://pjsp.com/universal?
bizNo=REF993883&...”
"additionalInfo": {
"deviceId": "12345679237",
}
}
41
b. Payment Status
Informasi Umum
Service Code 55
Name API Direct Debit Payment Status
Version 1.0
HTTP Method POST
Path .../{version}/debit/status
Request Body
Valu Mandato Lengt Descripti Example
Key
e ry h on
Original
transactio
n 2020102900
rReferenceNo g
on service 01
consumer
system
Original
transactio
n 2020102977
nceNo g
on service 09
provider
system
Original
3044378693
External-
originalExter Strin 0722726463
O 32 ID on
nalId g 2800979209
header
12
message
Transactio
Strin n type
serviceCode M 2 17
g indicator
(service
42
Key
e ry h on
code of
the
original
transactio
n request)
transactio
n date :
dd-MM-
12-02-2018
yyyy
transactionD Strin (mandatory)
O 25 (Mandator
ate g 10:18:00
y)
(optional)
HH:mm:s s
(Optional)
Net {
amount of
n.
then DR”
deci
amount O 18,3 value }
mal
includes 2
decimal
digits.
e.g. IDR
10.000,-
will be
placed
42
Key
e ry h on
with
10000.00
Merchant
identifier
merchantId O 64
g unique 0926
per each
merchant
Sub
O 32 merchant
d g 49487
ID
{"deviceId":
"123456792
Obje 37",
additionalInfo O
ct Additional "channel":
informatio "mobilephon
n e"}
Response Body
Parameter Example
Type ry h on
Strin Response
g code
Request has
Response
M 150 descriptio
age g processed
n
successfully
Original 2020102977
nceNo g
n 09
42
Parameter Example
Type ry h on
identifier
on service
provider
system.
Must be
filled upon
successful
transactio
n
Original
transactio
n 2020102900
rReferenceNo g
on service 01
consumer
system
Original
O 32
message 12
Transactio
n type
indicator
Strin
g
code of
the
original
42
Parameter Example
Type ry h on
transactio
n request)
00 -
Success
01 -
Initiated
02 - Paying
03 -
latestTransact
Pending
ionStatus String M 2 00
04 -
Refunded
05 -
Canceled
06 - Failed
07 - Not
found
Description
transactionSt
atusDesc
transaction
originalRespo
String M 7 Response 2000000
nseCode code
Request has
originalRespo been
String M 150 Response
nseMessage description processed
successfully
883737GHY
sessionId String O 25 Transaction
8839
invoice ID
requestID String O 25 Transaction 3763773
request ID
42
Parameter Example
Type ry h on
transaction
date :
12-02-2018
dd-MM-
transactionDa (mandatory)
String O 25 yyyy
te 10:18:00
(Mandatory
(optional)
)
HH:mm:ss
(Optional)
{"deviceId":
"123456792
37",
"channel":
Additional "mobilephon
informatio
e"}
n
Contoh Request
POST …/1.0/debit/status HTTP/1.2
X-TIMESTAMP: 2020-12-23T07:44:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
"2020102900000000000001",
42
"30443786930722726463280097920912",
"amount":{
“value”:“10000.00”,
},
"merchantId": "23489182303312",
"subMerchantId": "23489182303312",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-23T07:44:16+07:00
{
successfully",
"2020102900000000000001",
"30443786930722726463280097920912",
"originalResponseCode": "2000000",
"originalResponseMessage": "Request has been
processed successfully",
"requestID": "3763773",
"additionalInfo": {
"deviceId": "12345679237",
}
}
42
c. Payment Notify
Informasi Umum
Service Code 56
Name API Direct Debit Payment Notify
Version 1.0
HTTP Method POST
Path .../{version}/debit/notify
Request Body
Key
e ry h on
Original
transactio
n 2020102900
rReferenceNo g
on service 01
consumer
system
Original
transactio
n 2020102977
nceNo g
on service 09
provider
system
Original
originalExter Strin Customer
O 19 10052019
nalId g Reference
Number
Merchant
Strin 0000710001
merchantId O 64 identifier
g 0926
that is
42
Key
e ry h on
unique
per each
merchant
Sub
O 32 merchant
d g 49487
ID
Net
amount of
the
transactio
n.
If it’s IDR
then
value
Deci 2349810928
mal 4091284
decimal
digits.
e.g. IDR
10.000,-
will be
placed
with
10000.00
00 -
Success
latestTransa
Strin 01 -
ctionStatus M 2 00
g Initiated
02 -
Paying
42
Key
e ry h on
03 -
Pending
04 -
Refunded
05 -
Canceled
06 -
Failed
07 - Not
found
Descriptio
O 50 success
n
strin O 25 Transacti 2020-12-
g on 21T17:21:41
createdTime
created +07:00
time.
strin O 25 Transacti 2020-12-
g on 21T17:21:41
finishedTime
finished +07:00
time.
{"deviceId":
"123456792
Obje 37",
additionalInfo O
n e"}
42
Response Body
Parameter Example
Type ry h on
Strin Response
g code
Request has
Response
M 150 descriptio
age g processed
n
successfully
Contoh Request
POST …/1.0/debit/notify HTTP/1.2
X-TIMESTAMP: 2020-12-23T07:44:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"2020102900000000000001",
"30443786930722726463280097920912",
"merchantId": "23489182303312",
"subMerchantId": "23489182303312",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"createdTime": "2020-12-21T17:07:18+07:00",
43
"finishedTime": "2020-12-21T17:07:20+07:00",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-23T07:44:16+07:00
{
successfully",
}
d. Cancel Payment
Informasi Umum
Service Code 57
Name API Direct Debit Payment Cancel
Version 1.0
HTTP Method POST
Path .../{version}/debit/cancel
Request Body
Key
e ry h on
Transactio
n
2020102900
originalpartne Strin identifier
O 64 0000000000
rReferenceNo g on service
01
consumer
system
Original
O 64 n 7700000000
nceNo g
identifier 09
on service
43
Key
e ry h on
provider
system
Original
O 32
message 12
Merchant
identifier
merchantId O 64
g unique 0926
per each
merchant
Sub
O 32 merchant
d g 49487
ID
reason Strin O 256 Cancellati Network
g on timeout
reason.
{"deviceId":
"123456792
Obje 37",
additionalInfo O
n e"}
43
Response Body
Parameter Example
Type ry h on
Strin Response
g code
Request has
Response
M 150 descriptio
age g processed
n
successfully
Original
transactio
n 2020102900
rReferenceNo g
on service 01
consumer
system
Original
transactio
n 2020102977
nceNo g
on service 09
provider
system
Original
O 32
message 12
cancelTime String C 25 Cancel time

2020-10-
ISO-8601.
20T17:56:57
Must be
43
Parameter Example
Type ry h on
filled if
cancelled
transaction
success
yyyyM
transactionDa MddH 2020-10-20
O 255
te Hmms Transaction 17:56:57
s date
{"deviceId":
"123456792
37",
"channel":
Additional "mobilephon
informatio
e"}
n
Contoh Request
POST …/1.0/debit/cancel HTTP/1.2
X-TIMESTAMP: 2020-12-23T07:44:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"2020102900000000000001",
43
"30443786930722726463280097920912",
"merchantId": "23489182303312",
"subMerchantId": "23489182303312",
"reason": "Timeout",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-23T07:44:16+07:00
{
successfully",
"2020102900000000000001",
"30443786930722726463280097920912",
"cancelTime": "2020-12-21T17:07:25+07:00",
"additionalInfo": {
"deviceId": "12345679237",
}
}
e. Refund Payment
Informasi Umum
Service Code 58
Name API Direct Debit Payment Refund
Version 1.0
HTTP Method POST
Path .../{version}/debit/refund
43
Request Body
Key
e ry h on
Merchant
identifier
merchantId O 64
g unique 0926
per each
merchant
Sub
O 32 merchant
d g 49487
ID
Original
transactio
n 2020102900
rReferenceNo g
on service 01
consumer
system
Original
transactio
n 2020102977
nceNo g
on service 09
provider
system
Original
O 19 10052019
nalId g Reference
Number
43
Key
e ry h on
Reference
Number 2398509182
Strin
refundId M 64 from PJP 0498120597
g
AIS for the 0
refund.
refundAmoun Deci M 18, 3 Net {
t mal amount of “value”:“100
the 00.00”,
refund. “currency”:”I
DR”
}
Strin Refund Customer
reason O 256
g reason. complain.
{"deviceId":
"123456792
Obje 37",
additionalInfo O
n e"}
Response Body
Parameter Example
Type ry h on
Strin Response
g code
Request has
Response
M 150 descriptio
age g processed
n
successfully
43
Parameter Example
Type ry h on
Original
transactio
n 2020102900
rReferenceNo g
on service 01
consumer
system
Original
transactio
n 2020102977
nceNo g
on service 09
provider
system
Original
originalExter Customer
String O 19 10052019
nalId Reference
Number
referenceNum referenceN
String M 64 REF993883
ber umber
ReferenceN
2398509182
umber from
refundId String M 64 0498120597
PJP AIS for
0
the refund.
Net {
amount of
refundAmoun Decim
M 18, 3 the refund.
t al “value”:“100
00.00”,
43
Parameter Example
Type ry h on
“currency”:”I
DR”
}
Refund 2020-12-
refundTime String M 25 time. 21T17:21:41
ISO 8601 +07:00
Contoh Request
POST …/1.0/debit/refund HTTP/1.2
X-TIMESTAMP: 2020-12-23T07:44:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"merchantId": "23489182303312",
"subMerchantId": "23489182303312",
"2020102900000000000001",
"30443786930722726463280097920912",
refundId": "239850918204981205970",
"refundAmount": {
"value": "10000.00",
"currency": "IDR"
},
"reason": "Customer complain",
43
"additionalInfo": null
}
Contoh Response
X-TIMESTAMP: 2020-12-23T07:44:16+07:00
{
successfully",
"2020102900000000000001",
"30443786930722726463280097920912",
"partnerTrxId": "LA001",
" referenceNumber":"REF993883",
"refundId": "202010173821904898012234423",
"refundAmount": {
"value": "10000.00",
"currency": "IDR"
},
"refundTime": "2020-12-21T17:07:25+07:00",
"additionalInfo": null
}
44
5.2.2. API QR CPM
Sequence Diagram
Sequence Diagram API QR CPM
a. Generate QR
Informasi Umum
Service Code 59
Name API Generate QR CPM
Version 1.0
HTTP Method POST
Path .../{version}/qr/qr-cpm-generate
44
Request Body
Parameter Example
Type ry h on
Transactio
n
2020102900
M 64 0000000000
nceNo g on service
01
consumer
system
User
userAccessTo Strin token
M 128 xxxxxxxx
ken g binding/r
egistration
Merchant
identifier
merchantId O 64
g unique 0926
per each
merchant
Sub
O 32 merchant
d g 49487
ID
Partner 2020-12-
partnerTrxDa strin
M 64 transactio 23T07:50:11
te g
n Date +07:00
{"deviceId":
"123456792
Additional
37",
"channel":
n
"mobilephon
e"}
44
Response Body
Parameter Example
Type ry h on
Strin Response
g code
Request has
Response
M 150 descriptio
age g processed
n
successfully
Transactio
n
identifier
on service
provider 2020102977
Strin
g
Must be 09
filled upon
successful
transactio
n
Transactio
n
2020102900
partnerRefere identifier
String O 64 0000000000
nceNo on service
01
consumer
system
QR String
qrContent String O 512
CPM
URL to
PL0001
qrUrl String O 255 show QR in
web
44
Parameter Example
Type ry h on
string(25)
expiryTime String M 25 Expired QR
ISO-8601
{"deviceId":
"123456792
Additional
37",
"channel":
n
"mobilephon
e"}
Contoh Request
POST …/1.0/qr/qr-cpm-generate HTTP/1.2
X-TIMESTAMP: 2020-12-23T07:50:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"userAccessToken": "xxxxxx",
"merchantId": "8377388292",
"subMerchantId": "23489182303312",
"partnerTrxDate": "2020-12-23T07:50:11+07:00",
"additionalInfo": {
"deviceId": "12345679237",
}
}
44
Contoh Response
X-TIMESTAMP: 2020-12-23T07:50:19+07:00
{
successfully",
"referenceNo": "2020102977770000000009",
"qrContent": "hduvY...",
"qrUrl": "PL0001",
"expiryTime": "60",
"additionalInfo": {
"deviceId": "12345679237",
}
}
b. CPM Payment
Informasi Umum
Service Code 60
Name API CPM Payment
Version 1.0
HTTP Method POST
Path .../{version}/qr/qr-cpm-payment
Request Body
Parameter Example
Type ry h on
Transactio
n
2020102900
M 64 0000000000
nceNo g on service
01
consumer
system
Strin QR String
qrContent M 512 xxxxxxxx
g CPM
44
Parameter Example
Type ry h on
Net {
amount of
n.
then DR”
value }
Deci
mal
decimal
digits.
e.g. IDR
10.000,-
will be
placed
with
10000.00
{
“value”:“100
Deci Transacti 00.00”,
feeAmount O 18, 3
mal o fee
“currency”:”I
DR”
}
Merchant
Strin 0000710001
merchantId M 64 identifier
g 0926
that is
44
Parameter Example
Type ry h on
unique
per each
merchant
Sub
O 32 merchant
d g 49487
ID
merchantNa Strin Merchant
O 64 Merchant01
me g name
merchantLoc Strin Merchant Jakarta
O 64
ation g location Indonesia
Brief
Strin
title M 256 descriptio example
g
n
Num string(25)
expiryTime M 25 60
eric ISO-8601
Strin
items 1000
g
unique
Strin shop id in
storeId O 64 abcd
g merchant
side.
Strin Acquire
acquirerName O 64 LinkAja
g Name
Strin Terminal
terminalId O 32 6476378
g Id
Objec
scannerInfo O
t
The
Strin
deviceId O 64 unique 46252
g
device id.
44
Parameter Example
Type ry h on
The device
firmware
Strin
deviceVersion O 128 version, v.1.0
g
updatable
.
The device
Strin model, not
deviceModel O 128 Scanner
g updateabl
e.
The Public
IP
address
Strin when 172.24.281.
deviceIp O 64
g device 24
sends out
the
request.
{"deviceId":
"123456792
Additional
37",
"channel":
n
"mobilephon
e"}
Response Body
Parameter Example
Type ry h on
Strin Response
g code
44
Parameter Example
Type ry h on
Request has
Response
M 150 descriptio
age g processed
n
successfully
Transactio
n
identifier
on service
provider 2020102977
Strin
g
Must be 09
filled upon
successful
transactio
n
Transactio
n
2020102900
partnerRefere identifier
String O 64 0000000000
nceNo on service
01
consumer
system
yyyyM
transactionDat MddH Transaction 2020-10-
O 255
e Hmms date ISO- 20T17:56:57
s 8601
{"deviceId":
Additional
"123456792
37",
n
"channel":
44
Parameter Example
Type ry h on
"mobilephon
e"}
Contoh Request
POST …/1.0/qr/qr-cpm-payment HTTP/1.2
X-TIMESTAMP: 2020-12-23T07:54:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"qrContent": "hduvY...",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"merchantId": "23489182303312",
"subMerchantId": "23489182303312",
"title": "example",
"expiryTime": "60",
"items": {
"productId": "12345",
"productName": "goods A",
"qty": "6",
"desc": "barang"
},
"storeId": "abcd",
"merchantName": "Merchant01",
"merchantLocation": "Jakarta Indonesia",
"acquirerName": "LinkAja",
"terminalId": "6476378",
45
"scannerInfo": {
"deviceId": "46252",
"deviceVersion": "v.1.0",
"deviceModel": "Scanner",
"deviceIp": "172.24.281.24"
},
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-23T07:54:19+07:00
{
successfully",
"referenceNo": "2020102977770000000009",
"additionalInfo": {
"deviceId": "12345679237",
}
}
c. Query Payment
Informasi Umum
Service Code 61
Name API Query Payment
Version 1.0
HTTP Method POST
Path .../{version}/qr/qr-cpm-query
Request Body
Parameter Example
Type ry h on
Original 2020102977
nceNo g
n 09
45
Parameter Example
Type ry h on
identifier
on service
provider
system.
Must be
filled upon
successful
transactio
n
Original
transactio
n 2020102900
rReferenceNo g
on service 01
consumer
system
Original
O 19 10052019
nalId g Reference
Number
Merchant
identifier
merchantId O 64
g unique 0926
per each
merchant
Sub
O 32 merchant
d g 49487
ID
45
Parameter Example
Type ry h on
{"deviceId":
"123456792
Additional
37",
"channel":
n
"mobilephon
e"}
Response Body
Parameter Example
Type ry h on
Strin Response
g code
Request has
Response
M 150 descriptio
age g processed
n
successfully
Original
transactio
n 2020102977
nceNo g
on service 09
provider
system
Original
transactio
n 2020102900
rReferenceNo g
on service 01
consumer
system
45
Parameter Example
Type ry h on
Original
O 19 10052019
nalId g Reference
Number
title string M 64 Title query example
00 -
Success
01 -
Initiated
02 -
Paying
03 -
transactionSt Pending
string M 2 04 - 00
atus Refunded
05 -
Canceled
06 -
Failed
07 - Not
found
Descriptio
transactionSt
String O 50 n status success
atusDesc transactio
n
string(25) 2020-10-20
paidTime String M 25
ISO-8601 17:56:57
{"deviceId":
"123456792
Additional
37",
"channel":
n
"mobilephon
e"}
45
Contoh Request
POST …/1.0/qr/qr-cpm-query HTTP/1.2
X-TIMESTAMP: 2020-12-23T08:04:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"2020102900000000000001",
" originalExternalId": "10052019",
"merchantId": "29291921212",
"subMerchantId": "23489182303312",
"additionalInfo": {
"deviceId": "12345679237",
}
}
45
Contoh Response
X-TIMESTAMP: 2020-12-23T08:04:18+07:00
{
successfully",
"2020102900000000000001",
" originalExternalId": "10052019",
"title": "example",
"paidTime": "2020-12-23T08:04:11+07:00",
"additionalInfo": {
"deviceId": "12345679237",
}
}
45
d. Cancel Payment
Informasi Umum
Service Code 62
Name API Cancel Payment
Version 1.0
HTTP Method POST
Path .../{version}/qr/qr-cpm-cancel
Request Body
Parameter Example
Type ry h on
Original
transactio
n 2020102900
rReferenceNo g
on service 01
consumer
system
Original
transactio
n 2020102977
nceNo g
on service 09
provider
system
Original
O 32
message 12
Merchant
Strin 0000710001
g 0926
that is
45
Parameter Example
Type ry h on
unique
per each
merchant
Sub
O 32 merchant
d g 49487
ID
Net {
amount of
n.
then DR”
value }
Deci
mal
decimal
digits.
e.g. IDR
10.000,-
will be
placed
with
10000.00
Reason
strin cancel
reason M 512 cancellatio
g reason
n
{"deviceId":
Additional
"123456792
37",
n
"channel":
45
Parameter Example
Type ry h on
"mobilephon
e"}
Response Body
Parameter Example
Type ry h on
Strin Response
g code
Request has
Response
M 150 descriptio
age g processed
n
successfully
Original
transactio
n 2020102900
rReferenceNo g
on service 01
consumer
system
Original
transactio
n 2020102977
nceNo g
on service 09
provider
system
Original 3044378693
originalExtern External-ID 0722726463
String O 32
alId on header 2800979209
message 12
45
Parameter Example
Type ry h on
cancelTime String C 25 Cancel time

ISO-8601.
Must be
2020-10-
filled if
20T17:56:57
cancelled
transaction
success
yyyyM
transactionDa MddH 2020-10-20
O 255
te Hmms Transaction 17:56:57
s date
{"deviceId":
"123456792
Additional
37",
"channel":
n
"mobilephon
e"}
Contoh Request
POST …/1.0/qr/qr-cpm-cancel HTTP/1.2
X-TIMESTAMP: 2020-12-23T08:10:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
46
CHANNEL-ID: 95221
{
"2020102900000000000001",
"30443786930722726463280097920912",
"merchantId": "29291921212",
"subMerchantId": "23489182303312",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"reason": "cancel reason",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-23T08:10:18+07:00
{
successfully",
"2020102900000000000001",
"30443786930722726463280097920912",
"cancelTime": "2020-12-21T17:07:25+07:00",
"additionalInfo": {
"deviceId": "12345679237",
}
}
46
5.2.3. API Auth Payment
Sequence Diagram
Sequence Diagram API Auth Payment
a. API Auth Payment

Informasi Umum
Service Code 63
Name API Auth Payment
Version 1.0
HTTP Method GET
Path .../{version}/auth/payment
46
Request Body
Parameter Example
Type ry h on
Transactio
n
2020102900
M 64 0000000000
nceNo g on service
01
consumer
system
Merchant
identifier
merchantId M 64
g unique 0926
per each
merchant
Sub
O 32 merchant
d g 49487
ID
Net {
amount of
n.
Deci then DR”
amount M 18, 3
mal value }
includes 2
decimal
digits.
e.g. IDR
10.000,-
will be
46
Parameter Example
Type ry h on
placed
with
10000.00
1. OUR
Fee is
charged to
the sender
(default)
2. BEN
Fee is
charged to
the recipient
3.
to whom
SHA|1000
Strin the fee
feeType O 25 Fee is
g will be
shared
charged
between
sender and
recipient,
with sender
is charged
Rp 1.000,00
and the
recipient will
be charged
the rest
Merchant’
Strin
mcc O 32 s 5743
g
category.
46
Parameter Example
Type ry h on
Product
code to
identify
which
Strin 2938409182
productCode M 64 product
g 03
used for
this
particular
payment.
Ikan bakar
Strin Order
title M 256 bumbu
g title.
kuning
{
“goodsId“:”9
08132”,
“price“:{“curr
ency“:”360”,
Purchased
”value”:”100
List< goods/ser
00”},
items Good O N/A vice
“category“:”f
s> informatio
ood”,
n.
“unit“:”ekor”
,
“quantity“:”2
”
}
{"deviceId":
Additional
Obje "123456792
additionalInfo O informatio
ct 37",
n
"channel":
46
Parameter Example
Type ry h on
"mobilephon
e"}
Response Body
Parameter Example
Type ry h on
Strin Response
g code
Request has
Response
M 150 descriptio
age g processed
n
successfully
Transactio
n
identifier
on service
provider 2020102977
Strin
g
Must be 09
filled upon
successful
transactio
n
Transactio
n
2020102900
O 64 0000000000
nceNo g on service
01
consumer
system
46
Parameter Example
Type ry h on
Net {
amount of
n.
then DR”
value }
Deci
mal
decimal
digits.
e.g. IDR
10.000,-
will be
placed
with
10000.00
Transactio 2009-07-
Strin
paidTime M 25 n paid 03T12:08:56
g
time. -07:00
{"deviceId":
"123456792
Additional
Obje 37",
ct "channel":
n
"mobilephon
e"}
46
Contoh Request
POST …/1.0/auth/payment HTTP/1.2
X-TIMESTAMP: 2020-12-23T08:58:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"merchantId": "23489182303312",
"subMerchantId": "23489182303312",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"mcc": "5743",
"productCode": "293840918203",
"title": "Ikan bakar bumbu kuning",
"items": {
"goodsId": "908132",
"price": {
"value": "10000.00"
"currency": "IDR"
},
"category": "food"
"unit": "ekor",
"quantity": "2"
},
"additionalInfo": {
"deviceId": "12345679237",
}
}
46
Contoh Response
X-TIMESTAMP: 2020-12-23T08:58:19+07:00
{
successfully",
"referenceNo": "2020102977770000000009",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"paidTime": "2020-12-23T08:58:11+07:00",
"additionalInfo": {
"deviceId": "12345679237",
}
}
b. API Payment Query

Informasi Umum
Service Code 64
Name API Payment Query
Version 1.0
HTTP Method GET
Path .../{version}/auth/query
Request Body
Parameter Example
Type ry h on
Transactio
n
2020102900
M 64 0000000000
nceNo g on service
01
consumer
system
Merchant
Strin 0000710001
g 0926
that is
46
Parameter Example
Type ry h on
unique
per each
merchant
Sub
O 32 merchant
d g 49487
ID
{"deviceId":
"123456792
Additional
Obje 37",
ct "channel":
n
"mobilephon
e"}
Response Body
Parameter Example
Type ry h on
Strin Response
g code
Request has
Response
M 150 descriptio
age g processed
n
successfully
Transactio
n
2020102900
O 64 0000000000
nceNo g on service
01
consumer
system
Deci Net {
amount M 18, 3
mal amount of
47
Parameter Example
Type ry h on
the
transactio “value”:“100
n. 00.00”,
If it’s IDR
then “currency”:”I
value DR”
includes 2 }
decimal
digits.
e.g. IDR
10.000,-
will be
placed
with
10000.00
paidTime Strin M 25 Transacti 2009-07-
g on paid 03T12:08:56
time. -07:00
transactionSt Strin M 2 00 - 00
atus g Success
01 -
Initiated
02 -
Paying
03 -
Pending
04 -
Refunded
05 -
Canceled
47
Parameter Example
Type ry h on
06 -
Failed
07 - Not
found
Descriptio
O 50 success
n
{"deviceId":
"123456792
Additional
Obje 37",
ct "channel":
n
"mobilephon
e"}
Contoh Request
POST …/1.0/auth/query HTTP/1.2
X-TIMESTAMP: 2020-12-23T09:10:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"merchantId": "23489182303312",
"subMerchantId": "23489182303312",
47
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-23T09:10:18+07:00
{
successfully",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"paidTime": "2020-12-23T08:58:11+07:00",
"additionalInfo": {
"deviceId": "12345679237",
}
}
c. API Capture
Informasi Umum
Service Code 65
Name API Capture
Version 1.0
HTTP Method GET
Path .../{version}/auth/capture
Request Body
Parameter Example
Type ry h on
Strin
referenceNo M 64 n 7700000000
g
identifier 09
47
Parameter Example
Type ry h on
on service
provider
system
Transactio
n
2020102900
M 64 0000000000
nceNo g on service
01
consumer
system
Merchant
identifier
merchantId M 64
g unique 0926
per each
merchant
Sub
O 32 merchant
d g 49487
ID
captureAmou Strin M N/A Capture {
nt g amount. “currency“:”
360”,
“value“:”100
00”
}
title Strin M 256 Capture Confirmed.
g title.
lastCapture Strin O 8 Flag to TRUE
g determine
whether
this is the
47
Parameter Example
Type ry h on
last
capture
and void
the rest of
the
money if
there’s
any
money
left.
{"deviceId":
"123456792
Additional
Obje 37",
ct "channel":
n
"mobilephon
e"}
Response Body
Parameter Example
Type ry h on
Strin Response
g code
Request has
Response
M 150 descriptio
age g processed
n
successfully
Transactio
n 2020102977
Strin
referenceNo C 64 identifier 7700000000
g
on service 09
provider
47
Parameter Example
Type ry h on
system.
Must be
filled upon
successful
transactio
n
Transactio
n
2020102900
O 64 0000000000
nceNo g on service
01
consumer
system
captureId Strin M 64 PJSP’s 2020101738
g capture 2190489801
identifier. 2234423
Used to
trace the
capture
when
there’s
any issue
occurred.
captureAmou Mone M N/A Capture {
nt y amount. “currency“:”
360”,
“value“:”100
00”
}
47
Parameter Example
Type ry h on
captureTime Strin M 25 Capture 2009-07-
g time. 03T12:08:56
-07:00
{"deviceId":
"123456792
Additional
Obje 37",
ct "channel":
n
"mobilephon
e"}
Contoh Request
POST …/1.0/auth/capture HTTP/1.2
X-TIMESTAMP: 2020-12-23T09:12:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"referenceNo": "2020102977770000000009",
"merchantId": "23489182303312",
"subMerchantId": "23489182303312",
"captureAmount": {
"value": "10000.00",
"currency": "IDR"
},
"title": "Confirmed",
"lastCapture": "TRUE",
47
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-23T09:12:18+07:00
{
successfully",
"referenceNo": "2020102977770000000009",
"captureId": "202010173821904898012234423",
"captureAmount": {
"value": "10000.00",
"currency": "IDR"
},
"captureTime": "2020-12-23T09:12:11+07:00",
"additionalInfo": {
"deviceId": "12345679237",
}
}
d. API Capture Query

Informasi Umum
Service Code 66
Name API Capture Query
Version 1.0
HTTP Method GET
Path .../{version}/auth/capture-query
Request Body
Parameter Example
Type ry h on
Transactio
2020102977
Strin n
referenceNo O 64 7700000000
g identifier
09
on service
47
Parameter Example
Type ry h on
provider
system
Transactio
n
2020102900
M 64 0000000000
nceNo g on service
01
consumer
system
Merchant
identifier
merchantId M 64
g unique 0926
per each
merchant
Sub
O 32 merchant
d g 49487
ID
captureId Strin O 64 PJSP’s 2020101738
g capture 2190489801
identifier. 2234423
Used to
trace the
payment
when
there’s
any issue
occurred.
Obje
additionalInfo O informatio "123456792
ct
n 37",
47
Parameter Example
Type ry h on
"channel":
"mobilephon
e"}
Response Body
Data Mandator Descripti
Type y on
Response
code
Request has
Response
responseMess been
String M 150 descriptio
age processed
n
successfully
Transactio
n
identifier
on service
provider 2020102977
Must be 09
filled upon
successful
transactio
n
Transactio
n
2020102900
partnerReferen identifier
String O 64 0000000000
ceNo on service
01
consumer
system
48
Data Mandator Descripti
Type y on
captureId String M 64 PJSP’s 2020101738
capture 2190489801
identifier. 2234423
Used to
trace the
capture
when
there’s
any issue
occurred.
captureAmoun Money M N/A Capture {
t amount. “currency“:”
360”,
“value“:”100
00”
}
captureTime String M 25 Capture 2009-07-
time. 03T12:08:56
-07:00
captureStatus String M 32 Capture INIT,
status. SUCCESS,
FAILED.
{"deviceId":
"123456792
Additional
37",
"channel":
n
"mobilephon
e"}
48
Contoh Request
POST …/1.0/auth/capture-query HTTP/1.2
X-TIMESTAMP: 2020-12-23T09:15:11+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"referenceNo": "2020102977770000000009",
"merchantId": "23489182303312",
"subMerchantId": "23489182303312",
"captureId": "202010173821904898012234423",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-23T09:15:17+07:00
{
successfully",
"referenceNo": "2020102977770000000009",
"captureId": "202010173821904898012234423",
"captureAmount": {
"value": "10000.00",
"currency": "IDR"
},
"captureTime": "2020-12-23T09:15:11+07:00",
"captureStatus": "SUCCESS"
48
"additionalInfo": {
"deviceId": "12345679237",
}
}
e. API Void
Informasi Umum
Service Code 67
Name API Void
Version 1.0
HTTP Method GET
Path .../{version}/auth/void
Request Body
Parameter Example
Type ry h on
Transactio
n
2020102977
identifier
referenceNo String O 64 7700000000
on service
09
provider
system
Transactio
n
2020102900
partnerRefe identifier
String M 64 0000000000
renceNo on service
01
consumer
system
Merchant
identifier
that is 0000710001
unique 0926
per each
merchant
48
Parameter Example
Type ry h on
Sub
subMercha 3109289249
String O 32 merchant
ntId 49487
ID
voidAmoun Money M N/A Void {
360”,
“value“:”100
00”
}
voidRemain String O 8 Flag to TRUE
ingAmount determine
whether
this is the
last void
and void
the rest of
the
money.
reason String O 256 Capture Shorter
title. period/dista
nce.
{"deviceId":
"123456792
Additional
additionalI 37",
Object O informatio
nfo "channel":
n
"mobilephon
e"}
48
Response Body
Parameter Example
Type ry h on
Strin Response
g code
Request has
Response
responseMessag Strin been
M 150 descriptio
e g processed
n
successfully
Transactio
n
identifier
on service
provider 2020102977
Strin
g
Must be 09
filled upon
successful
transactio
n
Transactio
n
2020102900
partnerReferenc Strin identifier
O 64 0000000000
eNo g on service
01
consumer
system
voidId Strin M 64 PJSP’s 2020101738
g void 2190489801
identifier. 2234423
Used to
trace the
capture
48
Parameter Example
Type ry h on
when
there’s
any issue
occurred.
voidAmount Mone M N/A Void {
y amount. “currency“:”
360”,
“value“:”100
00”
}
voidTime Strin M 25 Void time. 2009-07-
g 03T12:08:56
-07:00
{"deviceId":
"123456792
Additional
Obje 37",
ct "channel":
n
"mobilephon
e"}
Contoh Request
POST …/1.0/auth/void HTTP/1.2
X-TIMESTAMP: 2020-12-23T09:19:47+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
48
CHANNEL-ID: 95221
{
"referenceNo": "2020102977770000000009",
"merchantId": "23489182303312",
"subMerchantId": "23489182303312",
"voidAmount": {
"value": "10000.00",
"currency": "IDR"
},
"voidRemainingAmount": "TRUE",
"reason": "Shorter period/distance.",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-23T09:19:56+07:00
{
successfully",
"referenceNo": "2020102977770000000009",
"voidId": "202010173821904898012234423",
"voidAmount": {
"value": "10000.00",
"currency": "IDR"
},
"voidTime": "2020-12-23T09:19:47+07:00",
"additionalInfo": {
"deviceId": "12345679237",
}
}
48
f. API Void Query
Informasi Umum
Service Code 68
Name API Void Query
Version 1.0
HTTP Method GET
Path .../{version}/auth/void-query
Request Body
Parameter Example
Type ry h on
Transactio
n
2020102977
Strin identifier
referenceNo O 64 7700000000
g on service
09
provider
system
Transactio
n
2020102900
M 64 0000000000
nceNo g on service
01
consumer
system
Merchant
identifier
merchantId M 64
g unique 0926
per each
merchant
Sub
O 32 merchant
d g 49487
ID
48
Parameter Example
Type ry h on
voidId Strin O 64 PJSP’s 2020101738
g void 2190489801
identifier. 2234423
Used to
trace the
payment
when
there’s
any issue
occurred.
{"deviceId":
"123456792
Additional
Obje 37",
ct "channel":
n
"mobilephon
e"}
Response Body
Parameter Example
Type ry h on
Strin Response
g code
Request has
Response
M 150 descriptio
e g processed
n
successfully
Transactio
2020102977
Strin n
g identifier
09
on service
48
Parameter Example
Type ry h on
provider
system.
Must be
filled upon
successful
transactio
n
Transactio
n
2020102900
partnerReferenc Strin identifier
O 64 0000000000
eNo g on service
01
consumer
system
voidId Strin M 64 PJSP’s 2020101738
g void 2190489801
identifier. 2234423
Used to
trace the
capture
when
there’s
any issue
occurred.
voidAmount Mone M N/A Void {
y amount. “currency“:”
360”,
“value“:”100
00”
}
49
Parameter Example
Type ry h on
voidTime Strin M 25 Void time. 2009-07-
g 03T12:08:56
-07:00
voidStatus Strin M 32 Void INIT,
g status. SUCCESS,
FAILED.
{"deviceId":
"123456792
Additional
Obje 37",
ct "channel":
n
"mobilephon
e"}
Contoh Request
POST …/1.0/auth/void-query HTTP/1.2
X-TIMESTAMP: 2020-12-23T09:22:47+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"referenceNo": "2020102977770000000009",
"merchantId": "23489182303312",
"subMerchantId": "23489182303312",
"voidId": "202010173821904898012234423",
"additionalInfo": {
49
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-23T09:22:56+07:00
{
successfully",
"referenceNo": "2020102977770000000009",
"voidId": "202010173821904898012234423",
"voidAmount": {
"value": "10000.00",
"currency": "IDR"
},
"voidTime": "2020-12-23T09:19:47+07:00",
"voidStatus": "SUCCESS"
"additionalInfo": {
"deviceId": "12345679237",
}
}
g. API Refund
Informasi Umum
Service Code 69
Name API Refund
Version 1.0
HTTP Method GET
Path .../{version}/auth/refund
Request Body
Parameter Example
Type ry h on
Transactio
2020102900
partnerRefere n
String M 64 0000000000
nceNo identifier
01
on service
49
Parameter Example
Type ry h on
consumer
system
Merchant
identifier
that is 0000710001
unique 0926
per each
merchant
Sub
subMerchantI 3109289249
String O 32 merchant
d 49487
ID
captureId String M 64 PJSP’s 2020101738
capture 2190489801
identifier. 2234423
Used to
trace the
payment
when
there’s
any issue
occurred.
refundAmoun Money M N/A Refund {
360”,
“value“:”100
00”
}
reason String M 256 Refund Customer
reason. complain.
49
Parameter Example
Type ry h on
{"deviceId":
"123456792
Additional
37",
"channel":
n
"mobilephon
e"}
Response Body
Parameter Example
Type ry h on
Strin Response
g code
Request has
Response
M 150 descriptio
age g processed
n
successfully
Transactio
n
identifier
on service
provider 2020102977
Strin
g
Must be 09
filled upon
successful
transactio
n
partnerRefere Strin
O 64 n 0000000000
nceNo g
identifier 01
49
Parameter Example
Type ry h on
on service
consumer
system
refundId Strin M 64 PJSP’s 2020101738
g refund 2190489801
identifier. 2234423
Used to
trace the
capture
when
there’s
any issue
occurred.
refundAmoun Mone M N/A Refund {
t y amount. “currency“:”
360”,
“value“:”100
00”
}
refundTime Strin M 25 Refund 2020-12-
g time. 23T09:19:47
+07:00
{"deviceId":
"123456792
Additional
Obje 37",
ct "channel":
n
"mobilephon
e"}
49
Contoh Request
POST …/1.0/auth/refund HTTP/1.2
X-TIMESTAMP: 2020-12-23T09:22:47+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"merchantId": "23489182303312",
"subMerchantId": "23489182303312",
"captureId": "202010173821904898012234423",
"refundAmount": {
"value": "10000.00",
"currency": "IDR"
},
"reason": "refund reason",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-23T09:22:56+07:00
{
successfully",
"referenceNo": "2020102977770000000009",
"refundId": "202010173821904898012234423",
"refundAmount": {
"value": "10000.00",
49
"currency": "IDR"
},
"refundTime": "2020-12-23T09:19:47+07:00",
"additionalInfo": {
"deviceId": "12345679237",
}
}
49
5.2.4. API Direct Debit BI-FAST
a. Registrasi E-Mandate
Sequence Diagram
Sequence Diagram API Registrasi e-Mandate
Informasi Umum
Service Code 70
Name API Registrasi e-Mandate
Version 1.0
HTTP Method POST
Path .../{version}/debit/fast-emandate
Request Body
Parameter Example
Type ry h on
Transactio
2020102900
partnerReferen Strin n
M 64 0000000000
ceNo g identifier
01
on service
49
Parameter Example
Type ry h on
consumer
system
Biller
bank code
Strin based on
bankCode M 3 014
g Bank
Indonesia
Code
Account
sourceAccount Strin 8888010001
M 19 number to
No g 57508
be billed
Source
sourceAccount Strin
M 100 Account Saving
Name g
Name
Strin Currency
currency O 3 IDR
g Type
Maximum {
amount to
be paid. “value”:“100
If it’s IDR 00.00”,
then
value “currency”:”I
Deci
maxAmount M 18, 3 includes 2 DR”
mal
decimal }
digits.
e.g. IDR
10.000,-
will be
placed
49
Parameter Example
Type ry h on
with
10000.00
Unique ID 315134
Strin
billerID M 30 to identify
g
biller
Strin Biller biller X

billerName M 50
g name
Customer 96891414
Strin ID
customerId M 45
g registered
on biller
DateTime
e- with
Follow Mandate timezone,
expiredDateti Datet
M s ISO- expiration which
me ime
8601 date and follows the
time ISO-8601
standard
Additional
Obje
additionalInfo O informatio …
ct
n
Response Body
Parameter Example
Type ry h on
Strin Response
g code
50
Parameter Example
Type ry h on
Request has
Response
M 150 descriptio
e g processed
n
successfully
Transactio
n
identifier
on service
provider 2020102977
Strin
g
Must be 09
filled upon
successful
transactio
n
Transactio
n
2020102900
partnerReference Strin identifier
O 64 0000000000
No g on service
01
consumer
system
Unique
key to
identify 9a8fau6d81
Strin
eMandateReffId M 30 an e- had833bas7
g
Mandate 184
registratio
n
50
Parameter Example
Type ry h on
{"deviceId":
"123456792
Additional
Obje 37",
ct "channel":
n
"mobilephon
e"}
Contoh Request
POST …/1.0/debit/fast-emandate HTTP/1.2
X-TIMESTAMP: 2020-12-22T08:12:16+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"bankCode": "014",
"sourceAccountName": "Saving",
"currency": "IDR",
"maxAmount": {
"value": "10000.00",
"currency": "IDR"
},
"billerId": "315134",
"billerName": "biller X",
"customerId": "96891414",
"expiredDatetime": "2022-12-22T08:01:16+07:00"
"additionalInfo": {
"deviceId": "12345679237",
50
}
}
Contoh Response
X-TIMESTAMP: 2020-12-22T08:12:22+07:00
{
successfully",
"referenceNo": "2020102977770000000009",
"eMandateReffId": "9a8fau6d81had833bas7184",
"additionalInfo": {
"deviceId": "12345679237",
}
}
b. Trigger Direct Debit Transfer

Sequence Diagram
Sequence Diagram API Trigger Direct Debit Transfer
50
Informasi Umum
Service Code 71
Name API Registrasi e-Mandate
Version 1.0
HTTP Method POST
Path .../{version}/debit/fast-payment
Request Body
Data Mandat Lengt Descripti
Parameter Example
Type ory h on
Transactio
n
2020102900
partnerReference Strin identifier
M 64 0000000000
No g on service
01
consumer
system
Strin Currency
currency O 3 IDR
g Type
Reference
Number /
customerReferen Strin No
M 30 10052019
ce g Referral /
Transacti
on ID
1. OUR
Fee is
charged to
to whom
the sender
Strin the fee
feeType O 25 (default)
g will be
2. BEN
charged
Fee is
charged to
the recipient
50
Parameter Example
Type ory h on
3.
SHA|1000
Fee is
shared
between
sender and
recipient,
with sender
is charged
Rp 1.000,00
and the
recipient will
be charged
the rest
Remark/tr
Strin ansaction
remark O 50 remark test
g descriptio
n
beneficiaryAccou Strin Biller 8888010001

M 19
ntNo g account 57508
Biller
beneficiaryAccou Strin account
M 100 Saving
ntName g Account
Name
transactio 12-02-2018
Strin n date : (mandatory)
transactionDate M 25
g dd-MM- 10:18:00
yyyy (optional)
50
Parameter Example
Type ory h on
(Mandator
y)
HH:mm:s
s
(Optional)
Bank
code
Strin based on
bankCode M 3 014
g Bank
Indonesia
Code
Debited
8888010000
sourceAccountN Strin customer
M 34 03301
o g account
number
Debited
sourceAccountN Strin customer
M 100 Saving
ame g account
Name
Debit
amount. {
If it’s IDR
then value “value”:“100
Deci includes 2 00.00”,
amount M 18, 3
mal decimal
digits. “currency”:”I
e.g. IDR DR”
10.000,- }
will be
50
Parameter Example
Type ory h on
placed
with
10000.00
Unique
key to
identify 9a8fau6d81
Strin
eMandateReffId M 30 an e- had833bas7
g
Mandate 184
registratio
n
{"deviceId":
"123456792
Additional
Obje 37",
ct "channel":
n
"mobilephon
e"}
Response Body
Parameter Example
Type ry h on
Strin Response
g code
Request has
Response
M 150 descriptio
e g processed
n
successfully
Transactio
2020102977
Strin n
g identifier
09
on service
50
Parameter Example
Type ry h on
provider
system.
Must be
filled upon
successful
transactio
n
Transactio
n
2020102900
partnerReferenc identifier
String O 64 0000000000
eNo on service
01
consumer
system
{"deviceId":
"123456792
Additional
37",
"channel":
n
"mobilephon
e"}
Contoh Request
POST …/1.0/debit/fast-payment HTTP/1.2
X-TIMESTAMP: 2020-12-22T08:26:16+07:00
X-SIGNATURE:
61b19a5
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
50
CHANNEL-ID: 95221
{
"currency": "IDR",
"feeType": "BEN",
"bankCode": "014",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-22T08:26:30+07:00
{
successfully",
"referenceNo": "2020102977770000000009",
"additionalInfo": {
"deviceId": "12345679237",
}
}
50
c. Notify
Sequence Diagram
Sequence Diagram API Notify - Direct Debit
Informasi Umum
Service Code 72
Name API Notify
Version 1.0
HTTP Method POST
Path .../{version}/debit/fast-notify
Request Body
Data Mandator Lengt Descripti
Parameter Example
Type y h on
Original
transaction
2020102977
originalReferenc identifier
String M 64 7700000000
eNo on service
09
provider
system
Original
transaction
2020102900
originalPartner identifier
String M 64 0000000000
ReferenceNo on service
01
consumer
system
51
Parameter Example
Type y h on
Original
originalExterna Customer
String O 19 10052019
lId Reference
Number
transactionSta Strin M 2 00 - 00
tus g Success
01 -
Initiated
02 -
Paying
03 -
Pending
04 -
Refunded
05 -
Canceled
06 -
Failed
07 - Not
found
Descriptio
transactionSta Strin n status
O 50 success
tusDesc g transactio
n
Unique
key to 9a8fau6d81
Strin
eMandateReffId M 30 identify had833bas7
g
an e- 184
Mandate
51
Parameter Example
Type y h on
registratio
n
Debited
8888010000
sourceAccount Strin customer
M 34 03301
No g account
number
Debited
sourceAccount Strin customer
M 100 Saving
Name g account
Name
Net {
amount of
transaction 00.00”,
.
then value DR”
Decim
amount M 18, 3 includes 2 }
al
decimal
digits.
e.g. IDR
10.000,-
will be
placed with
10000.00
Number for
tracking to
destination
bank
51
Parameter Example
Type y h on
{"deviceId":
"123456792
Additional
37",
"channel":
n
"mobilephon
e"}
Response Body
Parameter Example
Type ry h on
Strin Response
g code
Request has
Response
M 150 descriptio
e g processed
n
successfully
{"deviceId":
"123456792
Additional
37",
"channel":
n
"mobilephon
e"}
Contoh Request
POST …/1.0/debit/fast-notify HTTP/1.2
X-TIMESTAMP: 2020-12-22T08:26:16+07:00
X-SIGNATURE:
61b19a5
51
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
CHANNEL-ID: 95221
{
"2020102900000000000001",
"originalExternalId": "10052019",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"traceNo": "13415141",
"additionalInfo": {
"deviceId": "12345679237",
}
}
Contoh Response
X-TIMESTAMP: 2020-12-22T08:26:30+07:00
{
successfully",
"additionalInfo": {
"deviceId": "12345679237",
}
}
51
6. Bagian VI: Response Code
Response status merupakan informasi yang diberikan oleh service provider
kepada service consumer pada response body, sebagai indikasi hasil dari
pemrosesan request yang diterima.
Response status terdiri dari 2 komponen, yaitu kode (response code) dan
deskripsinya (response message).
Tipe
Komponen Length Keterangan
Data
response code = HTTP status code
responseCode String 7
+ service code + case code
responseMessage String 150
Daftar Response Code

HTTP Service Case Response
Category Code Code Code Message Description
Success 200 any 00 Successful Successful
Request In Transaction still on
Success 202 any 00 Progress process
General request failed
System 400 any 00 Bad Request error, including message
parsing failed.
Invalid Field
Message 400 any 01 Format {field Invalid format
name}
Invalid
Mandatory Missing or invalid format
Message 400 any 02
Field {field on mandatory field
name}
General unauthorized
error (No Interface Def,
API is Invalid, Oauth
Unauthorized Failed, Verify Client
System 401 any 00
. [reason] Secret Fail, Client
Forbidden Access API,
Unknown Client, Key not
Found)
Token found in request is
Invalid Token invalid (Access Token Not
System 401 any 01
(B2B) Exist, Access Token
Expiry)
51
Token found in request is
Invalid
invalid (Access Token Not
System 401 any 02 Customer
Exist, Access Token
Token Expiry)
Token not found in the
Token Not system. This occurs on
System 401 any 03
Found (B2B) any API that requires
token as input parameter
Token not found in the
Customer
system. This occurs on
System 401 any 04 Token Not
any API that requires
Found token as input parameter
Transaction
Business 403 any 00 Transaction expired
Expired
This merchant is not
Feature Not
System 403 any 01 allowed to call Direct
Allowed
Debit APIs
Exceeds
Exceeds Transaction
Business 403 any 02 Transaction
Amount Limit Amount Limit
Suspected
Business 403 any 03 Fraud Suspected Fraud
Activity Too many request,
Business 403 any 04 Count Limit Exceeds Transaction
Exceeded Frequency Limit
Account or User status is
Business 403 any 05 Do Not Honor abnormal
Feature Not
Allowed At
System 403 any 06 Cut off In Progress
This Time.
[reason]
The payment card is
Business 403 any 07 Card Blocked blocked
The payment card is
Business 403 any 08 Card Expired expired
Dormant
Business 403 any 09 The account is dormant
Account
Need To Set
Business 403 any 10 Need to set token limit
Token Limit
System 403 any 11 OTP Blocked OTP has been blocked
OTP Lifetime
System 403 any 12 Expired OTP has been expired
OTP Sent To initiates request OTP to
System 403 any 13
Cardholer the issuer
Insufficient
Business 403 any 14 Insufficient Funds
Funds
51
Transaction Transaction Not
Business 403 any 15 Not Permitted Permitted
Suspend
Business 403 any 16 Transaction Suspend Transaction
Purchase amount
Token Limit
Business 403 any 17 exceeds the token limit
Exceeded set prior
Inactive
Indicates inactive
Business 403 any 18 Card/Accoun
t/Customer account
Merchant Merchant is suspended
Business 403 any 19
Blacklisted from calling any APIs
Merchant aggregated
Merchant purchase amount on that
Business 403 any 20
Limit Exceed day exceeds the agreed
limit
Set Limit Not Set limit not allowed on
Business 403 any 21
Allowed particular token
The token limit desired
by the merchant is not
Token Limit
Business 403 any 22 within the agreed range
Invalid
between the merchant
and the Issuer
Invalid
Business 404 any 00 Transaction Invalid transaction status
Status
Transaction
Business 404 any 01 Not Found Transaction not found
Invalid
System 404 any 02 Routing Invalid Routing
Bank Not
Bank not supported by
System 404 any 03 Supported By
Switch switch
Transaction Transaction is cancelled
Business 404 any 04
Cancelled by customer
Merchant Is
Not
Merchant is not
Registered
Business 404 any 05 registered for Card
For Card
Registration services
Registration
Services
Need To
System 404 any 06 Request OTP Need to request OTP
Journey Not The journeyID cannot be
System 404 any 07
Found found in the system
51
Invalid Merchant does not exist
Business 404 any 08 Merchant or status abnormal
Business 404 any 09 No Issuer No issuer
Invalid API Invalid API transition
System 404 any 10 Transition within a journey
Invalid Card information may be
Card/Accoun invalid, or the card
Business 404 any 11
t/Customer account may be
[info] blacklisted.
The bill is
Business 404 any 12 Invalid Bill blocked/expired/suspend
ed/not found
The amount doesn't
Invalid
Business 404 any 13 match with what
Amount supposed to
Business 404 any 14 Paid Bill The bill has been paid
System 404 any 15 Invalid OTP OTP is incorrect
Partner Not Partner number can't be
Business 404 any 16 Found found
Invalid Terminal does not exist in
Business 404 any 17
Terminal the system
Inconsistent request
Inconsistent parameter found for the
Business 404 any 18
Request same partner reference
number/transaction id
Requested
Function Is Requested function is not
System 405 any 00
Not supported
Supported
Requested operation to
Requested
cancel/refund
Business 405 any 01 Opearation Is
transaction Is not allowed
Not Allowed at this time.
Cannot use same X-
System 409 any 00 Conflict EXTERNAL-ID in same
day
Too Many Maximum transaction
System 429 any 00 Requests limit exceeded
System 500 any 00 General Error General Error
System 504 any 00 Timeout timeout from the issuer
51
-Halaman akhir-
51

SNAP StandarDataSpesifikasiTeknis

Diunggah oleh

Informasi Dokumen

Judul Asli

Hak Cipta

Format Tersedia

Bagikan dokumen Ini

Bagikan atau Tanam Dokumen

Opsi Berbagi

Apakah menurut Anda dokumen ini bermanfaat?

Apakah konten ini tidak pantas?

Hak Cipta:

Format Tersedia

SNAP StandarDataSpesifikasiTeknis

Diunggah oleh

Hak Cipta:

Format Tersedia

Standar Nasional Open API Pembayaran

(Standar Data dan Spesifikasi Teknis)

Standar Nasional Open API Pembayaran (Standar Data dan Spesifikasi

Setiap pihak yang akan menggunakan Standar Nasional Open API

Standar Nasional Open API Pembayaran - Standar Data dan Spesifikasi

Versi Tanggal Penyusun Keterangan

1.1. SKENARIO PENGGUNAAN API REGISTRATION

Use Case Diagram API Card Registration (via PJP PIAS)

Use Case Diagram API Card Registration (Direct Integration)

API Registrasi dapat digunakan dalam sejumlah skema sebagai berikut:

Skema 2: Direct Integration (Konsumen – Non-PJP Pengguna Layanan /

Sejumlah API yang digunakan dalam skema-skema tersebut antara lain:

 API Card Registration Inquiry dapat digunakan untuk menampilkan data

 API Verify OTP merupakan API yang digunakan untuk melakukan

 API Card Registration Unbinding digunakan untuk melakukan

 API Account Creation dapat digunakan oleh Konsumen untuk

 API Account Binding adalah layanan yang digunakan untuk

 API Account Binding Inquiry dapat digunakan untuk menampilkan data

 API Account Unbinding digunakan untuk melakukan penghapusan data

Sequence Diagram API Card Registration (via PJP PIAS)

1.2.2. API Card Registration – Set Limit

Sequence Diagram API Card Registration Inquiry

Sequence Diagram API OTP Validation (Direct Integration)

Sequence Diagram API Card Registration Unbinding

Sequence Diagram API Account Creation

Sequence Diagram API Account Binding

redirect the https://ww

Sequence Diagram API Account binding inquiry

Sequence Diagram API Account Unbinding

1.2.11.API Get OAuth URL

Cara menyertakan seamless data:

Cara menyertakan seamlessSign

2.1. SKENARIO PENGGUNAAN API BALANCE INQUIRY

Use Case Diagram API Balance Inquiry

Sequence Diagram API Balance Inquiry

API Bank Statement merupakan API yang digunakan untuk mengakses

3.1. SKENARIO PENGGUNAAN API TRANSACTION HISTORY

Use Case Diagram API Transaction History

API Transaction History dapat digunakan dalam sejumlah skema sebagai

Dalam skema ini, Konsumen dapat mengakses riwayat transaksi yang

Skema 2: Konsumen – Non-PJP Pengguna Layanan – PJP PIAS

Skema 3: Konsumen – PJP PIAS – PJP AIS Bank

Sequence Diagram untuk API Transaction History List

Sequence Diagram untuk API Transaction History Detail

Sequence Diagram untuk API Bank Statement

4.1. SKENARIO PENGGUNAAN API TRANSFER KREDIT

Use Case Diagram API Transfer Credit

Dalam skema ini, Non-PJP Pengguna Layanan dapat terhubung langsung ke

 Request for Payment:

 Interbank Transfer - Bulk:

 Transfer Virtual Account:

Skenario penggunaan virtual account terbagi menjadi:

Sebelum melakukan pemindahbukuan Intrabank, dilakukan validasi nomor

Skema 2: Non-PJP Pengguna Layanan – PJP AIS Lembaga Selain Bank

Skema 3: Konsumen - Non-PJP Pengguna Layanan/PJP PIAS – PJP AIS

Skema 4: QR MPM (Konsumen – Non-PJP Pengguna Layanan – PJP PIAS

Apabila terjadi kesalahan dalam transaksi, konsumen dapat melakukan

4.2. SPESIFIKASI API TRANSFER KREDIT BANK

Sequence Diagram API Internal Account Inquiry

beneficiaryAcc “D” for

Sequence Diagram API External Account Inquiry

Sequence Diagram API Trigger Intrabank Transfer

beneficiaryAcco Beneficiary 88880100000