Disputes

GET /v3/spend/profiles/{{profileId}}/dispute-form/reasons

Retrieves the list of possible reasons for submitting a dispute.

Response

Returns a set of dispute objects.

GET /v3/spend/profiles/{{profileId}}/dispute-form/flows/{{scheme}}/{{reason}}?transactionId={{transactionId}}

Retrieves the JSON for initiating the dispute flow. The returned result can be used to generate the dispute flow UI using the Wise's open-source Dynamic Flows framework . The Dynamic Flows Framework will generate UI according to the received JSON and will handle the rest of the multi-step dispute submission including the generation of the subsequent pages (if needed) and the actual submission of the dispute and all the relevant documents.

An example of using a Dispute flow can be found here.

Because the calls to the above endpoint are authorised they cannot be made from the Dynamic Flows JavaScript framework directly (from the browser), but instead must be proxied by the partner with the added auth headers. Therefore, a partner is expected to implement 2 additional internal endpoints:

1. Get Dynamic Form Page:

GET https://{{yourApiUrl}}/v3/spend/profiles/{{profileId}}/dispute-form/flows/step/{{scheme}}/{{reason}}?transactionId={{transactionId}}

The implementation of this endpoint is expected to redirect the call to:

POST https://api.sandbox.transferwise.tech/v3/spend/profiles/{{profileId}}/dispute-form/flows/step/{{scheme}}/{{reason}}

This implementation is also expected to add an email of the disputer and the ID of the disputed transaction. The email is added in order to allow direct communication with a person who knows the dispute details. The body of the POST request forwarded to Wise should be of the following form:

{
    "email": "abc@def.com",
    "transactionId": "<transaction id>"
}

2. Post Dynamic Form Results:

The final step of the dispute flow will have to submit all the collected data to Wise. However, since Authorization header is required, a partner is expected to implement the following endpoint (please note the absence of a step in the URL path):

POST https://{{yourApiUrl}}/v3/spend/profiles/{{profileId}}/dispute-form/flows/{{scheme}}/{{reason}}

The request body will be generated by Dynamic Forms. The implementation of this endpoint is expected to redirect the call to:

POST https://api.sandbox.transferwise.tech/v3/spend/profiles/{{profileId}}/dispute-form/flows/{{scheme}}/{{reason}}

The response to this last call of the dynamic flow will include x-df-exit: true HTTP header. This header is used by the JavaScript framework to add an option to exit the dynamic flow and redirect the user to a different page (or exit a WebView depending on the client's implementation). In order to intercept the last page response on the frontend onClose function should be added to JavaScript, for example:

const onClose = () => {
  console.log("DF is exiting");
  window.location.href = "https://www.google.com/";
};

Both endpoints are expected to proxy the requests with the added auth headers. In order to redirect the Dynamic Flows JavaScript library to your domain please use baseUrl or fetcher as part of the dynamic flows setup.

The Dynamic Form CSS styles can be overriden. An example of a Dispute flow with custom CSS can be found here.