-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
1330 lines (1303 loc) · 58.1 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
title: Whitelabel E-wallet
description: |
Ayoconnect Whitelabel E-wallet SNAP APIs helps clients to manage and track an internal wallet for its users - which can be used for payments within client's ecosystem.
## Credentials
<p>Before starting Whitelabel E-Wallet SNAP APIs integration client must ensure that they have all the required credentials. Every client will receive unique set of credentials from Ayoconnect during onboarding process.</p>
| Credentials | Description | Source |
|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|
| merchantId | Unique identifier of the client in Ayoconnect system. | Provided by Ayoconnect. |
| client_id | Unique 32 character string used to generate B2B and B2B2C Tokens. | Provided by Ayoconnect. |
| client_secret | Unique 32 character string used to generate signature. | Provided by Ayoconnect. |
| Public Key | RSA Public key. Method to generate a valid key pair as mentioned below. Public key needs to be shared by partner during their onboarding process. | Generated by partner. |
| Private Key | RSA Private key. Method to generate a valid key pair as mentioned below. | Generated by partner. |
### RSA Key Pair Generation
1. Generate a private key with the correct length using ```openssl genrsa -out private-key.pem 3072```
2. Generate corresponding public key using ```openssl rsa -in private-key.pem -pubout -out public-key.pem```
## Authentication
All API requests must contain *Authorization Token* in header which is used to authenticate the client.
There are two types of Authorization Tokens :
1. **B2B Token**
Generated Using **Generate B2B Access Token** `/wallet/api/v1.0/access-token/b2b` and passed in header `Authorization` as Bearer Token. B2B Token is mandatory in all API requests.
```
Authorization : Bearer <b2b_token>
```
2. **B2B2C Token**
Generated Using **Generate B2B2C Access Token** `/wallet/api/v1.0/access-token/b2b2c` and passed in header `Authorization-Customer` as Bearer Token. B2B2c Token is mandatory in all transaction API requests.
```
Authorization-Customer : Bearer <b2b2c_token>
```
<p>Authentication Tokens (B2B or B2B2C) generate once are <b>only valid for 3600 seconds</b>, after that a new token must be generated.</p>
<h2>Signature Generation</h2>
<p>All API requests must contain a valid signature header. Signature is passed in <b>X-Signature</b> header of HTTP Request. Signature
generation algorithm and contents to sign dependes on the API being called. Below table mentions the APIs, signature algorithm and content to sign. </p>
| Signature Algorithm | Content to Sign | Key to SIgn | API Name |
|-----------------------------|-------------------------------------------------------------------------------------------------------------------------|--------------|---------------------------|
| SHA256withRSA | <code>client_ID + "|" + X- TIMESTAMP</code> | privateKey | Generate B2B Access Token |
| | | |Generate B2B2C Access Token|
| HMAC_SHA512 | <code>HTTPMethod +":"+ EndpointUrl +":"+ AccessToken +":"+ Lowercase(HexEncode(SHA-256(minify(RequestBody))))+":" + TimeStamp </code>| clientSecret |
<h3>Signature Generation Example</h3>
| Credential | Value |
|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| client_id | <code>fceda4da-ae95-4d14-8cb6-eef392139a1b</code> |
| client_secret | <code>fceda4da-ae95-4d14-8cb6-eef392139a2c</code> |
| private_key | <code>-----BEGIN RSA PRIVATE KEY-----<br>MIIBOgIBAAJBAJ9wKHG/JDCr+6eZ6as5hHspDhZEUkveTF9GnCcDqRVmS/E4rhYw<br>niRfSSf2hfp516cYpC7zJ2AFB4id63T3lxECAwEAAQJALk7qQFdvEH/zYPOwTd4v<br>34HGKKuBZ63Sat3cXuyOQLt3OSj/lgRx/XELRjdLMADQrxTI0ijUvr9jqLB0I6O1<br>DQIhAMo3voVyYA0dmZvNWPRf6JzkFeexsXKmsrpNij9pwvPHAiEAyde1FPNTAeQn<br>e0DW+gtE5dHg/omiZDYBKLBj4jb4bmcCIDhvSjqP6wJ+CkqTCopY4eA3P23EB5PJ<br>tgOMdFKyP3gtAiEAgC0db2p94guTDvBEFJGndRJtAPdCSsUIw2AQbg1egi0CIH+a<br>Z4Mar+3f+SFIElF+M+aD4AzzibGUJghJ03cbR6Pt<br>-----END RSA PRIVATE KEY-----</code> |
| public_key | <code>-----BEGIN PUBLIC KEY-----<br>MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAJ9wKHG/JDCr+6eZ6as5hHspDhZEUkve<br>TF9GnCcDqRVmS/E4rhYwniRfSSf2hfp516cYpC7zJ2AFB4id63T3lxECAwEAAQ==<br>-----END PUBLIC KEY-----</code> |
<p>Below are the examples for <b>Signature Generation</b> which are generated using above dummy credentials. Please do not try to use above credentials, they are just for reference.</p>
<ul>
<li>
<h3>SHA256WithRSA</h3>
| | |
|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
| String Format | <code>client_ID + "|" + X- TIMESTAMP</code> |
| client_id | <code>fceda4da-ae95-4d14-8cb6-eef392139a1b</code> |
| X- TIMESTAMP | <code>2023-03-28T22:13:27+07:00</code> |
| String to Sign | <code>fceda4da-ae95-4d14-8cb6-eef392139a1b|2023-03-28T22:13:27+07:00</code> |
| Hex Encoded Generated Signature | <code>2729b693fb377029422605c74a7f8d7c0769c6f733450ed9602b8152104328d47010bb88bb46a1e72b23ca2946c1807f753b60a38a53a6fd4e8e4cea8d26d6c8</code> |
</li>
<li>
<h3>HMAC_SHA512</h3>
| | |
|-------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| String Format | <code>http_method + “:” + url_path + ”:” + access_token + ”:” +Lowercase(HexEncode(SHA256(minify(RequestBody))))+ ”:” + timestamp</code> |
| http_method | <code>POST</code> |
| url_path | <code>/api/v2/registration-account-binding</code> |
| access_token | <code>ed8f7f42a6d741fbb891bae654e81678</code> |
| JSON Body | <code>{"partnerReferenceNo": "qic5taezfgta7yhn74u7cppr47wan027", "authCode": "8ecx3bnfk9bu2o4y0z8ur8pfhH12eltF", "merchantId": "AYOPOP"}</code> |
| Minified JSON Body | <code>{"partnerReferenceNo":"qic5taezfgta7yhn74u7cppr47wan027","authCode":"8ecx3bnfk9bu2o4y0z8ur8pfhH12eltF","merchantId":"AYOPOP"}</code> |
| timestamp | <code>2023-03-28T22:13:27+07:00</code> |
| String to Sign | <code>POST:/api/v2/registration-account-binding:ed8f7f42a6d741fbb891bae654e81678:626c42bf3d17e3a02bcabd6d265103135b6dd70e7af6341e87c56ad3650015ee:2023-03-28T22:13:27+07:00</code> |
| client_secret | <code>fceda4da-ae95-4d14-8cb6-eef392139a2c</code> |
| Encryption With client_secret | <code>2e955289baf7f297dda75b830c00f15b81a71710c2d0a0bbdf5884ae15bf47bb46e627a0b25cff1c1da16c42682ec69945950a1b120b6be490a53b7d613cf7e4</code> |
</li>
</ul>
API FLOWS:
1. Account Creation - Customer Wallet
2. Top Up - Customer Wallet
3. Withdrawal - Customer Wallet
4. Balance Inquiry
## Account Creation Flow
<p><img src="https://storage.cloud.google.com/api_spec_assets/image-20230418-213251.png"/></p>
## Top Up Flow
### Top Up Inquiry
<p><img src="https://storage.cloud.google.com/api_spec_assets/4_15_sequence_diagram_api_account_inquiry_-_customer_top_up.png"/></p>
### Top Up
<p><img src="https://storage.cloud.google.com/api_spec_assets/4_16_sequence_diagram_api_customer_top_up.png"/></p>
### Top Up Inquiry Status
<p><img src="https://storage.cloud.google.com/api_spec_assets/4_17_sequence_diagram_api_customer_top_up_inquiry_status.png"/></p>
## Withdrawal Flow
<p><img src="https://storage.cloud.google.com/api_spec_assets/Web_Photo_Editor.jpg"/></p>
version: 1.0.0
contact: {}
servers:
- url: https://sandbox.api.of.ayoconnect.id
description: Sandbox Environment
paths:
/wallet/api/v1.0/access-token/b2b:
post:
summary: Generate B2B Access token
description: This API generates access token used in Authorization Headers of Customer Registration, TopUp & Withdrawal flow requests.
operationId: generateB2bToken
parameters:
- name: X-Timestamp
in: header
schema:
type: string
example: 2023-10-06T18:47:02+07:00
- name: X-Client-Key
in: header
schema:
type: string
example: h8XiZaCHAaNIvUh60AQqwYO0hJssGfNt80Gq0LaMriOTUAH
- name: X-Signature
in: header
schema:
type: string
example: 57e850c5daaa6c8afb60801f9f47245b9ceef63cf76a46c1eb717e5e9174e260ce8dff1fde0a9870139840d081b4ff2c3a6a38bb2ce9df7e4115d2d61071b690957b328fa6dfb29b3305c7e596c96accc4f2515e7a5bae720062606c29b6500979bca96220e838da85c2312647ce837df49f6fa1ccf89c33aa9c46287074f1e70fc20dbada8ebee81177b18b001dabfd4464487c41d3f124178583d152339547e25b5bbbc6dfd4ec3d498e07f70dd1f91e4968c1798578c3a967be7ac0b43fb988c9a36598cba9344a9cbb4f8b0b55d533f73c6966f96f6f29945e28fbdf8a180cf51451a28ac588ba4a94f53c1c6e64977c641daac8fd195157e3fb589be45c
requestBody:
content:
application/json:
schema:
type: object
properties:
additionalInfo:
type: object
properties:
merchantId:
type: string
example: AYOPOP
grantType:
type: string
example: client_credentials
examples:
Generate B2B token:
value:
additionalInfo:
merchantId: AYOPOP
grantType: client_credentials
responses:
'200':
description: 'Generate B2B token response'
content:
application/json:
schema:
type: object
properties:
responseCode:
type: string
responseMessage:
type: string
tokenType:
type: string
responseTime:
type: string
accessToken:
type: string
expiresIn:
type: string
example:
{
"responseCode": "2000000",
"responseMessage": "successful",
"tokenType": "BearerToken",
"responseTime": "20231010072520",
"accessToken": "341a7c1cdbf54655bb82538ac2224146",
"expiresIn": "3600"
}
headers:
Content-Type:
description: The type of data sent in response.
schema:
type: string
X-Timestamp:
description: Timestamp of system when response was generated
schema:
type: string
/wallet/api/v1.0/access-token/b2b2c:
post:
summary: Generate B2B2C token
description: This API generates access token used in TopUp & Withdrawal flow.
operationId: generateB2b2cToken
parameters:
- name: X-Timestamp
in: header
schema:
type: string
example: 2023-10-06T18:47:02+07:00
- name: X-Client-Key
in: header
schema:
type: string
example: h8XiZaCHAaNIvUh60AQqwYO0hJssGfNt80Gq0LaMriOTUAH
- name: X-Signature
in: header
schema:
type: string
example: 57e850c5daaa6c8afb60801f9f47245b9ceef63cf76a46c1eb717e5e9174e260ce8dff1fde0a9870139840d081b4ff2c3a6a38bb2ce9df7e4115d2d61071b690957b328fa6dfb29b3305c7e596c96accc4f2515e7a5bae720062606c29b6500979bca96220e838da85c2312647ce837df49f6fa1ccf89c33aa9c46287074f1e70fc20dbada8ebee81177b18b001dabfd4464487c41d3f124178583d152339547e25b5bbbc6dfd4ec3d498e07f70dd1f91e4968c1798578c3a967be7ac0b43fb988c9a36598cba9344a9cbb4f8b0b55d533f73c6966f96f6f29945e28fbdf8a180cf51451a28ac588ba4a94f53c1c6e64977c641daac8fd195157e3fb589be45c
requestBody:
content:
application/json:
schema:
type: object
properties:
additionalInfo:
type: object
properties:
merchantId:
type: string
example: AYOPOP
authCode:
type: string
example: 7f44633389fe44ff99f976c948f7f089
grantType:
type: string
example: authorization_code
examples:
Generate B2B2C token:
value:
additionalInfo:
merchantId: AYOPOP
authCode: 7f44633389fe44ff99f976c948f7f089
grantType: authorization_code
responses:
'200':
description: 'Generate B2B2C token response'
content:
application/json:
schema:
type: object
properties:
responseCode:
type: string
responseMessage:
type: string
tokenType:
type: string
responseTime:
type: string
accessToken:
type: string
expiresIn:
type: string
example:
{
"responseCode": "2000000",
"responseMessage": "successful",
"tokenType": "BearerToken",
"responseTime": "20231010072520",
"accessToken": "341a7c1cdbf54655bb82538ac2224146",
"expiresIn": "3600"
}
headers:
Content-Type:
description: The type of data sent in response.
schema:
type: string
X-Timestamp:
description: Timestamp of system when response was generated
schema:
type: string
/wallet/api/v1.0/registration-account-creation:
post:
summary: Account Creation
description: Account CreationÐ
operationId: accountCreation
parameters:
- name: X-EXTERNAL-ID
in: header
schema:
type: string
example: '41017551351950293184162180797889'
- name: X-Signature
in: header
schema:
type: string
example: 57e850c5daaa6c8afb60801f9f47245b9ceef63cf76a46c1eb717e5e9174e260ce8dff1fde0a9870139840d081b4ff2c3a6a38bb2ce9df7e4115d2d61071b690957b328fa6dfb29b3305c7e596c96accc4f2515e7a5bae720062606c29b6500979bca96220e838da85c2312647ce837df49f6fa1ccf89c33aa9c46287074f1e70fc20dbada8ebee81177b18b001dabfd4464487c41d3f124178583d152339547e25b5bbbc6dfd4ec3d498e07f70dd1f91e4968c1798578c3a967be7ac0b43fb988c9a36598cba9344a9cbb4f8b0b55d533f73c6966f96f6f29945e28fbdf8a180cf51451a28ac588ba4a94f53c1c6e64977c641daac8fd195157e3fb589be45c
- name: X-Timestamp
in: header
schema:
type: string
example: '2023-05-31T13:17:11+07:00'
- name: X-Client-Key
in: header
schema:
type: string
example: h8XiZaCHAaNIvUh60AQqwYO0hJssGfNt80Gq0LaMriOTUAH
- name: Channel-ID
in: header
schema:
type: string
example: '95221'
requestBody:
content:
application/json:
schema:
type: object
properties:
email:
type: string
example: test_WE_06@email.com
merchantId:
type: string
example: AYOPOP
name:
type: string
example: TEST WE 06
partnerReferenceNo:
type: string
example: 20210630A10010110011010001001224
phoneNo:
type: string
example: '6289970864245'
examples:
Account Creation:
value:
email: test_WE_06@email.com
merchantId: AYOPOP
name: TEST WE 06
partnerReferenceNo: 20210630A10010110011010001001224
phoneNo: '6289970864245'
responses:
'200':
description: 'Account Creation response'
content:
application/json:
schema:
type: object
properties:
responseCode:
type: string
responseMessage:
type: string
responseTime:
type: string
referenceNo:
type: string
partnerReferenceNo:
type: string
registrationToken:
type: string
example:
{
"responseCode": "2000000",
"responseMessage": "successful",
"responseTime": "20231010072520",
"referenceNo": "495ba7007f8445538689df94f35304c3",
"partnerReferenceNo": "20210630A10110110011110001001224",
"registrationToken": "c33a713081c14e258d045c8fc6bd16f1"
}
headers:
Content-Type:
description: The type of data sent in response.
schema:
type: string
X-Timestamp:
description: Timestamp of system when response was generated
schema:
type: string
/wallet/api/v1.0/otp-verification:
post:
summary: OTP Verification
description: OTP Verification
operationId: otpVerification
parameters:
- name: X-EXTERNAL-ID
in: header
schema:
type: string
example: '41017551351950293184162180797889'
- name: X-Signature
in: header
schema:
type: string
example: 57e850c5daaa6c8afb60801f9f47245b9ceef63cf76a46c1eb717e5e9174e260ce8dff1fde0a9870139840d081b4ff2c3a6a38bb2ce9df7e4115d2d61071b690957b328fa6dfb29b3305c7e596c96accc4f2515e7a5bae720062606c29b6500979bca96220e838da85c2312647ce837df49f6fa1ccf89c33aa9c46287074f1e70fc20dbada8ebee81177b18b001dabfd4464487c41d3f124178583d152339547e25b5bbbc6dfd4ec3d498e07f70dd1f91e4968c1798578c3a967be7ac0b43fb988c9a36598cba9344a9cbb4f8b0b55d533f73c6966f96f6f29945e28fbdf8a180cf51451a28ac588ba4a94f53c1c6e64977c641daac8fd195157e3fb589be45c
- name: X-Timestamp
in: header
schema:
type: string
example: '2023-06-05T09:55:32+07:00'
- name: X-CLIENT-KEY
in: header
schema:
type: string
example: h8XiZaCHAaNIvUh60AQqwYO0hJssGfNt80Gq0LaMriOTUAH
- name: Channel-ID
in: header
schema:
type: string
example: '95221'
requestBody:
content:
application/json:
schema:
type: object
properties:
merchantId:
type: string
example: AYOPOP
otp:
type: string
example: '737661'
partnerReferenceNo:
type: string
example: 20210630A10010010010010001011248
registrationToken:
type: string
example: 1abd2523beaf46d79fe7f961af0509ce
examples:
OTP Verification:
value:
merchantId: AYOPOP
otp: '737661'
partnerReferenceNo: 20210630A10010010010010001011248
registrationToken: 1abd2523beaf46d79fe7f961af0509ce
responses:
'200':
description: ''
/wallet/api/v1.0/registration-account-webview:
post:
summary: Generate WebView
description: Generate WebView
operationId: generateWebview
parameters:
- name: X-EXTERNAL-ID
in: header
schema:
type: string
example: '41017551351950293184162180797889'
- name: X-Signature
in: header
schema:
type: string
example: 57e850c5daaa6c8afb60801f9f47245b9ceef63cf76a46c1eb717e5e9174e260ce8dff1fde0a9870139840d081b4ff2c3a6a38bb2ce9df7e4115d2d61071b690957b328fa6dfb29b3305c7e596c96accc4f2515e7a5bae720062606c29b6500979bca96220e838da85c2312647ce837df49f6fa1ccf89c33aa9c46287074f1e70fc20dbada8ebee81177b18b001dabfd4464487c41d3f124178583d152339547e25b5bbbc6dfd4ec3d498e07f70dd1f91e4968c1798578c3a967be7ac0b43fb988c9a36598cba9344a9cbb4f8b0b55d533f73c6966f96f6f29945e28fbdf8a180cf51451a28ac588ba4a94f53c1c6e64977c641daac8fd195157e3fb589be45c
- name: X-Timestamp
in: header
schema:
type: string
example: '2023-06-05T09:55:32+07:00'
- name: X-CLIENT-KEY
in: header
schema:
type: string
example: h8XiZaCHAaNIvUh60AQqwYO0hJssGfNt80Gq0LaMriOTUAH
- name: CHANNEL-ID
in: header
schema:
type: string
example: '95221'
requestBody:
content:
application/json:
schema:
type: object
properties:
merchantId:
type: string
example: AYOPOP
partnerReferenceNo:
type: string
example: 20230630A00000010000100001000231
redirectionDetails:
type: object
properties:
failureMethod:
type: string
example: POST
failureURL:
type: string
example: https://ayoconnect.id
redirectionRequired:
type: string
example: 'YES'
successMethod:
type: string
example: PUT
successURL:
type: string
example: https://ayoconnect.id
registrationToken:
type: string
example: 1abd2523beaf46d79fe7f961af0509ce
examples:
Generate WebView:
value:
merchantId: AYOPOP
partnerReferenceNo: 20230630A00000010000100001000231
redirectionDetails:
failureMethod: POST
failureURL: https://ayoconnect.id
redirectionRequired: 'YES'
successMethod: PUT
successURL: https://ayoconnect.id
registrationToken: 1abd2523beaf46d79fe7f961af0509ce
responses:
'200':
description: ''
/wallet/api/v1.0/registration-account-binding:
post:
summary: Account Binding
description: Account Binding
operationId: accountBinding
parameters:
- name: X-EXTERNAL-ID
in: header
schema:
type: string
example: '41017551351950293184162180797889'
- name: X-Signature
in: header
schema:
type: string
example: 57e850c5daaa6c8afb60801f9f47245b9ceef63cf76a46c1eb717e5e9174e260ce8dff1fde0a9870139840d081b4ff2c3a6a38bb2ce9df7e4115d2d61071b690957b328fa6dfb29b3305c7e596c96accc4f2515e7a5bae720062606c29b6500979bca96220e838da85c2312647ce837df49f6fa1ccf89c33aa9c46287074f1e70fc20dbada8ebee81177b18b001dabfd4464487c41d3f124178583d152339547e25b5bbbc6dfd4ec3d498e07f70dd1f91e4968c1798578c3a967be7ac0b43fb988c9a36598cba9344a9cbb4f8b0b55d533f73c6966f96f6f29945e28fbdf8a180cf51451a28ac588ba4a94f53c1c6e64977c641daac8fd195157e3fb589be45c
- name: X-Timestamp
in: header
schema:
type: string
example: '2023-06-05T09:55:32+07:00'
- name: X-CLIENT-KEY
in: header
schema:
type: string
example: h8XiZaCHAaNIvUh60AQqwYO0hJssGfNt80Gq0LaMriOTUAH
- name: Channel-ID
in: header
schema:
type: string
example: '95221'
requestBody:
content:
application/json:
schema:
type: object
properties:
authCode:
type: string
example: 76a345deaccf47d2ac786c1a3184f987
merchantId:
type: string
example: AYOPOP
partnerReferenceNo:
type: string
example: 20230630A00000000000010000000203
examples:
Account Binding:
value:
authCode: 76a345deaccf47d2ac786c1a3184f987
merchantId: AYOPOP
partnerReferenceNo: 20230630A00000000000010000000203
responses:
'200':
description: ''
/wallet/api/v1.0/emoney/account-inquiry:
post:
summary: TopUp- Inquiry
description: TopUp- Inquiry
operationId: topupInquiry
parameters:
- name: X-EXTERNAL-ID
in: header
schema:
type: string
example: '41107553135762192124162280797654'
- name: X-Signature
in: header
schema:
type: string
example: 57e850c5daaa6c8afb60801f9f47245b9ceef63cf76a46c1eb717e5e9174e260ce8dff1fde0a9870139840d081b4ff2c3a6a38bb2ce9df7e4115d2d61071b690957b328fa6dfb29b3305c7e596c96accc4f2515e7a5bae720062606c29b6500979bca96220e838da85c2312647ce837df49f6fa1ccf89c33aa9c46287074f1e70fc20dbada8ebee81177b18b001dabfd4464487c41d3f124178583d152339547e25b5bbbc6dfd4ec3d498e07f70dd1f91e4968c1798578c3a967be7ac0b43fb988c9a36598cba9344a9cbb4f8b0b55d533f73c6966f96f6f29945e28fbdf8a180cf51451a28ac588ba4a94f53c1c6e64977c641daac8fd195157e3fb589be45c
- name: X-Timestamp
in: header
schema:
type: string
example: '2023-06-20T13:17:11+07:00'
- name: Authorization-Customer
in: header
schema:
type: string
example: Bearer {{b2b2c_token}}
- name: X-Client-Key
in: header
schema:
type: string
example: h8XiZaCHAaNIvUh60AQqwYO0hJssGfNt80Gq0LaMriOTUAH
- name: Channel-ID
in: header
schema:
type: string
example: '95221'
requestBody:
content:
application/json:
schema:
type: object
properties:
accountToken:
type: string
example: 3c41c3c0d4034ca49b5f0db08dfa6d14
amount:
type: object
properties:
currency:
type: string
example: IDR
value:
type: string
example: '500.00'
merchantId:
type: string
example: AYOPOP
partnerReferenceNo:
type: string
example: 20230639A00910101601150010000205
publicUserId:
type: string
example: AYOPOP-285FRVRWJ
examples:
TopUp- Inquiry:
value:
accountToken: 3c41c3c0d4034ca49b5f0db08dfa6d14
amount:
currency: IDR
value: '500.00'
merchantId: AYOPOP
partnerReferenceNo: 20230639A00910101601150010000205
publicUserId: AYOPOP-285FRVRWJ
responses:
'200':
description: ''
/wallet/api/v1.0/emoney/topup:
post:
summary: TopUp
description: TopUp
operationId: topup
parameters:
- name: X-EXTERNAL-ID
in: header
schema:
type: string
example: '41807553358950093184162180797685'
- name: X-Signature
in: header
schema:
type: string
example: 57e850c5daaa6c8afb60801f9f47245b9ceef63cf76a46c1eb717e5e9174e260ce8dff1fde0a9870139840d081b4ff2c3a6a38bb2ce9df7e4115d2d61071b690957b328fa6dfb29b3305c7e596c96accc4f2515e7a5bae720062606c29b6500979bca96220e838da85c2312647ce837df49f6fa1ccf89c33aa9c46287074f1e70fc20dbada8ebee81177b18b001dabfd4464487c41d3f124178583d152339547e25b5bbbc6dfd4ec3d498e07f70dd1f91e4968c1798578c3a967be7ac0b43fb988c9a36598cba9344a9cbb4f8b0b55d533f73c6966f96f6f29945e28fbdf8a180cf51451a28ac588ba4a94f53c1c6e64977c641daac8fd195157e3fb589be45c
- name: X-Timestamp
in: header
schema:
type: string
example: '2023-06-20T13:17:11+07:00'
- name: Authorization-Customer
in: header
schema:
type: string
example: Bearer {{b2b2c_token}}
- name: X-Client-Key
in: header
schema:
type: string
example: h8XiZaCHAaNIvUh60AQqwYO0hJssGfNt80Gq0LaMriOTUAH
- name: Channel-ID
in: header
schema:
type: string
example: '95221'
requestBody:
content:
application/json:
schema:
type: object
properties:
accountToken:
type: string
example: f8412cd5bcec47d4868fb773d8178118
amount:
type: object
properties:
currency:
type: string
example: IDR
value:
type: string
example: '40000.00'
merchantId:
type: string
example: AYOPOP
partnerReferenceNo:
type: string
example: 20230630A00000000000000000000206
publicUserId:
type: string
example: AYOPOP-285FWN8WD
title:
type: string
example: Test_Chaitu_TOPUP_03
examples:
TopUp:
value:
accountToken: f8412cd5bcec47d4868fb773d8178118
amount:
currency: IDR
value: '40000.00'
merchantId: AYOPOP
partnerReferenceNo: 20230630A00000000000000000000206
publicUserId: AYOPOP-285FWN8WD
title: Test_Chaitu_TOPUP_03
responses:
'200':
description: ''
/wallet/api/v1.0/emoney/topup-status:
post:
summary: TopUp - Inquiry Status
description: TopUp - Inquiry Status
operationId: topupInquiryStatus
parameters:
- name: X-EXTERNAL-ID
in: header
schema:
type: string
example: '41807553358950093184162180797685'
- name: X-Signature
in: header
schema:
type: string
example: 57e850c5daaa6c8afb60801f9f47245b9ceef63cf76a46c1eb717e5e9174e260ce8dff1fde0a9870139840d081b4ff2c3a6a38bb2ce9df7e4115d2d61071b690957b328fa6dfb29b3305c7e596c96accc4f2515e7a5bae720062606c29b6500979bca96220e838da85c2312647ce837df49f6fa1ccf89c33aa9c46287074f1e70fc20dbada8ebee81177b18b001dabfd4464487c41d3f124178583d152339547e25b5bbbc6dfd4ec3d498e07f70dd1f91e4968c1798578c3a967be7ac0b43fb988c9a36598cba9344a9cbb4f8b0b55d533f73c6966f96f6f29945e28fbdf8a180cf51451a28ac588ba4a94f53c1c6e64977c641daac8fd195157e3fb589be45c
- name: X-Timestamp
in: header
schema:
type: string
example: '2023-06-20T13:17:11+07:00'
- name: Authorization-Customer
in: header
schema:
type: string
example: Bearer {{b2b2c_token}}
- name: X-Client-Key
in: header
schema:
type: string
example: h8XiZaCHAaNIvUh60AQqwYO0hJssGfNt80Gq0LaMriOTUAH
- name: Channel-ID
in: header
schema:
type: string
example: '95221'
requestBody:
content:
application/json:
schema:
type: object
properties:
merchantId:
type: string
example: AYOPOP
originalPartnerReferenceNo:
type: string
example: 20230630A00000000000000000000205
originalReferenceNo:
type: string
example: f51dd569fee44cd8943358db0ab94dab
publicUserId:
type: string
example: AYOPOP-285FWN8WD
serviceCode:
type: string
example: '43'
examples:
TopUp - Inquiry Status:
value:
merchantId: AYOPOP
originalPartnerReferenceNo: 20230630A00000000000000000000205
originalReferenceNo: f51dd569fee44cd8943358db0ab94dab
publicUserId: AYOPOP-285FWN8WD
serviceCode: '43'
responses:
'200':
description: ''
/wallet/api/v1.0/auth/payment:
post:
summary: Auth Payment - withdraw
description: Auth Payment - withdraw
operationId: authPaymentWithdraw
parameters:
- name: X-EXTERNAL-ID
in: header
schema:
type: string
example: '41809082831351123412265280797891'
- name: X-Signature
in: header
schema:
type: string
example: 57e850c5daaa6c8afb60801f9f47245b9ceef63cf76a46c1eb717e5e9174e260ce8dff1fde0a9870139840d081b4ff2c3a6a38bb2ce9df7e4115d2d61071b690957b328fa6dfb29b3305c7e596c96accc4f2515e7a5bae720062606c29b6500979bca96220e838da85c2312647ce837df49f6fa1ccf89c33aa9c46287074f1e70fc20dbada8ebee81177b18b001dabfd4464487c41d3f124178583d152339547e25b5bbbc6dfd4ec3d498e07f70dd1f91e4968c1798578c3a967be7ac0b43fb988c9a36598cba9344a9cbb4f8b0b55d533f73c6966f96f6f29945e28fbdf8a180cf51451a28ac588ba4a94f53c1c6e64977c641daac8fd195157e3fb589be45c
- name: X-Timestamp
in: header
schema:
type: string
example: '2023-06-20T13:17:11+07:00'
- name: Authorization-Customer
in: header
schema:
type: string
example: Bearer {{b2b2c_token}}
- name: X-Client-Key
in: header
schema:
type: string
example: h8XiZaCHAaNIvUh60AQqwYO0hJssGfNt80Gq0LaMriOTUAH
- name: Channel-ID
in: header
schema:
type: string
example: '95221'
requestBody:
content:
application/json:
schema:
type: object
properties:
accountToken:
type: string
example: 9f7cfb9e8b744785b0e5a0496dccab48
amount:
type: object
properties:
currency:
type: string
example: IDR
value:
type: string
example: '100000.00'
merchantId:
type: string
example: AYOPOP
partnerReferenceNo:
type: string
example: '30201012592224045978914301029091010910998'
publicUserId:
type: string
example: AYOPOP-285FRVRWJ
title:
type: string
example: Test
examples:
Auth Payment - withdraw:
value:
accountToken: 9f7cfb9e8b744785b0e5a0496dccab48
amount:
currency: IDR
value: '100000.00'
merchantId: AYOPOP
partnerReferenceNo: '30201012592224045978914301029091010910998'
publicUserId: AYOPOP-285FRVRWJ
title: Test
responses:
'200':
description: ''
/wallet/api/v1.0/auth/capture:
post:
summary: Auth Capture - withdraw
description: Auth Capture - withdraw
operationId: authCaptureWithdraw
parameters:
- name: X-EXTERNAL-ID
in: header
schema:
type: string
example: '41807553358950093184162180797673'
- name: X-Signature
in: header
schema:
type: string
example: 57e850c5daaa6c8afb60801f9f47245b9ceef63cf76a46c1eb717e5e9174e260ce8dff1fde0a9870139840d081b4ff2c3a6a38bb2ce9df7e4115d2d61071b690957b328fa6dfb29b3305c7e596c96accc4f2515e7a5bae720062606c29b6500979bca96220e838da85c2312647ce837df49f6fa1ccf89c33aa9c46287074f1e70fc20dbada8ebee81177b18b001dabfd4464487c41d3f124178583d152339547e25b5bbbc6dfd4ec3d498e07f70dd1f91e4968c1798578c3a967be7ac0b43fb988c9a36598cba9344a9cbb4f8b0b55d533f73c6966f96f6f29945e28fbdf8a180cf51451a28ac588ba4a94f53c1c6e64977c641daac8fd195157e3fb589be45c
- name: X-Timestamp
in: header
schema:
type: string
example: '2023-06-20T13:17:11+07:00'
- name: Authorization-Customer
in: header
schema:
type: string
example: Bearer {{b2b2c_token}}
- name: X-Client-Key
in: header
schema:
type: string
example: h8XiZaCHAaNIvUh60AQqwYO0hJssGfNt80Gq0LaMriOTUAH
- name: Channel-ID
in: header
schema:
type: string
example: '95221'
requestBody:
content:
application/json:
schema:
type: object
properties:
accountToken:
type: string
example: 633ca3e9035441299cca3bd54392b6af
captureAmount:
type: object
properties:
currency:
type: string
example: IDR
value:
type: string
example: '90000.00'
merchantId:
type: string
example: AYOPOP
originalPartnerReferenceNo:
type: string
example: '2020102900000000000100'
originalReferenceNo:
type: string
example: 9484481d8f98495288f1c79b0363161c
partnerCaptureNo:
type: string
example: '2020102900000000000103'
publicUserId:
type: string
example: AYOPOP-285FWN8WD
title:
type: string
example: Test_Chaitu_01
examples:
Auth Capture - withdraw:
value:
accountToken: 633ca3e9035441299cca3bd54392b6af
captureAmount:
currency: IDR
value: '90000.00'
merchantId: AYOPOP
originalPartnerReferenceNo: '2020102900000000000100'
originalReferenceNo: 9484481d8f98495288f1c79b0363161c
partnerCaptureNo: '2020102900000000000103'
publicUserId: AYOPOP-285FWN8WD
title: Test_Chaitu_01
responses:
'200':
description: ''
/wallet/api/v1.0/auth/void:
post:
summary: Auth Void - withdraw
description: Auth Void - withdraw
operationId: authVoidWithdraw
parameters:
- name: X-EXTERNAL-ID
in: header
schema:
type: string
example: '41809082831351123412254280797891'
- name: X-Signature
in: header
schema:
type: string
example: 57e850c5daaa6c8afb60801f9f47245b9ceef63cf76a46c1eb717e5e9174e260ce8dff1fde0a9870139840d081b4ff2c3a6a38bb2ce9df7e4115d2d61071b690957b328fa6dfb29b3305c7e596c96accc4f2515e7a5bae720062606c29b6500979bca96220e838da85c2312647ce837df49f6fa1ccf89c33aa9c46287074f1e70fc20dbada8ebee81177b18b001dabfd4464487c41d3f124178583d152339547e25b5bbbc6dfd4ec3d498e07f70dd1f91e4968c1798578c3a967be7ac0b43fb988c9a36598cba9344a9cbb4f8b0b55d533f73c6966f96f6f29945e28fbdf8a180cf51451a28ac588ba4a94f53c1c6e64977c641daac8fd195157e3fb589be45c
- name: X-Timestamp
in: header
schema:
type: string
example: '2023-06-20T13:17:11+07:00'
- name: Authorization-Customer
in: header
schema:
type: string
example: Bearer {{b2b2c_token}}
- name: X-Client-Key
in: header
schema:
type: string