Bank Accounts

Create new payment

post/sites/{site-identifier}/bank/payments

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
  • 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

Query parameters

save-bankboolean

Store the details with Used for Payments ticked.

Request body

FundIdentifierstring
ChartAccountGUIDstring guid
PaymentDatestring
PaymentAmountnumber float
PaymentMethod'E' | 'B'
PayerDescriptionstring
PayeeAccountNamestring
PayeeBSBstring
PayeeAccountNumberstring
PayeeDescriptionstring
BPAYBillerCodestring
BPAYCustomerReferenceNumberstring
DocumentGUIDstring guid

Example request

{
  "FundIdentifier": "FUNDCODE",
  "ChartAccountGUID": "df7f1068-e0c3-709d-8a14-ac2af4b632f8",
  "PaymentDate": "2025-01-09",
  "PaymentAmount": 1000,
  "PayerDescription": "Monthly subscription payment",
  "PayeeAccountName": "To bank account name",
  "PayeeBSB": "123456",
  "PayeeAccountNumber": "987654321",
  "PayeeDescription": "Supplier account",
  "BPAYBillerCode": "123456",
  "BPAYCustomerReferenceNumber": "987654321",
  "DocumentGUID": "df7f1068-e0c3-709d-8a14-ac2af4b632f8"
}

Response

Created

PaymentGUIDstring guid

Example response

{
  "PaymentGUID": "df7f1068-e0c3-709d-8a14-ac2af4b632f8"
}

Changes

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