GET /sites/{site-identifier}/bank/payments/{payment-guid}

Bank Accounts

Retrieve the payment details

get/sites/{site-identifier}/bank/payments/{payment-guid}

Request

Base URL: https://api-dev.superconcepts.com.au/api/v1
URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/bank/payments/{payment-guid}
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: actuarial_write, audit_read, audit_write, client_access_grant, contactevents_read, contactevents_write, default, documents_read, documents_write, fund:investments_read, fund:members_read, fund:members_write, fund:transactions_read, fund:transactions_write, fund_read, fund_write, security:domains_write, security:policies_write, security:users_invite, site:accounting-notes_write, site:asset-categories_write, site:auditor_write, site:branding_write, site:datafeed-config_write, site:identity_write, site:letters_write, site:policies_write, site:reporting_write, sites_read, superstream:config_write)

Path parameters

site-identifierstring required

The GUID that identifies a site

payment-guidstring required

The GUID that identifies a payment

Response

Success

PaymentGUIDstring guid

FundCodestring

FundNamestring

PaymentDatestring

PaymentAmountnumber float

PaymentMethod'E' | 'B'

PaymentStatusstring

PayerBSBNumberstring

PayerAccountNumberstring

PayerAccountNamestring

PayerChartAccountGUIDstring guid

PayerDescriptionstring

PayeeBSBNumberstring

PayeeAccountNumberstring

PayeeAccountNamestring

PayeeDescriptionstring

BPAYBillerCodestring

BPAYCustomerReferenceNumberstring

ApprovalsRequiredinteger

ApprovalsProvidedinteger

ApprovalsRemaininginteger

PaymentStatusDisplayStringstring

CreatedByIdentityGUIDstring guid

CreatedByUserCodestring

CreatedByUserNamestring

CreatedDateTimestring date-time

ReasonForRejectionstring

DocumentGUIDstring guid

Example response

{
  "PaymentGUID": "df7f1068-e0c3-709d-8a14-ac2af4b632f8",
  "FundCode": "FND001",
  "FundName": "Growth Fund",
  "PaymentDate": "2025-01-09",
  "PaymentAmount": 1000,
  "PaymentStatus": "Unauthorised",
  "PayerBSBNumber": "123456",
  "PayerAccountNumber": "987654321",
  "PayerAccountName": "John Doe",
  "PayerChartAccountGUID": "e36d1fa6-5936-7ba8-d214-fe59706d687b",
  "PayerDescription": "Monthly rent payment",
  "PayeeBSBNumber": "654321",
  "PayeeAccountNumber": "123456789",
  "PayeeAccountName": "Jane Smith",
  "PayeeDescription": "Landlord account",
  "BPAYBillerCode": "123456",
  "BPAYCustomerReferenceNumber": "987654321",
  "ApprovalsRequired": 2,
  "ApprovalsProvided": 1,
  "ApprovalsRemaining": 1,
  "PaymentStatusDisplayString": "Unauthorised (1/2)",
  "CreatedByIdentityGUID": "df7f1068-e0c3-709d-8a14-ac2af4b632f9",
  "CreatedByUserCode": "USER001",
  "CreatedByUserName": "John Admin",
  "CreatedDateTime": "2025-01-09T12:34:56",
  "DocumentGUID": "df7f1068-e0c3-709d-8a14-ac2af4b63210",
  "Permissions": [
    "authorise",
    "reject",
    "modify",
    "delete"
  ],
  "History": [
    {
      "Action": "CREATE",
      "UserCode": "USERONE",
      "UserName": "User Name",
      "EventDateTime": "2025-01-09T12:34:56"
    }
  ]
}

Changes

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