v1

latestOpenAPI 3.0.02026-07-24126202516.7 KB

Item Actions

Refund

Refund an Item's funds. A partial amount can be specified otherwise the full amount will be refunded. This will transition the Item state to 'refunded' if the full amount is refunded, or to the previously held state if a partial amount is specified.

patch/items/{id}/refund

Path parameters

idstring required

Marketplace / Platform item ID to be refunded

Request body

refund_amountinteger

For partial refunds, if they are enabled for marketplace.

refund_messagestring

Reason for the request.

account_idstring

The account id to be used to get the refunds from. This will need to be an account that has already been set up within Assembly

Response

Example response

{
  "items": {
    "id": "7190770-1-2908",
    "name": "Item #001",
    "description": "My first Item.",
    "state": "pending",
    "status": 22000,
    "amount": 20000,
    "payment_type_id": 2,
    "currency": "AUD",
    "buyer_name": "Sample Buyer",
    "buyer_email": "sample.buyer@assemblypayments.com",
    "buyer_country": "AUS",
    "seller_name": "Sample Seller",
    "seller_email": "sample.seller@assemblypayments.com",
    "seller_country": "AUS",
    "tds_check_state": "NA",
    "net_amount": 20000,
    "seller_fees": 400,
    "promisepay_fee": 350,
    "total_outstanding": 20000,
    "total_amount": 20000,
    "payment_method": "pending",
    "payment_credit_card_enabled": true,
    "payment_direct_debit_enabled": true,
    "related": {
      "buyers": "064d6800-fff3-11e5-86aa-5e5517507c66",
      "sellers": "5830def0-ffe8-11e5-86aa-5e5517507c66"
    }
  }
}