GET

/PaymentDetail

When to Use

Retrieve payment details by paymentDetailID or externalPaymentDetailId
Verify bank account information before processing transactions
Access payment details for distribution and redemption workflows
Look up payment information independently of BizEntity operations

Prerequisites

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

Considerations

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

Description

Retrieves a specific payment detail record from the 7G platform using paymentDetailID or externalPaymentDetailId. Returns the complete payment data including bank account details, payment type flags, and international transfer information.

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.

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