# MyGigsters Docs

> Build payments and superannuation into your marketplace with the MyGigsters APIs.

- [MyGigsters developer docs](https://mg-payments-api.mintlify.app/index.md): Build payments and superannuation into your marketplace with the MyGigsters APIs.
- [Payments](https://mg-payments-api.mintlify.app/home/payments.md)
- [Superannuation](https://mg-payments-api.mintlify.app/home/superannuation.md)
- [Payments for marketplaces](https://mg-payments-api.mintlify.app/payments/overview.md): Collect payments from your customers and pay out your workers through one API, built for marketplaces.
- [How MyGigsters works](https://mg-payments-api.mintlify.app/get-started/how-it-works.md): Who is involved in a MyGigsters integration and how money moves through your marketplace.
- [Quickstart](https://mg-payments-api.mintlify.app/get-started/quickstart.md): Create a demo account, make your first authenticated request, and create a customer you can charge.
- [Authentication](https://mg-payments-api.mintlify.app/get-started/authentication.md): Authenticate every request with an API key pair sent over HTTP Basic authentication, plus an API version header.
- [Environments and base URLs](https://mg-payments-api.mintlify.app/get-started/environments.md): Build and test against the demo environment, then switch base URLs to go live.
- [Charge a customer](https://mg-payments-api.mintlify.app/guides/charge-a-customer.md): Charge a saved card with payment intents, either in two steps or in a single call.
- [Take payments with payment links](https://mg-payments-api.mintlify.app/guides/payment-links.md): Generate a hosted payment link, send it to your customer, and track its status.
- [Set up subscriptions](https://mg-payments-api.mintlify.app/guides/subscriptions.md): Bill customers on a recurring schedule.
- [Issue refunds](https://mg-payments-api.mintlify.app/guides/refunds.md): Refund a payment and track the refund.
- [Onboard and pay out a worker](https://mg-payments-api.mintlify.app/guides/onboard-and-pay-a-worker.md): Register a worker, collect their bank details, and send a payout.
- [Send invoices and receipts](https://mg-payments-api.mintlify.app/guides/invoices-and-receipts.md): Create and email invoices with a payment link built in, and send receipts.
- [Issue and apply credit notes](https://mg-payments-api.mintlify.app/guides/credit-notes.md): Correct an invoice with a credit note: draft it, issue it, then apply it to an invoice, refund it, or void it.
- [Document verification](https://mg-payments-api.mintlify.app/guides/document-verification.md): Verify ABNs, licences, passports, visas, vehicle registrations, police checks, and right to work.
- [Partner accounts overview](https://mg-payments-api.mintlify.app/platform/overview.md): Onboard your own customers as connected accounts, check their balances, and run batch payouts on their behalf.
- [Core objects and relationships](https://mg-payments-api.mintlify.app/concepts/core-objects.md): How customers, cards, intents, workers, and payouts relate.
- [Payment intent lifecycle](https://mg-payments-api.mintlify.app/concepts/payment-intent-lifecycle.md): Every state a payment intent can be in, and what moves it to the next one.
- [Security model](https://mg-payments-api.mintlify.app/concepts/security-model.md): How the API keeps credentials and card data safe.
- [Receive webhooks](https://mg-payments-api.mintlify.app/security/webhooks.md): Get notified about payment, payout, beneficiary, and invoice events as they happen, instead of polling.
- [API keys and key rotation](https://mg-payments-api.mintlify.app/security/api-keys-and-rotation.md): Rotate API keys with no downtime. The old key keeps working for a grace period while you switch to the new one.
- [Restricted keys](https://mg-payments-api.mintlify.app/security/restricted-keys.md): Create API keys that can only reach the modules an integration needs.
- [Idempotency](https://mg-payments-api.mintlify.app/security/idempotency.md): Retry a request safely without creating a second payment, refund, or payout.
- [API versioning](https://mg-payments-api.mintlify.app/security/versioning.md): Pin your integration to an API version with the X-API-Version header and upgrade on your own schedule.
- [API reference](https://mg-payments-api.mintlify.app/api-reference/introduction.md): Base URLs, authentication, and conventions for the MyGigsters Payments API.
- [Errors and conventions](https://mg-payments-api.mintlify.app/api-reference/errors-and-conventions.md): Error format, status codes, and conventions shared by every endpoint.
- [Authenticate partner](https://mg-payments-api.mintlify.app/api-reference/partner-account/partner-authenticate.md): Authenticates a partner using their registered email and secret OAuth key. Returns a scoped JWT Bearer access token used to authorize subsequent partner operations such as rotating keys or onboarding connected accounts.
- [Rotate auth key](https://mg-payments-api.mintlify.app/api-reference/partner-account/partner-rotate-auth-key.md): Immediately revokes the partner's current OAuth key and generates a brand-new 64-character secret key. All active sessions are invalidated, requiring the partner to re-authenticate with the new key.
- [Create connected account](https://mg-payments-api.mintlify.app/api-reference/partner-account/partner-connected-account.md): Onboards and registers a connected client account under the authenticated partner. Automatically generates a unique client UUID (account_id) and a secure, time-sensitive KYC magic link (kyc_magic_link) for direct customer verification.
- [Get connected account status](https://mg-payments-api.mintlify.app/api-reference/partner-account/partner-ca-status.md): Fetches the current verification and operational status of a connected account under your partner umbrella, including its active state and mapped clearing account identifier.
- [Get KYC magic link](https://mg-payments-api.mintlify.app/api-reference/partner-account/partner-ca-magic-link.md): Generates a secure, pre-authenticated hosted KYC onboarding link for a connected account. Partners can send this link to their clients or talent so they can complete identity checks, business verification, and banking details directly...
- [Simulate account status](https://mg-payments-api.mintlify.app/api-reference/partner-account/partner-ca-simulate-status.md): Sandbox development simulation endpoint that instantly transitions a newly provisioned connected account to active status (KYC activated). This enables platform partners to test end-to-end multi-currency wallet queries, ledger...
- [Get connected account balances](https://mg-payments-api.mintlify.app/api-reference/partner-account/partner-ca-balance.md): Returns the real-time multi-currency wallet balances (including available, pending, and reserved funds) for the specified connected account across supported currencies such as AUD, USD, SGD, GBP, and HKD.
- [Get connected account transactions](https://mg-payments-api.mintlify.app/api-reference/partner-account/partner-ca-transactions.md): Retrieves a paginated ledger of financial transactions (both debits and credits) for a specific connected account within a given date range. Each transaction record includes amount, currency, counterparty merchant, settlement status,...
- [Batch payout](https://mg-payments-api.mintlify.app/api-reference/partner-account/partner-batch-payout.md): Submits a bulk payout batch containing multiple payment instructions. Supports real-time NPP (fast transfer) or standard Bank Transfer clearing rails with idempotency protection.
- [Batch status](https://mg-payments-api.mintlify.app/api-reference/partner-account/partner-batch-status.md): Retrieves the real-time processing and approval status for all individual payment line items in a previously submitted payout batch.
- [Get webhook events](https://mg-payments-api.mintlify.app/api-reference/partner-webhooks/partner-webhook-events.md): Retrieves the catalog of all supported webhook events that your application can subscribe to, including event codes, IDs, and payload structures.
- [Subscribe webhook events](https://mg-payments-api.mintlify.app/api-reference/partner-webhooks/partner-webhook-subscribe.md): Registers a new webhook destination URL with specified event subscriptions and generates a secure HMAC signing secret key for payload verification.
- [Get subscribed webhooks](https://mg-payments-api.mintlify.app/api-reference/partner-webhooks/partner-webhook-list.md): Retrieves a paginated list of all active webhook subscriptions configured for the authenticated partner account.
- [Update webhook](https://mg-payments-api.mintlify.app/api-reference/partner-webhooks/partner-webhook-update.md): Updates the callback destination URL and subscribed event topics for an existing webhook subscription.
- [Create customer](https://mg-payments-api.mintlify.app/api-reference/customers/customer-create.md): This endpoint allows you to create a new customer.
- [Retrieve customer](https://mg-payments-api.mintlify.app/api-reference/customers/customer-details.md): This endpoint makes an HTTP GET request to retrieve the details of a specific customer. Upon successful execution, the response returns a status code of 200 and a JSON object with the keys 'message' and 'customer'.
- [Update customer](https://mg-payments-api.mintlify.app/api-reference/customers/customer-update.md): This endpoint allows you to update an existing customer's information.
- [Delete customer](https://mg-payments-api.mintlify.app/api-reference/customers/customer-delete.md): This endpoint allows programmatically deleting a specific customer by ID.
- [Default card status](https://mg-payments-api.mintlify.app/api-reference/cards/default-card-status.md): This endpoint retrieves the default card status for a specific customer.
- [Default card details](https://mg-payments-api.mintlify.app/api-reference/cards/card-details.md): This endpoint allows you to retrieve detailed information about the customer's default card (payment consented).
- [Set default card](https://mg-payments-api.mintlify.app/api-reference/cards/set-default-card.md): This endpoint allows you to set an existing card as default for a specific customer in the system. It is used to associate a payment card with a customer's profile, enabling seamless transactions in future interactions.
- [Get all cards](https://mg-payments-api.mintlify.app/api-reference/cards/get-all-cards.md): This endpoint retrieves the card details associated with a specific customer ID. The customerId is passed as a path parameter in the URL.
- [Get single card](https://mg-payments-api.mintlify.app/api-reference/cards/get-all-cards-single.md): This endpoint retrieves the card details associated with a single card ID for a specific customer ID. The customerId and cardId is passed as a path parameter in the URL.
- [Remove card](https://mg-payments-api.mintlify.app/api-reference/cards/remove-card.md): This endpoint allows you to remove a payment card associated with a specific customer.
- [Create intent](https://mg-payments-api.mintlify.app/api-reference/payment-intents/create-intent.md): The Create Intent endpoint allows you to create a new payment for a customer.
- [Update intent](https://mg-payments-api.mintlify.app/api-reference/payment-intents/update-intent.md): The Update Customer Intent endpoint is used to update the intent for a customer. You can only update the amount using this endpoint.
- [Confirm intent](https://mg-payments-api.mintlify.app/api-reference/payment-intents/confirm-intent.md): The Confirm Customer Intent endpoint is used to confirm a customer's intent.
- [Capture intent](https://mg-payments-api.mintlify.app/api-reference/payment-intents/capture-intent.md): The Capture Customer Intent endpoint is used to capture an amount on customer's intent.
- [Cancel intent](https://mg-payments-api.mintlify.app/api-reference/payment-intents/cancel-intent.md): The Cancel Customer Intent endpoint is used to cancel a customer's intent with the provided details.
- [Retrieve intent](https://mg-payments-api.mintlify.app/api-reference/payment-intents/retrieve-intent.md): The Retrieve Customer Intent endpoint is used to retrieve the intent details for a customer.
- [Create charge](https://mg-payments-api.mintlify.app/api-reference/payment-intents/create-charge.md): The Create Charge endpoint allows you to create a new payment for a customer.
- [Generate payment link](https://mg-payments-api.mintlify.app/api-reference/payments/generate-payment-link.md): This endpoint allows you to create a payment link. (currently only supports AUD currency).
- [Get payment link status](https://mg-payments-api.mintlify.app/api-reference/payments/get-payment-link-status.md): This endpoint allows you to retrieve the status of a payment link using its unique identifier.
- [Get payment details](https://mg-payments-api.mintlify.app/api-reference/payments/get-payment-details.md): This endpoint is used to retrieve payment details for a customer using the payment intent ID.
- [Create refund](https://mg-payments-api.mintlify.app/api-reference/payments/create-refund.md): The Refund Customer endpoint is used to initiate a refund for a customer.
- [Refund status](https://mg-payments-api.mintlify.app/api-reference/payments/refund-status.md): The refund-status endpoint allows you to retrieve the status of a refund for a customer.
- [Get wallet balances](https://mg-payments-api.mintlify.app/api-reference/wallet/get-wallet.md): Returns the real-time multi-currency wallet balances (including available, pending, and reserved funds across AUD, SGD, USD, etc.) along with the associated settlement banking and clearing details.
- [Create worker](https://mg-payments-api.mintlify.app/api-reference/workers/worker-create.md): This endpoint allows you to create a new worker with their personal and banking details.
- [Retrieve worker](https://mg-payments-api.mintlify.app/api-reference/workers/worker-details.md): This endpoint allows you to get details of a worker using their unique worker ID.
- [Update worker](https://mg-payments-api.mintlify.app/api-reference/workers/worker-update.md): This endpoint allows you to update an existing worker's personal, banking, and early pay details.
- [Add bank details](https://mg-payments-api.mintlify.app/api-reference/workers/add-bank-details.md): This endpoint allows you to add bank details for a worker.
- [Beneficiary URL](https://mg-payments-api.mintlify.app/api-reference/workers/beneficiary-url.md): This endpoint allows you to generate a unique onboarding/form URL for a beneficiary/worker.
- [Delete worker](https://mg-payments-api.mintlify.app/api-reference/workers/worker-delete.md): This endpoint allows you to delete an existing worker using their unique ID.
- [Payout worker](https://mg-payments-api.mintlify.app/api-reference/payouts/payout-worker.md): This endpoint allows the user to initiate a bank payout for a worker.
- [Payout status](https://mg-payments-api.mintlify.app/api-reference/payouts/payout-status.md): This endpoint is used to retrieve the payout status of a worker.
- [Talent payouts](https://mg-payments-api.mintlify.app/api-reference/payouts/talent-payouts.md): This endpoint processes a payout to a talent (worker) using their bank details.
- [Payout history](https://mg-payments-api.mintlify.app/api-reference/payouts/payout-history.md): This endpoint is used to retrieve the paginated list of all payouts.
- [Get all invoices](https://mg-payments-api.mintlify.app/api-reference/invoices/get-all-invoices.md): This endpoint retrieves all invoices with support for search, date filters, and pagination.
- [Create and send invoice](https://mg-payments-api.mintlify.app/api-reference/invoices/create-send-invoice.md): This endpoint creates an invoice, generates a PDF, and optionally emails it to the customer.
- [Delete invoice](https://mg-payments-api.mintlify.app/api-reference/invoices/delete-invoice.md): This endpoint deletes an invoice from the system by its unique ID.
- [Payment receipt](https://mg-payments-api.mintlify.app/api-reference/invoices/payment-receipt.md): This endpoint enables you to generate and send a payment receipt for a business transaction. The receipt will be emailed to the address provided in the request.
- [Payout receipt](https://mg-payments-api.mintlify.app/api-reference/invoices/payout-receipt.md): This endpoint enables you to generate and send a payout receipt for a business transaction. The receipt will be emailed to the address provided in the request.
- [Create draft credit note](https://mg-payments-api.mintlify.app/api-reference/credit-notes/create-draft-credit-note.md): Creates a new credit note in DRAFT state against an invoice. Drafts can be edited or deleted prior to official issuance.
- [Update draft credit note](https://mg-payments-api.mintlify.app/api-reference/credit-notes/update-draft-credit-note.md): Modifies the details of an existing unissued draft credit note. Once a credit note is ISSUED, it can no longer be edited via this endpoint.
- [Delete draft credit note](https://mg-payments-api.mintlify.app/api-reference/credit-notes/delete-draft-credit-note.md): Permanently deletes an unissued draft credit note. Only credit notes in DRAFT status can be deleted. Issued credit notes must be voided instead.
- [Issue credit note](https://mg-payments-api.mintlify.app/api-reference/credit-notes/issue-credit-note.md): Transitions a credit note from DRAFT to ISSUED. Assigns a formal credit note reference number, locks draft modification, and activates the credit balance for invoice allocation.
- [Apply credit note](https://mg-payments-api.mintlify.app/api-reference/credit-notes/apply-credit-note.md): Allocates credit note balance to reduce the outstanding amount on an invoice. Updates credit note status to PARTIALLY_APPLIED or FULLY_APPLIED and records an allocation audit entry.
- [Refund credit note](https://mg-payments-api.mintlify.app/api-reference/credit-notes/refund-credit-note.md): Processes a payment gateway refund against the credit note balance. The refund is disbursed directly back to the customer's original payment method, remaining balance is deducted, and a refund allocation is created for auditing.
- [Void credit note](https://mg-payments-api.mintlify.app/api-reference/credit-notes/void-credit-note.md): Permanently revokes an issued credit note with a required audit reason. Status transitions to VOIDED and any unallocated balance is removed.
- [List credit notes](https://mg-payments-api.mintlify.app/api-reference/credit-notes/list-credit-notes.md): Returns a paginated list of credit notes with support for status filtering, text search, column sorting, and overall summary analytics.
- [Retrieve credit note](https://mg-payments-api.mintlify.app/api-reference/credit-notes/get-credit-note.md): Retrieves the full details of a specific credit note including balance calculations, associated customer and invoice details, and current lifecycle status.
- [Get allocations](https://mg-payments-api.mintlify.app/api-reference/credit-notes/get-credit-note-allocations.md): Returns the full audit log of invoice allocations made against this credit note, showing credited invoices, amounts, timestamps, and notes.
- [Download credit note PDF](https://mg-payments-api.mintlify.app/api-reference/credit-notes/download-credit-note.md): Generates and streams the formal credit note PDF document containing company details, credited items, tax information, and issued status.
- [List subscriptions](https://mg-payments-api.mintlify.app/api-reference/subscriptions/list-subscriptions.md): The List Subscriptions endpoint is used to retrieve a list of all subscriptions.
- [Create subscription](https://mg-payments-api.mintlify.app/api-reference/subscriptions/create-subscription.md): The Create Subscription endpoint is used to create a new recurring subscription for a customer.
- [Update subscription](https://mg-payments-api.mintlify.app/api-reference/subscriptions/update-subscription.md): The Update Subscription endpoint is used to update an existing subscription's parameters such as amount, frequency, start date, and end date.
- [Pause subscription](https://mg-payments-api.mintlify.app/api-reference/subscriptions/pause-subscription.md): The Pause Subscription endpoint is used to pause an existing subscription.
- [Resume subscription](https://mg-payments-api.mintlify.app/api-reference/subscriptions/resume-subscription.md): The Resume Subscription endpoint is used to resume a paused subscription.
- [Cancel subscription](https://mg-payments-api.mintlify.app/api-reference/subscriptions/cancel-subscription.md): The Cancel Subscription endpoint is used to cancel an existing subscription.
- [Verify ABN](https://mg-payments-api.mintlify.app/api-reference/document-verification/verify-abn.md): This endpoint verifies an Australian Business Number (ABN) and returns detailed business registration information including entity name, status, address, and GST registration details.
- [Verify driving licence](https://mg-payments-api.mintlify.app/api-reference/document-verification/verify-driving-license.md): This endpoint verifies an Australian driving licence against official government records. It performs a field-by-field comparison and returns match results for each submitted detail.
- [Verify visa](https://mg-payments-api.mintlify.app/api-reference/document-verification/verify-visa.md): This endpoint verifies a visa against official records using the holder's personal details and passport information. It returns field-by-field match results for each submitted detail.
- [Verify passport](https://mg-payments-api.mintlify.app/api-reference/document-verification/verify-passport.md): This endpoint verifies an Australian passport against official government records. It performs a field-by-field comparison and returns match results for each submitted detail including name, birth date, travel document number, gender,...
- [Vehicle registration check](https://mg-payments-api.mintlify.app/api-reference/document-verification/verify-vehicle.md): This endpoint checks a vehicle registration against official records and returns detailed vehicle information including make, model, colour, body style, registration expiry, and insurance details.
- [Initiate police check](https://mg-payments-api.mintlify.app/api-reference/document-verification/initiate-police-check.md): This endpoint initiates a new national police check application. It registers the applicant's basic details and returns a unique check ID along with a continuation URL where the applicant can complete the process.
- [Police check status](https://mg-payments-api.mintlify.app/api-reference/document-verification/police-check-status.md): This endpoint retrieves the current status of a police check application. It returns the applicant's details, processing status, verification status, and the check result from ACIC (Australian Criminal Intelligence Commission).
- [Right to work](https://mg-payments-api.mintlify.app/api-reference/document-verification/right-to-work.md): This endpoint verifies a person's right to work in Australia using their passport details. It returns visa information, work entitlement status, and any conditions that apply to their employment.
- [Embed the Card SDK](https://mg-payments-api.mintlify.app/sdks/card-sdk.md): Collect card details with hosted fields.
- [Embed the Beneficiary SDK](https://mg-payments-api.mintlify.app/sdks/beneficiary-sdk.md): Collect worker bank details with a hosted form.
- [Changelog](https://mg-payments-api.mintlify.app/changelog.md): What changed in each release of the MyGigsters APIs.
- [Super for marketplaces](https://mg-payments-api.mintlify.app/super/overview.md): Pay superannuation for the freelancers on your marketplace, from onboarding to the fund, through one API.
- [Quickstart](https://mg-payments-api.mintlify.app/super/quickstart.md): Go from an API key to a submitted super contribution in six steps.
- [Authentication](https://mg-payments-api.mintlify.app/super/authentication.md): Authenticate Super API requests with an API key pair sent over HTTP Basic authentication.
- [Onboard an employer](https://mg-payments-api.mintlify.app/super/guides/onboard-an-employer.md): Create the employer of record before you submit super contributions, through the API or with embedded components.
- [Add employees](https://mg-payments-api.mintlify.app/super/guides/add-employees.md): Register the freelancers you pay super for, through the API or with embedded components.
- [Member verification (MVR)](https://mg-payments-api.mintlify.app/super/guides/member-verification.md): Check that a super fund will accept contributions for a member before you pay.
- [Async contribution submissions](https://mg-payments-api.mintlify.app/super/guides/async-submissions.md): Submit large contribution batches asynchronously and get the result by webhook or polling.
- [Self-managed super funds (SMSF)](https://mg-payments-api.mintlify.app/super/guides/smsf.md): Validate and pay contributions to self-managed super funds.
- [Log in](https://mg-payments-api.mintlify.app/super/api-reference/api-keys/log-in.md): This endpoint is to login so you can create an API key. You need to be signed up to MyGigsters first to be able to log in this way.
- [Verify OTP](https://mg-payments-api.mintlify.app/super/api-reference/api-keys/verify-otp.md): This route returns the JWT for use with API Keys routes (/api-keys/) - note that the OTP is always 123456 for non-production environments
- [Create API key](https://mg-payments-api.mintlify.app/super/api-reference/api-keys/create-api-key.md): This endpoint creates an API key. The API Key is to be used in Basic Authentication format eg. curl -u 'apiUsername:apiPassword'. To access this endpoint you need to obtain a JWT via Get OTP and Verify OTP sections.
- [List API keys](https://mg-payments-api.mintlify.app/super/api-reference/api-keys/list-api-keys.md): This endpoint lists API keys. The API Key is to be used in Basic Authentication format eg. curl -u 'apiUsername:apiPassword'. To access this endpoint you need to obtain a JWT via Get OTP and Verify OTP sections.
- [Delete API key](https://mg-payments-api.mintlify.app/super/api-reference/api-keys/delete-api-key.md): This endpoint deletes an API key. To access this endpoint you need to obtain a JWT via Get OTP and Verify OTP sections.
- [Onboard Employer](https://mg-payments-api.mintlify.app/super/api-reference/employers/onboard-employer.md): Onboards a new employer to the system. This endpoint creates a new employer record with company details, contact information, address, and payment account configuration.
- [List Client Employers](https://mg-payments-api.mintlify.app/super/api-reference/employers/list-client-employers.md): Retrieves all employers associated with the authenticated client. Returns a list of employer records with their contact information, payment details, and metadata.
- [Get Employer by ID](https://mg-payments-api.mintlify.app/super/api-reference/employers/get-employer-by-id.md): Retrieves a single employer record by its ID. Returns the employer's contact information, payment configuration, clearing house onboarding status, and metadata.
- [Update Employer](https://mg-payments-api.mintlify.app/super/api-reference/employers/update-employer.md): Updates an existing employer's company, contact, address, and payment details. This is a full replace - send the complete payload, same shape as POST /v1/employers/onboard. The employer must belong to the authenticated client,...
- [Create Employee](https://mg-payments-api.mintlify.app/super/api-reference/employees/create-employee.md): Creates a new employee record and stores static employee information in the database. This information will be used when submitting contributions, so you only need to provide variable data (amounts, pay periods) in...
- [List All Employees](https://mg-payments-api.mintlify.app/super/api-reference/employees/list-all-employees.md): Retrieves all employees associated with the authenticated client. Returns a paginated list of employee records with their static information.
- [Get Employee by ID](https://mg-payments-api.mintlify.app/super/api-reference/employees/get-employee-by-id.md): Retrieves employee information by UUID. Returns all static employee data stored in the database.
- [Update Employee](https://mg-payments-api.mintlify.app/super/api-reference/employees/update-employee.md): Updates an existing employee record. Only the fields provided in the request body will be updated. All other fields will remain unchanged.
- [Search Employees](https://mg-payments-api.mintlify.app/super/api-reference/employees/search-employees.md): Searches for employees by various attributes such as USI, email, name, member number, etc. You can search by one or multiple attributes. All provided search criteria are combined with AND logic.
- [Get super owed](https://mg-payments-api.mintlify.app/super/api-reference/employees/get-super-owed.md): Retrieves the total superannuation owed to an employee, broken down by employer and individual payment transactions. This endpoint is useful for providing employees with a transparent view of their super entitlements and...
- [Create employee (v2)](https://mg-payments-api.mintlify.app/super/api-reference/employees/create-employee-v2.md): Identical to POST /v1/employees, with one difference: this endpoint automatically triggers Member Verification (MVR) for the new employee once their fund identity (usi/smsf) is available. Calling this v2 endpoint **is** the...
- [Bulk upload employees (v2)](https://mg-payments-api.mintlify.app/super/api-reference/employees/bulk-upload-employees-v2.md): Upload a CSV file to onboard multiple employees at once. Identical to POST /v1/employees/bulk-upload, with one difference: this endpoint automatically triggers MVR (Member Verification) for every successfully-created row that...
- [Update employee (v2)](https://mg-payments-api.mintlify.app/super/api-reference/employees/update-employee-v2.md): Identical to PUT /v1/employees/:employeeId, with one difference: changing the employee's fund identity (usi/smsf), name, gender, date of birth, address, or TFN re-triggers MVR (Member Verification) for this employee — these...
- [Submit member verification](https://mg-payments-api.mintlify.app/super/api-reference/member-verification/submit-member-verification.md): Manually submit a Member Verification Request for an employee to SuperChoice. This is the same funnel used internally by the Employees v2 endpoints' automatic MVR trigger — calling it directly behaves identically: the...
- [Validate member verification](https://mg-payments-api.mintlify.app/super/api-reference/member-verification/validate-member-verification.md): Builds a Member Verification Request payload for an employee and validates it against SuperChoice **without submitting it**. Use this to check that an employee's stored details (name, DOB, address, TFN, fund identity) are...
- [Get MVR outcome](https://mg-payments-api.mintlify.app/super/api-reference/member-verification/get-mvr-outcome.md): Look up the stored outcome of an MVR request by its transactionId — the same ID returned by POST /v2/mvr/submit (or found via the Employees v2 automatic trigger). Use this to poll for a result instead of waiting for the...
- [Override MVR payment gate](https://mg-payments-api.mintlify.app/super/api-reference/member-verification/override-mvr-payment-gate.md): Exempts (or restores) a single employee from the MVR payment gate — **without changing their mvrStatus**mvrStatus**. mvrStatus/mvrStatusReason keep updating normally (from the v2 auto-trigger, a manual POST /v2/mvr/submit, or...
- [Set MVR status (testing)](https://mg-payments-api.mintlify.app/super/api-reference/member-verification/set-mvr-status-testing.md): Forces mvrStatus onto an employee **without a real SuperChoice submission** — intended for QA/testing environments, where real funds never reply, so you can still exercise every status/webhook outcome your integration needs to...
- [Validate superannuation fund](https://mg-payments-api.mintlify.app/super/api-reference/funds/validate-superannuation-fund.md): Validates one or more superannuation fund USIs (Unique Superannuation Identifiers) to confirm they are active and able to receive electronic contributions through Superannuation clearing house.
- [SuperSelector](https://mg-payments-api.mintlify.app/super/api-reference/funds/superselector.md): Searches for superannuation funds associated with an employee using the SuperSelector service. This endpoint matches employee details to find potential fund matches.
- [Get active superannuation funds](https://mg-payments-api.mintlify.app/super/api-reference/funds/get-active-superannuation-funds.md): Retrieves a comprehensive list of all superannuation funds currently registered and active in the Superannuation clearing house network. These funds are verified and capable of receiving electronic contributions.
- [Submit Contribution](https://mg-payments-api.mintlify.app/super/api-reference/contributions/submit-contribution.md): Submits a superannuation contribution for processing. This endpoint automatically retrieves employer and employee static information from the database, so you only need to provide variable data such as fund amounts, pay...
- [Submit contribution (async)](https://mg-payments-api.mintlify.app/super/api-reference/contributions/submit-contribution-async.md): Async version of POST /v1/contributions/contribution for larger batches. The request body is **identical** to v1 — only the response and the limits differ. See the Async Submission (v2) guide for the full flow, statuses and...
- [Get Async Submission Status](https://mg-payments-api.mintlify.app/super/api-reference/contributions/get-async-submission-status.md): Get the current status of an async contribution submission by the transactionId returned from POST /v2/contributions. The response has the same shape as the data of the contribution.submission_completed webhook, so you can...
- [Cancel Contribution Batch](https://mg-payments-api.mintlify.app/super/api-reference/contributions/cancel-contribution-batch.md): Cancels an in-flight contribution batch with the clearing house. The cancellation window is narrow — the payment must be in **SOURCE PENDING** state, meaning the debit has been initiated but has not yet cleared from the...
- [Get contribution history](https://mg-payments-api.mintlify.app/super/api-reference/contributions/get-contribution-history.md): Retrieves all submitted contributions with filtering and pagination support. Each record represents one fund's payment for one member within a submission, and includes the current payment status, full contribution details, and...
- [Get payment status](https://mg-payments-api.mintlify.app/super/api-reference/payment-status/get-payment-status.md): Retrieves the payment status for a specific transaction by transaction ID. This endpoint allows you to check the current status of a payment that was submitted through the contribution submission endpoint.
- [Get transaction response](https://mg-payments-api.mintlify.app/super/api-reference/payment-status/get-transaction-response.md): Fetches the fund response payload from the super clearing house after contributions have been processed. Available once the super clearing house has received responses from super funds. Each entry in responseTransaction...
- [Get detailed transaction response](https://mg-payments-api.mintlify.app/super/api-reference/payment-status/get-detailed-transaction-response.md): Identical to GET /v1/payments/response/transaction/:transactionId in every way, except the errorDetails object includes one additional field: errorDetailedDescription.
- [Register webhook](https://mg-payments-api.mintlify.app/super/api-reference/webhooks/register-webhook.md): Register a URL to receive webhook event deliveries. Once registered, the platform will POST events to your URL for employer onboarding, payment status changes, MVR (Member Verification) status changes, and async (v2)...
- [Remove webhook](https://mg-payments-api.mintlify.app/super/api-reference/webhooks/remove-webhook.md): Removes the registered webhook URL for your client. After deletion, no further events will be delivered. The webhook secret is also invalidated.
- [Embedded super components](https://mg-payments-api.mintlify.app/super/components/overview.md): Drop MyGigsters' pre-built employer and freelancer onboarding screens into your product instead of building your own.
- [Employer onboarding screens](https://mg-payments-api.mintlify.app/super/components/employer-onboarding.md): The five-step form an employer completes after opening their magic link.
- [Freelancer onboarding screens](https://mg-payments-api.mintlify.app/super/components/employee-onboarding.md): The three-step form a freelancer completes after opening their magic link, including the ATO super fund lookup.
- [Management dashboard](https://mg-payments-api.mintlify.app/super/components/dashboard.md): The screen your admins use to invite, track, and bulk-upload employers and freelancers.
- [Install and embed](https://mg-payments-api.mintlify.app/super/components/install.md): Add the super components to your React app and mount them with a short-lived token.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.