API referencePay In endpointsDisputes and Returns

Get dispute record

Retrieves a chargeback record and its details.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

IdlongRequired

ID of the chargeback or return record. This is returned as chargebackId in the RecievedChargeback and ReceivedAchReturn webhook notifications.

Response

Success
accountTypestring
Bank account type or card brand.
caseNumberstring
Number of case assigned to the chargeback.
chargebackDatedatetime

Date of chargeback in format YYYY-MM-DD or MM/DD/YYYY.

createdAtdatetime
Timestamp when the register was created, in UTC.
customerobject
idlong
Identifier of chargeback or return.
lastFourstring
Last 4 digits of card or bank account involved in chargeback or return.
methodstring

Type of payment vehicle: ach or card.

netAmountdouble
Net amount in chargeback or ACH return.
orderIdstring<=250 characters
Custom identifier for the transaction.
parentOrgNamestring
The name of the parent organization.
paymentDataobject
PaymentIdstring
ReferenceId of the transaction in Payabli.
paypointDbanamestring
The paypoint's DBA name.
paypointEntrynamestring<=50 characters
The paypoint's entryname.
paypointLegalnamestring
The paypoint's legal name.
reasonstring
Text describing the chargeback or ACH return reason.
reasonCodestring
'R' code for returned ACH or custom code identifying the reason.
referenceNumberstring
Processor reference number to the chargeback.
responseslist of objects
Chargeback response records.
statusinteger

Status for chargeback or ACH return

  • 0: Open (chargebacks only)
  • 1: Pending (chargebacks only)
  • 2: Closed-Won (chargebacks only)
  • 3: Closed-Lost (chargebacks only)
  • 4: ACH Return (ACH only)
  • 5: ACH Dispute, Not Authorized (ACH only)
transactionobject
transactionTimedatetime
Timestamp when transaction was submitted, in UTC.

Errors

400
Bad Request Error
400
Bad Request Error
401
Unauthorized Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error