Issue Provisional Credit

If a customer wishes to dispute a transaction, in some cases you need to issue a provisional credit while the dispute is being processed. Use the API endpoint below to issue a credit and tie it to the original transaction via the "parentTxnId" field. See also Recover Provisional Credit.

ENDPOINT

1. /v1/dispute/credit

REQUEST

1. {
2.  "parentTxnId":"txn-7ea45596-916b-44f2-ba75-6df3ed86b423",
3.  "amount":"5.00",
4.  "title":"Optional title",
5.  "description":"Optional description"
6. }
7. ‍

RESPONSE

1. {
2.  "id": "txn-33f6a59c-c092-4fe8-b803-3a87a9cb7871",
3.  "txnType": "credit",
4.  "title": "Optional title",
5.  "amount": "5.00",
6.  "transferType": "card",
7.  "subType": "provisional",
8.  "description": "Optional description",
9.  "balance": "997.00",
10.  "status": "settled",
11.  "accountId": "acc-08e95401-5bc1-4f6e-aeb9-d66a5fd61a12",
12.  "businessId": "bus-968f407a-66dd-4fbc-b563-5ba45a7a30dc",
13.  "programId": "prg-b29fd1c3-cd5a-4cfa-a0e1-f78193c7b91f",
14.  "personId": "per-80a3796e-6471-4225-9003-8d8df0484aa5",
15.  "familyId": "",
16.  "parentTransferId": "tra-f6ca69b0-2d34-4ea3-8274-3d3da97f98c8",
17.  "parentTxnId": "txn-7ea45596-916b-44f2-ba75-6df3ed86b423",
18.  "reviewCode": "",
19.  "reviewMessage": "",
20.  "intrabank": null,
21.  "ach": null,
22.  "card": {
23.    "id": "",
24.    "transferId": "tra-f6fbd9ab-2c0e-4588-a476-8d65c404f152",
25.    "label": "",
26.    "merchant": {
27.      "merchantName": "",
28.      "merchantCity": "",
29.      "merchantState": "",
30.      "merchantCountry": "",
31.      "postalCode": "",
32.      "merchantCategory": "",
33.      "merchantCategoryCode": "",
34.      "merchantId": ""
35.    },
36.    "authMethod": "other",
37.    "wallet": "",
38.    "authId": "",
39.    "localTransactionAmount": "0.00",
40.    "localTransactionCurrency": "",
41.    "currencyConversionRate": "",
42.    "rewardAmount": "",
43.    "isCaptured": false,
44.    "capturedAt": "",
45.    "disputeStatus": "notInitiated",
46.    "availableLimit": "",
47.    "pinVerified": false,
48.    "3DSVerified": false
49.  },
50.  "domesticWire": null,
51.  "internationalWire": null,
52.  "digitalCheck": null,
53.  "physicalCheck": null,
54.  "debitCard": null,
55.  "solidCard": null,
56.  "crossBorder": null,
57.  "buy": null,
58.  "sell": null,
59.  "enrichedData": null,
60.  "dispute": null,
61.  "createdAt": "2024-01-24T09:25:10Z",
62.  "modifiedAt": "2024-01-24T09:25:10Z",
63.  "txnDate": "2024-01-24T09:25:10Z",
64.  "metadata": null,
65.  "fallbackTransferId": "",
66.  "fallbackTxnId": ""
67. }