A payment change object specifies the exact movement of funds into or out of the payment's origin account and into or out of one or more of the Platform's members accounts. The payment's origin account is the account used to perform the payment (using the accountKey field when creating a payment to use a non-default account). A positive amount represents funds flowing out of the payment's origin account and into the merchant's specified account. A negative amount represents funds flowing out of the merchant's specified account and into the payment's origin account.
1st-levelstring | object
The keys on the first level are customer merchantKeys of the customer's that should have funds affected. More than one customer can be specified.
The value as a string represent the amount of funds to affect from the customer's default account. The amount can be positive or negative. Positive amounts move funds away from the payment's origin account and towards the specified merchant's default account.
The value as an object allows for specifying more advanced fund movement options on the customer (see 2nd level)
2nd-levelstring | object
The keys on the second level are customer account keys of the customer from the first level that can be used to move funds. More than one account can be specified.
The value as a string represents the amount fo funds to move using the customer's given account. The amount can be positive or negative.
The value as on object allows for specifying more advanced fund movement options on the customer (see 3rd level).
The keys on the third level can be either final or transferable and represent the state the funds should be in after moving funds from or to a particular customer account. The values can be positive or negative amounts.
When funds are marked as final, they are no longer able to be transferred to other member's of the platform and are available for withdrawal once the payment has been paid.
When funds are marked as transferable, they remain available to be dispersed to other member's of the platform but are not able to be withdrawn even after the payment as been paid. Transferable funds must eventually be marked as final in order to eventually be withdrawn.