CMS API

The CMS API is used to pull Chargeback case data from ConnexPay’s CMS (Chargeback Management System).

Authentication

The API uses basic authentication by adding the username and password in the auth header as Base64 encoded string appended to the text "Basic". The Chargeback system requires merchant specific API credentials be created separately from your normal ConnexPay CRM user.

Endpoints

The CMS API is publicly accessible via the following base url path.
Base URL: https://cmsapi.connexpay.com/chargeback/

GetByUser Resource

The GetByUser endpoint returns merchant specific chargeback data for a given user. You may also specify the start and end date. See the request samples below for an example.

Sample Postman Request

10031003

Sample Requests

Return all chargebacks for the authenticated user:
https://cmsapi.connexpay.com/api/Chargeback/GetByUser

Return all chargebacks for the authenticated user with a start date:
https://cmsapi.connexpay.com/api/Chargeback/GetByUser?startDate=2016-12-01

Return all chargebacks for the authenticated user with a start and end date:
https://cmsapi.connexpay.com/api/Chargeback/GetByUser?startDate=2016-12-01&endDate=2016-12-01

Return all chargebacks for the authenticated user with a start and end date based on resolved date:
https://cmsapi.connexpay.com/api/Chargeback/GetByResolvedDate?startDate=2019-09-20&endDate=2019-10-21

Sample Response

[
    {
        "ID": 00001,
        "UUID": "abc123 ",
        "FileId": 00001,
        "MerchantId": 001,
        "Arn": "12312312312312312312312",
        "CaseNumber": "0000000000001",
        "Amount": 298.00,
        "RecordType": " ",
        "CaseType": "25",
        "ReasonCode": "4837",
        "ReasonDescription": "No Cardholder Authorization                       ",
        "CardBrand": 2,
        "TransactionCode": "05",
        "ResolutionTo": "M",
        "TransactionDate": "2020-12-08T00:00:00",
        "LoadDate": "2021-02-12T00:00:00",
        "PostDate": "2020-12-08T00:00:00",
        "ResolvedDate": "2021-03-02T00:00:00",
        "FamilyId": 00000001,
        "HasImage": false,
        "HasResponse": false,
        "ImageFileUrl": "",
        "Created": "2021-03-02T23:01:00",
        "OrderNumber": "23447161",
        "DueDate": "2021-02-24T00:00:00",
        "IsSurrendered": false,
        "IdSale": 0000001,
        "IncomingTransactionCode": "1231231231231231231231231",
        "SaleGuid": "1238aff0-18b3-46ce-b123-1ede8ff09123",
        "SaleFirstFour": "1234",
        "SaleLastFour": "1234",
        "AuthCode": "12312Z",
        "NetPosition": -298.0000,
        "WinLoss": "Loss (Pending)"
    },
    {
        "ID": 00002,
        "UUID": "abc456 ",
        "FileId": 00001,
        "MerchantId": 115,
        "Arn": "45645645645645645645645",
        "CaseNumber": "0000000000002",
        "Amount": 61.39,
        "RecordType": " ",
        "CaseType": "21",
        "ReasonCode": "13.1",
        "ReasonDescription": "Merchandise/Services Not Received                 ",
        "CardBrand": 1,
        "TransactionCode": "05",
        "ResolutionTo": "M",
        "TransactionDate": "2021-02-04T00:00:00",
        "LoadDate": "2021-02-16T00:00:00",
        "PostDate": "2021-02-04T00:00:00",
        "ResolvedDate": "2021-02-16T00:00:00",
        "FamilyId": 00000002,
        "HasImage": false,
        "HasResponse": false,
        "ImageFileUrl": "",
        "Created": "2021-02-16T23:02:00",
        "OrderNumber": "45121742",
        "DueDate": "2021-02-28T00:00:00",
        "IsSurrendered": false,
        "IdSale": 0000002,
        "IncomingTransactionCode": "456DF6263745611632034566",
        "SaleGuid": "456f41ef-4564-456e-85dc-d1a0545684d8",
        "SaleFirstFour": "4567",
        "SaleLastFour": "4567",
        "AuthCode": "45645A",
        "NetPosition": 0.0000,
        "WinLoss": "Win"
    }
]

API Reference

ParameterDescription
IDConnexPay specific ID
UUIDProcessor specific Identifier
FileIdConnexPay specific ID that identifies which file this chargeback came in on
MerchantIdThe ID of the Merchant
ArnThe ARN (Acquirer Reference Number) of the chargeback. If there are multiple chargebacks or chargeback events associated with the same transaction/chargeback, they will all have the same Arn (but different Case Numbers).
CaseNumberThe Case Number of the chargeback
AmountAmount of the chargeback
RecordTypePossible values are Blank or R
CaseTypeRecord descriptor for the case. See "Reference Case Types" below for a list of available types and descriptions.
ReasonCodeReason Code and Reason Description go hand in hand. See Ref ReasonCodes for a list of available types and descriptions.
ReasonDescriptionSee Reason Code section above
CardBrand1 - Visa

2 - MasterCard

3 - Discover

4 - American Express

5 - PayPal
TransactionCode05 - Credit

06 - Debit
ResolutionToResolution To indicates the party responsible for responding to a specific case. As a chargeback transitions through its various states, new cases (related by FamilyId) are created with specific Resolution To values indicating the party responsible for acting.

M - means the merchant is responsible for responding to the current case

B - means the bank is responsible for responding to the current case

S - means the chargeback has been resolved to split, meaning a partial credit has been issued

G - means the case has been moved to the general ledger and is likely being offset by another duplicate or related chargeback
TransactionDateDate of the original transaction (not the date of the chargeback)
LoadDateThe date the chargeback was loaded in to the system
PostDateThe date the chargeback was posted in to the system
ResolvedDateThe date the chargeback was resolved
FamilyIdAka, Chargeback Id, this Id groups chargeback data together into a “family” of related cases for a given chargeback.
HasImageIndicates if there is supporting documentation for the particular chargeback
HasResponseIndicates if the chargeback has been responded to
ImageFileUrlThe URL of the image file containing the supporting documentation of the chargeback
CreatedDate and time record was created in database
OrderNumberOrder number submitted with the original transaction. This is what most clients will want to use to tie the chargeback in their system
DueDateThis is when the chargeback needs to be responded to based on the chargeback rules about time to respond
IsSurrendered
IdSale
IncomingTransactionCode
SaleGuid
SaleFirstFour
SaleLastFour
AuthCode
NetPosition
WinLoss
CodeDescriptionAbbreviation
0RetrievalR
1First ChargebackFC
2Second ChargebackSC
3First ReversalFR
4Second ReversalSR
9Visa Pre ArbVPA
17Amex RetrievalAR
18Amex ChargebackAC
19Amex ReversalARV
20AllocationALC
21CollaborationCL
22Allocation ReversalALRV
23Collaboration ReversalCLRV
24Collaboration Pre ArbCPA
11Disc RetrievalDR
12Disc ChargebackDSC
13Disc ReversalDSR
14Disc PreArbDSPA
15Disc Incoming Dispute ArbDSID
16Disc PreArb/Arb DebitDSPD

Reason Codes

10.1EMV Liability Shift Non-Counterfeit FraudVisa
10.2EMV Liability Shift Counterfeit FraudVisa
10.3Other Fraud - Card-Present EnvVisa
10.4Other Fraud - Card-Absent EnvVisa
10.5Visa Fraud Monitoring ProgramVisa
11.1Card Recovery BulletinVisa
11.2Declined AuthVisa
11.3No AuthVisa
12.1Late PresentmentVisa
12.2Incorrect Transaction CodeVisa
12.3Incorrect CurrencyVisa
12.4Incorrect Account NumberVisa
12.5Incorrect AmountVisa
12.7Invalid DataVisa
12.6Dup Process/Paid by Other MeansVisa
13.1Merch/Svc Not RecdVisa
13.2Cancelled Recurring TransactionVisa
13.3Not as Described or Defective MerchVisa
13.4Counterfeit MerchVisa
13.5MisrepresentationVisa
13.6Credit Not ProcessedVisa
13.7Cancelled Merch/SvcVisa
13.8Orig Credit Transaction Not AcceptedVisa
13.9Non-Receipt of Cash or LoadVisa
4808Auth related chargebackMastercard
4812Account Number Not on fileMastercard
4841Cancelled Recurring or Dig GoodsMastercard
4853Cardholder DisputesMastercard
4854Cardholder Disputes-Not elsewhere classifiedMastercard
4855Goods or Services Not ProvidedMastercard
4837No Cardholder AuthMastercard
4840Fraudulent Processing of TransactionMastercard
4849Questionable Merchant ActivityMastercard
4863Cardholder Does Not Recognize/Potential FruadMastercard
4870Chip Liability ShiftMastercard
4871Chip/PIN Liability Shift-Lost/Stolen/Never Recd Issue FraudMastercard
4831incorrect Trans AmountMastercard
4834Point of Interaction - POIMastercard
4842Late PresentmentMastercard
4846Incorrect Currency CodeMastercard