Disputes API

Create, manage, and resolve disputes over the Admin API

Using the 29 Next Admin API, you can create and manage disputes programmatically from any third party application.  This allows you to sync data between 29 Next and your payment services, or a disputes service provider like Midigator.
Create, Modify, or Delete Disputes
Create a new dispute in 29 Next and associate it to an existing transaction by using the disputes_create API.  
To modify an existing dispute, for example to add a resolution to the dispute, use the disputes_update API.  To delete a dispute, use disputes_delete API.
The following data points can be associated to a dispute upon creation.
Data
Type
Example Values
id
integer
title: ID
readOnly: true
​
type
string
title: TypeEnum:
Array [ 2 ]
[ alert, chargeback ]
status
string
title: Status
readOnly: trueEnum:
Array [ 3 ]
[ new, open, resolved ]
arn
string
title: Arn
maxLength: 256
x-nullable: true
​
case_number
string
title: Case Number
maxLength: 256
x-nullable: true
​
amount
string($decimal)
title: Dispute Amount
x-nullable: true
​
currency
string
title: Currency
x-nullable: trueEnum:
Array [ 7 ]
[ USD, SEK, NOK, EUR, GBP, THB, CAD ]
report_amount
string($decimal)
title: Report Amount
readOnly: true
​
report_currency
string
title: Report Currency
readOnly: true
minLength: 1
​
order
integer
title: Order
readOnly: true
​
date_created
string($date-time)
title: Date Created
readOnly: true
​
transaction
integer
title: Transaction
x-nullable: true
​
resolution
string
title: Resolution
x-nullable: trueEnum:
Array [ 10 ]
[ could_not_find_order,
declined_or_canceled_nothing_to_do, issued_full_refund, issued_refund_for_remaining_amount, 3ds_authorized_successfully, previously_refunded_nothing_to_do, unable_to_refund_merchant_account_closed, won, lost, other ]
​
List Disputes
To return a list of all disputes, or to search disputes by certain parameters, use the disputes_list API.  Query the API using the following parameters to return a list of all matching disputes (partial match).
Data
Type
id
string(query)
type
string(query)
status
string(query)
order_number
string(query)
transaction_id
string(query)
card_type
string(query)
card_first_six
string(query)
card_last_four
string(query)
case_number
string(query)
payment_method
string(query)
resolution
string(query)
page
integer(query)
A page number within the paginated result set.
To query a specific dispute by id use the disputes_read API and specify a dispute id.  

Data	Type	Example Values
id	integer title: ID readOnly: true
type	string title: TypeEnum: Array [ 2 ]	[ alert, chargeback ]
status	string title: Status readOnly: trueEnum: Array [ 3 ]	[ new, open, resolved ]
arn	string title: Arn maxLength: 256 x-nullable: true
case_number	string title: Case Number maxLength: 256 x-nullable: true
amount	string($decimal) title: Dispute Amount x-nullable: true
currency	string title: Currency x-nullable: trueEnum: Array [ 7 ]	[ USD, SEK, NOK, EUR, GBP, THB, CAD ]
report_amount	string($decimal) title: Report Amount readOnly: true
report_currency	string title: Report Currency readOnly: true minLength: 1
order	integer title: Order readOnly: true
date_created	string($date-time) title: Date Created readOnly: true
transaction	integer title: Transaction x-nullable: true
resolution	string title: Resolution x-nullable: trueEnum: Array [ 10 ]	[ could_not_find_order, declined_or_canceled_nothing_to_do, issued_full_refund, issued_refund_for_remaining_amount, 3ds_authorized_successfully, previously_refunded_nothing_to_do, unable_to_refund_merchant_account_closed, won, lost, other ]

Data	Type
id	string(query)
type	string(query)
status	string(query)
order_number	string(query)
transaction_id	string(query)
card_type	string(query)
card_first_six	string(query)
card_last_four	string(query)
case_number	string(query)
payment_method	string(query)
resolution	string(query)
page	integer(query) A page number within the paginated result set.

PayPal Admin API Guide

Support Ticket APIs

Last modified 1yr ago