Members

<b>BETA:</b> Process a payment for the member.

The conditions API should first be used to see what conditions of release are available to the member followed by the calculate API to determine the amount available for the payment.

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

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
  • 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, fund_write, fund:members_write)

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

OR
OR
OR
OR
OR

Example request

{
  "PaymentType": "PENSION",
  "NetAmount": 500,
  "PAYGAmount": 250
}

Response

Success

TranIDstring
ClearingTransactionGUIDstring
SuperStreamMessageGUIDstring

Example response

{
  "TranID": "f7a254ec-85ed-d9bf-7b14-74b80db1a45a",
  "ClearingTransactionGUID": "f7a254ec-85ed-d9bf-8000-74b80db1a45a",
  "SuperStreamMessageGUID": "f7a254ec-85ed-d9bf-7b14-56234dfsdf34"
}

Changes

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