Sign in

v1

latestOpenAPI 3.0.02026-07-24126202516.7 KB
Item Actions

Make Payment

Make a payment for an Item. Pass the :account_id of a Bank Account or a Card Account associated with the Item's buyer. The Item state will transition to one of payment_held, payment_pending or completed for an Express or Approve payment type.

patch/items/{id}/make_payment

Path parameters

idstring required

Marketplace / Platform item ID

Request body

account_idstring required

Account id of the bank account/credit card, etc making payment (not user id)

device_idstring

Device Information for the device initiating the payment. This will need to be provided for card payments.

ip_addressstring

IP Information for the device initiating the payment. This will need to be provided for card payments.

cvvstring

CVV / CVC

merchant_phonestring

Seller User Phone Number or Mobile number. International number format. Include '+' and no spaces.

Example request

{
  "account_id": "725cc8c0-759b-0138-5d6d-0a58a9feac05"
}

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