PUT

/PaymentDetail

When to Use

Update bank account details for existing payment methods
Change payment type flags or usage context
Modify account names, addresses, or reference information
Update international transfer details (swift/iban)

Considerations

Complete Replacement: The entire payment detail record is replaced
ID Immutability: paymentDetailID and externalPaymentDetailId cannot be changed
Entity Ownership: bizEntityID cannot be changed - payment details are bound to specific entities
Bank Validation: Updated bsb/account numbers must pass validation checks

Description

Updates an existing payment detail record with new bank account information, payment preferences, or international transfer details. This endpoint performs a complete replacement of the payment detail structure.

Advanced Resource: Payment detail records can be updated independently via this endpoint or managed through BizEntity operations. Use this endpoint for direct payment method modifications, account ownership verification, or compliance-driven updates.

⚠️ Complete Replacement Pattern

This endpoint replaces the entire payment detail record. Always retrieve the current payment detail first, modify the required fields, then send the complete updated object.

Required Headers - See Authentication

Header	Value	Description
Authorization	{accessToken}	Bearer token for API access
Version	2.0	API version identifier
Content-Type	application/json	Content type for request body

Request Body

Parameter	Type	Required	Description
`paymentDetailID` >	integer	> Required...	The native 7G identifier for the payment detail to update.
`externalPaymentDetailId`	string(50)	Optional	Your external identifier for this payment detail. Cannot be changed after creation.
`paymentTypeID` >	integer	> Required...	Payment method type identifier. Links to lookup table for Australian direct debit, international wire transfer, local bank transfer, and other payment methods. Determines validation rules for bank account format, international transfer capabilities, and usage contexts. Critical for compliance with payment processing regulations and automated distribution workflows.
`BizEntityID`	integer	Optional	7G identifier of the business entity that owns this payment detail. Cannot be changed after creation.
`externalBizEntityId`	string(50)	Optional	Your external identifier for the business entity that owns this payment detail. Cannot be changed after creation.
`bsb` >	string?	> Conditional...	Australian Bank State Branch (BSB) number for domestic bank accounts. Must be 6 digits in format XXXXXX or XXX-XXX. Validated against Australian banking registry for account verification. Required for Australian domestic transfers, BECS direct debit processing, and automated distribution payments within Australia.
`accountNumber` >	string?	> Conditional...	Bank account number for the payment account. Format and length varies by financial institution. Combined with BSB for Australian domestic payments and validated for format compatibility. Critical for automated distribution and redemption processing, payment file generation, and transaction reconciliation.
`accountName`	string?	Optional	Account name as registered with the financial institution. Must match or closely align with entity's legal name for compliance verification and payment processing validation. Mismatches may trigger payment delays or rejection by receiving banks. Used for automated payment file generation, name-matching compliance checks, and audit verification.
`address`	string?	Optional	Bank branch address or account holder address for verification purposes.
`comments`	string?	Optional	Internal notes about this payment method (e.g., 'Primary distribution account').
`currencyID`	integer	Optional	Currency identifier for the payment account. Determines currency for all transactions using this payment detail. Links to lookup table for AUD, USD, EUR, GBP, and other supported currencies. Critical for multi-currency distribution processing, foreign exchange reconciliation, and international payment routing. Defaults to base currency (typically AUD) if not specified.
`iban` >	string?	> Conditional...	International Bank Account Number (IBAN) for cross-border payments. Required for international transfers in SEPA regions and many international jurisdictions. Must be valid IBAN format with correct country code prefix and check digits. Used in combination with SWIFT code for routing international distributions, redemption payments, and cross-border fund transfers.
`intermediaryBankAccountName`	string?	Optional	Correspondent/intermediary bank account name for multi-stage international transfers. Required when receiving bank cannot be reached directly and payment must route through intermediary institution. Used for complex cross-border payment chains and compliance with international banking network requirements.
`intermediaryBankAccountNumber`	string?	Optional	Correspondent bank account number for routing international payments through intermediary institutions. Required for certain cross-border payment corridors where direct routing is unavailable. Critical for successful delivery of international distributions and redemption payments.
`intermediaryBankAddress`	string?	Optional	Physical address of the intermediary/correspondent bank for international transfers. Required for SWIFT messaging and compliance with international payment regulations. Used in automated payment file generation for cross-border wire transfers.
`intermediaryBankName`	string?	Optional	Name of correspondent/intermediary bank for international wire transfers. Required when payment must route through intermediary institution before reaching final beneficiary bank. Essential for multi-hop international payment processing and automated SWIFT message generation.
`intermediaryBankSWIFT`	string?	Optional	SWIFT/BIC code of the intermediary/correspondent bank for international transfers. 8 or 11 character code identifying the intermediary institution in multi-stage payment chains. Required when payment cannot route directly to beneficiary bank. Critical for successful cross-border payment delivery.
`isForDeposit`	bool	Optional	Designates this account for receiving incoming deposits and investment funds. When true, account details may be provided to investors for direct deposit instructions and subscription processing. Note: Deposit accounts typically reference fund's receiving account rather than investor payout accounts. Used for initial investment workflows and additional contribution processing.
`isForDistribution`	bool	Optional	Enables this account for distribution payments including dividends, income distributions, and capital distributions. When true, account becomes available for selection in distribution processing workflows. Multiple accounts can be enabled for distributions, allowing investors to split payments across different accounts for tax or estate planning purposes.
`isForOther`	bool	Optional	Enables account for general purpose payment processing not categorized as distribution, redemption, or deposit. Used for fee payments, expense reimbursements, tax withholding refunds, or other financial transactions. Provides flexibility for custom payment workflows beyond standard investment operations and regulatory requirements.
`isForRedemption`	bool	Optional	Enables this account for redemption proceeds, unit withdrawals, and investment exit payments. When true, account becomes available for redemption processing workflows and automated payout calculations. Essential for investor liquidity management, withdrawal processing, and compliance with redemption timeframe requirements.
`isDefault`	bool	Required	Designates this as the default payment method for the entity. Only one payment detail per entity can be marked as default - setting a new default automatically removes default status from existing payment details. Used by distribution processing and redemption workflows when no specific payment method is nominated. Changes to default status trigger audit logging for compliance tracking and operational oversight.
`message`	string?	Optional	Payment reference message or memo to include with transfers. Appears on bank statements and payment advices for recipient identification. Used for payment reconciliation, investor reference tracking, or compliance audit trails. Maximum length typically limited by payment file format (e.g., 18 characters for BECS, 140 characters for SWIFT messages).
`personalName`	string?	Optional	Personal name for payment reference, may differ from account name. Used for informal payment identification or when account name differs from investor's preferred name. Appears in payment advices and distribution statements but not typically in bank payment files.
`reference`	string?	Optional	Payment reference code for transaction tracking and reconciliation. Unique identifier used in payment batch processing, automated reconciliation workflows, and integration with external accounting systems. Critical for audit trails, payment tracking, and financial reporting processes.
`swift` >	string?	> Conditional...	SWIFT/BIC code for international bank transfers. 8 or 11 character code identifying receiving financial institution for cross-border payments. Required when IBAN is provided for international accounts. System validates format (bank code, country code, location code, optional branch code) and uses for automated international wire transfer processing, SWIFT message generation, and compliance reporting.

paymentDetailID

integer

> Required...

The native 7G identifier for the payment detail to update.

externalPaymentDetailId

string(50)

Optional

Your external identifier for this payment detail. Cannot be changed after creation.

paymentTypeID

integer

> Required...

Payment method type identifier. Links to lookup table for Australian direct debit, international wire transfer, local bank transfer, and other payment methods. Determines validation rules for bank account format, international transfer capabilities, and usage contexts. Critical for compliance with payment processing regulations and automated distribution workflows.

BizEntityID

integer

Optional

7G identifier of the business entity that owns this payment detail. Cannot be changed after creation.

externalBizEntityId

string(50)

Optional

Your external identifier for the business entity that owns this payment detail. Cannot be changed after creation.

bsb

string?

> Conditional...

Australian Bank State Branch (BSB) number for domestic bank accounts. Must be 6 digits in format XXXXXX or XXX-XXX. Validated against Australian banking registry for account verification. Required for Australian domestic transfers, BECS direct debit processing, and automated distribution payments within Australia.

accountNumber

string?

> Conditional...

Bank account number for the payment account. Format and length varies by financial institution. Combined with BSB for Australian domestic payments and validated for format compatibility. Critical for automated distribution and redemption processing, payment file generation, and transaction reconciliation.

accountName

string?

Optional

Account name as registered with the financial institution. Must match or closely align with entity's legal name for compliance verification and payment processing validation. Mismatches may trigger payment delays or rejection by receiving banks. Used for automated payment file generation, name-matching compliance checks, and audit verification.

address

string?

Optional

Bank branch address or account holder address for verification purposes.

comments

string?

Optional

Internal notes about this payment method (e.g., 'Primary distribution account').

currencyID

integer

Optional

Currency identifier for the payment account. Determines currency for all transactions using this payment detail. Links to lookup table for AUD, USD, EUR, GBP, and other supported currencies. Critical for multi-currency distribution processing, foreign exchange reconciliation, and international payment routing. Defaults to base currency (typically AUD) if not specified.

iban

string?

> Conditional...

International Bank Account Number (IBAN) for cross-border payments. Required for international transfers in SEPA regions and many international jurisdictions. Must be valid IBAN format with correct country code prefix and check digits. Used in combination with SWIFT code for routing international distributions, redemption payments, and cross-border fund transfers.

intermediaryBankAccountName

string?

Optional

Correspondent/intermediary bank account name for multi-stage international transfers. Required when receiving bank cannot be reached directly and payment must route through intermediary institution. Used for complex cross-border payment chains and compliance with international banking network requirements.

intermediaryBankAccountNumber

string?

Optional

Correspondent bank account number for routing international payments through intermediary institutions. Required for certain cross-border payment corridors where direct routing is unavailable. Critical for successful delivery of international distributions and redemption payments.

intermediaryBankAddress

string?

Optional

Physical address of the intermediary/correspondent bank for international transfers. Required for SWIFT messaging and compliance with international payment regulations. Used in automated payment file generation for cross-border wire transfers.

intermediaryBankName

string?

Optional

Name of correspondent/intermediary bank for international wire transfers. Required when payment must route through intermediary institution before reaching final beneficiary bank. Essential for multi-hop international payment processing and automated SWIFT message generation.

intermediaryBankSWIFT

string?

Optional

SWIFT/BIC code of the intermediary/correspondent bank for international transfers. 8 or 11 character code identifying the intermediary institution in multi-stage payment chains. Required when payment cannot route directly to beneficiary bank. Critical for successful cross-border payment delivery.

isForDeposit

bool

Optional

Designates this account for receiving incoming deposits and investment funds. When true, account details may be provided to investors for direct deposit instructions and subscription processing. Note: Deposit accounts typically reference fund's receiving account rather than investor payout accounts. Used for initial investment workflows and additional contribution processing.

isForDistribution

bool

Optional

Enables this account for distribution payments including dividends, income distributions, and capital distributions. When true, account becomes available for selection in distribution processing workflows. Multiple accounts can be enabled for distributions, allowing investors to split payments across different accounts for tax or estate planning purposes.

isForOther

bool

Optional

Enables account for general purpose payment processing not categorized as distribution, redemption, or deposit. Used for fee payments, expense reimbursements, tax withholding refunds, or other financial transactions. Provides flexibility for custom payment workflows beyond standard investment operations and regulatory requirements.

isForRedemption

bool

Optional

Enables this account for redemption proceeds, unit withdrawals, and investment exit payments. When true, account becomes available for redemption processing workflows and automated payout calculations. Essential for investor liquidity management, withdrawal processing, and compliance with redemption timeframe requirements.

isDefault

bool

Required

Designates this as the default payment method for the entity. Only one payment detail per entity can be marked as default - setting a new default automatically removes default status from existing payment details. Used by distribution processing and redemption workflows when no specific payment method is nominated. Changes to default status trigger audit logging for compliance tracking and operational oversight.

message

string?

Optional

Payment reference message or memo to include with transfers. Appears on bank statements and payment advices for recipient identification. Used for payment reconciliation, investor reference tracking, or compliance audit trails. Maximum length typically limited by payment file format (e.g., 18 characters for BECS, 140 characters for SWIFT messages).

personalName

string?

Optional

Personal name for payment reference, may differ from account name. Used for informal payment identification or when account name differs from investor's preferred name. Appears in payment advices and distribution statements but not typically in bank payment files.

reference

string?

Optional

Payment reference code for transaction tracking and reconciliation. Unique identifier used in payment batch processing, automated reconciliation workflows, and integration with external accounting systems. Critical for audit trails, payment tracking, and financial reporting processes.

swift

string?

> Conditional...

SWIFT/BIC code for international bank transfers. 8 or 11 character code identifying receiving financial institution for cross-border payments. Required when IBAN is provided for international accounts. System validates format (bank code, country code, location code, optional branch code) and uses for automated international wire transfer processing, SWIFT message generation, and compliance reporting.

Update Process

Retrieve the current payment detail using GET endpoint
Modify the fields you want to change
Include all existing data you want to retain
Send the complete updated object to this PUT endpoint

Important: For Australian accounts, bsb and accountNumber are required. For international accounts, iban and swift are required.

Example Requests

json

{
  "paymentDetailID": 12345,
  "externalPaymentDetailId": "PD-001",
  "paymentTypeID": 1,
  "bizEntityID": 789,
  "externalBizEntityId": "EXT-789",
  "bsb": "012345",
  "accountNumber": "987654321",
  "accountName": "Smith Super Fund - Updated",
  "address": "456 New Banking Street, Melbourne VIC 3000",
  "comments": "Primary distribution account - updated address",
  "currencyID": 1,
  "iban": null,
  "intermediaryBankAccountName": null,
  "intermediaryBankAccountNumber": null,
  "intermediaryBankAddress": null,
  "intermediaryBankName": null,
  "intermediaryBankSWIFT": null,
  "isForDeposit": false,
  "isForDistribution": true,
  "isForOther": false,
  "isForRedemption": true,
  "isDefault": true,
  "message": "Updated payment reference for all distributions",
  "personalName": "John Smith",
  "reference": "DIST-2024-UPDATED",
  "swift": null
}

Response Examples

json

{
  "result": true,
  "message": "Payment detail updated successfully",
  "recordCount": 1,
  "data": [
    {
      "paymentDetailID": 12345,
      "externalPaymentDetailId": "PD-001",
      "paymentTypeID": 1,
      "bizEntityID": 789,
      "externalBizEntityId": "EXT-789",
      "bsb": "012345",
      "accountNumber": "987654321",
      "accountName": "Smith Super Fund - Updated",
      "address": "456 New Banking Street, Melbourne VIC 3000",
      "comments": "Primary distribution account - updated address",
      "currencyID": 1,
      "iban": null,
      "intermediaryBankAccountName": null,
      "intermediaryBankAccountNumber": null,
      "intermediaryBankAddress": null,
      "intermediaryBankName": null,
      "intermediaryBankSWIFT": null,
      "isForDeposit": false,
      "isForDistribution": true,
      "isForOther": false,
      "isForRedemption": true,
      "isDefault": true,
      "message": "Updated payment reference for all distributions",
      "personalName": "John Smith",
      "reference": "DIST-2024-UPDATED",
      "swift": null
    }
  ]
}

When to Use

Considerations

Description

⚠️ Complete Replacement Pattern

Required Headers - See Authentication

Request Body

Update Process

Example Requests

Response Examples

Related Endpoints

Connection Lost