API ReferenceHome

The recoup request object

{
  "acme_corp_platform": "-2.00"
}

{
  "acme_corp_sub_1": {
    "california_funds": "-5.00"
}

{
  "acme_corp_sub_1": {
    "default": {
      "final": "-2.00",
      "transferable": "-3.00"
    } 
  }
}

1st-level string | object
The keys on the first level are customer merchantKeys of the customer's that should have funds recouped from them. More than one customer can be specified.

string
The value as a string represent the amount of funds to recoup from the customer's default account. The amount should be negative.

object
The value as an object allows for specifying more advanced recoup options on the customer (see 2nd level)

2nd-level string | object
The keys on the second level are customer account keys of the customer from the first level that can be used to recoup funds. More than one account can be specified.

string
The value as a string represents the amount fo funds to recoup from the customer's given account. The amount should be negative.

object
The value as on object allows for specifying more advanced recoup option on the customer (see 3rd level).

3rd-level string
The keys on the third level can be either final or transferable and represent the state the funds should be in after recouping from a particular customer account. The values should be negative amounts.