Skip to main content
GET

Use Case

  • Check payment status after submitting a contribution
  • Monitor payment processing progress
  • Verify if a payment has been completed or failed
  • Track payment status for reconciliation purposes

Transaction ID

The transaction ID should be the server-generated transaction ID (in format txn-{uuid}) that was returned when submitting the contribution via the /v1/contributions/contribution endpoint.

Overall Payment Status (paymentOverview.paymentStatus)

  • EMPLOYER_PAYMENT: Payment is in employer payment stage
  • FUND_PAYMENT: Payment is in fund payment stage
  • PAYMENT_COMPLETE: Overall payment is complete

Transaction Payment Status (paymentTransaction[].paymentStatus)

  • PENDING: Payment is queued and awaiting processing
  • PROCESSING: Payment is currently being processed
  • COMPLETED: Payment has been successfully processed
  • SOURCE_FAILED: Source payment (employer) failed
  • SOURCE_CANCELLED: Source payment was cancelled
  • DESTINATION_FAILED: Destination payment (fund) failed
  • DESTINATION_CANCELLED: Destination payment was cancelled

Response Variants

The API returns different response structures based on the payment status. Below are examples of various response scenarios:

1. Response with COMPLETED and PENDING Statuses

2. Response with SOURCE_FAILED Status

3. Response with SOURCE_CANCELLED Status

4. Response with DESTINATION_FAILED Status

5. Response with DESTINATION_CANCELLED Status

Request Parameters

string
required
Server-generated transaction ID from the contribution submission (format: txn-{uuid})

Responses

Response fields

object
Request identifier for tracking the payment status
object
Overview of the payment including source and target information
array
Array of payment transactions associated with this payment
boolean
Always false for error responses, indicating the operation did not succeed.
integer
HTTP status code indicating the type of error. Common values: 400 (Bad Request), 401 (Unauthorized), 404 (Not Found), 500 (Server Error)
string
Human-readable error message explaining what went wrong.
Last modified on November 10, 2026