Members

<b>BETA:</b> Calculate the amount available to process a member payment.

post/sites/{site-identifier}/funds/{fund-identifier}/members/{member-identifier}/payments/calculate

Request

  • Base URL: https://api-dev.superconcepts.com.au/api/v1
  • URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/funds/{fund-identifier}/members/{member-identifier}/payments/calculate
  • Auth: OAuth 2 (authorization code, authorization URL https://api.supermate.com.au/oauth/v1/authorize, token URL https://api.supermate.com.au/oauth/v1/token, scopes: default)

Path parameters

site-identifierstring required

The GUID that identifies a site

fund-identifierstring required

The GUID that identifies a fund

member-identifierstring required

The GUID that identifies a member

Request body

MemberAccountGUIDstring
BeneficiaryGUIDstring guid
PaymentType'LUMP-SUM' | 'ROLLOVER' | 'RELEASE-AUTHORITY' | 'INCOME-STREAM' | 'MARRIAGE-SPLIT' | 'CONTRIBUTION-SPLIT'
ConditionOfRelease'COMPASSIONATE' | 'COMPASSIONATE-CORONAVIRUS' | 'CEASED-EMPLOYMENT' | 'FINANCIAL-HARDSHIP' | 'RESTRICTED/RETIREMENT' | 'TERMINAL-ILLNESS' | 'UNRESTRICTED' | 'DEATH' | 'VOL-RELEASE' | 'COMP-RELEASE' | 'NON-CONCESSIONAL-CONT-RELEASE' | 'CONCESSIONAL-CONT-RELEASE' | 'FIRST-HOME-SAVER-RELEASE' | 'NON-CONCESSIONAL-CONT-TAX-RELEASE' | 'DIVISION-293-RELEASE' | 'MARRIAGE-SPLIT' | 'CONTRIBUTION-SPLIT'
PaymentDatestring date
NetPaymentnumber double
GrossPaymentnumber double
BenefitPaidTo'TAX-DEPENDENT' | 'TRUSTEE-ESTATE' | 'NON-DEPENDENT'
CurrentYearSplittingboolean

Example request

{
  "BeneficiaryGUID": "83a664e0-2c0a-d8bf-bc14-798e0c3983dc",
  "NetPayment": 1000
}

Response

Success

MemberAccountGUIDstring
MemberAgenumber
PreservationAgenumber
PaymentTypestring
ConditionOfReleasestring
AvailableAmountnumber double
PaymentDatestring date
GrossPaymentnumber double
NetPaymentnumber double
InsuranceBenefitnumber double

Example response

{
  "PaymentType": "LUMP-SUM",
  "ConditionOfRelease": "UNRESTRICTED-WITHDRAWAL"
}

Changes

No recorded changes to this operation across all 1 revision of this API.