REST API

GET Account

/fundraiser/api/v1/accounts/

`Path Variables`

Variable	Example	Description
id	ASF123456	The ASF Member Number of the fundraising account

`Query Parameters`

Parameter	Example	Description
channel	acmePlatform Integration	The channel (source) of the donation.

Example

Request

/fundraiser/api/v1/accounts/ASF123456?channel=acmePlatform Integration

Response

Success

{
    "apiVersion": "1.0.21",
    "correlationId": "5de0600a-781a-4a65-a2ca-a99cebf059a5",
    "method": "/accounts/ASF123456",
    "data": {
        "items": {
            "name": "Acme Cricket Club",
            "memberNumber": "ASF123456",
            "abn": "123456789",
            "products": [
                {
                    "name": "acmePlatform Integration",
                    "description": "We are raising funds to purchase new training equipment for our junior teams.",
                    "status": "Activated",
                    "logo": "https://example.com/logo.jpg",
                    "coverImage": "https://example.com/cover_image.png",
                    "donationAmounts": [
                        10,
                        20,
                        50,
                        100
                    ],
                    "story": "",
                    "campaigns": {}
                }
            ]
        }
    }
}

Error

{
    "apiVersion": "1.0.21",
    "correlationId": "11d9b39e-bb08-4c20-b822-8c402508549c",
    "method": "/accounts/ASF123456",
    "error": {
        "code": "FUNDRAISER:VALIDATION",
        "timeStamp": "2026-02-09T00:13:20",
        "message": "Fundraiser Validation Unsuccessful",
        "cause": "Fundraiser with Id:000028 doesn't have an active enrollment with acmePlatform Integration Product."
    }
}

POST Donation

/fundraiser/api/v1/donations

Path Variables

None

Query Parameters

None

Example

Request

{
    "donor": {
        "firstName": "Jane",
        "lastName": "Citizen",
        "mobile": "",
        "businessName": "",
        "billingAddress": {
            "country": "Australia",
            "city": "",
            "street": "",
            "postalCode": "2000",
            "state": "NSW"
        },
        "email": "jane@example.com",
        "verifiedEmail": "jane@example.com"
    },
    "source": {
        "channel": "acmePlatform Integration",
        "fundraiserId": "ASF123456"
    },
    "sourceMetadata": {
        "orderNumber": "12345",
        "customerId": "1234567890",
        "orderDate": "2026-01-22T12:01:01+10:00",
        "orderTotal": "195.00"
    },
    "transaction": {
        "date": "2026-01-22T12:00:58+10:00",
        "amount": "20",
        "id": "987654321"
    }
}

Response

{
    "apiVersion": "1.0.21",
    "correlationId": "927e2aa9-9f09-4f0d-beb0-d7f46e494da4",
    "method": "/donations",
    "data": {
        "items": {
            "donationReferenceId": "0123456-9876543"
        }
    }
}

POST Remittance

/fundraiser/api/v1/remittances

Path Variables

None

Query Parameters

None

Example

Request

{
  "source": {
    "channel": "acmePlatform Integration",
    "fundraiserId": "ASF123456"
  },
  "remittances": [
    {
      "bankReferenceId": "utYQGptmAuOiyqpLdUFZ",
      "amount": 7 0,
      "donationIds": [
        "0123456-9876543",
        "0123456-9876544"
      ]
    }
  ]
}

Response

TBC