This doc page has moved! You should be automatically redirected to the resources page for the eBay Fulfillment API. If you are not redirected automatically, follow this link to the Fulfillment API.

eBay Fulfillment APIVersion 1.2.0

PaymentHold

This type contains information about a hold placed on a payment to a seller for an order, including the reason why the buyer's payment for the order is being held, the expected release date of the funds into the seller's account, the current state of the hold, and the actual release date if the payment has been released, and possible actions the seller can take to expedite the payout of funds into their account.

Type that uses PaymentHold:

Calls that use PaymentHold:

Fields



expectedReleaseDate ( string ) [0..?]
The date and time that the payment being held is expected to be released to the seller. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: YYYY-MM-DDTHH:MM:SS.SSSZ
Example: 2015-08-04T19:09:02.768Z
See the Field Index to learn which calls use expectedReleaseDate.

holdAmount ( Amount ) [0..?]
The monetary amount of the payment being held.
See the Field Index to learn which calls use holdAmount.

holdReason ( string ) [0..?]
The reason that the payment is being held.
See the Field Index to learn which calls use holdReason.

holdState ( string ) [0..?]
The current stage or condition of the hold.

Applicable values:
  • HELD
  • HELD_PENDING
  • NOT_HELD
  • RELEASE_CONFIRMED
  • RELEASE_FAILED
  • RELEASE_PENDING
  • RELEASED
See the Field Index to learn which calls use holdState.

releaseDate ( string ) [0..?]
The date and time that the payment being held was actually released to the seller. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: YYYY-MM-DDTHH:MM:SS.SSSZ
Example: 2015-08-04T19:09:02.768Z
See the Field Index to learn which calls use releaseDate.

sellerActionsToRelease ( array of SellerActionsToRelease ) [0..?]
A list of actions the seller can take to release the hold on the payment.
See the Field Index to learn which calls use sellerActionsToRelease.