Sign in

v1

latestOpenAPI 3.0.02026-07-24126202516.7 KB
Items

Create Item

Create an Item. Items require two Users, a buyer and a seller. The buyer_id and seller_id are your unique user identifiers.

post/items

Request body

idstring required

Unique ID that can be generated by the platform. Cannot contain '.' or '/' characters. Contact Assembly support if you want item IDs to be generated automatically.

namestring required

A name for the item

amountinteger required

The cost in cents

currencystring

ISO 4217 alpha-3 currency code. This is an optional field and if not provided, the item will be created with the default currency of the marketplace.

payment_typeinteger required

Payment type: 2. Express

buyer_idstring required

Marketplace / Pltform buyer ID

seller_idstring required

Marketplace / Platform Seller ID

fee_idsstring

A comma separated list of fee IDs to apply

descriptionstring

A description of the item

buyer_urlstring

Link for the buyer CTA (Call To Action)

seller_urlstring

Link for the seller CTA (Call To Action)

tax_invoiceboolean

Toggle to generate tax invoice once Item is complete

custom_descriptorstring

When custom_descriptors are enabled, this is the information to appear on credit card and direct debit statements.

Example request

{
  "id": "7190770-1-2908",
  "name": "Item 7190770-1-2908",
  "currency": "AUD",
  "buyer_id": "buyer-719013950014",
  "seller_id": "seller-71718579",
  "description": "Test Item 7190770-1-2908"
}

Response

OK

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"
    }
  }
}