Skip to main content
GET

When to Call This Endpoint

Call this endpoint after a transaction has reached AWAITING_FUND_RESPONSE, SETTLED, SETTLED_WITH_WARNING, REFUNDED, or FUND_TRANSFER_FAILED status in the contribution history. The fund response is only available once the fund has processed the payment and returned a result.

Response Structure

Top-level

responseTransaction[] entry

Each entry is for one fund. It contains either employerResponseDetails or memberResponseDetails (not both — they are mutually exclusive).

memberResponseDetails.memberRequest key fields

These fields come from the original contribution submission and are echoed back in the response so you can identify which member this entry belongs to.

employerResponse / memberResponse

refundData

errorDetails

Response Types

responseType on employerResponse.responseType or memberResponse.responseType:

Error Severity Codes

errorSeverityCode on errorDetails.errorSeverityCode:

When does a member appear in the response?

Not every member appears in responseTransaction. The fund only includes entries when it has something to report: So absence means clean success. If a member appears with NON_REFUND + WARNING, their contribution was still processed — the fund is just flagging a note (e.g. account number was auto-corrected). If they appear with a refund type, the contribution was rejected and money is being returned.

When does the payment status update?

After a payment reaches AWAITING_FUND_RESPONSE, a background process polls the fund response once the response window has passed. When the fund responds, the payment status in the contribution history will update to one of the following terminal statuses: Each status change also triggers a payment.status_changed webhook event if a webhook URL is registered.
Note: The SuperStream process assumes all submissions succeed. The clearing house does not give us an exact settlement date, so SETTLED / SETTLED_WITH_WARNING is only indicative — it is based on the super fund not rejecting the contribution within 3 business days of receiving it.

Multi-Member USI Note

When multiple members share the same USI and one has an issue, only the member with something to report will appear in responseTransaction. A cleanly accepted member will have no entry. To identify which employee an entry belongs to, read memberResponseDetails.memberRequest.employmentPayrollNumber. This is the payroll number you submitted when creating the employee, and it is the only reliable way to match a response entry back to a specific person when multiple members share a USI.
Note: Optional memberRequest fields (e.g. phoneNumber, salarySacrificedAmount, employmentStartDate) are only echoed back if they were included in the original contribution submission. Fields not submitted will be absent from the response, not null.

Employer Refund

Member Refund

Member Contribution Type Refund

Successful (No Refund)

Request Parameters

string
required
Transaction ID from the contribution submission

Responses

Response fields

object
Request identifier
array
One entry per fund per transaction. Each entry contains either employerResponseDetails or memberResponseDetails (mutually exclusive).
boolean
integer
string
Last modified on November 10, 2026