GET

/PaymentDetail

When to Use

Retrieve payment details for distribution processing
Find bank account information for redemption payments
Validate payment methods before transaction processing
Audit payment details for compliance reporting

Common Scenarios

Specific Record Retrieval: Get a payment detail by paymentDetailID or externalPaymentDetailId
Bank Account Validation: Verify payment details before processing transactions
Payment Method Discovery: Retrieve complete payment account information
International Transfers: Get swift/iban details for foreign payments

Prerequisites

Valid Bearer token with payment detail read permissions
Payment detail ID or external payment detail ID for specific record retrieval
Understanding of payment structure for processing retrieved data

Considerations

Payment details are unique per BizEntity - one payment detail cannot belong to multiple entities
bsb validation applies to Australian domestic accounts
swift/iban required for international transfers
Payment type flags determine usage context (deposit, distribution, redemption)

Description

Retrieves payment details by ID or external ID. Returns bank account information, payment preferences, and international transfer details for distribution processing and transaction settlements.

Advanced Resource: Payment detail records are typically created and managed through BizEntity operations, but can be accessed independently via this endpoint for verification, distribution processing, or compliance purposes.

Payment Type Usage

isForDeposit - Accepts incoming funds (investments, transfers)
isForDistribution - Receives distribution payments
isForRedemption - Receives redemption proceeds
isForOther - General purpose payment account

Required Headers - See Authentication

Header	Value	Description
Authorization	{accessToken}	Bearer token for API access
Version	2.0	API version identifier

Query Parameters

Parameter	Type	Required	Description
`PaymentDetailID`	integer	Optional	The native 7G identifier for the payment detail record. Returns a single record when specified.
`ExternalPaymentDetailId`	string(50)	Optional	Your external identifier for the payment detail. Returns a single record when specified.

PaymentDetailID

integer

Optional

The native 7G identifier for the payment detail record. Returns a single record when specified.

ExternalPaymentDetailId

string(50)

Optional

Your external identifier for the payment detail. Returns a single record when specified.

Example Requests

bash

# Get a specific payment detail by ID
curl -X GET https://api.7g.com.au/PaymentDetail?PaymentDetailID=12345 \
  -H "Authorization: {accessToken}" \
  -H "Version: 2.0"

# Get a payment detail by external ID
curl -X GET "https://api.7g.com.au/PaymentDetail?ExternalPaymentDetailId=PD-001" \
  -H "Authorization: {accessToken}" \
  -H "Version: 2.0"

# Get all payment details
curl -X GET "https://api.7g.com.au/PaymentDetail" \
  -H "Authorization: {accessToken}" \
  -H "Version: 2.0"

Response Examples

json

{
  "result": true,
  "message": null,
  "recordCount": 1,
  "data": [
    {
      "paymentDetailID": 12345,
      "externalPaymentDetailId": "PD-001",
      "paymentTypeID": 1,
      "bizEntityID": 789,
      "externalBizEntityId": "EXT-789",
      "bsb": "012345",
      "accountNumber": "987654321",
      "accountName": "Smith Super Fund",
      "address": "123 Banking Street, Sydney NSW 2000",
      "comments": "Primary distribution account",
      "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": "For all distribution and redemption payments",
      "personalName": "John Smith",
      "reference": "DIST-2024",
      "swift": null
    }
  ]
}