Zai Wallet Accounts API

openapi: 3.2.0
info:
  title: Assembly Wallet Accounts API
  description: Assembly (formely PromisePay) is a powerful payments engine custom-built for platforms and marketplaces.
  version: '2.3'
  contact:
    email: support@assemblypayments.com
    url: http://docs.assemblypayments.com/
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
security:
- oAuth2ClientCredentials: []
tags:
- name: Wallet Accounts
paths:
  /wallet_accounts/{id}/bill_payment:
    post:
      tags:
      - Wallet Accounts
      summary: Pay a Bill
      description: Pay a bill by withdrawing funds from a **Wallet Account** to a specified bpay account.
      operationId: billPayment
      parameters:
      - name: id
        in: path
        description: Account ID
        required: true
        schema:
          type: string
          default: 901d8cd0-6af3-0138-967d-0a58a9feac04
        example: 8a31ebfa-421b-4cbb-9241-632f71b3778a
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bill_payment_requestBody'
      responses:
        '201':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_disbursement'
              examples:
                response:
                  value:
                    disbursements:
                      reference_id: test100
                      id: 8a31ebfa-421b-4cbb-9241-632f71b3778a
                      amount: 173
                      currency: AUD
                      batch_id: null
                      cuscal_payment_transaction_id: null
                      created_at: '2020-05-09T07:09:03.383Z'
                      updated_at: '2020-05-09T07:09:04.585Z'
                      state: pending
                      to: BPay Account
                      account_name: My Water Company
                      biller_name: ABC Water
                      biller_code: 123456
                      crn: 0987654321
                      links:
                        transactions: /disbursements/8a31ebfa-421b-4cbb-9241-632f71b3778a/transactions
                        wallet_accounts: /disbursements/8a31ebfa-421b-4cbb-9241-632f71b3778a/wallet_accounts
                        bank_accounts: /disbursements/8a31ebfa-421b-4cbb-9241-632f71b3778a/bank_accounts
                        bpay_accounts: /disbursements/8a31ebfa-421b-4cbb-9241-632f71b3778a/bpay_accounts
                        paypal_accounts: /disbursements/8a31ebfa-421b-4cbb-9241-632f71b3778a/paypal_accounts
                        items: /disbursements/8a31ebfa-421b-4cbb-9241-632f71b3778a/items
                        users: /disbursements/8a31ebfa-421b-4cbb-9241-632f71b3778a/users
  /wallet_accounts/{id}/users:
    get:
      tags:
      - Wallet Accounts
      summary: Show Wallet Account User
      description: Show the **User** the **Wallet Account** is associated with using a given `:id`.
      operationId: showWalletAccountUser
      parameters:
      - name: id
        in: path
        description: Account ID
        required: true
        style: simple
        explode: false
        schema:
          type: string
          default: 901d8cd0-6af3-0138-967d-0a58a9feac04
        example: 901d8cd0-6af3-0138-967d-0a58a9feac04
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_user'
              examples:
                response:
                  value:
                    users:
                      created_at: '2020-04-03T07:59:00.379Z'
                      updated_at: '2020-04-03T07:59:00.379Z'
                      id: Seller_1234
                      full_name: Samuel Seller
                      email: sam@example.com
                      mobile: 69543131
                      phone: null
                      logo_url: null
                      color_1: null
                      color_2: null
                      first_name: Samuel
                      last_name: Seller
                      custom_descriptor: Sam Garden Jobs
                      location: AUS
                      verification_state: pending
                      held_state: false
                      roles:
                      - customer
                      dob: encrypted
                      government_number: encrypted
                      drivers_license: null
                      flags: {}
                      related:
                        addresses: 11111111-2222-3333-4444-55555555555,
                      links:
                        self: /bank_accounts/901d8cd0-6af3-0138-967d-0a58a9feac04/users
                        items: /users/e6bc0480-57ae-0138-c46e-0a58a9feac03/items
                        card_accounts: /users/e6bc0480-57ae-0138-c46e-0a58a9feac03/card_accounts
                        paypal_accounts: /users/e6bc0480-57ae-0138-c46e-0a58a9feac03/paypal_accounts
                        payid_accounts: /users/e6bc0480-57ae-0138-c46e-0a58a9feac03/payid_accounts
                        bank_accounts: /users/e6bc0480-57ae-0138-c46e-0a58a9feac03/bank_accounts
                        wallet_accounts: /users/e6bc0480-57ae-0138-c46e-0a58a9feac03/wallet_accounts
  /wallet_accounts/{id}/withdraw:
    post:
      tags:
      - Wallet Accounts
      summary: Withdraw Funds
      description: Withdraw funds from a **Wallet Account** to a specified disbursement account.
      operationId: withdrawFunds
      parameters:
      - name: id
        in: path
        description: Wallet account ID
        required: true
        schema:
          type: string
          default: bd6e9c20-73f1-0138-fb91-0a58a9feac09
        example: bd6e9c20-73f1-0138-fb91-0a58a9feac09
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/withdraw_requestBody'
      responses:
        '201':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/withdraw_disbursement'
              examples:
                response:
                  value:
                    disbursements:
                      id: 8a31ebfa-421b-4cbb-9241-632f71b3778a
                      reference_id: 7190770-1-2908
                      amount: 173
                      currency: AUD
                      batch_id: null
                      cuscal_payment_transaction_id: null
                      created_at: '2020-05-09T07:09:03.383Z'
                      updated_at: '2020-05-09T07:09:04.585Z'
                      state: pending
                      to: Bank Account
                      bank_name: Test Bank Assembly
                      bank_account_name: Assembly seller71718579
                      bank_account_number: XXX130
                      bank_routing_number: XXXXX8
                      npp_payout_state: trying
                      end_to_end_id: PRTYAUXXXX
                      ifti_information:
                        instruction_identification: BANKNTSTXXXI20180501000000000000010
                        ultimate_debtor_information:
                          name: John Doe
                          country_of_residence: AU
                          address:
                            country_code: AU
                            address_line:
                            - Level 4
                            - 1 Margaret
                          organisation_identification:
                          - identification: sample
                            identification_type_proprietary: sample
                            identification_type_code: BBAN
                            identification_issuer: sample
                        charge_bearer: CRED
                        previous_instructing_agent:
                          agent_bic: YOURBIC1234
                        creditor_agent_instruction:
                          instruction_information: sample
                          code: CHQB
                        initiating_party_information:
                          name: Initiator Name
                          address:
                            country_code: AU
                            address_line:
                            - Level 4
                            - 1 Margaret
                          organisation_identification:
                          - identification: sample
                            identification_type_proprietary: sample
                            identification_type_code: BBAN
                            identification_issuer: sample
                        instructed_amount:
                          currency: AUD
                          amount: '3.25'
                        ultimate_creditor_information:
                          name: Jane Doe
                          country_of_residence: AU
                          address:
                            country_code: AU
                            address_line:
                            - Level 4
                            - 2 Margaret
                          organisation_identification:
                          - identification: sample
                            identification_type_proprietary: sample
                            identification_type_code: BBAN
                            identification_issuer: sample
                        exchange_rate: '1.23'
                        payment_purpose_proprietary: Prtry
                        payment_information:
                          remittance_information_unstructured: MAP_RE_Happy
                          payment_purpose_code: EPAY
                        regulatory_reporting:
                        - authority_name: Name
                        remittance_information_structured:
                          referred_document_amount:
                          - due_payable_amount:
                              currency: AUD
                              amount: '3.25'
                        related_remittance_information:
                        - identification: S010
                      links:
                        transactions: /disbursements/8a31ebfa-421b-4cbb-9241-632f71b3778a/transactions
                        wallet_accounts: /disbursements/8a31ebfa-421b-4cbb-9241-632f71b3778a/wallet_accounts
                        bank_accounts: /disbursements/8a31ebfa-421b-4cbb-9241-632f71b3778a/bank_accounts
                        paypal_accounts: /disbursements/8a31ebfa-421b-4cbb-9241-632f71b3778a/paypal_accounts
                        items: /disbursements/8a31ebfa-421b-4cbb-9241-632f71b3778a/items
                        users: /disbursements/8a31ebfa-421b-4cbb-9241-632f71b3778a/users
  /wallet_accounts/{id}:
    get:
      tags:
      - Wallet Accounts
      summary: Show Wallet Account
      description: Show details of a specific **Wallet Account** using a given `:id.`
      operationId: showWalletAccount
      parameters:
      - name: id
        in: path
        description: Account ID
        required: true
        style: simple
        explode: false
        schema:
          type: string
          default: 5c1c6b10-4c56-0137-8cd7-0242ac110002
        example: 5c1c6b10-4c56-0137-8cd7-0242ac110002
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/wallet_account'
              examples:
                response:
                  value:
                    wallet_accounts:
                      id: 5c1c6b10-4c56-0137-8cd7-0242ac110002
                      active: true
                      created_at: '2019-04-29T02:42:31.536Z'
                      updated_at: '2020-05-03T12:01:02.254Z'
                      balance: 663337
                      currency: AUD
                      links:
                        self: /transactions/aed45af0-6f63-0138-901c-0a58a9feac03/wallet_accounts
                        users: /wallet_accounts/5c1c6b10-4c56-0137-8cd7-0242ac110002/users
                        batch_transactions: /wallet_accounts/5c1c6b10-4c56-0137-8cd7-0242ac110002/batch_transactions
                        transactions: /wallet_accounts/5c1c6b10-4c56-0137-8cd7-0242ac110002/transactions
                        bpay_details: /wallet_accounts/5c1c6b10-4c56-0137-8cd7-0242ac110002/bpay_details
                        npp_details: /wallet_accounts/5c1c6b10-4c56-0137-8cd7-0242ac110002/npp_details
                        virtual_accounts: /wallet_accounts/5c1c6b10-4c56-0137-8cd7-0242ac110002/virtual_accounts
  /wallet_accounts/{id}/npp_details:
    get:
      tags:
      - Wallet Accounts
      summary: Show Wallet Account NPP Details
      description: Show NPP details of a specific **Wallet Account** using a given `:id.`
      operationId: showWalletAccountNPPDetails
      parameters:
      - name: id
        in: path
        description: Account ID
        required: true
        style: simple
        explode: false
        schema:
          type: string
          default: 5c1c6b10-4c56-0137-8cd7-0242ac110002
        example: 5c1c6b10-4c56-0137-8cd7-0242ac110002
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/wallet_account_npp_details'
              examples:
                response:
                  value:
                    wallet_accounts:
                      id: 5c1c6b10-4c56-0137-8cd7-0242ac110002
                      npp_details:
                        pay_id: npp@assemblypayments.com
                        marketplace_pay_ids:
                        - pay_id: npp@assemblypayments.com
                          type: emal
                        - pay_id: Assembly Payments
                          type: orgn
                        - pay_id: 96637632645
                          type: aubn
                        reference: '100014012148074'
                        amount: $0.00
                        currency: AUD
  /wallet_accounts/{id}/bpay_details:
    get:
      tags:
      - Wallet Accounts
      summary: Show Wallet Account BPAY Details
      description: Show BPAY details of a specific **Wallet Account** using a given `:id.`
      operationId: showWalletAccountNBPAYDetails
      parameters:
      - name: id
        in: path
        description: Account ID
        required: true
        style: simple
        explode: false
        schema:
          type: string
          default: 5c1c6b10-4c56-0137-8cd7-0242ac110002
        example: 5c1c6b10-4c56-0137-8cd7-0242ac110002
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/wallet_account_bpay_details'
              examples:
                response:
                  value:
                    wallet_accounts:
                      id: 5c1c6b10-4c56-0137-8cd7-0242ac110002
                      bpay_details:
                        biller_code: '230680'
                        reference: '100014012148074'
                        amount: $0.00
                        currency: AUD
components:
  schemas:
    ifti_information_response:
      type: object
      properties:
        instruction_identification:
          type: string
          example: BANKNTSTXXXI20180501000000000000010
        ultimate_debtor_information:
          allOf:
          - $ref: '#/components/schemas/party_identification_sample'
          - type: object
        charge_bearer:
          type: string
          example: CRED
        previous_instructing_agent:
          type: object
          properties:
            agent_bic:
              type: string
              example: YOURBIC1234
        creditor_agent_instruction:
          type: object
          properties:
            instruction_information:
              type: string
              example: sample
            code:
              type: string
              example: CHQB
        initiating_party_information:
          allOf:
          - $ref: '#/components/schemas/party_identification_sample'
          - type: object
        instructed_amount:
          type: object
          properties:
            currency:
              type: string
              example: AUD
            amount:
              type: string
              example: '3.25'
        ultimate_creditor_information:
          allOf:
          - $ref: '#/components/schemas/party_identification_sample'
          - type: object
        exchange_rate:
          type: string
          example: '1.23'
        payment_purpose_proprietary:
          type: string
          example: Prtry
        payment_information:
          type: object
          properties:
            remittance_information_unstructured:
              type: string
              example: MAP_RE_Happy
            payment_purpose_code:
              type: string
              example: EPAY
        regulatory_reporting:
          type: array
          items:
            type: object
            properties:
              authority_name:
                type: string
                example: Name
        remittance_information_structured:
          type: object
          properties:
            referred_document_amount:
              type: object
              properties:
                due_payable_amount:
                  type: object
                  properties:
                    currency:
                      type: string
                      example: AUD
                    amount:
                      type: string
                      example: '3.25'
        related_remittance_information:
          type: array
          items:
            type: object
            properties:
              identification:
                type: string
                example: S010
    contact_details:
      type: object
      properties:
        name_prefix:
          type: string
          enum:
          - DOCT
          - MIST
          - MISS
          - MADM
        name:
          maxLength: 140
          type: string
        phone_number:
          pattern: \+[0-9]{1,3}-[0-9()+\-]{1,30}
          type: string
        mobile_number:
          pattern: \+[0-9]{1,3}-[0-9()+\-]{1,30}
          type: string
        fax_number:
          pattern: \+[0-9]{1,3}-[0-9()+\-]{1,30}
          type: string
        email_address:
          maxLength: 2048
          type: string
        other:
          maxLength: 35
          type: string
    generic_identification:
      required:
      - identification
      type: object
      properties:
        identification:
          maxLength: 35
          type: string
        identification_type_proprietary:
          maxLength: 35
          type: string
        identification_type_code:
          maxLength: 4
          minLength: 1
          type: string
          example: BBAN
        identification_issuer:
          maxLength: 35
          type: string
    withdraw_requestBody:
      type: object
      required:
      - account_id
      - amount
      properties:
        account_id:
          description: Account to withdraw to.
          type: string
          example: c1824ad0-73f1-0138-3700-0a58a9feac09
          default: c1824ad0-73f1-0138-3700-0a58a9feac09
        amount:
          description: Amount (in cents) to withdraw.
          type: integer
          example: '173'
          default: '173'
        custom_descriptor:
          description: A descriptor specified by the customer to be passed on the withdraw call. This requires that custom_descriptors are enabled. In the case of fast payments (AU / NPP) Assembly will append a value in the beginning of descriptor, the customer can use 200 characters (excluding URL, javascript/code, emojis). In the case of DE batch payments will allow 18 characters
          type: string
          example: ''
        reference_id:
          description: Unique reference information that can be specified for a for wallet withdrawal request. This is an optional field and cannot contain '.' character.
          type: string
          example: 7190770-1-2908
          default: 7190770-1-2908
        end_to_end_id:
          description: A unique identifier assigned by the initiating party to track and reconcile the IFTI payout throughout its lifecycle. This value must be unique per transaction and is included in payment messaging for traceability across participating financial institutions. This is the Debtor’s (customer) reference for the Payment to be provided to Creditor (customer). Mandatory for NPP IFTI Payment.
          type: string
          example: PRTYAUXXXX
          default: NOTPROVIDED
        ifti_information:
          required:
          - instruction_identification
          - ultimate_debtor_information
          - charge_bearer
          - previous_instructing_agent
          - creditor_agent_instruction
          - initiating_party_information
          description: 'IFTI Payer Information.


            This is an optional field and cannot contain invalid characters.

            Please get in touch with customer service before enabling this feature.


            Fields marked below are required exclusively for **IFTI payout processing to meet reporting and compliance

            requirements**.


            Please refer to individual field descriptions for specific conditional requirements'
          type: object
          properties:
            instruction_identification:
              description: 'A unique transaction reference number that identifies the

                final domestic payout request for NPP. It is recommended that this reference

                number matches the point-to-point transaction reference used in your Austrac reporting.

                Mandatory for NPP IFTI Payment.'
              type: string
              example: BANKNTSTXXXI20180501000000000000010
            ultimate_debtor_information:
              allOf:
              - $ref: '#/components/schemas/party_identification'
              - description: "Following fields are mandatory. \n\n**name, address.country_code, address.address_line, country_of_residence**. \n\nFields from these two groups must not be mixed. Either (organisation_identification\nor organisation_identification and organisation_bic) or (private_identification,\nor private_identification and date_place_of_birth) **must be present**."
            charge_bearer:
              description: "Specifies which party/parties will bear the charges of processing payment transaction.\n\nValid values - \n'CRED' (Borne by Creditor),\n'DEBT' (Borne by Debtor),\n'SHAR' (Shared)."
              type: string
              enum:
              - CRED
              - DEBT
              - SHAR
              example: CRED
            previous_instructing_agent:
              description: This identifies the agent or remitter's bank that instructs the intermediary bank or NPP payer participant to clear funds, typically for bulk or aggregated transfers to your account. This can either be the agent_bic OR clearing system identification and clearing system member identification.
              type: object
              properties:
                agent_bic:
                  type: string
                  example: YOURBIC1234
                clearing_system_identification:
                  type: string
                  example: BICCODE123
                clearing_system_member_identification:
                  type: string
                  example: BICCODE123MEM
            creditor_agent_instruction:
              description: Refers to additional details or instructions provided to the bank or financial institution responsible for crediting the funds to the recipient (the creditor). These instructions are provided by the initiating party and help the creditor agent accurately complete the transfer.
              type: object
              properties:
                instruction_information:
                  description: 'We recommend providing the Originating Debtor Agent BIC as indicated in the initial message,

                    which received the international pay-in instruction from the initiating party.'
                  type: string
                  example: sample
                code:
                  type: string
                  example: CHQB
            initiating_party_information:
              allOf:
              - $ref: '#/components/schemas/party_identification'
              - description: "Following fields are mandatory. \n\n**name, address.country_code, address.address_line, country_of_residence**. \n\nFields from these two groups must not be mixed. Either (organisation_identification\nor organisation_identification and organisation_bic) or (private_identification,\nor private_identification and date_place_of_birth) **must be present**."
            ultimate_creditor_information:
              allOf:
              - $ref: '#/components/schemas/party_identification'
              - description: 'The name of the final recipient of the funds, not including any intermediaries

                  or account holders. Mandatory for IFTI if present in the source international message."'
            instructed_amount:
              description: Transaction Amount. This is the amount originated in foreign currency.
              type: object
              properties:
                currency:
                  type: string
                  example: AUD
                amount:
                  type: string
                  example: '3.25'
            exchange_rate:
              description: Exchange rate used for AUD FX conversion.  Mandatory for IFTI if present in the source international message.
              type: string
              example: '1.23'
            payment_purpose_proprietary:
              description: Refers to a code or description used to specify the reason or purpose for the payment. This information is often provided by the sender to clarify the intent of the transfer, such as payment for goods, services, or a personal remittance. Mandatory for IFTI if present in the source international message.
              type: string
              example: Prtry
            payment_information:
              description: Mandatory for IFTI if present in the source international message.
              type: object
              properties:
                remittance_information_unstructured:
                  description: Refers to additional, free-text details provided by the sender about the purpose or context of the payment.
                  type: string
                  example: MAP_RE_Happy
                payment_purpose_code:
                  description: This refers to the standardized code that indicates the reason for the payment. It helps to identify the nature of the transaction for regulatory and compliance purposes. Refer to https://www.iso20022.org/catalogue-messages/additional-content-messages/external-code-sets for full list of Payment Purpose code.
                  type: string
                  example: EPAY
            regulatory_reporting:
              description: Refers to the obligation to report certain transaction details to regulatory authorities to comply with anti-money laundering (AML), counter-terrorism financing (CTF), and other financial regulations.
              type: array
              items:
                type: object
                properties:
                  authority_name:
                    description: Refers to the name of the regulatory body or financial authority to which the payment details are reported for compliance purposes. This is typically a government or financial intelligence agency that monitors transactions for anti-money laundering (AML) and counter-terrorism financing (CTF) efforts.
                    type: string
                    example: Name
            remittance_information_structured:
              description: It is any additional information or directions provided by the offshore debtor to the creditor in relation to the instruction should be forwarded in this field.
              type: object
              properties:
                referred_document_amount:
                  description: Transaction Amount
                  type: object
                  properties:
                    due_payable_amount:
                      type: object
                      properties:
                        currency:
                          type: string
                          maximum: 3
                          minimum: 3
                          example: AUD
                        amount:
                          type: string
                          example: '3.25'
            related_remittance_information:
              type: array
              items:
                type: object
                properties:
                  identification:
                    type: string
                    example: S010
    single_disbursement:
      type: object
      properties:
        disbursements:
          $ref: '#/components/schemas/disbursement'
    ifti_address:
      type: object
      description: 'This represents address of an individual or non-individual customer of a NPP participant.

        This object could be populated in one of formats below:'
      properties:
        address_type:
          allOf:
          - $ref: '#/components/schemas/address_type'
        department:
          maxLength: 70
          minLength: 1
          type: string
          description: Department
          example: Finance
        sub_department:
          maxLength: 70
          minLength: 1
          type: string
          description: Sub Department
          example: Billing
        street_name:
          maxLength: 70
          minLength: 1
          type: string
          description: Street Name
          example: Kent
        bldg_name:
          maxLength: 16
          minLength: 1
          type: string
          description: Building name
          example: '123'
        postcode:
          maxLength: 16
          minLength: 1
          type: string
          description: Post Code
          example: '2000'
        town_name:
          maxLength: 35
          minLength: 1
          type: string
          description: Town name
          example: Sydney
        ctry_sub_division:
          maxLength: 35
          minLength: 1
          type: string
          description: Country Subdivision
          example: NSW
        country_code:
          pattern: '[A-Z]{2,2}'
          type: string
          description: Country Code
          example: AU
        address_line:
          maxItems: 7
          minItems: 0
          type: array
          items:
            maxLength: 70
            minLength: 1
            type: string
          description: 'Address Lines:


            "address_line": ["Melbourne", "2000" ]'
    wallet_account_bpay_details:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: 46deb476-c1a6-41eb-8eb7-26a695bbe5bc
        bpay_details:
          type: object
          properties:
            biller_code:
              type: string
            reference:
              type: string
            amount:
              type: string
            currency:
              type: string
    party_identification:
      type: object
      properties:
        name:
          maxLength: 140
          type: string
          example: John Doe
        address:
          allOf:
          - $ref: '#/components/schemas/ifti_address'
        organisation_identification:
          type: array
          items:
            $ref: '#/components/schemas/generic_identification'
        organisation_bic:
          pattern: '[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}'
          type: string
          example: SMPLAU2SXXX
        private_identification:
          type: array
          items:
            $ref: '#/compone

# --- truncated at 32 KB (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zai/refs/heads/main/openapi/zai-wallet-accounts-api-openapi.yml