Create Item

post

https://test.api.promisepay.com/items

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

string

required

Defaults to 7190770-1-2908

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.

name

string

required

Defaults to Item 7190770-1-2908

A name for the item

amount

integer

required

Defaults to 102

The cost in cents

currency

string

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_type

integer

required

Defaults to 2

Payment type: 2. Express

buyer_id

string

required

Defaults to buyer-719013950014

Marketplace / Pltform buyer ID

seller_id

string

required

Defaults to seller-71718579

Marketplace / Platform Seller ID

fee_ids

string

A comma separated list of fee IDs to apply

description

string

A description of the item

buyer_url

string

Link for the buyer CTA (Call To Action)

seller_url

string

Link for the seller CTA (Call To Action)

tax_invoice

boolean

Toggle to generate tax invoice once Item is complete

custom_descriptor

string

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

Response

Language

Credentials

OAuth2

URL

Loading…

Response

Choose an example:

application/json

201OK