openapi: 3.2.0
info:
  title: Zai Item Actions API
  contact:
    email: support@assemblypayments.com
    url: http://docs.assemblypayments.com/
  version: '1.0'
  description: 'Operations tagged Item Actions across 2 of this provider''s published API definitions: zai-assembly-api.json, zai-async-api.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://test.api.promisepay.com
  description: Pre-live environment
- url: https://secure.api.promisepay.com
  description: Production environment
- url: https://au-0000.sandbox.auth.assemblypay.com
  description: Pre-Live (Sandbox) Auth issuing server and API
- url: https://au-0000.auth.assemblypay.com
  description: Production Auth issuing server and API
- description: SwaggerHub API Auto Mocking
  url: https://virtserver.swaggerhub.com/AssemblyPlatforms/assembly-api/2.3
- description: SwaggerHub API Auto Mocking
  url: https://virtserver.swaggerhub.com/AssemblyPlatforms/assembly-async-api/1.0.0
- url: https://test.tnq.api.assemblypay.com/
  description: Sandbox (AKA Pre-live) environment hosting asynchronous endpoints.
- url: https://tnq.api.assemblypay.com/
  description: Production environment hosting asynchronous endpoints.
tags:
- name: Item Actions
paths:
  /items/{id}/make_payment:
    patch:
      tags:
      - Item Actions
      summary: Make Payment
      description: '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.

        '
      operationId: makePayment
      parameters:
      - name: id
        in: path
        description: Marketplace / Platform item ID
        required: true
        schema:
          type: string
          default: 7190770-1-2908
        example: 7190770-1-2908
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/account_id_requestBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_item'
      security:
      - oAuth2ClientCredentials: []
    servers:
    - url: https://test.api.promisepay.com
      description: Pre-live environment
    - url: https://secure.api.promisepay.com
      description: Production environment
    - url: https://au-0000.sandbox.auth.assemblypay.com
      description: Pre-Live (Sandbox) Auth issuing server and API
    - url: https://au-0000.auth.assemblypay.com
      description: Production Auth issuing server and API
    - description: SwaggerHub API Auto Mocking
      url: https://virtserver.swaggerhub.com/AssemblyPlatforms/assembly-api/2.3
  /items/{id}/make_payment_async:
    patch:
      tags:
      - Item Actions
      summary: Make an async Payment
      description: '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.

        '
      operationId: makePaymentAsync
      parameters:
      - name: id
        in: path
        description: Marketplace / Platform item ID
        required: true
        schema:
          type: string
        example: 7190770-1-2908
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/account_id_asyncRequestBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/acknowledge_payment'
      security:
      - oAuth2ClientCredentials: []
    servers:
    - url: https://test.api.promisepay.com
      description: Pre-live environment
    - url: https://secure.api.promisepay.com
      description: Production environment
    - url: https://au-0000.sandbox.auth.assemblypay.com
      description: Pre-Live (Sandbox) Auth issuing server and API
    - url: https://au-0000.auth.assemblypay.com
      description: Production Auth issuing server and API
    - description: SwaggerHub API Auto Mocking
      url: https://virtserver.swaggerhub.com/AssemblyPlatforms/assembly-api/2.3
  /items/{id}/cancel:
    patch:
      tags:
      - Item Actions
      summary: Cancel
      description: Cancel an **Item**. This will transition the **Item** state to `cancelled`. **Items** can only be cancelled if they haven't been actioned in any other way.
      operationId: cancelItem
      parameters:
      - name: id
        in: path
        description: Marketplace / Platform item ID
        required: true
        style: simple
        explode: false
        schema:
          type: string
          default: 7190770-1-2908
        example: 7190770-1-2908
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_item'
              examples:
                response:
                  value:
                    items:
                      id: 7190770-1-2908
                      name: Item 7190770-1-2908
                      description: Test Item 7190770-1-2908
                      custom_descriptor: null
                      payout_descriptor: null
                      created_at: '2020-05-11T10:26:49.660Z'
                      updated_at: '2020-05-11T10:26:49.660Z'
                      state: pending
                      net_amount: 102
                      chargedback_amount: 0
                      refunded_amount: 0
                      released_amount: 0
                      seller_url: ''
                      buyer_url: ''
                      remaining_amount: 102
                      status: 22000
                      amount: 102
                      payment_type_id: 2
                      due_date: null
                      requested_release_amount: 0
                      pending_release_amount: 0
                      dynamic_descriptor: null
                      invoice_url: null
                      deposit_reference: '100014012533386'
                      buyer_fees: 0
                      seller_fees: 0
                      credit_card_fee: 0
                      direct_debit_fee: 0
                      paypal_fee: 0
                      promisepay_fee: 1
                      batch_state: null
                      total_outstanding: 102
                      total_amount: 102
                      currency: AUD
                      payment_method: pending
                      buyer_name: Neol Buyer
                      buyer_email: neol_buyer719013950014@assemblypayments.com
                      buyer_country: AUS
                      seller_name: Assembly seller71718579
                      seller_email: neol_seller71718579@assemblypayments.com
                      seller_country: AUS
                      payment_credit_card_enabled: true
                      payment_direct_debit_enabled: true
                      tds_check_state: null
                      related:
                        buyers: buyer-719013950014
                        sellers: seller-71718579
                      links:
                        self: /items/7190770-1-2908/cancel
                        buyers: /items/7190770-1-2908/buyers
                        sellers: /items/7190770-1-2908/sellers
                        status: /items/7190770-1-2908/status
                        fees: /items/7190770-1-2908/fees
                        transactions: /items/7190770-1-2908/transactions
                        batch_transactions: /items/7190770-1-2908/batch_transactions
                        wire_details: /items/7190770-1-2908/wire_details
                        bpay_details: /items/7190770-1-2908/bpay_details
                        tds_checks: /items/7190770-1-2908/tds_checks
      security:
      - oAuth2ClientCredentials: []
    servers:
    - url: https://test.api.promisepay.com
      description: Pre-live environment
    - url: https://secure.api.promisepay.com
      description: Production environment
    - url: https://au-0000.sandbox.auth.assemblypay.com
      description: Pre-Live (Sandbox) Auth issuing server and API
    - url: https://au-0000.auth.assemblypay.com
      description: Production Auth issuing server and API
    - description: SwaggerHub API Auto Mocking
      url: https://virtserver.swaggerhub.com/AssemblyPlatforms/assembly-api/2.3
  /items/{id}/refund:
    patch:
      tags:
      - Item Actions
      summary: Refund
      description: 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.
      operationId: refund
      parameters:
      - name: id
        in: path
        description: Marketplace / Platform item ID to be refunded
        required: true
        style: simple
        explode: false
        schema:
          type: string
          default: 7190770-1-2908
        example: 7190770-1-2908
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/refund_requestBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_item'
              examples:
                response:
                  value:
                    id: 7190770-1-2908
                    name: Item 7190770-1-2908
                    description: Test Item 7190770-1-2908
                    custom_descriptor: null
                    payout_descriptor: null
                    created_at: '2020-05-11T10:26:49.660Z'
                    updated_at: '2020-05-11T10:26:49.660Z'
                    state: pending
                    net_amount: 102
                    chargedback_amount: 0
                    refunded_amount: 0
                    released_amount: 0
                    seller_url: ''
                    buyer_url: ''
                    remaining_amount: 102
                    status: 22000
                    amount: 102
                    payment_type_id: 2
                    due_date: null
                    requested_release_amount: 0
                    pending_release_amount: 0
                    dynamic_descriptor: null
                    invoice_url: null
                    deposit_reference: '100014012533386'
                    buyer_fees: 0
                    seller_fees: 0
                    credit_card_fee: 0
                    direct_debit_fee: 0
                    paypal_fee: 0
                    promisepay_fee: 1
                    batch_state: null
                    total_outstanding: 102
                    total_amount: 102
                    currency: AUD
                    payment_method: pending
                    buyer_name: Neol Buyer
                    buyer_email: neol_buyer719013950014@assemblypayments.com
                    buyer_country: AUS
                    seller_name: Assembly seller71718579
                    seller_email: neol_seller71718579@assemblypayments.com
                    seller_country: AUS
                    payment_credit_card_enabled: true
                    payment_direct_debit_enabled: true
                    tds_check_state: null
                    related:
                      buyers: buyer-719013950014
                      sellers: seller-71718579
                    links:
                      self: /items/7190770-1-2908/refund
                      buyers: /items/7190770-1-2908/buyers
                      sellers: /items/7190770-1-2908/sellers
                      status: /items/7190770-1-2908/status
                      fees: /items/7190770-1-2908/fees
                      transactions: /items/7190770-1-2908/transactions
                      batch_transactions: /items/7190770-1-2908/batch_transactions
                      wire_details: /items/7190770-1-2908/wire_details
                      bpay_details: /items/7190770-1-2908/bpay_details
                      tds_checks: /items/7190770-1-2908/tds_checks
      security:
      - oAuth2ClientCredentials: []
    servers:
    - url: https://test.api.promisepay.com
      description: Pre-live environment
    - url: https://secure.api.promisepay.com
      description: Production environment
    - url: https://au-0000.sandbox.auth.assemblypay.com
      description: Pre-Live (Sandbox) Auth issuing server and API
    - url: https://au-0000.auth.assemblypay.com
      description: Production Auth issuing server and API
    - description: SwaggerHub API Auto Mocking
      url: https://virtserver.swaggerhub.com/AssemblyPlatforms/assembly-api/2.3
  /items/{id}/authorize_payment:
    patch:
      tags:
      - Item Actions
      summary: Authorize Payment
      description: 'Where pre-authentication is enabled on a platform, initiates a credit card payment authorization for an item. When an authorization is successful, your platform holds the item amount for capture, but there is no transfer of funds happening. This call is used with the Capture Payment or Void Payment calls.

        '
      operationId: authorizePayment
      parameters:
      - name: id
        in: path
        description: Marketplace / Platform item ID
        required: true
        style: simple
        explode: false
        schema:
          type: string
          default: 7190770-1-2908
        example: 7190770-1-2908
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/card_account_id_requestBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_item'
              examples:
                response:
                  value:
                    items:
                      id: 7190770-1-2908
                      name: Item 7190770-1-2908
                      description: Test Item 7190770-1-2908
                      custom_descriptor: null
                      payout_descriptor: null
                      created_at: '2020-05-11T10:26:49.660Z'
                      updated_at: '2020-05-11T10:26:49.660Z'
                      state: pending
                      net_amount: 102
                      chargedback_amount: 0
                      refunded_amount: 0
                      released_amount: 0
                      seller_url: ''
                      buyer_url: ''
                      remaining_amount: 102
                      status: 22000
                      amount: 102
                      payment_type_id: 2
                      due_date: null
                      requested_release_amount: 0
                      pending_release_amount: 0
                      dynamic_descriptor: null
                      invoice_url: null
                      deposit_reference: '100014012533386'
                      buyer_fees: 0
                      seller_fees: 0
                      credit_card_fee: 0
                      direct_debit_fee: 0
                      paypal_fee: 0
                      promisepay_fee: 1
                      batch_state: null
                      total_outstanding: 102
                      total_amount: 102
                      currency: AUD
                      payment_method: pending
                      buyer_name: Neol Buyer
                      buyer_email: neol_buyer719013950014@assemblypayments.com
                      buyer_country: AUS
                      seller_name: Assembly seller71718579
                      seller_email: neol_seller71718579@assemblypayments.com
                      seller_country: AUS
                      payment_credit_card_enabled: true
                      payment_direct_debit_enabled: true
                      tds_check_state: null
                      related:
                        buyers: buyer-719013950014
                        sellers: seller-71718579
                      links:
                        self: /items/7190770-1-2908/authorize_payment?account_id=725cc8c0-759b-0138-5d6d-0a58a9feac05
                        buyers: /items/7190770-1-2908/buyers
                        sellers: /items/7190770-1-2908/sellers
                        status: /items/7190770-1-2908/status
                        fees: /items/7190770-1-2908/fees
                        transactions: /items/7190770-1-2908/transactions
                        batch_transactions: /items/7190770-1-2908/batch_transactions
                        wire_details: /items/7190770-1-2908/wire_details
                        bpay_details: /items/7190770-1-2908/bpay_details
                        tds_checks: /items/7190770-1-2908/tds_checks
      security:
      - oAuth2ClientCredentials: []
    servers:
    - url: https://test.api.promisepay.com
      description: Pre-live environment
    - url: https://secure.api.promisepay.com
      description: Production environment
    - url: https://au-0000.sandbox.auth.assemblypay.com
      description: Pre-Live (Sandbox) Auth issuing server and API
    - url: https://au-0000.auth.assemblypay.com
      description: Production Auth issuing server and API
    - description: SwaggerHub API Auto Mocking
      url: https://virtserver.swaggerhub.com/AssemblyPlatforms/assembly-api/2.3
  /items/{id}/capture_payment:
    patch:
      tags:
      - Item Actions
      summary: Capture Payment
      description: 'Where pre-authentication is enabled on a platform, completes a credit card payment for an item whose payment is authorized. This call is used with the Authorize Payment call.

        '
      operationId: capturePayment
      parameters:
      - name: id
        in: path
        description: Marketplace / Platform item ID
        required: true
        style: simple
        explode: false
        schema:
          type: string
          default: 7190770-1-2908
        example: 7190770-1-2908
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/partial_payment'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_item'
              examples:
                response:
                  value:
                    items:
                      id: 7190770-1-2908
                      name: Item 7190770-1-2908
                      description: Test Item 7190770-1-2908
                      custom_descriptor: null
                      payout_descriptor: null
                      created_at: '2020-05-11T10:26:49.660Z'
                      updated_at: '2020-05-11T10:26:49.660Z'
                      state: pending
                      net_amount: 102
                      chargedback_amount: 0
                      refunded_amount: 0
                      released_amount: 0
                      seller_url: ''
                      buyer_url: ''
                      remaining_amount: 102
                      status: 22000
                      amount: 102
                      payment_type_id: 2
                      due_date: null
                      requested_release_amount: 0
                      pending_release_amount: 0
                      dynamic_descriptor: null
                      invoice_url: null
                      deposit_reference: '100014012533386'
                      buyer_fees: 0
                      seller_fees: 0
                      credit_card_fee: 0
                      direct_debit_fee: 0
                      paypal_fee: 0
                      promisepay_fee: 1
                      batch_state: null
                      total_outstanding: 102
                      total_amount: 102
                      currency: AUD
                      payment_method: pending
                      buyer_name: Neol Buyer
                      buyer_email: neol_buyer719013950014@assemblypayments.com
                      buyer_country: AUS
                      seller_name: Assembly seller71718579
                      seller_email: neol_seller71718579@assemblypayments.com
                      seller_country: AUS
                      payment_credit_card_enabled: true
                      payment_direct_debit_enabled: true
                      tds_check_state: null
                      related:
                        buyers: buyer-719013950014
                        sellers: seller-71718579
                      links:
                        self: /items/7190770-1-2908/capture_payment
                        buyers: /items/7190770-1-2908/buyers
                        sellers: /items/7190770-1-2908/sellers
                        status: /items/7190770-1-2908/status
                        fees: /items/7190770-1-2908/fees
                        transactions: /items/7190770-1-2908/transactions
                        batch_transactions: /items/7190770-1-2908/batch_transactions
                        wire_details: /items/7190770-1-2908/wire_details
                        bpay_details: /items/7190770-1-2908/bpay_details
                        tds_checks: /items/7190770-1-2908/tds_checks
      security:
      - oAuth2ClientCredentials: []
    servers:
    - url: https://test.api.promisepay.com
      description: Pre-live environment
    - url: https://secure.api.promisepay.com
      description: Production environment
    - url: https://au-0000.sandbox.auth.assemblypay.com
      description: Pre-Live (Sandbox) Auth issuing server and API
    - url: https://au-0000.auth.assemblypay.com
      description: Production Auth issuing server and API
    - description: SwaggerHub API Auto Mocking
      url: https://virtserver.swaggerhub.com/AssemblyPlatforms/assembly-api/2.3
  /items/{id}/void_payment:
    patch:
      tags:
      - Item Actions
      summary: Void Payment
      description: 'Where pre-authentication is enabled on a platform, voids the `payment_authorized` status for an item. This call is used with the Authorize Payment call. **Note**: Not all payment gateways support the Void Payment API call. In this case, you can wait until a payment authorization expires. A payment authorisation expires after 3 to 6 days if not captured.

        '
      operationId: voidPayment
      parameters:
      - name: id
        in: path
        description: Marketplace / Platform item ID
        required: true
        style: simple
        explode: false
        schema:
          type: string
          default: 7190770-1-2908
        example: 7190770-1-2908
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_item'
              examples:
                response:
                  value:
                    items:
                      id: 7190770-1-2908
                      name: Item 7190770-1-2908
                      description: Test Item 7190770-1-2908
                      custom_descriptor: null
                      payout_descriptor: null
                      created_at: '2020-05-11T10:26:49.660Z'
                      updated_at: '2020-05-11T10:26:49.660Z'
                      state: pending
                      net_amount: 102
                      chargedback_amount: 0
                      refunded_amount: 0
                      released_amount: 0
                      seller_url: ''
                      buyer_url: ''
                      remaining_amount: 102
                      status: 22000
                      amount: 102
                      payment_type_id: 2
                      due_date: null
                      requested_release_amount: 0
                      pending_release_amount: 0
                      dynamic_descriptor: null
                      invoice_url: null
                      deposit_reference: '100014012533386'
                      buyer_fees: 0
                      seller_fees: 0
                      credit_card_fee: 0
                      direct_debit_fee: 0
                      paypal_fee: 0
                      promisepay_fee: 1
                      batch_state: null
                      total_outstanding: 102
                      total_amount: 102
                      currency: AUD
                      payment_method: pending
                      buyer_name: Neol Buyer
                      buyer_email: neol_buyer719013950014@assemblypayments.com
                      buyer_country: AUS
                      seller_name: Assembly seller71718579
                      seller_email: neol_seller71718579@assemblypayments.com
                      seller_country: AUS
                      payment_credit_card_enabled: true
                      payment_direct_debit_enabled: true
                      tds_check_state: null
                      related:
                        buyers: buyer-719013950014
                        sellers: seller-71718579
                      links:
                        self: /items/7190770-1-2908/void_payment
                        buyers: /items/7190770-1-2908/buyers
                        sellers: /items/7190770-1-2908/sellers
                        status: /items/7190770-1-2908/status
                        fees: /items/7190770-1-2908/fees
                        transactions: /items/7190770-1-2908/transactions
                        batch_transactions: /items/7190770-1-2908/batch_transactions
                        wire_details: /items/7190770-1-2908/wire_details
                        bpay_details: /items/7190770-1-2908/bpay_details
                        tds_checks: /items/7190770-1-2908/tds_checks
      security:
      - oAuth2ClientCredentials: []
    servers:
    - url: https://test.api.promisepay.com
      description: Pre-live environment
    - url: https://secure.api.promisepay.com
      description: Production environment
    - url: https://au-0000.sandbox.auth.assemblypay.com
      description: Pre-Live (Sandbox) Auth issuing server and API
    - url: https://au-0000.auth.assemblypay.com
      description: Production Auth issuing server and API
    - description: SwaggerHub API Auto Mocking
      url: https://virtserver.swaggerhub.com/AssemblyPlatforms/assembly-api/2.3
  /items/{id}/release_payment:
    patch:
      tags:
      - Item Actions
      summary: Release Payment (Deprecated - Do Not Use)
      description: Included for legacy purposes for existing customers that use Escrow payments which are no longer supported for new flows/customers. Release funds held in escrow from an **Item** with an **Escrow** or **Escrow Partial Release** payment type.  This will transition the **Item** state to `completed`.
      operationId: releasePayment
      parameters:
      - name: id
        in: path
        description: Marketplace / Platform item ID
        required: true
        style: simple
        explode: false
        schema:
          type: string
          default: 7190770-1-2908
        example: 7190770-1-2908
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/release_payment_requestBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_item'
              examples:
                response:
                  value:
                    items:
                      id: 7190770-1-2908
                      name: Item 7190770-1-2908
                      description: Test Item 7190770-1-2908
                      custom_descriptor: null
                      payout_descriptor: null
                      created_at: '2020-05-11T10:26:49.660Z'
                      updated_at: '2020-05-11T10:26:49.660Z'
                      state: completed
                      net_amount: 102
                      chargedback_amount: 0
                      refunded_amount: 0
                      released_amount: 102
                      seller_url: ''
                      buyer_url: ''
                      remaining_amount: 102
                      status: 22500
                      amount: 102
                      payment_type_id: 1
                      due_date: null
                      requested_release_amount: 0
                      pending_release_amount: 0
                      dynamic_descriptor: null
                      invoice_url: null
                      deposit_reference: '100014012533386'
                      buyer_fees: 0
                      seller_fees: 0
                      credit_card_fee: 0
                      direct_debit_fee: 0
                      paypal_fee: 0
                      promisepay_fee: 1
                      batch_state: null
                      total_outstanding: 0
                      total_amount: 102
                      currency: AUD
                      payment_method: pending
                      buyer_name: Neol Buyer
                      buyer_email: neol_buyer719013950014@assemblypayments.com
                      buyer_country: AUS
                      seller_name: Assembly seller71718579
                      seller_email: neol_seller71718579@assemblypayments.com
                      seller_country: AUS
                      payment_credit_card_enabled: true
                      payment_direct_debit_enabled: true
                      tds_check_state: null
                      related:
                        buyers: buyer-719013950014
                        sellers: seller-71718579
                      links:
                        self: /items/7190770-1-2908/cancel
                        buyers: /items/7190770-1-2908/buyers
                        sellers: /items/7190770-1-2908/sellers
                        status: /items/7190770-1-2908/status
                        fees: /items/7190770-1-2908/fees
                        transactions: /items/7190770-1-2908/transactions
                        batch_transactions: /items/7190770-1-2908/batch_transactions
                        wire_details: /items/7190770-1-2908/wire_details
                        bpay_details: /items/7190770-1-2908/bpay_details
                        tds_checks: /items/7190770-1-2908/tds_checks
      security:
      - oAuth2ClientCredentials: []
    servers:
    - url: https://test.api.promisepay.com
      description: Pre-live environment
    - url: https://secure.api.promisepay.com
      description: Production environment
    - url: https://au-0000.sandbox.auth.assemblypay.com
      description: Pre-Live (Sandbox) Auth issuing server and API
    - url: https://au-0000.auth.assemblypay.com
      description: Production Auth issuing server and API
    - description: SwaggerHub API Auto Mocking
      url: https://virtserver.swaggerhub.com/AssemblyPlatforms/assembly-api/2.3
components:
  schemas:
    card_account_id_requestBody:
      type: object
      required:
      - account_id
      properties:
        account_id:
          description: Card account ID
          type: string
          example: 725cc8c0-759b-0138-5d6d-0a58a9feac05
          default: 725cc8c0-759b-0138-5d6d-0a58a9feac05
        cvv:
          description: CVV / CVC
          type: string
          example: ''
        merchant_phone:
          description: Seller User Phone Number or Mobile number. International number format. Include '+' and no spaces.
          type: string
          example: ''
    refund_requestBody:
      type: object
      properties:
        refund_amount:
          description: For partial refunds, if they are enabled for marketplace.
          type: integer
          example: ''
        refund_message:
          description: Reason for the request.
          type: string
          example: ''
        account_id:
          description: 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
          type: string
          example: ''
    acknowledge_payment:
      type: object
      properties:
        payment_id:
          type: string
          description: Generated payment ID
          example: '1000014012533486'
        account_id:
          type: string
          description: Card Account ID
          example: 86991380-90a5-013a-57cc-5e50adfe91ad
        payment_token:
          type: string
          description: Token passed to front-end component, for secure access of the payment status
        items:
          $ref: '#/components/schemas/item'
    release_payment_requestBody:
      type: object
      properties:
        release_amount:
          description: Partial amount to be released in cents
          type: integer
          example: ''
        flag_release:
          description: to be used if release flagging enabled for your marketplace
          type: boolean
          example: ''
    single_item:
      type: object
      properties:
        items:
          $ref: '#/components/schemas/item'
    account_id_asyncRequestBody:
      type: object
      required:
      - account_id
      properties:
        account_id:
          description: Account id of the bank account/credit card, etc making payment (not user id)
          type: string
        request_three_d_secure:
          description: '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.

            '
          type: string
          example: challenge
          default: automatic
          enum:
          - automatic
          - challenge
          - any
    partial_payment:
      type: object
      properties:
        amount:
          description: For partial payment, if they are enabled for marketplace.
          type: integer
          example: 100
    item:
      type: object
      required:
      - id
      - name
      - amount
      - payment_type
      - buyer_id
      - seller_id
      properties:
        id:
          type: string
          example: 7190770-1-2908
        name:
          type: string
          example: 'Item #001'
        description:
          type: string
          example: My first Item.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        state:
          type: string
          enum:
          - pending
          - payment_required
          - wire_pending
          - payment_pending
          - payment_held
          - payment_authorized
          - void_pending
          - voided
          - fraud_hold
          - payment_deposited
          - work_completed
          - problem_flagged
          - problem_resolve_requested
          - problem_escalated
          - completed
          - cancelled
          - refunded
          - refund_pending
          - refund_flagged
          - off_platform_refunded
          - partial_completed
          - partial_paid
          - off_platform_chargedback
          example: pending
        status:
          type: integer
          enum:
          - 22000
          - 22100
          - 22110
          - 22150
          - 22175
          - 22180
          - 22185
          - 22195
          - 22190
          - 22200
          - 22300
          - 22400
          - 22410
          - 22420
          - 22500
          - 22575
          - 22600
          - 22610
          - 22650
          - 22670
          - 22700
          - 22800
          - 22680
          example: 22000
        amount:
          type: integer
          example: 20000
        payment_type_id:
          type: integer
          example: 2
        currency:
          type: string
          example: AUD
        buyer_name:
          type: string
          example: Sample Buyer
        buyer_email:
          type: string
          format: email
          example: sample.buyer@assemblypayments.com
        buyer_country:
          type: string
          example: AUS
        seller_name:
          type: string
          example: Sample Seller
        seller_email:
          type: string
          format: email
          example: sample.seller@assemblypayments.com
        seller_country:
          type: string
          format: email
          example: AUS
        tds_check_state:
          type: string
          format: email
          example: NA
        batch_state:
          type: string
          example: null
        invoice_url:
          type: string
          example: null
        payout_descriptor:
          type: string
          example: null
        remaining_amount:
          type: integer
          example: 0
        requested_release_amount:
          type: integer
          example: 0
        custom_descriptor:
          type: string
          example: null
        net_amount:
          type: integer
          example: 20000
        chargedback_amount:
          type: integer
          example: 0
        refunded_amount:
          type: integer
          example: 0
        released_amount:
          type: integer
          example: 0
        buyer_fees:
          type: integer
          example: 0
        seller_fees:
          type: integer
          example: 400
        credit_card_fee:
          type: integer
          example: 0
        paypal_fee:
          type: integer
          example: 0
        seller_url:
          type: string
        buyer_url:
          type: string
        direct_debit_fee:
          type: integer
          example: 0
        due_date:
          type:
          - string
          - 'null'
          format: date
        pending_release_amount:
          type: integer
          example: 0
        dynamic_descriptor:
          type: string
          example: null
        deposit_reference:
          type: string
          example: 100014013961629
        promisepay_fee:
          type: integer
          example: 350
        total_outstanding:
          type: integer
          example: 20000
        total_amount:
          type: integer
          example: 20000
        payment_method:
          type: string
          example: pending
        payment_credit_card_enabled:
          type: boolean
          example: true
        payment_direct_debit_enabled:
          type: boolean
          example: true
        related:
          type: object
          properties:
            buyers:
              type: string
              example: 064d6800-fff3-11e5-86aa-5e5517507c66
            sellers:
              type: string
              example: 5830def0-ffe8-11e5-86aa-5e5517507c66
        links:
          type: object
          properties:
            self:
              type: string
            buyers:
              type: string
            sellers:
              type: string
            status:
              type: string
            fees:
              type: string
            transactions:
              type: string
            batch_transactions:
              type: string
            wire_details:
              type: string
            bpay_details:
              type: string
            tds_checks:
              type: string
    account_id_requestBody:
      type: object
      required:
      - account_id
      properties:
        account_id:
          description: Account id of the bank account/credit card, etc making payment (not user id)
          type: string
          example: 725cc8c0-759b-0138-5d6d-0a58a9feac05
          default: 725cc8c0-759b-0138-5d6d-0a58a9feac05
        device_id:
          description: Device Information for the device initiating the payment. This will need to be provided for card payments.
          type: string
          example: ''
        ip_address:
          description: IP Information for the device initiating the payment. This will need to be provided for card payments.
          type: string
          example: ''
        cvv:
          description: CVV / CVC
          type: string
          example: ''
        merchant_phone:
          description: Seller User Phone Number or Mobile number. International number format. Include '+' and no spaces.
          type: string
          example: ''
    links:
      type: object
      properties:
        status:
          type: string
          format: URL
          description: Call this end point to retrieve the internal business response if received, or a status update otherwise.
          example: https://tnq.api.assemblypay.com/request/d749f28378554394adab0b2401380bc7/status
        callbacks:
          type: string
          format: URL
          description: Call this end point to retrieve callback tracking information. This property is only present if a callback was supplied with the original API invocation.
          example: https://tnq.api.assemblypay.com/request/d749f28378554394adab0b2401380bc7/callbacks
    status:
      type: object
      properties:
        last_updated:
          type: string
          format: DateTime RFC3339
          example: 2020-07-15T15:04:05Z07:00
        submission_count:
          type: integer
          example: 0
        message:
          type: string
          example: request awaiting submission
        links:
          $ref: '#/components/schemas/links'
    make_payment_requestBody:
      type: object
      required:
      - account_id
      properties:
        account_id:
          description: Account id of the bank account/credit card, etc making payment (not user id)
          type: string
          example: 725cc8c0-759b-0138-5d6d-0a58a9feac05
          default: 725cc8c0-759b-0138-5d6d-0a58a9feac05
        device_id:
          description: Device Information for the device initiating the payment. This must be provided for card payments.
          type: string
          example: '358277090995038'
          default: '358277090995038'
        ip_address:
          description: IP Information for the device initiating the payment. This must be provided for card payments.
          type: string
          example: 49.192.154.141
          default: 49.192.154.141
        wait:
          description: Time in seconds to wait for item response (up to 30). If this value is not provided, it will defaul to 0 and the call will go asynchronously.
          type: integer
          example: '15'
          default: '15'
        callback:
          description: Address to callback when an internal business system response is received. Path parameters {account} {item} and {uuid} may be used. The value must be URL-encoded. The example value shown here represents the URL https://callback.example.com/assembly/{item}/{account}/{uuid}
          type: string
          example: https%3A%2F%2Fcallback.example.com%2Fassembly%2F%7Bitem%7D%2F%7Baccount%7D%2F%7Buuid%7D
          default: https%3A%2F%2Fcallback.example.com%2Fassembly%2F%7Bitem%7D%2F%7Baccount%7D%2F%7Buuid%7D
    item_2:
      type: object
      properties:
        id:
          type: string
          example: 100fd4a0-0538-11e6-b512-3e1d05defe78
        name:
          type: string
          example: 'Landscaping Job #001'
        description:
          type: string
          example: Planting of natives, removal of tree stump.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        state:
          type: string
          enum:
          - pending
          - payment_required
          - wire_pending
          - payment_pending
          - payment_held
          - payment_authorized
          - voided
          - fraud_hold
          - payment_deposited
          - work_completed
          - problem_flagged
          - problem_resolve_requested
          - problem_escalated
          - completed
          - cancelled
          - refunded
          - refund_pending
          - refund_flagged
          - off_platform_refunded
          - partial_completed
          - partial_paid
          - off_platform_chargedback
          example: pending
        status:
          type: integer
          enum:
          - 22000
          - 22100
          - 22110
          - 22150
          - 22175
          - 22180
          - 22195
          - 22190
          - 22200
          - 22300
          - 22400
          - 22410
          - 22420
          - 22500
          - 22575
          - 22600
          - 22610
          - 22650
          - 22670
          - 22700
          - 22800
          - 22680
          example: 22000
        amount:
          type: integer
          example: 20000
        payment_type_id:
          type: integer
          example: 2
        currency:
          type: string
          example: AUD
        buyer_name:
          type: string
          example: Bella Buyer
        buyer_email:
          type: string
          format: email
          example: bella.buyer@assemblypayments.com
        buyer_country:
          type: string
          example: AUS
        seller_name:
          type: string
          example: Samuel Seller
        seller_email:
          type: string
          format: email
          example: samuel.seller@assemblypayments.com
        seller_country:
          type: string
          format: email
          example: AUS
        tds_check_state:
          type: string
          format: email
          example: NA
        batch_state:
          type: string
          example: null
        invoice_url:
          type: string
          example: null
        payout_descriptor:
          type: string
          example: null
        remaining_amount:
          type: integer
          example: 0
        requested_release_amount:
          type: integer
          example: 0
        custom_descriptor:
          type: string
          example: null
        net_amount:
          type: integer
          example: 20000
        chargedback_amount:
          type: integer
          example: 0
        refunded_amount:
          type: integer
          example: 0
        released_amount:
          type: integer
          example: 0
        buyer_fees:
          type: integer
          example: 0
        seller_fees:
          type: integer
          example: 400
        credit_card_fee:
          type: integer
          example: 0
        paypal_fee:
          type: integer
          example: 0
        seller_url:
          type: string
        buyer_url:
          type: string
        direct_debit_fee:
          type: integer
          example: 0
        due_date:
          type: string
          format: date
        pending_release_amount:
          type: integer
          example: 0
        dynamic_descriptor:
          type: string
          example: null
        deposit_reference:
          type: string
          example: 100014013961629
        promisepay_fee:
          type: integer
          example: 350
        total_outstanding:
          type: integer
          example: 20000
        total_amount:
          type: integer
          example: 20000
        payment_method:
          type: string
          example: pending
        payment_credit_card_enabled:
          type: boolean
          example: true
        payment_direct_debit_enabled:
          type: boolean
          example: true
        related:
          type: object
          properties:
            buyers:
              type: string
              example: 064d6800-fff3-11e5-86aa-5e5517507c66
            sellers:
              type: string
              example: 5830def0-ffe8-11e5-86aa-5e5517507c66
        links:
          type: object
          properties:
            self:
              type: string
            buyers:
              type: string
            sellers:
              type: string
            status:
              type: string
            fees:
              type: string
            transactions:
              type: string
            batch_transactions:
              type: string
            wire_details:
              type: string
            bpay_details:
              type: string
            tds_checks:
              type: string
  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
      description: Please refer to Authentication section within https://developer.assemblypayments.com/reference#authentication
      flows:
        clientCredentials:
          tokenUrl: https://au-0000.sandbox.auth.assemblypay.com/tokens
          scopes: {}
    basicAuth:
      type: http
      scheme: basic
x-refined-from:
- zai-assembly-api.json
- zai-async-api.json
x-explorer-enabled: false
x-samples-languages:
- curl
- ruby
- php
- javascript
- csharp
- go
x-proxy-enabled: true
x-samples-enabled: true