Fetch Dispute Adjustment Transfers

attention

This API is available for Finix Flex and Finix Core customers.

List the adjustment Transfers for a Dispute. Depending on the stage of the Dispute, different adjustment Transfer subtypes can be applied. There are four available subtypes: PLATFORM_CREDIT, MERCHANT_DEBIT, MERCHANT_CREDIT, and PLATFORM_DEBIT.

Copy
Copied
curl https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/adjustment_transfers \
    -H "Content-Type: application/vnd.json+api" \
    -u  USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e

Example Response:

Copy
Copied
{
  "_embedded" : {
    "transfers" : [ {
      "id" : "TRrqiR7x5zwUPV5SpPSbKH8B",
      "amount" : 888888,
      "tags" : { },
      "state" : "SUCCEEDED",
      "trace_id" : "c14d481c-60eb-4338-8331-9f34b3445710",
      "currency" : "USD",
      "application" : "APgPDQrLD52TYvqazjHJJchM",
      "source" : null,
      "destination" : null,
      "ready_to_settle_at" : "2022-01-27T07:43:03.91Z",
      "externally_funded" : "FALSE",
      "fee" : 0,
      "statement_descriptor" : null,
      "type" : "DISPUTE",
      "messages" : [ ],
      "raw" : null,
      "created_at" : "2022-01-27T07:43:03.94Z",
      "updated_at" : "2022-01-27T07:43:03.48Z",
      "idempotency_id" : null,
      "merchant_identity" : "IDddHpRqwf2VsH2XB1fmLfhM",
      "subtype" : "PLATFORM_CREDIT",
      "_links" : {
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
        },
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRrqiR7x5zwUPV5SpPSbKH8B"
        },
        "merchant_identity" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDddHpRqwf2VsH2XB1fmLfhM"
        },
        "payment_instruments" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRrqiR7x5zwUPV5SpPSbKH8B/payment_instruments"
        },
        "disputed_transfer" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRrqiR7x5zwUPV5SpPSbKH8B/disputed_transfer"
        },
        "fee_profile" : {
          "href" : "https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8"
        }
      }
    }, {
      "id" : "TRsfZUjgXSCj7k2stZR7APEn",
      "amount" : 888888,
      "tags" : { },
      "state" : "SUCCEEDED",
      "trace_id" : "08cb6b23-d177-47fb-b941-1bb7b8d78f70",
      "currency" : "USD",
      "application" : "APgPDQrLD52TYvqazjHJJchM",
      "source" : null,
      "destination" : "PIe2YvpcjvoVJ6PzoRPBK137",
      "ready_to_settle_at" : "2022-01-27T07:43:03.76Z",
      "externally_funded" : "FALSE",
      "fee" : 0,
      "statement_descriptor" : null,
      "type" : "DISPUTE",
      "messages" : [ ],
      "raw" : null,
      "created_at" : "2022-01-27T07:43:03.77Z",
      "updated_at" : "2022-01-27T07:43:03.48Z",
      "idempotency_id" : null,
      "merchant_identity" : "IDpYDM7J9n57q849o9E9yNrG",
      "subtype" : "MERCHANT_DEBIT",
      "_links" : {
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
        },
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRsfZUjgXSCj7k2stZR7APEn"
        },
        "merchant_identity" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG"
        },
        "payment_instruments" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRsfZUjgXSCj7k2stZR7APEn/payment_instruments"
        },
        "disputed_transfer" : {
          "href" : "https://finix.sandbox-payments-api.com/transfers/TRsfZUjgXSCj7k2stZR7APEn/disputed_transfer"
        },
        "destination" : {
          "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137"
        },
        "fee_profile" : {
          "href" : "https://finix.sandbox-payments-api.com/fee_profiles/FPq6PQ9pHsab66fKMmjQ7jb5"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/disputes/DIs7yQRkHDdMYhurzYz72SFk/adjustment_transfers?offset=0&limit=20&sort=created_at,desc&sort=id,desc"
    }
  },
  "page" : {
    "offset" : 0,
    "limit" : 20,
    "count" : 2
  }
}

HTTP Request

GET https://finix.sandbox-payments-api.com/disputes/:DISPUTE_ID/adjustment_transfers

URL Parameters

Parameter Description
:DISPUTE_ID ID of the Dispute

Response

Field Type Description
id string ID of the Transfer
amount integer The total amount to be adjusted in cents
application string ID of the Application
currency string 3-letter ISO code designating the currency of the adjustment
destination string ID of the Payment Instrument where funds are deposited
fee integer The amount of the adjustment you would like to collect as your Fee in cents. Defaults to zero (must be less than or equal to the amount)
idempotency_id string A randomly generated value that you want associated with the request
merchant_identity string The ID of the Identity for the Merchant that you are transacting or charging on behalf of
messages string Message field that provides additional details. This field is typically null
raw string Raw card data. This field is typically null
ready_to_settle_at string Timestamp of when the Transfer is ready to be settled
source string ID of the Payment Instrument where funds are debited
state string The state of the Transfer. There are four available values: PENDING, SUCCEEDED, CANCELED, or FAILED
statement_descriptor string Billing descriptor displayed on the buyer's bank or card statement (Length must be between 1 and 20 characters)
subtype string Specifies money movement to and from the Merchant. There are four available subtypes: PLATFORM_CREDIT, MERCHANT_DEBIT, MERCHANT_CREDIT, and PLATFORM_DEBIT
tags object Key value pair for annotating custom metadata
trace_id string Trace ID
type string Type of adjustment. There is one available value: DISPUTE
created_at string Timestamp of when the adjustment was created
updated_at string Timestamp of when the adjustment was updated