Chargeback Stage

post

https://api.signifyd.com/v3/orders/events/chargebacks/stages

To change the stage of a Chargeback in the Signifyd system, you need to record a Chargeback Stage Event.

As well as changing the Chargeback stage, this Api allows you to optionally also update the Chargeback Amount, Reason and Representment Outcome.

This event must change the stage of a Chargeback. If the request contains the existing stage, then the request will be rejected.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

orderId

string

required

The unique identifier for the order. This must be the same order ID originally provided in the Checkout/Sale event.

chargebackId

string

required

Unique Chargeback id as given by payment processor or merchant. Maximum length of 256 characters.

partnerChargebackId

string

Optional field containing a unique Id generated within a partner's system to represent a chargeback case.

chargebackStage

string

enum

required

The Chargeback Stage refers to the stage within the chargeback dispute lifecycle that the chargeback is in with respect to the payment processor/gateway.

RETRIEVAL - To be used when the issuer or the cardholder requests additional information regarding a charge on their card before they request for a credit and it is converted into a chargeback. There is no financial adjustment made at this stage.
CHARGEBACK - To be used when the issuing bank initiates the first chargeback on behalf of the cardholder by sending a chargeback notification stating the dispute reason.
- More information: First Chargeback
PREARBITRATION - A pre-arb (pre-arbitration) is a second chargeback. To be used when the merchant challenges the chargeback and the bank initially rules in the merchant's favor, the cardholder can raise a second chargeback.
- More information: Pre-Arbitration
ARBITRATION - The final step that a merchant may encounter in the chargeback process is called arbitration. Arbitration involves the relevant card association stepping in to help resolve the dispute between the acquiring and issuing banks, and by extension the merchant and the cardholder.
- More information: Arbitration
RECALLED - To be used when the issuer or the cardholder recalls the chargeback. There are no adjustments to chargeback details made at this stage.

Allowed:

changeAmount

object

The amount of the transaction and the currency it is within.

changeReason

object

A Payment Processor's view of the reason for the chargeback.

changeRepresentmentOutcome

string

enum

The Representment Outcome indicates the final result of the representment case.

NONE - To be used when the chargeback was disputed but the outcome is not available, cannot be obtained or was not received.
LOST - To be used when the chargeback was resolved in favor of the cardholder.
WON - To be used when the chargeback was resolved in favor of the merchant.

Allowed:

issuerReportedDate

date-time

The date on which the issuer reported updating the chargeback stage. Formatted as yyyy-MM-dd'T'HH:mm:ssZ per ISO 8601

dueDate

date-time

The date by which a response to the new chargeback stage is required. Formatted as yyyy-MM-dd'T'HH:mm:ssZ per ISO 8601

assumedOwnership

object

Assumed ownership is an optional field passed to Signifyd to provide details about the assumed owning party of the representation rights upon creation of the chargeback case. This field will be ignored unless the caller is a Signifyd partner.

Headers

SIGNIFYD-TEAM-ID

int64

The team id requested for authentication. This should normally be omitted, as it's only relevant when auth credentials allow requests for multiple teams.

Responses

201Returned when a chargeback has been successfully updated.

400Response if there was a problem with the request, such as when a required field is missing or otherwise fails validation.

401Response if the provided authentication credentials are not known or do not match what is on file for the specified user.

404Response if the requested entity can't be found. This indicates Signifyd could not match the request to a chargeback in the system.

409Response if the Request is considered to conflict with data already on the system. This indicates the requested Stage change does not change the current Chargeback Stage.

500Response if an unexplained error occurs on the server.