Skip to content

Commit 1a437fa

Browse files
damilola-paystackdamilola-paystack
authored
Merge pull request #64 from PaystackOSS/patch-disputes
chore: update disputes examples and descriptions
2 parents f5eb926 + 75b7b83 commit 1a437fa

15 files changed

+303
-46
lines changed

‎dist/paystack.yaml‎

Lines changed: 152 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4412,8 +4412,8 @@ paths:
44124412
$ref: '#/components/schemas/RefundRetry'
44134413
responses:
44144414
'200':
4415-
$ref: '#/components/responses/RefundCreateSuccess'
4416-
'401':
4415+
$ref: '#/components/responses/RefundRetrySuccess'
4416+
'422':
44174417
$ref: '#/components/responses/Unauthorized'
44184418
default:
44194419
description: Server error
@@ -4446,6 +4446,7 @@ paths:
44464446
tags:
44474447
- Dispute
44484448
summary: List Disputes
4449+
description: List transaction disputes filed by customers
44494450
operationId: dispute_list
44504451
parameters:
44514452
- in: query
@@ -4460,9 +4461,15 @@ paths:
44604461
type: integer
44614462
- in: query
44624463
name: status
4463-
description: Dispute Status. Acceptable values are awaiting-merchant-feedback, awaiting-bank-feedback, pending, resolved
4464+
description: Dispute status
44644465
schema:
44654466
type: string
4467+
enum:
4468+
- awaiting-merchant-feedback
4469+
- awaiting-bank-feedback
4470+
- pending
4471+
- resolved
4472+
example: awaiting-merchant-feedback
44664473
- in: query
44674474
name: transaction
44684475
description: Transaction ID
@@ -4492,15 +4499,17 @@ paths:
44924499
/dispute/{id}:
44934500
parameters:
44944501
- name: id
4495-
description: Dispute ID
4502+
description: The unique identifier of the dispute
44964503
in: path
44974504
required: true
44984505
schema:
4499-
type: string
4506+
type: integer
4507+
example: 1801929
45004508
get:
45014509
tags:
45024510
- Dispute
45034511
summary: Fetch Dispute
4512+
description: Fetch a transaction dispute
45044513
operationId: dispute_fetch
45054514
responses:
45064515
'200':
@@ -4515,6 +4524,7 @@ paths:
45154524
tags:
45164525
- Dispute
45174526
summary: Update Dispute
4527+
description: Update a transaction dispute
45184528
operationId: dispute_update
45194529
requestBody:
45204530
content:
@@ -4537,15 +4547,17 @@ paths:
45374547
get:
45384548
tags:
45394549
- Dispute
4540-
summary: Get Upload URL
4550+
summary: Fetch Upload URL
4551+
description: Get the URL to upload a dispute evidence
45414552
operationId: dispute_uploadUrl
45424553
parameters:
45434554
- name: id
4544-
description: Dispute ID
4555+
description: The unique identifier of the dispute
45454556
in: path
45464557
required: true
45474558
schema:
4548-
type: string
4559+
type: integer
4560+
example: 4734583785
45494561
responses:
45504562
'200':
45514563
$ref: '#/components/responses/DisputeUploadURLSuccess'
@@ -4560,6 +4572,7 @@ paths:
45604572
tags:
45614573
- Dispute
45624574
summary: Export Disputes
4575+
description: Export the disputes available on your integration
45634576
operationId: dispute_download
45644577
parameters:
45654578
- in: query
@@ -4576,6 +4589,12 @@ paths:
45764589
name: status
45774590
schema:
45784591
type: string
4592+
enum:
4593+
- awaiting-merchant-feedback
4594+
- awaiting-bank-feedback
4595+
- pending
4596+
- resolved
4597+
example: awaiting-merchant-feedback
45794598
- in: query
45804599
name: from
45814600
schema:
@@ -4602,14 +4621,16 @@ paths:
46024621
tags:
46034622
- Dispute
46044623
summary: List Transaction Disputes
4624+
description: List all disputes filed for a transaction
46054625
operationId: dispute_transaction
46064626
parameters:
46074627
- name: id
4608-
description: Transaction ID
4628+
description: The unique identifier of the transaction
46094629
in: path
46104630
required: true
46114631
schema:
4612-
type: string
4632+
type: integer
4633+
example: 4734583785
46134634
responses:
46144635
'200':
46154636
$ref: '#/components/responses/DisputeListTransactionSuccess'
@@ -4623,15 +4644,17 @@ paths:
46234644
put:
46244645
tags:
46254646
- Dispute
4626-
summary: Resolve a Dispute
4647+
summary: Resolve Dispute
4648+
description: Resolve a transaction dispute
46274649
operationId: dispute_resolve
46284650
parameters:
46294651
- name: id
4630-
description: Dispute ID
4652+
description: The unique identifier of the dispute
46314653
in: path
46324654
required: true
46334655
schema:
4634-
type: string
4656+
type: integer
4657+
example: 4734583785
46354658
requestBody:
46364659
content:
46374660
application/json:
@@ -4654,6 +4677,7 @@ paths:
46544677
tags:
46554678
- Dispute
46564679
summary: Add Evidence
4680+
description: Provide evidence for a dispute
46574681
operationId: dispute_evidence
46584682
requestBody:
46594683
content:
@@ -4665,11 +4689,12 @@ paths:
46654689
$ref: '#/components/schemas/DisputeEvidence'
46664690
parameters:
46674691
- name: id
4668-
description: Dispute ID
4692+
description: The unique identifier of the dispute
46694693
in: path
46704694
required: true
46714695
schema:
4672-
type: string
4696+
type: integer
4697+
example: 4734583785
46734698
responses:
46744699
'200':
46754700
$ref: '#/components/responses/DisputeAddEvidenceSuccess'
@@ -16549,6 +16574,95 @@ components:
1654916574
properties:
1655016575
refund_account_details:
1655116576
$ref: '#/components/schemas/RefundRetryAccountDetails'
16577+
RefundRetryResponse:
16578+
title: Generated schema for Root
16579+
type: object
16580+
properties:
16581+
status:
16582+
type: boolean
16583+
message:
16584+
type: string
16585+
data:
16586+
type: object
16587+
properties:
16588+
integration:
16589+
type: number
16590+
transaction:
16591+
type: number
16592+
dispute:
16593+
type: object
16594+
settlement:
16595+
type: object
16596+
id:
16597+
type: number
16598+
domain:
16599+
type: string
16600+
currency:
16601+
type: string
16602+
amount:
16603+
type: number
16604+
status:
16605+
type: string
16606+
refunded_at:
16607+
type: string
16608+
nullable: true
16609+
expected_at:
16610+
type: string
16611+
channel:
16612+
type: string
16613+
refunded_by:
16614+
type: string
16615+
customer_note:
16616+
type: string
16617+
merchant_note:
16618+
type: string
16619+
deducted_amount:
16620+
type: number
16621+
fully_deducted:
16622+
type: boolean
16623+
bank_reference:
16624+
type: string
16625+
nullable: true
16626+
reason:
16627+
type: string
16628+
customer:
16629+
type: object
16630+
initiated_by:
16631+
type: string
16632+
reversed_at:
16633+
type: string
16634+
nullable: true
16635+
session_id:
16636+
type: string
16637+
nullable: true
16638+
required:
16639+
- integration
16640+
- transaction
16641+
- dispute
16642+
- settlement
16643+
- id
16644+
- domain
16645+
- currency
16646+
- amount
16647+
- status
16648+
- refunded_at
16649+
- expected_at
16650+
- channel
16651+
- refunded_by
16652+
- customer_note
16653+
- merchant_note
16654+
- deducted_amount
16655+
- fully_deducted
16656+
- bank_reference
16657+
- reason
16658+
- customer
16659+
- initiated_by
16660+
- reversed_at
16661+
- session_id
16662+
required:
16663+
- status
16664+
- message
16665+
- data
1655216666
RefundFetchResponse:
1655316667
type: object
1655416668
properties:
@@ -17240,11 +17354,13 @@ components:
1724017354
- refund_amount
1724117355
properties:
1724217356
refund_amount:
17243-
description: The amount to refund, in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR
17244-
type: string
17357+
description: The amount to refund, in the subunit of your currency
17358+
type: integer
1724517359
uploaded_filename:
1724617360
description: Filename of attachment returned via response from the Dispute upload URL
1724717361
type: string
17362+
example:
17363+
refund_amount: 50000
1724817364
DisputeUpdateResponse:
1724917365
type: object
1725017366
properties:
@@ -17810,14 +17926,19 @@ components:
1781017926
description: Reason for resolving
1781117927
type: string
1781217928
refund_amount:
17813-
description: The amount to refund, in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR
17814-
type: string
17929+
description: The amount to refund, in the subunit of your integration currency
17930+
type: integer
1781517931
uploaded_filename:
1781617932
description: Filename of attachment returned via response from the Dispute upload URL
1781717933
type: string
1781817934
evidence:
1781917935
description: Evidence Id for fraud claims
1782017936
type: integer
17937+
example:
17938+
resolution: merchant-accepted
17939+
message: Merchant accepted
17940+
refund_amount: 50000
17941+
uploaded_filename: qesp8a4df1xejihd9x5q
1782117942
DisputeResolveResponse:
1782217943
type: object
1782317944
properties:
@@ -17946,6 +18067,11 @@ components:
1794618067
description: ISO 8601 representation of delivery date (YYYY-MM-DD)
1794718068
type: string
1794818069
format: date-time
18070+
example:
18071+
customer_email: [email protected]
18072+
customer_name: Mensah King
18073+
customer_phone: '08012345678'
18074+
service_details: claim for buying cups
1794918075
DisputeAddEvidenceResponse:
1795018076
type: object
1795118077
properties:
@@ -18836,6 +18962,12 @@ components:
1883618962
application/json:
1883718963
schema:
1883818964
$ref: '#/components/schemas/RefundCreateResponse'
18965+
RefundRetrySuccess:
18966+
description: Refund Create response
18967+
content:
18968+
application/json:
18969+
schema:
18970+
$ref: '#/components/schemas/RefundRetryResponse'
1883918971
RefundFetchSuccess:
1884018972
description: Refund Fetch response
1884118973
content:
@@ -18861,7 +18993,7 @@ components:
1886118993
schema:
1886218994
$ref: '#/components/schemas/DisputeUpdateResponse'
1886318995
DisputeUploadURLSuccess:
18864-
description: Dispute Upload U R L response
18996+
description: Dispute Upload URL response
1886518997
content:
1886618998
application/json:
1886718999
schema:

‎src/assets/openapi/components/responses/DisputeUploadURLSuccess.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
description: Dispute Upload U R L response
1+
description: Dispute Upload URL response
22
content:
33
application/json:
44
schema:

‎src/assets/openapi/components/responses/RefundRetrySuccess.yaml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
description: Refund Create response
2+
content:
3+
application/json:
4+
schema:
5+
$ref: ../schemas/RefundRetryResponse.yaml

‎src/assets/openapi/components/schemas/DisputeEvidence.yaml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,9 @@ properties:
2424
description: ISO 8601 representation of delivery date (YYYY-MM-DD)
2525
type: string
2626
format: date-time
27+
example:
28+
customer_email: [email protected]
29+
customer_name: Mensah King
30+
customer_phone: '08012345678'
31+
service_details: claim for buying cups
32+

‎src/assets/openapi/components/schemas/DisputeResolve.yaml‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,16 @@ properties:
1212
description: Reason for resolving
1313
type: string
1414
refund_amount:
15-
description: >-
16-
The amount to refund, in kobo if currency is NGN, pesewas, if currency is
17-
GHS, and cents, if currency is ZAR
18-
type: string
15+
description: The amount to refund, in the subunit of your integration currency
16+
type: integer
1917
uploaded_filename:
2018
description: Filename of attachment returned via response from the Dispute upload URL
2119
type: string
2220
evidence:
2321
description: Evidence Id for fraud claims
2422
type: integer
23+
example:
24+
resolution: 'merchant-accepted'
25+
message: Merchant accepted
26+
refund_amount: 50000
27+
uploaded_filename: qesp8a4df1xejihd9x5q

‎src/assets/openapi/components/schemas/DisputeUpdate.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ required:
33
- refund_amount
44
properties:
55
refund_amount:
6-
description: >-
7-
The amount to refund, in kobo if currency is NGN, pesewas, if currency is
8-
GHS, and cents, if currency is ZAR
9-
type: string
6+
description: The amount to refund, in the subunit of your currency
7+
type: integer
108
uploaded_filename:
119
description: Filename of attachment returned via response from the Dispute upload URL
1210
type: string
11+
example:
12+
refund_amount: 50000

0 commit comments

Comments
 (0)