List Chargeback Evidences

Use this API to view the chargeback evidences/materials for chargeback transactions through the Pay1st Gateway

Used in Gateway Integration

📘

NOTE This API feature is still in a beta state

Overview

Chargeback's Evidences/Materials can be viewed with the Pay1st gateway after submitting them. This API is a GET request returns the list of evidences/materials that have been provided for the chargeback.

Pre Requisites

API Description

HTTP Headers

Header NameDescription
AccessTokenThis is the Access Token field returned from the Authentication - Generate Access Token response. This should be in the format Bearer <AccessToken>
Content-Typeapplication/vnd.carry1st.payments.chargeback+json

URL Format

https://<payments_url>/api/pay1st/transactions/chargebacks/{chargebackreference}/evidences

Success Response

Valid HTTP Success Status Codes:

HTTP Status CodeNameDescription
200SuccessThis indicates that the request has been successful.
400Bad RequestAn invalid AccessTokenmight be used

HTTP Response Body:

{
    "evidences": [
        {
            "id": 14,
            "uploadReference": "C-MW1WZHRIKPI08BGCC9O-CE",
            "chargebackReference": "C-1IBLH7AWL1YT8U00JS6-C",
            "fileName": "2022-03-01_9-35-03.png",
            "contentType": "image/png",
            "fileSizeBytes": 174653,
            "source": "ADMIN_UPLOAD",
            "uploadedByPartnerCode": "SHOP",
            "uploadedByAdminUserId": 146,
            "uploadedAt": "2026-Jun-02 07:59:15",
            "status": "ACTIVE"
        },
    ]
}

HTTP Response Fields

The response is an array of Evidences. Each Evidence object contains the following fields

NameTypeDescription
idNumberThe unique identifier for this evidence
uploadReferenceStringThe Pay1st upload reference for this evidence
fileNameStringThe filename of the evidence
contentTypeStringThe mime type of the evidence
fileSizeBytesNumberThe file size of the evidence in bytes
sourceStringDescribes the source of the evidence. Possible values are MERCHANT_UPLOAD, ADMIN_UPLOAD, SYSTEM_FULFILMENT_EMAIL, SYSTEM_FULFILMENT_LOG
uploadedByPartnerCodeStringThe Pay1st Partner code that represents the account that uploaded this evidence
uploadedByAdminUserIdStringIf materials are uploaded using the Pay1st console, then this is uploaded with the Admin User Identifier that performed the upload
uploadedAtStringThe date when the evidence was uploaded
statusStringThe status of the evidence. Possible values are ACTIVE, DELETED

Error Response

See Handling Error Codes for more details on handling error responses.