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

Parameter

Description

ID

ConnexPay specific ID

UUID

Processor specific Identifier

FileId

ConnexPay specific ID that identifies which file this chargeback came in on

MerchantId

The ID of the Merchant

Arn

The 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).

CaseNumber

The Case Number of the chargeback

Amount

Amount of the chargeback

RecordType

Possible values are Blank or R

CaseType

Record descriptor for the case. See "Reference Case Types" below for a list of available types and descriptions.

ReasonCode

Reason Code and Reason Description go hand in hand. See Ref ReasonCodes for a list of available types and descriptions.

ReasonDescription

See Reason Code section above

CardBrand

1 - Visa

2 - MasterCard

3 - Discover

4 - American Express

5 - PayPal

TransactionCode

05 - Credit

06 - Debit

ResolutionTo

Resolution 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

TransactionDate

Date of the original transaction (not the date of the chargeback)

LoadDate

The date the chargeback was loaded in to the system

PostDate

The date the chargeback was posted in to the system

ResolvedDate

The date the chargeback was resolved

FamilyId

Aka, Chargeback Id, this Id groups chargeback data together into a “family” of related cases for a given chargeback.

HasImage

Indicates if there is supporting documentation for the particular chargeback

HasResponse

Indicates if the chargeback has been responded to

ImageFileUrl

The URL of the image file containing the supporting documentation of the chargeback

Created

Date and time record was created in database

OrderNumber

Order number submitted with the original transaction. This is what most clients will want to use to tie the chargeback in their system

DueDate

This 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

Code

Description

Abbreviation

0

Retrieval

R

1

First Chargeback

FC

2

Second Chargeback

SC

3

First Reversal

FR

4

Second Reversal

SR

9

Visa Pre Arb

VPA

17

Amex Retrieval

AR

18

Amex Chargeback

AC

19

Amex Reversal

ARV

20

Allocation

ALC

21

Collaboration

CL

22

Allocation Reversal

ALRV

23

Collaboration Reversal

CLRV

24

Collaboration Pre Arb

CPA

11

Disc Retrieval

DR

12

Disc Chargeback

DSC

13

Disc Reversal

DSR

14

Disc PreArb

DSPA

15

Disc Incoming Dispute Arb

DSID

16

Disc PreArb/Arb Debit

DSPD

Reason Codes

10.1

EMV Liability Shift Non-Counterfeit Fraud

Visa

10.2

EMV Liability Shift Counterfeit Fraud

Visa

10.3

Other Fraud - Card-Present Env

Visa

10.4

Other Fraud - Card-Absent Env

Visa

10.5

Visa Fraud Monitoring Program

Visa

11.1

Card Recovery Bulletin

Visa

11.2

Declined Auth

Visa

11.3

No Auth

Visa

12.1

Late Presentment

Visa

12.2

Incorrect Transaction Code

Visa

12.3

Incorrect Currency

Visa

12.4

Incorrect Account Number

Visa

12.5

Incorrect Amount

Visa

12.7

Invalid Data

Visa

12.6

Dup Process/Paid by Other Means

Visa

13.1

Merch/Svc Not Recd

Visa

13.2

Cancelled Recurring Transaction

Visa

13.3

Not as Described or Defective Merch

Visa

13.4

Counterfeit Merch

Visa

13.5

Misrepresentation

Visa

13.6

Credit Not Processed

Visa

13.7

Cancelled Merch/Svc

Visa

13.8

Orig Credit Transaction Not Accepted

Visa

13.9

Non-Receipt of Cash or Load

Visa

4808

Auth related chargeback

Mastercard

4812

Account Number Not on file

Mastercard

4841

Cancelled Recurring or Dig Goods

Mastercard

4853

Cardholder Disputes

Mastercard

4854

Cardholder Disputes-Not elsewhere classified

Mastercard

4855

Goods or Services Not Provided

Mastercard

4837

No Cardholder Auth

Mastercard

4840

Fraudulent Processing of Transaction

Mastercard

4849

Questionable Merchant Activity

Mastercard

4863

Cardholder Does Not Recognize/Potential Fruad

Mastercard

4870

Chip Liability Shift

Mastercard

4871

Chip/PIN Liability Shift-Lost/Stolen/Never Recd Issue Fraud

Mastercard

4831

incorrect Trans Amount

Mastercard

4834

Point of Interaction - POI

Mastercard

4842

Late Presentment

Mastercard

4846

Incorrect Currency Code

Mastercard


Did this page help you?