Card Disputes
If unauthorized activity occurs on a card, you can create a Card Dispute and we’ll work with the card networks to return the funds if appropriate.
Events
Your application can listen to webhooks
about this resource.
The events about Card Disputes will have
the categories "card_dispute.created" or "card_dispute.updated"
.
The Card Dispute object
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
{
"amount": 1000,
"card_id": "card_oubs0hwk5rn6knuecxg2",
"created_at": "2020-01-31T23:59:59Z",
"disputed_transaction_id": "transaction_uyrp7fld2ium70oa7oi",
"id": "card_dispute_h9sc95nbl1cgltpp7men",
"idempotency_key": null,
"loss": null,
"network": "visa",
"rejection": null,
"status": "pending_response",
"type": "card_dispute",
"user_submission_required_by": null,
"visa": {
"network_events": [],
"required_user_submission_category": null,
"user_submissions": [
{
"accepted_at": null,
"amount": 1000,
"attachment_files": [],
"category": "chargeback",
"chargeback": {
"authorization": null,
"category": "fraud",
"consumer_canceled_merchandise": null,
"consumer_canceled_recurring_transaction": null,
"consumer_canceled_services": null,
"consumer_counterfeit_merchandise": null,
"consumer_credit_not_processed": null,
"consumer_damaged_or_defective_merchandise": null,
"consumer_merchandise_misrepresentation": null,
"consumer_merchandise_not_as_described": null,
"consumer_merchandise_not_received": null,
"consumer_non_receipt_of_cash": null,
"consumer_original_credit_transaction_not_accepted": null,
"consumer_quality_merchandise": null,
"consumer_quality_services": null,
"consumer_services_misrepresentation": null,
"consumer_services_not_as_described": null,
"consumer_services_not_received": null,
"fraud": {
"fraud_type": "lost"
},
"processing_error": null
},
"created_at": "2020-01-31T23:59:59Z",
"explanation": null,
"further_information_requested_at": null,
"further_information_requested_reason": null,
"status": "pending_reviewing",
"updated_at": "2020-01-31T23:59:59Z"
}
]
},
"win": null,
"withdrawal": null
}
Attributes
amount
integer
The amount of the dispute.
card_id
string
The Card that the Card Dispute is associated with.
created_at
string
The ISO 8601 date and time at which the Card Dispute was created.
disputed_transaction_id
string
The identifier of the Transaction that was disputed.
id
string
The Card Dispute identifier.
idempotency_key
string
Nullable
The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.
loss
dictionary
Nullable
If the Card Dispute’s status is lost, this will contain details of the lost dispute.
network
enum
The network that the Card Dispute is associated with.
rejection
dictionary
Nullable
If the Card Dispute has been rejected, this will contain details of the rejection.
status
enum
The status of the Card Dispute.
type
string
A constant representing the object’s type. For this resource it will always be card_dispute.
user_submission_required_by
string
Nullable
The ISO 8601 date and time at which the user submission is required by. Present only if status is user_submission_required and a user submission is required by a certain time. Otherwise, this will be nil.
visa
dictionary
Nullable
Card Dispute information for card payments processed over Visa’s network. This field will be present in the JSON response if and only if network is equal to visa.
win
dictionary
Nullable
If the Card Dispute’s status is won, this will contain details of the won dispute.
withdrawal
dictionary
Nullable
If the Card Dispute has been withdrawn, this will contain details of the withdrawal.
List Card Disputes
1
2
3
curl \
--url "${INCREASE_URL}/card_disputes" \
-H "Authorization: Bearer ${INCREASE_API_KEY}"1
2
3
4
5
6
7
8
9
10
import Increase from 'increase';
const client = new Increase({
apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const cardDispute of client.cardDisputes.list()) {
console.log(cardDispute.id);
}1
2
3
4
5
6
7
8
9
import os
from increase import Increase
client = Increase(
api_key=os.environ.get("INCREASE_API_KEY"), # This is the default and can be omitted
)
page = client.card_disputes.list()
page = page.data[0]
print(page.id)1
2
3
4
5
6
7
8
9
require "increase"
increase = Increase::Client.new(
api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)
page = increase.card_disputes.list
puts(page)1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
package main
import (
"context"
"fmt"
"os"
"github.com/Increase/increase-go"
"github.com/Increase/increase-go/option"
)
func main() {
client := increase.NewClient(
option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
)
page, err := client.CardDisputes.List(context.TODO(), increase.CardDisputeListParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", page)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
package com.increase.api.example;
import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.carddisputes.CardDisputeListPage;
import com.increase.api.models.carddisputes.CardDisputeListParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
CardDisputeListPage page = client.cardDisputes().list();
}
}1
2
3
4
5
6
7
8
9
10
11
12
package com.increase.api.example
import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.carddisputes.CardDisputeListPage
import com.increase.api.models.carddisputes.CardDisputeListParams
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val page: CardDisputeListPage = client.cardDisputes().list()
}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
<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Increase\Client;
use Increase\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('INCREASE_API_KEY'));
try {
$page = $client->cardDisputes->list(
createdAt: [
'after' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
'before' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
'onOrAfter' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
'onOrBefore' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
],
cursor: 'cursor',
idempotencyKey: 'x',
limit: 1,
status: ['in' => ['user_submission_required']],
);
var_dump($page);
} catch (APIException $e) {
echo $e->getMessage();
}1
2
3
4
5
6
7
8
9
10
11
12
13
using System;
using Increase.Api;
using Increase.Api.Models.CardDisputes;
IncreaseClient client = new();
CardDisputeListParams parameters = new();
var page = await client.CardDisputes.List(parameters);
await foreach (var item in page.Paginate())
{
Console.WriteLine(item);
}
Returns a
list response
:
1
2
3
4
5
6
7
8
{
"data": [
{ /* Card Dispute object */ },
{ /* Card Dispute object */ }
/* ... */
],
"next_cursor": "v57w5d",
}
Parameters
status.in
array of strings
Filter Card Disputes for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.
idempotency_key
string
Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.
More
cursor
string
limit
integer
created_at.after
string
created_at.before
string
created_at.on_or_after
string
created_at.on_or_before
string
Create a Card Dispute
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
curl -X "POST" \
--url "${INCREASE_URL}/card_disputes" \
-H "Authorization: Bearer ${INCREASE_API_KEY}" \
-H "Content-Type: application/json" \
-d $'{
"amount": 100,
"disputed_transaction_id": "transaction_uyrp7fld2ium70oa7oi",
"network": "visa",
"visa": {
"category": "fraud",
"fraud": {
"fraud_type": "account_or_credentials_takeover"
}
}
}'1
2
3
4
5
6
7
8
9
10
11
12
import Increase from 'increase';
const client = new Increase({
apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});
const cardDispute = await client.cardDisputes.create({
disputed_transaction_id: 'transaction_uyrp7fld2ium70oa7oi',
network: 'visa',
});
console.log(cardDispute.id);1
2
3
4
5
6
7
8
9
10
11
import os
from increase import Increase
client = Increase(
api_key=os.environ.get("INCREASE_API_KEY"), # This is the default and can be omitted
)
card_dispute = client.card_disputes.create(
disputed_transaction_id="transaction_uyrp7fld2ium70oa7oi",
network="visa",
)
print(card_dispute.id)1
2
3
4
5
6
7
8
9
require "increase"
increase = Increase::Client.new(
api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)
card_dispute = increase.card_disputes.create(disputed_transaction_id: "transaction_uyrp7fld2ium70oa7oi", network: :visa)
puts(card_dispute)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
package main
import (
"context"
"fmt"
"os"
"github.com/Increase/increase-go"
"github.com/Increase/increase-go/option"
)
func main() {
client := increase.NewClient(
option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
)
cardDispute, err := client.CardDisputes.New(context.TODO(), increase.CardDisputeNewParams{
DisputedTransactionID: increase.F("transaction_uyrp7fld2ium70oa7oi"),
Network: increase.F(increase.CardDisputeNewParamsNetworkVisa),
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", cardDispute.ID)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
package com.increase.api.example;
import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.carddisputes.CardDispute;
import com.increase.api.models.carddisputes.CardDisputeCreateParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
CardDisputeCreateParams params = CardDisputeCreateParams.builder()
.disputedTransactionId("transaction_uyrp7fld2ium70oa7oi")
.network(CardDisputeCreateParams.Network.VISA)
.build();
CardDispute cardDispute = client.cardDisputes().create(params);
}
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
package com.increase.api.example
import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.carddisputes.CardDispute
import com.increase.api.models.carddisputes.CardDisputeCreateParams
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val params: CardDisputeCreateParams = CardDisputeCreateParams.builder()
.disputedTransactionId("transaction_uyrp7fld2ium70oa7oi")
.network(CardDisputeCreateParams.Network.VISA)
.build()
val cardDispute: CardDispute = client.cardDisputes().create(params)
}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
<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Increase\Client;
use Increase\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('INCREASE_API_KEY'));
try {
$cardDispute = $client->cardDisputes->create(
disputedTransactionID: 'transaction_uyrp7fld2ium70oa7oi',
network: 'visa',
amount: 100,
attachmentFiles: [['fileID' => 'file_id']],
explanation: 'x',
visa: [
'category' => 'fraud',
'authorization' => ['accountStatus' => 'account_closed'],
'consumerCanceledMerchandise' => [
'merchantResolutionAttempted' => 'attempted',
'purchaseExplanation' => 'x',
'receivedOrExpectedAt' => '2019-12-27',
'returnOutcome' => 'not_returned',
'cardholderCancellation' => [
'canceledAt' => '2019-12-27',
'canceledPriorToShipDate' => 'canceled_prior_to_ship_date',
'cancellationPolicyProvided' => 'not_provided',
'reason' => 'x',
],
'notReturned' => [],
'returnAttempted' => [
'attemptExplanation' => 'x',
'attemptReason' => 'merchant_not_responding',
'attemptedAt' => '2019-12-27',
'merchandiseDisposition' => 'x',
],
'returned' => [
'returnMethod' => 'dhl',
'returnedAt' => '2019-12-27',
'merchantReceivedReturnAt' => '2019-12-27',
'otherExplanation' => 'x',
'trackingNumber' => 'x',
],
],
'consumerCanceledRecurringTransaction' => [
'cancellationTarget' => 'account',
'merchantContactMethods' => [
'applicationName' => 'x',
'callCenterPhoneNumber' => 'x',
'emailAddress' => 'x',
'inPersonAddress' => 'x',
'mailingAddress' => 'x',
'textPhoneNumber' => 'x',
],
'transactionOrAccountCanceledAt' => '2019-12-27',
'otherFormOfPaymentExplanation' => 'x',
],
'consumerCanceledServices' => [
'cardholderCancellation' => [
'canceledAt' => '2019-12-27',
'cancellationPolicyProvided' => 'not_provided',
'reason' => 'x',
],
'contractedAt' => '2019-12-27',
'merchantResolutionAttempted' => 'attempted',
'purchaseExplanation' => 'x',
'serviceType' => 'guaranteed_reservation',
'guaranteedReservation' => [
'explanation' => 'cardholder_canceled_prior_to_service'
],
'other' => [],
'timeshare' => [],
],
'consumerCounterfeitMerchandise' => [
'counterfeitExplanation' => 'x',
'dispositionExplanation' => 'x',
'orderExplanation' => 'x',
'receivedAt' => '2019-12-27',
],
'consumerCreditNotProcessed' => [
'canceledOrReturnedAt' => '2019-12-27',
'creditExpectedAt' => '2019-12-27',
],
'consumerDamagedOrDefectiveMerchandise' => [
'merchantResolutionAttempted' => 'attempted',
'orderAndIssueExplanation' => 'x',
'receivedAt' => '2019-12-27',
'returnOutcome' => 'not_returned',
'notReturned' => [],
'returnAttempted' => [
'attemptExplanation' => 'x',
'attemptReason' => 'merchant_not_responding',
'attemptedAt' => '2019-12-27',
'merchandiseDisposition' => 'x',
],
'returned' => [
'returnMethod' => 'dhl',
'returnedAt' => '2019-12-27',
'merchantReceivedReturnAt' => '2019-12-27',
'otherExplanation' => 'x',
'trackingNumber' => 'x',
],
],
'consumerMerchandiseMisrepresentation' => [
'merchantResolutionAttempted' => 'attempted',
'misrepresentationExplanation' => 'x',
'purchaseExplanation' => 'x',
'receivedAt' => '2019-12-27',
'returnOutcome' => 'not_returned',
'notReturned' => [],
'returnAttempted' => [
'attemptExplanation' => 'x',
'attemptReason' => 'merchant_not_responding',
'attemptedAt' => '2019-12-27',
'merchandiseDisposition' => 'x',
],
'returned' => [
'returnMethod' => 'dhl',
'returnedAt' => '2019-12-27',
'merchantReceivedReturnAt' => '2019-12-27',
'otherExplanation' => 'x',
'trackingNumber' => 'x',
],
],
'consumerMerchandiseNotAsDescribed' => [
'merchantResolutionAttempted' => 'attempted',
'receivedAt' => '2019-12-27',
'returnOutcome' => 'returned',
'returnAttempted' => [
'attemptExplanation' => 'x',
'attemptReason' => 'merchant_not_responding',
'attemptedAt' => '2019-12-27',
'merchandiseDisposition' => 'x',
],
'returned' => [
'returnMethod' => 'dhl',
'returnedAt' => '2019-12-27',
'merchantReceivedReturnAt' => '2019-12-27',
'otherExplanation' => 'x',
'trackingNumber' => 'x',
],
],
'consumerMerchandiseNotReceived' => [
'cancellationOutcome' => 'cardholder_cancellation_prior_to_expected_receipt',
'deliveryIssue' => 'delayed',
'lastExpectedReceiptAt' => '2019-12-27',
'merchantResolutionAttempted' => 'attempted',
'purchaseInfoAndExplanation' => 'x',
'cardholderCancellationPriorToExpectedReceipt' => [
'canceledAt' => '2019-12-27', 'reason' => 'x'
],
'delayed' => [
'explanation' => 'x',
'returnOutcome' => 'not_returned',
'notReturned' => [],
'returnAttempted' => ['attemptedAt' => '2019-12-27'],
'returned' => [
'merchantReceivedReturnAt' => '2019-12-27',
'returnedAt' => '2019-12-27',
],
],
'deliveredToWrongLocation' => ['agreedLocation' => 'x'],
'merchantCancellation' => ['canceledAt' => '2019-12-27'],
'noCancellation' => [],
],
'consumerNonReceiptOfCash' => [],
'consumerOriginalCreditTransactionNotAccepted' => [
'explanation' => 'x',
'reason' => 'prohibited_by_local_laws_or_regulation',
],
'consumerQualityMerchandise' => [
'expectedAt' => '2019-12-27',
'merchantResolutionAttempted' => 'attempted',
'purchaseInfoAndQualityIssue' => 'x',
'receivedAt' => '2019-12-27',
'returnOutcome' => 'not_returned',
'notReturned' => [],
'ongoingNegotiations' => [
'explanation' => 'x',
'issuerFirstNotifiedAt' => '2019-12-27',
'startedAt' => '2019-12-27',
],
'returnAttempted' => [
'attemptExplanation' => 'x',
'attemptReason' => 'merchant_not_responding',
'attemptedAt' => '2019-12-27',
'merchandiseDisposition' => 'x',
],
'returned' => [
'returnMethod' => 'dhl',
'returnedAt' => '2019-12-27',
'merchantReceivedReturnAt' => '2019-12-27',
'otherExplanation' => 'x',
'trackingNumber' => 'x',
],
],
'consumerQualityServices' => [
'cardholderCancellation' => [
'acceptedByMerchant' => 'accepted',
'canceledAt' => '2019-12-27',
'reason' => 'x',
],
'nonFiatCurrencyOrNonFungibleTokenRelatedAndNotMatchingDescription' => 'not_related',
'purchaseInfoAndQualityIssue' => 'x',
'servicesReceivedAt' => '2019-12-27',
'cardholderPaidToHaveWorkRedone' => 'did_not_pay_to_have_work_redone',
'ongoingNegotiations' => [
'explanation' => 'x',
'issuerFirstNotifiedAt' => '2019-12-27',
'startedAt' => '2019-12-27',
],
'restaurantFoodRelated' => 'not_related',
],
'consumerServicesMisrepresentation' => [
'cardholderCancellation' => [
'acceptedByMerchant' => 'accepted',
'canceledAt' => '2019-12-27',
'reason' => 'x',
],
'merchantResolutionAttempted' => 'attempted',
'misrepresentationExplanation' => 'x',
'purchaseExplanation' => 'x',
'receivedAt' => '2019-12-27',
],
'consumerServicesNotAsDescribed' => [
'cardholderCancellation' => [
'acceptedByMerchant' => 'accepted',
'canceledAt' => '2019-12-27',
'reason' => 'x',
],
'explanation' => 'x',
'merchantResolutionAttempted' => 'attempted',
'receivedAt' => '2019-12-27',
],
'consumerServicesNotReceived' => [
'cancellationOutcome' => 'cardholder_cancellation_prior_to_expected_receipt',
'lastExpectedReceiptAt' => '2019-12-27',
'merchantResolutionAttempted' => 'attempted',
'purchaseInfoAndExplanation' => 'x',
'cardholderCancellationPriorToExpectedReceipt' => [
'canceledAt' => '2019-12-27', 'reason' => 'x'
],
'merchantCancellation' => ['canceledAt' => '2019-12-27'],
'noCancellation' => [],
],
'fraud' => ['fraudType' => 'account_or_credentials_takeover'],
'processingError' => [
'errorReason' => 'duplicate_transaction',
'merchantResolutionAttempted' => 'attempted',
'duplicateTransaction' => ['otherTransactionID' => 'x'],
'incorrectAmount' => ['expectedAmount' => 0],
'paidByOtherMeans' => [
'otherFormOfPaymentEvidence' => 'canceled_check',
'otherTransactionID' => 'x',
],
],
],
);
var_dump($cardDispute);
} catch (APIException $e) {
echo $e->getMessage();
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
using System;
using Increase.Api;
using Increase.Api.Models.CardDisputes;
IncreaseClient client = new();
CardDisputeCreateParams parameters = new()
{
DisputedTransactionID = "transaction_uyrp7fld2ium70oa7oi",
Network = Network.Visa,
};
var cardDispute = await client.CardDisputes.Create(parameters);
Console.WriteLine(cardDispute);
Parameters
amount
integer
The monetary amount of the part of the transaction that is being disputed. This is optional and will default to the full amount of the transaction if not provided. If provided, the amount must be less than or equal to the amount of the transaction.
attachment_files
array
The files to be attached to the initial dispute submission.
disputed_transaction_id
string
Required
The Transaction you wish to dispute. This Transaction must have a source_type of card_settlement.
More about Transactions.
explanation
string
The free-form explanation provided to Increase to provide more context for the user submission. This field is not sent directly to the card networks.
network
enum
Required
The network of the disputed transaction. Details specific to the network are required under the sub-object with the same identifier as the network.
visa
dictionary
The Visa-specific parameters for the dispute. Required if and only if network is visa.
Retrieve a Card Dispute
1
2
3
curl \
--url "${INCREASE_URL}/card_disputes/card_dispute_h9sc95nbl1cgltpp7men" \
-H "Authorization: Bearer ${INCREASE_API_KEY}"1
2
3
4
5
6
7
8
9
import Increase from 'increase';
const client = new Increase({
apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});
const cardDispute = await client.cardDisputes.retrieve('card_dispute_h9sc95nbl1cgltpp7men');
console.log(cardDispute.id);1
2
3
4
5
6
7
8
9
10
import os
from increase import Increase
client = Increase(
api_key=os.environ.get("INCREASE_API_KEY"), # This is the default and can be omitted
)
card_dispute = client.card_disputes.retrieve(
"card_dispute_h9sc95nbl1cgltpp7men",
)
print(card_dispute.id)1
2
3
4
5
6
7
8
9
require "increase"
increase = Increase::Client.new(
api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)
card_dispute = increase.card_disputes.retrieve("card_dispute_h9sc95nbl1cgltpp7men")
puts(card_dispute)1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
package main
import (
"context"
"fmt"
"os"
"github.com/Increase/increase-go"
"github.com/Increase/increase-go/option"
)
func main() {
client := increase.NewClient(
option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
)
cardDispute, err := client.CardDisputes.Get(context.TODO(), "card_dispute_h9sc95nbl1cgltpp7men")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", cardDispute.ID)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
package com.increase.api.example;
import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.carddisputes.CardDispute;
import com.increase.api.models.carddisputes.CardDisputeRetrieveParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
CardDispute cardDispute = client.cardDisputes().retrieve("card_dispute_h9sc95nbl1cgltpp7men");
}
}1
2
3
4
5
6
7
8
9
10
11
12
package com.increase.api.example
import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.carddisputes.CardDispute
import com.increase.api.models.carddisputes.CardDisputeRetrieveParams
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val cardDispute: CardDispute = client.cardDisputes().retrieve("card_dispute_h9sc95nbl1cgltpp7men")
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Increase\Client;
use Increase\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('INCREASE_API_KEY'));
try {
$cardDispute = $client->cardDisputes->retrieve(
'card_dispute_h9sc95nbl1cgltpp7men'
);
var_dump($cardDispute);
} catch (APIException $e) {
echo $e->getMessage();
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
using System;
using Increase.Api;
using Increase.Api.Models.CardDisputes;
IncreaseClient client = new();
CardDisputeRetrieveParams parameters = new()
{
CardDisputeID = "card_dispute_h9sc95nbl1cgltpp7men"
};
var cardDispute = await client.CardDisputes.Retrieve(parameters);
Console.WriteLine(cardDispute);
Parameters
card_dispute_id
string
Required
The identifier of the Card Dispute.
More about Card Disputes.
Submit a User Submission for a Card Dispute
1
2
3
4
5
6
7
8
9
10
11
12
13
curl -X "POST" \
--url "${INCREASE_URL}/card_disputes/card_dispute_h9sc95nbl1cgltpp7men/submit_user_submission" \
-H "Authorization: Bearer ${INCREASE_API_KEY}" \
-H "Content-Type: application/json" \
-d $'{
"network": "visa",
"visa": {
"category": "merchant_prearbitration_decline",
"merchant_prearbitration_decline": {
"reason": "The pre-arbitration received from the merchantdoes not explain how they obtained permission to charge the card."
}
}
}'1
2
3
4
5
6
7
8
9
10
11
12
import Increase from 'increase';
const client = new Increase({
apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});
const cardDispute = await client.cardDisputes.submitUserSubmission(
'card_dispute_h9sc95nbl1cgltpp7men',
{ network: 'visa' },
);
console.log(cardDispute.id);1
2
3
4
5
6
7
8
9
10
11
import os
from increase import Increase
client = Increase(
api_key=os.environ.get("INCREASE_API_KEY"), # This is the default and can be omitted
)
card_dispute = client.card_disputes.submit_user_submission(
card_dispute_id="card_dispute_h9sc95nbl1cgltpp7men",
network="visa",
)
print(card_dispute.id)1
2
3
4
5
6
7
8
9
require "increase"
increase = Increase::Client.new(
api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)
card_dispute = increase.card_disputes.submit_user_submission("card_dispute_h9sc95nbl1cgltpp7men", network: :visa)
puts(card_dispute)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
package main
import (
"context"
"fmt"
"os"
"github.com/Increase/increase-go"
"github.com/Increase/increase-go/option"
)
func main() {
client := increase.NewClient(
option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
)
cardDispute, err := client.CardDisputes.SubmitUserSubmission(
context.TODO(),
"card_dispute_h9sc95nbl1cgltpp7men",
increase.CardDisputeSubmitUserSubmissionParams{
Network: increase.F(increase.CardDisputeSubmitUserSubmissionParamsNetworkVisa),
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", cardDispute.ID)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
package com.increase.api.example;
import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.carddisputes.CardDispute;
import com.increase.api.models.carddisputes.CardDisputeSubmitUserSubmissionParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
CardDisputeSubmitUserSubmissionParams params = CardDisputeSubmitUserSubmissionParams.builder()
.cardDisputeId("card_dispute_h9sc95nbl1cgltpp7men")
.network(CardDisputeSubmitUserSubmissionParams.Network.VISA)
.build();
CardDispute cardDispute = client.cardDisputes().submitUserSubmission(params);
}
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
package com.increase.api.example
import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.carddisputes.CardDispute
import com.increase.api.models.carddisputes.CardDisputeSubmitUserSubmissionParams
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val params: CardDisputeSubmitUserSubmissionParams = CardDisputeSubmitUserSubmissionParams.builder()
.cardDisputeId("card_dispute_h9sc95nbl1cgltpp7men")
.network(CardDisputeSubmitUserSubmissionParams.Network.VISA)
.build()
val cardDispute: CardDispute = client.cardDisputes().submitUserSubmission(params)
}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
<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Increase\Client;
use Increase\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('INCREASE_API_KEY'));
try {
$cardDispute = $client->cardDisputes->submitUserSubmission(
'card_dispute_h9sc95nbl1cgltpp7men',
network: 'visa',
amount: 1,
attachmentFiles: [['fileID' => 'file_id']],
explanation: 'x',
visa: [
'category' => 'merchant_prearbitration_decline',
'chargeback' => [
'category' => 'authorization',
'authorization' => ['accountStatus' => 'account_closed'],
'consumerCanceledMerchandise' => [
'merchantResolutionAttempted' => 'attempted',
'purchaseExplanation' => 'x',
'receivedOrExpectedAt' => '2019-12-27',
'returnOutcome' => 'not_returned',
'cardholderCancellation' => [
'canceledAt' => '2019-12-27',
'canceledPriorToShipDate' => 'canceled_prior_to_ship_date',
'cancellationPolicyProvided' => 'not_provided',
'reason' => 'x',
],
'notReturned' => [],
'returnAttempted' => [
'attemptExplanation' => 'x',
'attemptReason' => 'merchant_not_responding',
'attemptedAt' => '2019-12-27',
'merchandiseDisposition' => 'x',
],
'returned' => [
'returnMethod' => 'dhl',
'returnedAt' => '2019-12-27',
'merchantReceivedReturnAt' => '2019-12-27',
'otherExplanation' => 'x',
'trackingNumber' => 'x',
],
],
'consumerCanceledRecurringTransaction' => [
'cancellationTarget' => 'account',
'merchantContactMethods' => [
'applicationName' => 'x',
'callCenterPhoneNumber' => 'x',
'emailAddress' => 'x',
'inPersonAddress' => 'x',
'mailingAddress' => 'x',
'textPhoneNumber' => 'x',
],
'transactionOrAccountCanceledAt' => '2019-12-27',
'otherFormOfPaymentExplanation' => 'x',
],
'consumerCanceledServices' => [
'cardholderCancellation' => [
'canceledAt' => '2019-12-27',
'cancellationPolicyProvided' => 'not_provided',
'reason' => 'x',
],
'contractedAt' => '2019-12-27',
'merchantResolutionAttempted' => 'attempted',
'purchaseExplanation' => 'x',
'serviceType' => 'guaranteed_reservation',
'guaranteedReservation' => [
'explanation' => 'cardholder_canceled_prior_to_service'
],
'other' => [],
'timeshare' => [],
],
'consumerCounterfeitMerchandise' => [
'counterfeitExplanation' => 'x',
'dispositionExplanation' => 'x',
'orderExplanation' => 'x',
'receivedAt' => '2019-12-27',
],
'consumerCreditNotProcessed' => [
'canceledOrReturnedAt' => '2019-12-27',
'creditExpectedAt' => '2019-12-27',
],
'consumerDamagedOrDefectiveMerchandise' => [
'merchantResolutionAttempted' => 'attempted',
'orderAndIssueExplanation' => 'x',
'receivedAt' => '2019-12-27',
'returnOutcome' => 'not_returned',
'notReturned' => [],
'returnAttempted' => [
'attemptExplanation' => 'x',
'attemptReason' => 'merchant_not_responding',
'attemptedAt' => '2019-12-27',
'merchandiseDisposition' => 'x',
],
'returned' => [
'returnMethod' => 'dhl',
'returnedAt' => '2019-12-27',
'merchantReceivedReturnAt' => '2019-12-27',
'otherExplanation' => 'x',
'trackingNumber' => 'x',
],
],
'consumerMerchandiseMisrepresentation' => [
'merchantResolutionAttempted' => 'attempted',
'misrepresentationExplanation' => 'x',
'purchaseExplanation' => 'x',
'receivedAt' => '2019-12-27',
'returnOutcome' => 'not_returned',
'notReturned' => [],
'returnAttempted' => [
'attemptExplanation' => 'x',
'attemptReason' => 'merchant_not_responding',
'attemptedAt' => '2019-12-27',
'merchandiseDisposition' => 'x',
],
'returned' => [
'returnMethod' => 'dhl',
'returnedAt' => '2019-12-27',
'merchantReceivedReturnAt' => '2019-12-27',
'otherExplanation' => 'x',
'trackingNumber' => 'x',
],
],
'consumerMerchandiseNotAsDescribed' => [
'merchantResolutionAttempted' => 'attempted',
'receivedAt' => '2019-12-27',
'returnOutcome' => 'returned',
'returnAttempted' => [
'attemptExplanation' => 'x',
'attemptReason' => 'merchant_not_responding',
'attemptedAt' => '2019-12-27',
'merchandiseDisposition' => 'x',
],
'returned' => [
'returnMethod' => 'dhl',
'returnedAt' => '2019-12-27',
'merchantReceivedReturnAt' => '2019-12-27',
'otherExplanation' => 'x',
'trackingNumber' => 'x',
],
],
'consumerMerchandiseNotReceived' => [
'cancellationOutcome' => 'cardholder_cancellation_prior_to_expected_receipt',
'deliveryIssue' => 'delayed',
'lastExpectedReceiptAt' => '2019-12-27',
'merchantResolutionAttempted' => 'attempted',
'purchaseInfoAndExplanation' => 'x',
'cardholderCancellationPriorToExpectedReceipt' => [
'canceledAt' => '2019-12-27', 'reason' => 'x'
],
'delayed' => [
'explanation' => 'x',
'returnOutcome' => 'not_returned',
'notReturned' => [],
'returnAttempted' => ['attemptedAt' => '2019-12-27'],
'returned' => [
'merchantReceivedReturnAt' => '2019-12-27',
'returnedAt' => '2019-12-27',
],
],
'deliveredToWrongLocation' => ['agreedLocation' => 'x'],
'merchantCancellation' => ['canceledAt' => '2019-12-27'],
'noCancellation' => [],
],
'consumerNonReceiptOfCash' => [],
'consumerOriginalCreditTransactionNotAccepted' => [
'explanation' => 'x',
'reason' => 'prohibited_by_local_laws_or_regulation',
],
'consumerQualityMerchandise' => [
'expectedAt' => '2019-12-27',
'merchantResolutionAttempted' => 'attempted',
'purchaseInfoAndQualityIssue' => 'x',
'receivedAt' => '2019-12-27',
'returnOutcome' => 'not_returned',
'notReturned' => [],
'ongoingNegotiations' => [
'explanation' => 'x',
'issuerFirstNotifiedAt' => '2019-12-27',
'startedAt' => '2019-12-27',
],
'returnAttempted' => [
'attemptExplanation' => 'x',
'attemptReason' => 'merchant_not_responding',
'attemptedAt' => '2019-12-27',
'merchandiseDisposition' => 'x',
],
'returned' => [
'returnMethod' => 'dhl',
'returnedAt' => '2019-12-27',
'merchantReceivedReturnAt' => '2019-12-27',
'otherExplanation' => 'x',
'trackingNumber' => 'x',
],
],
'consumerQualityServices' => [
'cardholderCancellation' => [
'acceptedByMerchant' => 'accepted',
'canceledAt' => '2019-12-27',
'reason' => 'x',
],
'nonFiatCurrencyOrNonFungibleTokenRelatedAndNotMatchingDescription' => 'not_related',
'purchaseInfoAndQualityIssue' => 'x',
'servicesReceivedAt' => '2019-12-27',
'cardholderPaidToHaveWorkRedone' => 'did_not_pay_to_have_work_redone',
'ongoingNegotiations' => [
'explanation' => 'x',
'issuerFirstNotifiedAt' => '2019-12-27',
'startedAt' => '2019-12-27',
],
'restaurantFoodRelated' => 'not_related',
],
'consumerServicesMisrepresentation' => [
'cardholderCancellation' => [
'acceptedByMerchant' => 'accepted',
'canceledAt' => '2019-12-27',
'reason' => 'x',
],
'merchantResolutionAttempted' => 'attempted',
'misrepresentationExplanation' => 'x',
'purchaseExplanation' => 'x',
'receivedAt' => '2019-12-27',
],
'consumerServicesNotAsDescribed' => [
'cardholderCancellation' => [
'acceptedByMerchant' => 'accepted',
'canceledAt' => '2019-12-27',
'reason' => 'x',
],
'explanation' => 'x',
'merchantResolutionAttempted' => 'attempted',
'receivedAt' => '2019-12-27',
],
'consumerServicesNotReceived' => [
'cancellationOutcome' => 'cardholder_cancellation_prior_to_expected_receipt',
'lastExpectedReceiptAt' => '2019-12-27',
'merchantResolutionAttempted' => 'attempted',
'purchaseInfoAndExplanation' => 'x',
'cardholderCancellationPriorToExpectedReceipt' => [
'canceledAt' => '2019-12-27', 'reason' => 'x'
],
'merchantCancellation' => ['canceledAt' => '2019-12-27'],
'noCancellation' => [],
],
'fraud' => ['fraudType' => 'account_or_credentials_takeover'],
'processingError' => [
'errorReason' => 'duplicate_transaction',
'merchantResolutionAttempted' => 'attempted',
'duplicateTransaction' => ['otherTransactionID' => 'x'],
'incorrectAmount' => ['expectedAmount' => 0],
'paidByOtherMeans' => [
'otherFormOfPaymentEvidence' => 'canceled_check',
'otherTransactionID' => 'x',
],
],
],
'merchantPrearbitrationDecline' => [
'reason' => 'The pre-arbitration received from the merchantdoes not explain how they obtained permission to charge the card.',
],
'userPrearbitration' => [
'reason' => 'x',
'categoryChange' => ['category' => 'authorization', 'reason' => 'x'],
],
],
);
var_dump($cardDispute);
} catch (APIException $e) {
echo $e->getMessage();
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
using System;
using Increase.Api;
using Increase.Api.Models.CardDisputes;
IncreaseClient client = new();
CardDisputeSubmitUserSubmissionParams parameters = new()
{
CardDisputeID = "card_dispute_h9sc95nbl1cgltpp7men",
Network = CardDisputeSubmitUserSubmissionParamsNetwork.Visa,
};
var cardDispute = await client.CardDisputes.SubmitUserSubmission(parameters);
Console.WriteLine(cardDispute);
Parameters
card_dispute_id
string
Required
The identifier of the Card Dispute to submit a user submission for.
More about Card Disputes.
amount
integer
The adjusted monetary amount of the part of the transaction that is being disputed. This is optional and will default to the most recent amount provided. If provided, the amount must be less than or equal to the amount of the transaction.
attachment_files
array
The files to be attached to the user submission.
explanation
string
The free-form explanation provided to Increase to provide more context for the user submission. This field is not sent directly to the card networks.
network
enum
Required
The network of the Card Dispute. Details specific to the network are required under the sub-object with the same identifier as the network.
visa
dictionary
The Visa-specific parameters for the dispute. Required if and only if network is visa.
Withdraw a Card Dispute
1
2
3
4
5
6
7
curl -X "POST" \
--url "${INCREASE_URL}/card_disputes/card_dispute_h9sc95nbl1cgltpp7men/withdraw" \
-H "Authorization: Bearer ${INCREASE_API_KEY}" \
-H "Content-Type: application/json" \
-d $'{
"explanation": "The explanation for withdrawing the Card Dispute."
}'1
2
3
4
5
6
7
8
9
import Increase from 'increase';
const client = new Increase({
apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});
const cardDispute = await client.cardDisputes.withdraw('card_dispute_h9sc95nbl1cgltpp7men');
console.log(cardDispute.id);1
2
3
4
5
6
7
8
9
10
import os
from increase import Increase
client = Increase(
api_key=os.environ.get("INCREASE_API_KEY"), # This is the default and can be omitted
)
card_dispute = client.card_disputes.withdraw(
card_dispute_id="card_dispute_h9sc95nbl1cgltpp7men",
)
print(card_dispute.id)1
2
3
4
5
6
7
8
9
require "increase"
increase = Increase::Client.new(
api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)
card_dispute = increase.card_disputes.withdraw("card_dispute_h9sc95nbl1cgltpp7men")
puts(card_dispute)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
package main
import (
"context"
"fmt"
"os"
"github.com/Increase/increase-go"
"github.com/Increase/increase-go/option"
)
func main() {
client := increase.NewClient(
option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
)
cardDispute, err := client.CardDisputes.Withdraw(
context.TODO(),
"card_dispute_h9sc95nbl1cgltpp7men",
increase.CardDisputeWithdrawParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", cardDispute.ID)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
package com.increase.api.example;
import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.carddisputes.CardDispute;
import com.increase.api.models.carddisputes.CardDisputeWithdrawParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
CardDispute cardDispute = client.cardDisputes().withdraw("card_dispute_h9sc95nbl1cgltpp7men");
}
}1
2
3
4
5
6
7
8
9
10
11
12
package com.increase.api.example
import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.carddisputes.CardDispute
import com.increase.api.models.carddisputes.CardDisputeWithdrawParams
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val cardDispute: CardDispute = client.cardDisputes().withdraw("card_dispute_h9sc95nbl1cgltpp7men")
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Increase\Client;
use Increase\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('INCREASE_API_KEY'));
try {
$cardDispute = $client->cardDisputes->withdraw(
'card_dispute_h9sc95nbl1cgltpp7men',
explanation: 'The explanation for withdrawing the Card Dispute.',
);
var_dump($cardDispute);
} catch (APIException $e) {
echo $e->getMessage();
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
using System;
using Increase.Api;
using Increase.Api.Models.CardDisputes;
IncreaseClient client = new();
CardDisputeWithdrawParams parameters = new()
{
CardDisputeID = "card_dispute_h9sc95nbl1cgltpp7men"
};
var cardDispute = await client.CardDisputes.Withdraw(parameters);
Console.WriteLine(cardDispute);
Parameters
card_dispute_id
string
Required
The identifier of the Card Dispute to withdraw.
More about Card Disputes.
explanation
string
The explanation for withdrawing the Card Dispute.
Sandbox: Advance the state of a Card Dispute
After a Card Dispute is created in production, the dispute will initially be in a pending_user_submission_reviewing state. Since no review or further action happens in sandbox, this endpoint simulates moving a Card Dispute through its various states.
1
2
3
4
5
6
7
8
9
10
11
curl -X "POST" \
--url "${INCREASE_URL}/simulations/card_disputes/card_dispute_h9sc95nbl1cgltpp7men/action" \
-H "Authorization: Bearer ${INCREASE_API_KEY}" \
-H "Content-Type: application/json" \
-d $'{
"network": "visa",
"visa": {
"accept_user_submission": {},
"action": "accept_user_submission"
}
}'1
2
3
4
5
6
7
8
9
10
11
12
import Increase from 'increase';
const client = new Increase({
apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});
const cardDispute = await client.simulations.cardDisputes.action(
'card_dispute_h9sc95nbl1cgltpp7men',
{ network: 'visa' },
);
console.log(cardDispute.id);1
2
3
4
5
6
7
8
9
10
11
import os
from increase import Increase
client = Increase(
api_key=os.environ.get("INCREASE_API_KEY"), # This is the default and can be omitted
)
card_dispute = client.simulations.card_disputes.action(
card_dispute_id="card_dispute_h9sc95nbl1cgltpp7men",
network="visa",
)
print(card_dispute.id)1
2
3
4
5
6
7
8
9
require "increase"
increase = Increase::Client.new(
api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)
card_dispute = increase.simulations.card_disputes.action("card_dispute_h9sc95nbl1cgltpp7men", network: :visa)
puts(card_dispute)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
package main
import (
"context"
"fmt"
"os"
"github.com/Increase/increase-go"
"github.com/Increase/increase-go/option"
)
func main() {
client := increase.NewClient(
option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
)
cardDispute, err := client.Simulations.CardDisputes.Action(
context.TODO(),
"card_dispute_h9sc95nbl1cgltpp7men",
increase.SimulationCardDisputeActionParams{
Network: increase.F(increase.SimulationCardDisputeActionParamsNetworkVisa),
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", cardDispute.ID)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
package com.increase.api.example;
import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.carddisputes.CardDispute;
import com.increase.api.models.simulations.carddisputes.CardDisputeActionParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
CardDisputeActionParams params = CardDisputeActionParams.builder()
.cardDisputeId("card_dispute_h9sc95nbl1cgltpp7men")
.network(CardDisputeActionParams.Network.VISA)
.build();
CardDispute cardDispute = client.simulations().cardDisputes().action(params);
}
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
package com.increase.api.example
import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.carddisputes.CardDispute
import com.increase.api.models.simulations.carddisputes.CardDisputeActionParams
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val params: CardDisputeActionParams = CardDisputeActionParams.builder()
.cardDisputeId("card_dispute_h9sc95nbl1cgltpp7men")
.network(CardDisputeActionParams.Network.VISA)
.build()
val cardDispute: CardDispute = client.simulations().cardDisputes().action(params)
}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
<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Increase\Client;
use Increase\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('INCREASE_API_KEY'));
try {
$cardDispute = $client->simulations->cardDisputes->action(
'card_dispute_h9sc95nbl1cgltpp7men',
network: 'visa',
visa: [
'action' => 'accept_user_submission',
'acceptChargeback' => [],
'acceptUserSubmission' => [],
'declineUserPrearbitration' => [],
'receiveMerchantPrearbitration' => [],
'represent' => [],
'requestFurtherInformation' => ['reason' => 'x'],
'timeOutChargeback' => [],
'timeOutMerchantPrearbitration' => [],
'timeOutRepresentment' => [],
'timeOutUserPrearbitration' => [],
],
);
var_dump($cardDispute);
} catch (APIException $e) {
echo $e->getMessage();
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
using System;
using Increase.Api;
using Increase.Api.Models.Simulations.CardDisputes;
IncreaseClient client = new();
CardDisputeActionParams parameters = new()
{
CardDisputeID = "card_dispute_h9sc95nbl1cgltpp7men",
Network = Network.Visa,
};
var cardDispute = await client.Simulations.CardDisputes.Action(parameters);
Console.WriteLine(cardDispute);
Parameters
card_dispute_id
string
Required
The dispute you would like to action.
More about Card Disputes.
network
enum
Required
The network of the Card Dispute. Details specific to the network are required under the sub-object with the same identifier as the network.
visa
dictionary
The Visa-specific parameters for the taking action on the dispute. Required if and only if network is visa.