GET

/paymentdetail

Usage Notes

When

Retrieve payment details by paymentDetailID or externalPaymentDetailId
Verify bank account information before processing payments
Access payment details for distribution or redemption workflows

Requirements

PaymentDetailID or ExternalPaymentDetailId to identify the record (or omit both to retrieve all)

Notes

Returns complete payment data including bank details and payment type flags
PaymentDetailID provides faster lookup than ExternalPaymentDetailId
Each payment detail links to exactly one BizEntity

Description

Retrieves payment detail records with bank account information, payment type flags, and entity association. Supports lookup by ID or retrieval of all records.

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
    }
  ]
}