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
- An access token needs to be generated in order to use this API (see Authentication - Generate Access Token)
API Description
HTTP Headers
| Header Name | Description |
|---|---|
| AccessToken | This is the Access Token field returned from the Authentication - Generate Access Token response. This should be in the format Bearer <AccessToken> |
| Content-Type | application/vnd.carry1st.payments.chargeback+json |
URL Format
https://<payments_url>/api/pay1st/transactions/chargebacks/{chargebackreference}/evidencesSuccess Response
Valid HTTP Success Status Codes:
| HTTP Status Code | Name | Description |
|---|---|---|
| 200 | Success | This indicates that the request has been successful. |
| 400 | Bad Request | An 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
| Name | Type | Description |
|---|---|---|
| id | Number | The unique identifier for this evidence |
| uploadReference | String | The Pay1st upload reference for this evidence |
| fileName | String | The filename of the evidence |
| contentType | String | The mime type of the evidence |
| fileSizeBytes | Number | The file size of the evidence in bytes |
| source | String | Describes the source of the evidence. Possible values are MERCHANT_UPLOAD, ADMIN_UPLOAD, SYSTEM_FULFILMENT_EMAIL, SYSTEM_FULFILMENT_LOG |
| uploadedByPartnerCode | String | The Pay1st Partner code that represents the account that uploaded this evidence |
| uploadedByAdminUserId | String | If materials are uploaded using the Pay1st console, then this is uploaded with the Admin User Identifier that performed the upload |
| uploadedAt | String | The date when the evidence was uploaded |
| status | String | The status of the evidence. Possible values are ACTIVE, DELETED |
Error Response
See Handling Error Codes for more details on handling error responses.
