docs/openapi-v1.yaml at main · paycrest/docs · GitHub

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: Paycrest Aggregator API
  version: 1.0.0
  description: |
    OpenAPI schema for the Paycrest Aggregator API. This covers sender, provider, and general endpoints.
tags:
  - name: Sender
    description: Endpoints for senders to create and manage payment orders
  - name: Provider
    description: Endpoints for providers to manage and fulfill orders
  - name: General
    description: General protocol and utility endpoints
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: API-Key
  schemas:

    # Sender Schemas
    NewPaymentOrderPayload:
      type: object
      required:
        - amount
        - token
        - rate
        - network
        - recipient
      properties:
        amount:
          type: number
        token:
          type: string
          description: Token symbol (USDT, USDC, cNGN). See [Supported Stablecoins](/resources/supported-stablecoins) for available options.
        rate:
          type: number
        network:
          type: string
          enum: [ethereum, base, bnb-smart-chain, lisk, scroll, celo, arbitrum-one, polygon, asset-chain]
          description: Network identifier for the blockchain
        recipient:
          $ref: '#/components/schemas/PaymentOrderRecipient'
        reference:
          type: string
        returnAddress:
          type: string
    PaymentOrderRecipient:
      type: object
      required:
        - institution
        - accountIdentifier
        - accountName
        - memo
      properties:
        institution:
          type: string
          description: Institution code (SWIFT code or custom PayCrest code ending with 'PC'). See [Code Standards](/resources/code-standards) for details.
        accountIdentifier:
          type: string
          description: Bank account number, mobile number, or other account identifier
        accountName:
          type: string
          description: Name of the account holder
        memo:
          type: string
          description: Memo or reference for the transaction
        providerId:
          type: string
          description: Optional provider ID for specific routing
        metadata:
          type: object
          description: Additional metadata for the transaction
        currency:
          type: string
          description: ISO 4217 currency code (e.g., NGN, KES, UGX). See [Supported Currencies](/resources/supported-currencies) for available options.
    ReceiveAddressResponse:
      type: object
      properties:
        id:
          type: string
        amount:
          type: string
        token:
          type: string
          description: Token symbol (USDT, USDC, cNGN). See [Supported Stablecoins](/resources/supported-stablecoins) for available options.
        network:
          type: string
          enum: [ethereum, base, bnb-smart-chain, lisk, scroll, celo, arbitrum-one, polygon, asset-chain]
          description: Network identifier for the blockchain
        receiveAddress:
          type: string
        validUntil:
          type: string
          format: date-time
        senderFee:
          type: string
        transactionFee:
          type: string
        reference:
          type: string
        orderType:
          type: string
    SenderOrderResponse:
      type: object
      properties:
        id:
          type: string
        amount:
          type: string
        amountInUsd:
          type: string
        amountPaid:
          type: string
        amountReturned:
          type: string
        token:
          type: string
          description: Token symbol (USDT, USDC, cNGN). See [Supported Stablecoins](/resources/supported-stablecoins) for available options.
        senderFee:
          type: string
        transactionFee:
          type: string
        rate:
          type: string
        network:
          type: string
          enum: [ethereum, base, bnb-smart-chain, lisk, scroll, celo, arbitrum-one, polygon, asset-chain]
          description: Network identifier for the blockchain
        gatewayId:
          type: string
        recipient:
          $ref: '#/components/schemas/PaymentOrderRecipient'
        fromAddress:
          type: string
        returnAddress:
          type: string
          description: Deprecated — use refundAddress
        refundAddress:
          type: string
        receiveAddress:
          type: string
        feeAddress:
          type: string
        reference:
          type: string
        orderType:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        txHash:
          type: string
        status:
          type: string
        transactionLogs:
          type: array
          items:
            $ref: '#/components/schemas/TransactionLog'
    SenderPaymentOrderList:
      type: object
      properties:
        total:
          type: integer
        page:
          type: integer
        pageSize:
          type: integer
        orders:
          type: array
          items:
            $ref: '#/components/schemas/SenderOrderResponse'
    SenderStatsResponse:
      type: object
      properties:
        totalOrders:
          type: integer
        totalOrderVolume:
          type: string
        totalFeeEarnings:
          type: string

    # Provider Schemas
    ProviderOrderList:
      type: object
      properties:
        total:
          type: integer
        page:
          type: integer
        pageSize:
          type: integer
        orders:
          type: array
          items:
            $ref: '#/components/schemas/ProviderOrderResponse'
    ProviderOrderResponse:
      type: object
      properties:
        id:
          type: string
        token:
          type: string
          description: Token symbol (USDT, USDC, cNGN). See [Supported Stablecoins](/resources/supported-stablecoins) for available options.
        gatewayId:
          type: string
        amount:
          type: string
        amountInUsd:
          type: string
        rate:
          type: string
        blockNumber:
          type: integer
        txHash:
          type: string
        institution:
          type: string
          description: Institution code (SWIFT code or custom PayCrest code ending with 'PC'). See [Code Standards](/resources/code-standards) for details.
        accountIdentifier:
          type: string
        accountName:
          type: string
        providerId:
          type: string
        memo:
          type: string
        network:
          type: string
          enum: [ethereum, base, bnb-smart-chain, lisk, scroll, celo, arbitrum-one, polygon, asset-chain]
          description: Network identifier for the blockchain
        orderType:
          type: string
        status:
          type: string
        updatedAt:
          type: string
          format: date-time
        createdAt:
          type: string
          format: date-time
        transactionLogs:
          type: array
          items:
            $ref: '#/components/schemas/TransactionLog'
        cancellationReasons:
          type: array
          items:
            type: string
    AcceptOrderResponse:
      type: object
      properties:
        id:
          type: string
        amount:
          type: number
        institution:
          type: string
          description: Institution code (SWIFT code or custom PayCrest code ending with 'PC'). See [Code Standards](/resources/code-standards) for details.
        accountIdentifier:
          type: string
        accountName:
          type: string
        memo:
          type: string
        metadata:
          type: object
    FulfillLockOrderPayload:
      type: object
      required:
        - psp
        - txId
      properties:
        psp:
          type: string
        txId:
          type: string
        validationStatus:
          type: string
        validationError:
          type: string
    CancelLockOrderPayload:
      type: object
      required:
        - reason
      properties:
        reason:
          type: string
    MarketRateSide:
      type: object
      description: Tolerance band for one side (buy or sell) of the market rate.
      properties:
        marketRate:
          type: string
        minimumRate:
          type: string
        maximumRate:
          type: string
    MarketRateResponse:
      type: object
      description: Market rate bounds split by side (same shape as `GET /v2/provider/rates/{token}/{fiat}`).
      properties:
        buy:
          $ref: '#/components/schemas/MarketRateSide'
        sell:
          $ref: '#/components/schemas/MarketRateSide'
    ProviderStatsResponse:
      type: object
      properties:
        totalOrders:
          type: integer
        totalFiatVolume:
          type: string
        totalCryptoVolume:
          type: string

    # General Schemas
    SupportedCurrencies:
      type: object
      properties:
        code:
          type: string
          description: ISO 4217 currency code (e.g., NGN, KES, UGX). See [Supported Currencies](/resources/supported-currencies) for available options.
        name:
          type: string
        shortName:
          type: string
        decimals:
          type: integer
        symbol:
          type: string
        marketBuyRate:
          type: string
        marketSellRate:
          type: string
    SupportedInstitutions:
      type: object
      properties:
        name:
          type: string
        code:
          type: string
          description: Institution code (SWIFT code or custom PayCrest code ending with 'PC'). See [Code Standards](/resources/code-standards) for details.
        type:
          type: string
    SupportedTokenResponse:
      type: object
      properties:
        symbol:
          type: string
          description: Token symbol (USDT, USDC, cNGN). See [Supported Stablecoins](/resources/supported-stablecoins) for available options.
        contractAddress:
          type: string
        decimals:
          type: integer
        baseCurrency:
          type: string
        network:
          type: string
          enum: [ethereum, base, bnb-smart-chain, lisk, scroll, celo, arbitrum-one, polygon, asset-chain]
          description: Network identifier for the blockchain

    # Order Status Schemas
    ProviderOrderStatusResponse:
      type: object
      properties:
        orderId:
          type: string
        amount:
          type: string
        amountInUsd:
          type: string
        token:
          type: string
          description: Token symbol (USDT, USDC, cNGN). See [Supported Stablecoins](/resources/supported-stablecoins) for available options.
        network:
          type: string
          enum: [ethereum, base, bnb-smart-chain, lisk, scroll, celo, arbitrum-one, polygon, asset-chain]
          description: Network identifier for the blockchain
        settlePercent:
          type: string
        status:
          type: string
        txHash:
          type: string
        settlements:
          type: array
          items:
            $ref: '#/components/schemas/PaymentOrderSplitOrder'
        txReceipts:
          type: array
          items:
            $ref: '#/components/schemas/PaymentOrderTxReceipt'
        updatedAt:
          type: string
          format: date-time
    PaymentOrderSplitOrder:
      type: object
      properties:
        splitOrderId:
          type: string
        amount:
          type: string
        rate:
          type: string
        orderPercent:
          type: string
    PaymentOrderTxReceipt:
      type: object
      properties:
        status:
          type: string
        txHash:
          type: string
        timestamp:
          type: string
          format: date-time

    # Common Schemas
    TransactionLog:
      type: object
      properties:
        id:
          type: string
        gateway_id:
          type: string
        status:
          type: string
        tx_hash:
          type: string
        created_at:
          type: string
          format: date-time

    # System Schemas
    VerifyAccountRequest:
      type: object
      required:
        - institution
        - accountIdentifier
      properties:
        institution:
          type: string
          description: Institution code (SWIFT code or custom PayCrest code ending with 'PC'). See [Code Standards](/resources/code-standards) for details.
        accountIdentifier:
          type: string
          description: Bank account number, mobile number, or other account identifier
    ErrorResponse:
      type: object
      properties:
        status:
          type: string
          example: error
        message:
          type: string
          example: Error message
        data:
          nullable: true
          description: "null on most errors; an array of field-level errors on validation failures"
          oneOf:
            - type: array
              items:
                type: object
                properties:
                  field:
                    type: string
                  message:
                    type: string
            - type: object
              additionalProperties: true
    StandardResponse:
      type: object
      properties:
        status:
          type: string
          example: success
        message:
          type: string
          example: Operation successful
        data:
          type: object
          description: The actual response data (e.g., ReceiveAddressResponse, etc.)

servers:
  - url: https://api.paycrest.io/v1
paths:

  /sender/orders:
    post:
      tags:
        - Sender
      summary: Initiate payment order
      security:
        - ApiKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewPaymentOrderPayload'
      responses:
        '201':
          description: Payment order initiated
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/StandardResponse'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/ReceiveAddressResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    get:
      tags:
        - Sender
      summary: List payment orders
      security:
        - ApiKeyAuth: []
      parameters:
        - in: query
          name: status
          schema:
            type: string
        - in: query
          name: token
          schema:
            type: string
        - in: query
          name: network
          schema:
            type: string
            enum: [ethereum, base, bnb-smart-chain, lisk, scroll, celo, arbitrum-one, polygon, asset-chain]
            description: Network identifier for the blockchain
        - in: query
          name: ordering
          schema:
            type: string
      responses:
        '200':
          description: List of payment orders
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/StandardResponse'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/SenderPaymentOrderList'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /sender/orders/{id}:
    get:
      tags:
        - Sender
      summary: Get payment order by ID
      security:
        - ApiKeyAuth: []
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Payment order
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/StandardResponse'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/SenderOrderResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /sender/stats:
    get:
      tags:
        - Sender
      summary: Get sender stats
      security:
        - ApiKeyAuth: []
      responses:
        '200':
          description: Sender stats
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/StandardResponse'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/SenderStatsResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /orders/{chain_id}/{id}:
    get:
      tags:
        - Sender
      summary: Get order status by Gateway ID
      parameters:
        - in: path
          name: chain_id
          required: true
          schema:
            type: string
        - in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Order status
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/StandardResponse'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/ProviderOrderStatusResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'

  # Provider Endpoints
  /provider/orders:
    get:
      tags:
        - Provider
      summary: List orders (provider)
      security:
        - ApiKeyAuth: []
      parameters:
        - in: query
          name: currency
          schema:
            type: string
        - in: query
          name: status
          schema:
            type: string
        - in: query
          name: ordering
          schema:
            type: string
      responses:
        '200':
          description: List of lock payment orders
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/StandardResponse'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/ProviderOrderList'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /provider/rates/{token}/{fiat}:
    get:
      tags:
        - Provider
      summary: Get market rate
      security:
        - ApiKeyAuth: []
      parameters:
        - in: path
          name: token
          required: true
          schema:
            type: string
        - in: path
          name: fiat
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Market rate
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/StandardResponse'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/MarketRateResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /provider/stats:
    get:
      tags:
        - Provider
      summary: Get provider stats
      security:
        - ApiKeyAuth: []
      parameters:
        - in: query
          name: currency
          schema:
            type: string
      responses:
        '200':
          description: Provider stats
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/StandardResponse'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/ProviderStatsResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /provider/node-info:
    get:
      tags:
        - Provider
      summary: Get node info
      security:
        - ApiKeyAuth: []
      responses:
        '200':
          description: Node info
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/StandardResponse'
                  - type: object
                    properties:
                      data:
                        type: object
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Service unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'


  # General Endpoints
  /currencies:
    get:
      tags:
        - General
      summary: List supported fiat currencies
      responses:
        '200':
          description: List of currencies
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: success
                  message:
                    type: string
                    example: Operation successful
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SupportedCurrencies'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /institutions/{currency_code}:
    get:
      tags:
        - General
      summary: List supported institutions for a currency
      parameters:
        - in: path
          name: currency_code
          required: true
          schema:
            type: string
      responses:
        '200':
          description: List of institutions
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: success
                  message:
                    type: string
                    example: Operation successful
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SupportedInstitutions'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /tokens:
    get:
      tags:
        - General
      summary: List supported tokens
      parameters:
        - in: query
          name: network
          schema:
            type: string
            enum: [ethereum, base, bnb-smart-chain, lisk, scroll, celo, arbitrum-one, polygon, asset-chain]
            description: Network identifier for the blockchain
      responses:
        '200':
          description: List of tokens
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: success
                  message:
                    type: string
                    example: Operation successful
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SupportedTokenResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /rates/{token}/{amount}/{fiat}:
    get:
      tags:
        - General
      summary: Get token rate
      parameters:
        - in: path
          name: token