Skip to main content
POST
Report a Chargeback

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

JSON A full chargebacks object.

object
string

Value is “Chargeback”

vid
string

A Globally Unique Identifier (GUID) for this object. Assigned by CashBox.

Maximum string length: 128
amount
number

This chargeback’s settlement amount, which usually matches the amount of the original transaction. In some cases, customers charge back only part of a transaction. (Vindicia does not provide information on the items that are charged back.)

Example:

26.99

currency
string
default:USD

ISO 4217 Currency Code of this chargeback’s settlement amount. The default is USD.

presentment_amount
number

The amount charged back (in the presentment currency), which usually matches the amount of the original transaction. Specify this attribute if the original transaction was processed with Chase Paymentech in a currency other than USD.

Example:

26.99

presentment_currency
string
default:USD

The ISO 4217 currency code of this transaction at presentment. The default is USD

division_number
string

The number of your division or group your payment processor used when processing the original Transaction. Chase Paymentech refers to this number as the Division Number; Litle calls it the Report Group; MeS calls it the Profile ID.

reason_code
string

Your bank’s case number for this Chargeback object, if any.

reference_number
string

Your bank’s reference number for this Chargeback object, if any.

merchant_number
string

Your bank’s merchant number, which identifies you as the merchant.

transaction_id
string

Your unique identifier for the transaction associated with this Chargeback object. If CashBox generated the transaction, for example, for a recurring bill, CashBox created this ID for you when processing the transaction with your payment processor. If you did not process the transaction through CashBox, but only reported it to Vindicia, then this ID must match the order number you used when processing the transaction with your payment processor.

transaction_timestamp
string<date-time>

A time stamp that specifies the date and time when the original transaction occurred.

processor_received_timestamp
string<date-time>

A time stamp that specifies the date and time when your bank received the chargeback from the customer.

posted_timestamp
string<date-time>

A time stamp that specifies the date and time when the chargeback was posted in the Vindicia database. The difference in time between the chargeback, and this posted time stamp, will depend on the frequency at which Vindicia downloads chargebacks from your bank or payment processor.

status_changed_timestamp
string<date-time>

A time stamp that specifies the date and time for the last status change.

status
enum<string>

Can be Challenged, CollectionsLost, CollectionsNew, CollectionsWon, Duplicate, Expired, Incomplete, Legitimate, Lost, New, NewSecondChargeback, Pass, Represented, Responded, Retrieval, Won

Available options:
Challenged,
CollectionsLost,
CollectionsNew,
CollectionsWon,
Duplicate,
Expired,
Incomplete,
Legitimate,
Lost,
New,
NewSecondChargeback,
Pass,
Represented,
Responded,
Retrieval,
Won
merchant_user_id
string

Your unique identifier for the account of the customer who conducted the original transaction.

note
string

Notes on the Chargeback object. Vindicia personnel might make entries here during the dispute process.

metadata
string

A set of key/value pairs that you can attach to an object. Useful for storing additional information.

Response

JSON A full ChargeBacks object.

object
string

Value is “Chargeback”

vid
string

A Globally Unique Identifier (GUID) for this object. Assigned by CashBox.

Maximum string length: 128
amount
number

This chargeback’s settlement amount, which usually matches the amount of the original transaction. In some cases, customers charge back only part of a transaction. (Vindicia does not provide information on the items that are charged back.)

Example:

26.99

currency
string
default:USD

ISO 4217 Currency Code of this chargeback’s settlement amount. The default is USD.

presentment_amount
number

The amount charged back (in the presentment currency), which usually matches the amount of the original transaction. Specify this attribute if the original transaction was processed with Chase Paymentech in a currency other than USD.

Example:

26.99

presentment_currency
string
default:USD

The ISO 4217 currency code of this transaction at presentment. The default is USD

division_number
string

The number of your division or group your payment processor used when processing the original Transaction. Chase Paymentech refers to this number as the Division Number; Litle calls it the Report Group; MeS calls it the Profile ID.

reason_code
string

Your bank’s case number for this Chargeback object, if any.

reference_number
string

Your bank’s reference number for this Chargeback object, if any.

merchant_number
string

Your bank’s merchant number, which identifies you as the merchant.

transaction_id
string

Your unique identifier for the transaction associated with this Chargeback object. If CashBox generated the transaction, for example, for a recurring bill, CashBox created this ID for you when processing the transaction with your payment processor. If you did not process the transaction through CashBox, but only reported it to Vindicia, then this ID must match the order number you used when processing the transaction with your payment processor.

transaction_timestamp
string<date-time>

A time stamp that specifies the date and time when the original transaction occurred.

processor_received_timestamp
string<date-time>

A time stamp that specifies the date and time when your bank received the chargeback from the customer.

posted_timestamp
string<date-time>

A time stamp that specifies the date and time when the chargeback was posted in the Vindicia database. The difference in time between the chargeback, and this posted time stamp, will depend on the frequency at which Vindicia downloads chargebacks from your bank or payment processor.

status_changed_timestamp
string<date-time>

A time stamp that specifies the date and time for the last status change.

status
enum<string>

Can be Challenged, CollectionsLost, CollectionsNew, CollectionsWon, Duplicate, Expired, Incomplete, Legitimate, Lost, New, NewSecondChargeback, Pass, Represented, Responded, Retrieval, Won

Available options:
Challenged,
CollectionsLost,
CollectionsNew,
CollectionsWon,
Duplicate,
Expired,
Incomplete,
Legitimate,
Lost,
New,
NewSecondChargeback,
Pass,
Represented,
Responded,
Retrieval,
Won
merchant_user_id
string

Your unique identifier for the account of the customer who conducted the original transaction.

note
string

Notes on the Chargeback object. Vindicia personnel might make entries here during the dispute process.

metadata
string

A set of key/value pairs that you can attach to an object. Useful for storing additional information.