Sign in

v1

latestOpenAPI 3.0.02026-07-24126202516.7 KB
Item Actions

Make an async Payment

Initiate a card payment with 3D Secure 2.0 authentication support. This endpoint initiates the payment process and returns a payment_token required for 3DS2 component initialisation.

patch/items/{id}/make_payment_async

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)

request_three_d_secure'automatic' | 'challenge' | 'any'

Customise the 3DS (3D Secure) preference for this payment. If automatic, 3DS preference is determined automatically by the system. If challenge, Request a 3DS challenge is presented to the user. If any, request a 3DS frictionless or challenge flow. Important: Use the returned payment_token to initialise the 3DS2 web component.

Example request

{
  "request_three_d_secure": "challenge"
}

Response

OK

payment_idstring

Generated payment ID

account_idstring

Card Account ID

payment_tokenstring

Token passed to front-end component, for secure access of the payment status

Example response

{
  "payment_id": "1000014012533486",
  "account_id": "86991380-90a5-013a-57cc-5e50adfe91ad",
  "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"
    }
  }
}