APIPay In endpointsDisputes and Returns

Get dispute record

Retrieves a chargeback record and its details.

Path parameters

IdlongRequired

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

Headers

requestTokenstringRequired

Response

Success
Idlong
Identifier of chargeback or return.
ChargebackDatedatetime

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

CaseNumberstring
Number of case assigned to the chargeback.
ReasonCodestring
R code for returned ACH or custom code identifying the reason.
Reasonstring
Text describing the chargeback or ACH return reason.
ReferenceNumberstring
Processor reference number to the chargeback.
LastFourstring
Last 4 digits of card or bank account involved in chargeback or return.
AccountTypestring
Bank account type or card brand.
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)
Methodstring

Type of payment vehicle: ach or card.

CreatedAtdatetime
Timestamp when the register was created, in UTC.
ReplyBydatetime
Time that a response to a chargeback is due, in UTC.
PaymentTransIdstring
ReferenceId of the transaction in Payabli.
OrderIdstring<=250 characters
Custom identifier for the transaction.
TransactionTimedatetime
Timestamp when transaction was submitted, in UTC.
Customerobject
PaymentDataobject
PaypointLegalnamestring
The paypoint's legal name.
PaypointDbanamestring
The paypoint's DBA name.
ParentOrgNamestring
The name of the parent organization.
ParentOrgIdlong
The ID of the parent organization.
PaypointEntrynamestring<=50 characters
The paypoint's entryname.
Responseslist of objects
Chargeback response records.
Transactionobject
messageslist of objects
Messages related to the chargeback.
ServiceGroupstring
Service group classification.
DisputeTypestring
Type of dispute classification.
ProcessorNamestring
Name of the payment processor.
ScheduleReferencelong or null
Reference to the subscription originating the transaction.
NetAmountdouble or null
Net amount in chargeback or ACH return.
externalPaypointIDstring or null

A custom identifier for the paypoint, if applicable. Like entrypoint is the Payabli identifier for the merchant, externalPaypointId is a custom field you can use to include the merchant’s ID from your own systems.

pageidentifierstring or null
Auxiliary validation used internally by payment pages and components.

Errors