Overview

A Chargeback's Details can be viewed with the Pay1st gateway after a payment has been processed. This API is a GET request returns the details of 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}

Chargeback Status URL Parameters

These are the list of POST parameters that needs to be passed from the Pay1st Partner to the Pay1st Gateway.

Param	Format	Mandatory	Description
chargebackReference	Decimal	N	The chargeback reference

Success 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 `AccessToken`might be used

HTTP Response Body:

{
  "chargebackReference": "CB-11111",
  "transactionReference": "C-12345-T",
  "chargebackAmount": 100.00,
  "currencyCode": "ZAR",
  "reasonCode": "FRAUDULENT",
  "reasonDescription": "Fraudulent transaction",
  "status": "OPEN",
  "responseDeadline": "2026-03-11T04:00:00Z",
  "createdDate": "2026-03-10T12:00:00Z",
  "lastModifiedDate": "2026-03-10T12:00:00Z",
  "statusHistory": [
    {
      "status": "OPEN",
      "message": "Chargeback initiated by issuing bank",
      "createdDate": "2026-03-10T12:00:00Z"
    }
  ]
}

HTTP Response Fields

Name	Type	Description
chargebackReference	String	A unique identifier that identifies the chargeback transaction
transactionReference	String	The original Pay1st transaction reference for the request
chargebackAmount	Number	The amount of the chargeback
currencyCode	String	The currency code used for the chargeback
reasonCode	String	Indicates the reason code for the chargeback. Possible values are `FRAUDULENT, DUPLICATE, PRODUCT_NOT_RECEIVED, PRODUCT_UNACCEPTABLE, CREDIT_NOT_PROCESSED, SUBSCRIPTION_CANCELLED, AUTHORIZATION_ERROR, GENERAL, OTHER`
reasonDescription	String	Describes the chargeback in more detail
status	String	The status of the chargeback. Valid statuses are `OPEN, UNDER_REVIEW, WON, LOST, CANCELLED`
responseDeadline	String	The date at which to respond for the chargeback
createdDate	String	The date when the chargeback has been created
lastModifiedDate	String	The date when the chargeback has been last modified
statusHistory	List[StatusHistory]	A list of Status History objects that describes the timeline of the chargeback

StatusHistory Fields

Name	Type	Description
status	String	The status of the chargeback transitioned into. Valid statuses are `OPEN, UNDER_REVIEW, WON, LOST, CANCELLED`
message	String	The detailed message of the chargeback
createdDate	String	The date when the chargeback has been created

Error Response

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