For AI agents: the docs index is at https://docs.wingspan.app/llms.txt. Append .md to any documentation page URL to get its markdown version.
Jump to Content
WingspanWingspan
HomeGuidesRecipesAPI Reference
Log InWingspan
API Reference
Log In
HomeGuidesRecipesAPI Reference

Wingspan Payments API

  • Payables Management
    • Retrieve Summary of All Payablesget
    • Retrieve Approved Payables Ready for Immediate Payrollget
    • List All Payables Associated with a Clientget
    • Create a New Payable for a Member on Behalf of a Clientpost
    • Retrieve Payable Details by Payable IDget
    • Update Client Payable Information by Payable IDpatch
    • Delete Client Payable by Payable IDdel
    • Execute Approved Payroll Transactionspost
    • Retrieve Summary of All Payablesget
    • Retrieve Approved Payables Ready for Immediate Payrollget
    • List All Payables Associated with a Clientget
    • Create a New Payable for a Member on Behalf of a Clientpost
    • Retrieve Payable Details by Payable IDget
    • Update Client Payable Information by Payable IDpatch
    • Delete Client Payable by Payable IDdel
    • Execute Approved Payroll Transactionspost
  • Invoice Management
    • Retrieve All Member Invoicesget
    • Initiate New Invoice for a Memberpost
    • Fetch Invoice by IDget
    • Modify Existing Invoice Detailspatch
    • Remove Invoice Record by IDdel
    • Retrieve All Invoices Generated by a Clientget
    • Generate a New Invoice on Behalf of the Clientpost
    • Fetch Specific Client-Generated Invoice by IDget
    • Modify an Existing Client-Generated Invoicepatch
    • Execute Payment for a Client-Generated Invoicepost
    • Retrieve all available invoice templatesget
    • Create a new invoice templatepost
    • Retrieve a specific invoice template by IDget
    • Modify details of an existing invoice templatepatch
    • Remove a specific invoice templatedel
    • Retrieve all client-generated invoice templatesget
    • Create a new client-generated invoice templatepost
    • Fetch a specific client-generated invoice template by IDget
    • Modify a client-generated invoice templatepatch
    • Generate a PDF for a specific invoicepost
    • Send an invoice by emailpost
    • Refund a deposited invoicepost
    • Try to pay an invoice using the Client's autopay settingspost
    • Retrieve Fees Associated with a Client's Invoiceget
    • Generate Test Invoice for a Clientpost
    • Retrieve All Member Invoicesget
    • Initiate New Invoice for a Memberpost
    • Fetch Invoice by IDget
    • Modify Existing Invoice Detailspatch
    • Remove Invoice Record by IDdel
    • Retrieve All Invoices Generated by a Clientget
    • Generate a New Invoice on Behalf of the Clientpost
    • Fetch Specific Client-Generated Invoice by IDget
    • Modify an Existing Client-Generated Invoicepatch
    • Execute Payment for a Client-Generated Invoicepost
    • Retrieve all available invoice templatesget
    • Create a new invoice templatepost
    • Retrieve a specific invoice template by IDget
    • Modify details of an existing invoice templatepatch
    • Remove a specific invoice templatedel
    • Retrieve all client-generated invoice templatesget
    • Create a new client-generated invoice templatepost
    • Fetch a specific client-generated invoice template by IDget
    • Modify a client-generated invoice templatepatch
    • Generate a PDF for a specific invoicepost
    • Send an invoice by emailpost
    • Refund a deposited invoicepost
    • Try to pay an invoice using the Client's autopay settingspost
    • Retrieve Fees Associated with a Client's Invoiceget
    • Generate Test Invoice for a Clientpost
  • Collaborator Management
    • Retrieve All Collaborator Groupsget
    • Generate New Collaborator Grouppost
    • Register a New Deduction for a Collaboratorpost
    • Retrieve All Deductions for Collaboratorsget
    • Retrieve Specific Deduction Detailsget
    • Modify Details of a Specific Deductionpatch
    • Erase a Specific Deduction Entrydel
    • Retrieve Events Associated with a Collaboratorget
    • Retrieve Details of a Specific Collaboratorget
    • Modify Collaborator Detailspatch
    • Remove a Specific Collaborator Recorddel
    • Retrieve All Registered Collaboratorsget
    • Register a New Collaboratorpost
    • Associate Collaborator with a Specific Grouppatch
    • Disassociate Collaborator from a Specific Grouppatch
    • Retrieve All Collaborators (Version 2)get
    • Retrieve Specific Collaborator Details (Version 2)get
    • Retrieve All Collaborator Groupsget
    • Generate New Collaborator Grouppost
  • Client Management
    • Retrieve detailed information of a specific member-client relationshipget
    • Register a New Client Deductionpost
    • Update information of a specific member-client relationshippatch
    • Retrieve All Client Deductionsget
    • Remove a specific member-client relationship from the systemdel
    • Fetch Specific Client Deduction Detailsget
    • Modify a Client Deductionpatch
    • Remove a Client Deductiondel
    • Retrieve All Clients (Version 2)get
    • Retrieve Specific Client Details (Version 2)get
    • Register a New Client Deductionpost
    • Retrieve All Client Deductionsget
    • Fetch Specific Client Deduction Detailsget
    • Modify a Client Deductionpatch
    • Remove a Client Deductiondel
  • Banking Management
    • Retrieve All Bank Statementsget
    • Retrieve Specific Bank Statementget
    • Download a specific bank statement as a PDFget
    • Deprecated Retrieve Instant Payout Informationget
    • Fetch the application link for setting up a clearing bank accountget
    • Deprecated Remove Instant Payout Configurationdel
    • Retrieve banking institution details by its routing numberget
    • Deprecated Set Up Instant Payout Configurationpost
    • Fetch all registered payout debit cards for a memberget
    • Register a new payout debit card for a memberpost
    • Retrieve a specific payout debit card linked to a memberget
    • Unlink and delete a specific payout debit card from a member's profiledel
    • Retrieve payout settings for a specific memberget
    • Modify and update payout settings for a specific memberpatch
    • Fetch all registered payout debit cards for a memberget
    • Register a new payout debit card for a memberpost
    • Retrieve a specific payout debit card linked to a memberget
    • Unlink and delete a specific payout debit card from a member's profiledel
    • Retrieve payout settings for a specific memberget
    • Modify and update payout settings for a specific memberpatch
    • Check if payouts are admin-disabled for a memberget
  • Reporting and Analytics
    • Retrieve detailed information on all collaboratorsget
    • Obtain a summarized report of payable amounts for each collaboratorget
    • Retrieve Aging Report for Payablesget
    • Retrieve Aging Report for Invoicesget
    • Obtain Aging Report for Line Itemsget
    • Retrieve detailed information on all collaboratorsget
    • Obtain a summarized report of payable amounts for each collaboratorget
    • Retrieve Aging Report for Payablesget
    • Retrieve Aging Report for Invoicesget
    • Obtain Aging Report for Line Itemsget
  • Service Settings
    • Check Service Statusget
    • Check Service Statusget
    • List all services and their enablement statusget
    • Retrieve the enablement status for a specific serviceget
    • update service enablement statuspatch
  • Payroll Settings
    • Retrieve Individual Payroll Settingsget
    • Modify Existing Payroll Settingspatch
  • Bulk Operations
    • Retrieve All Bulk Payable Batchesget
    • Initiate a New Bulk Payable Batchpost
    • Retrieve Details of a Specific Bulk Payable Batchget
    • Modify a Specific Bulk Payable Batchpatch
    • Remove a Specific Bulk Payable Batchdel
    • Retrieve all items from a specific bulk payable batchget
    • Add a new item to a specific bulk payable batchpost
    • Fetch the import summary for a specific bulk payable batchget
    • Retrieve a Specific Item from a Bulk Payable Batchget
    • Modify a Specific Item in a Bulk Payable Batchpatch
    • Retrieve All Bulk Invoice Batchesget
    • Initiate a New Bulk Invoice Batchpost
    • Retrieve details of a specific bulk invoice batchget
    • Modify the details of a specific bulk invoice batchpatch
    • Fetch all items from a specific bulk invoice batchget
    • Add a new item to a specific bulk invoice batchpost
    • Retrieve a specific item from a bulk invoice batchget
    • Modify a specific item within a bulk invoice batchpatch
    • Fetch all bulk collaborator batchesget
    • Initiate a new bulk collaborator batch.post
    • Retrieve Details of a Specific Collaborator Batchget
    • Modify Details of a Bulk Collaborator Batchpatch
    • Remove a Specific Collaborator Batchdel
    • Retrieve all items from a specific collaborator batchget
    • Append a new item to a specific collaborator batchpost
    • Retrieve details of a specific item from a collaborator batchget
    • Modify the details of a specific item within a collaborator batchpatch
    • Retrieve all bulk client batchesget
    • Create a new bulk client batchpost
    • Fetch Details of a Specific Item from a Client Batchget
    • Modify Details of a Specific Item in a Client Batchpatch
    • Retrieve All Items from a Client Batchget
    • Add a New Item to a Client Batchpost
    • Fetch Details of a Specific Item from a Client Batchget
    • Modify Details of a Specific Item in a Client Batchpatch
    • Retrieve All Bulk Payable Batchesget
    • Initiate a New Bulk Payable Batchpost
    • Retrieve Details of a Specific Bulk Payable Batchget
    • Modify a Specific Bulk Payable Batchpatch
    • Remove a Specific Bulk Payable Batchdel
    • Retrieve all items from a specific bulk payable batchget
    • Add a new item to a specific bulk payable batchpost
    • Fetch the import summary for a specific bulk payable batchget
    • Retrieve a Specific Item from a Bulk Payable Batchget
    • Modify a Specific Item in a Bulk Payable Batchpatch
    • Retrieve All Bulk Invoice Batchesget
    • Initiate a New Bulk Invoice Batchpost
    • Retrieve details of a specific bulk invoice batchget
    • Modify the details of a specific bulk invoice batchpatch
    • Fetch all items from a specific bulk invoice batchget
    • Add a new item to a specific bulk invoice batchpost
    • Retrieve a specific item from a bulk invoice batchget
    • Modify a specific item within a bulk invoice batchpatch
    • Fetch all bulk collaborator batchesget
    • Initiate a new bulk collaborator batch.post
    • Retrieve Details of a Specific Collaborator Batchget
    • Modify Details of a Bulk Collaborator Batchpatch
    • Remove a Specific Collaborator Batchdel
    • Retrieve all items from a specific collaborator batchget
    • Append a new item to a specific collaborator batchpost
    • Retrieve details of a specific item from a collaborator batchget
    • Modify the details of a specific item within a collaborator batchpatch
    • Retrieve all bulk client batchesget
    • Create a new bulk client batchpost
    • Fetch Details of a Specific Item from a Client Batchget
    • Modify Details of a Specific Item in a Client Batchpatch
    • Retrieve All Items from a Client Batchget
    • Add a New Item to a Client Batchpost
    • Fetch Details of a Specific Item from a Client Batchget
    • Modify Details of a Specific Item in a Client Batchpatch
    • Fetch all bulk payroll batchesget
    • Initiate a new bulk payroll batch.post
    • Retrieve Details of a Specific Payroll Batchget
    • Retrieve all items from a specific payroll batchget
    • Retrieve details of a specific item from a collaborator batchget
  • Custom Field Management
    • Add a New Custom Fieldpost
    • Retrieve All Custom Fieldsget
    • Fetch Details of a Specific Custom Fieldget
    • Modify Details of a Specific Custom Fieldpatch
    • Remove a Specific Custom Fielddel
    • Add a New Custom Fieldpost
    • Retrieve All Custom Fieldsget
    • Fetch Details of a Specific Custom Fieldget
    • Modify Details of a Specific Custom Fieldpatch
    • Remove a Specific Custom Fielddel
  • Merchant Category Codes
    • Retrieve Merchant Category Codes (MCC)get
    • Retrieve Merchant Category Codes (MCC)get
  • 1099 Operations
    • Determine 1099 Amounts for Collaboratorspost
    • Request a new mailing of the 1099 form for a collaboratorpost
    • Indicate a collaborator's 1099 form was returned undeliveredpost
    • Retrieve all bulk calculation 1099 batchesget
    • Initialize a new batch for bulk calculation 1099post
    • Retrieve specific details of a bulk calculation 1099 batchget
    • Modify the details of a specific bulk calculation 1099 batchpatch
    • Retrieve all items from a calculation 1099 batchget
    • Add a new item to a calculation 1099 batchpost
    • Fetch details of a specific item from a calculation 1099 batchget
    • Revise the attributes of an item in a calculation 1099 batchpatch
    • Fetch 1099 tax forms.get
    • Create a new tax form.post
    • Fetch tax form.get
    • Update a tax form.patch
    • Re-enable recipient sync on a tax form.post
    • Provide Recipient Proof of Identitypost
    • Re-deliver a tax form by mail or electronic methods.post
    • Submit or request a tax form correction.post
    • Update recipient correction from payer sidepatch
    • Reject a requested tax form correction.post
    • Accepts and submits a pending tax form correction.post
    • Downloads tax form submission PDFpost
    • Retrieve Form 1099 PDF for a Collaborator by Year and Indexget
    • Retrieve Form W9 PDF for a Collaboratorget
    • Determine 1099 Amounts for Collaboratorspost
    • Request a new mailing of the 1099 form for a collaboratorpost
    • Indicate a collaborator's 1099 form was returned undeliveredpost
    • Retrieve all bulk calculation 1099 batchesget
    • Initialize a new batch for bulk calculation 1099post
    • Retrieve specific details of a bulk calculation 1099 batchget
    • Modify the details of a specific bulk calculation 1099 batchpatch
    • Retrieve all items from a calculation 1099 batchget
    • Add a new item to a calculation 1099 batchpost
    • Fetch details of a specific item from a calculation 1099 batchget
    • Revise the attributes of an item in a calculation 1099 batchpatch
    • Submit or request a tax form correction.post
    • Update recipient correction from payer sidepatch
    • Reject a requested tax form correction.post
    • Accepts and submits a pending tax form correction.post
    • Downloads tax form submission PDFpost
    • Fetch tax form submission detailsget
    • Redeliver a specific tax form submissionpost
    • Generate a secure link to tax form submissionpost
    • Get tax form information with a tokenget
    • Download a tax form with a tokenget
  • Invoicing config
    • Get invoicing config configured by given client/payerget
    • Get configured invoicing settingsget
    • Update invoicing configpatch
    • Get invoicing config configured by given client/payerget
    • Get configured invoicing settingsget
    • Update invoicing configpatch
  • Payer Payee Management
    • Fetch a list of payersget
    • Establish a new association between a payer and payeepost
    • Retrieve detailed information of a specific payer relationshipget
    • Update information of a specific payerpatch
    • Fetch a list of payeesget
    • Establish a new association between a payer and payeepost
    • Retrieve detailed information of a specific payee relationshipget
    • Update information of a specific payeepatch
    • Retrieve Form W9 PDF for a payeeget
    • Retrieve Form W9 PDF for a payeeget
    • Re-sends payee invite email to the payee if they have not registered yetpost
    • Preview the results of changing a payee's emailget
    • Update a payee's email addresspost
    • Fetch entity history for a payeeget
    • Fetch a list of payersget
    • Establish a new association between a payer and payeepost
    • Retrieve detailed information of a specific payer relationshipget
    • Update information of a specific payerpatch
    • Fetch a list of payeesget
    • Establish a new association between a payer and payeepost
    • Retrieve detailed information of a specific payee relationshipget
    • Update information of a specific payeepatch
    • Retrieve Form W9 PDF for a payeeget
    • Retrieve Form W9 PDF for a payeeget
    • Re-sends payee invite email to the payee if they have not registered yetpost
    • Preview the results of changing a payee's emailget
    • Update a payee's email addresspost
    • Fetch entity history for a payeeget
  • Payer Engagements Management
    • Add new engagement for payerpost
    • Fetch a list of payer engagementsget
    • Get details of single payer engagementget
    • Update information of a specific payer engagementpatch
    • Add new engagement for payerpost
    • Fetch a list of payer engagementsget
    • Get details of single payer engagementget
    • Update information of a specific payer engagementpatch
    • Fetch work definitions for a payer engagementget
  • Payee Engagements Management
    • Add new engagement for payeepost
    • Fetch a list of payee engagementsget
    • Get details of single payee engagementget
    • Update information of a specific payee engagementpatch
    • Override an engagement's requirement statuspatch
    • Add new engagement for payeepost
    • Fetch a list of payee engagementsget
    • Fetch a list of payee engagementsget
    • Create a new payee engagementpost
    • Get details of single payee engagementget
    • Update information of a specific payee engagementpatch
    • Delete a specific payee engagementdel
    • Get a combined rate card from a payee engagementget
    • Get details of single payee engagementget
    • Update information of a specific payee engagementpatch
    • Delete a specific payee engagementdel
    • Get a combined rate card from a payee engagementget
    • Override an engagement's requirement statuspatch
    • Reset a requirementpost
  • Wingspan Wallet
    • Request a verification code for card authenticationpost
    • Validate verification code to receive a tokenpatch
  • Document Signing and Eligibility
    • Add a New Payment Eligibility Requirementpost
    • Retrieve All Payment Eligibility Requirementsget
    • Retrieve details of a specific Payment Eligibility Requirementget
    • Modify a specific Payment Eligibility Requirementpatch
    • Remove a specific Payment Eligibility Requirementdel
    • Remove Eligibility Requirement from Collaborator Groupdel
    • Modify Eligibility Requirement for Collaborator Grouppatch
    • Retrieve Specific Collaborator Group Configurationget
    • Modify Collaborator Group Configurationpatch
    • Add a New Payment Eligibility Requirementpost
    • Retrieve All Payment Eligibility Requirementsget
    • Retrieve details of a specific Payment Eligibility Requirementget
    • Modify a specific Payment Eligibility Requirementpatch
    • Remove a specific Payment Eligibility Requirementdel
    • Retrieve Specific Collaborator Group Configurationget
    • Modify Collaborator Group Configurationpatch
  • Payment methods
    • Initiate Payment Card Createpost
    • List Payment Cards on the User Accountget
    • Complete Payment Card Createpost
    • Get Payment Card by IDget
    • Remove Payment Card by IDdel
    • Initiate Single-Use Payment Card Createpost
    • Complete Payment Card Createpost
    • Initiate Payment Card Createpost
    • List Payment Cards on the User Accountget
    • Complete Payment Card Createpost
    • Get Payment Card by IDget
    • Remove Payment Card by IDdel
    • Initiate Single-Use Payment Card Createpost
    • Complete Payment Card Createpost
  • Engagements
    • Create a new Engagementpost
    • List Engagementsget
    • Retrieve Engagement by IDget
    • Update Engagement by IDpatch
    • Add Requirement To Engagementpost
    • Remove Requirement From Engagementdel
    • Migration from Collaborator Groups to Engagements
    • Create a new Engagementpost
    • List Engagementsget
    • Retrieve Engagement by IDget
    • Update Engagement by IDpatch
    • Add Requirement To Engagementpost
    • Delete Engagement by IDdel
    • Remove Requirement Definition From Engagementdel
    • Add WorkDefinition To Engagementpost
    • Remove WorkDefinition From Engagementdel
  • Requirements
    • List Requirementsget
    • Create a new Requirementpost
    • Retrieve Requirement by IDget
    • Update Requirement by IDpatch
    • List Requirementsget
    • Retrieve Requirement by IDget
    • Update Requirement by IDpatch
    • Renew a Requirement by IDpost
    • Reset a requirement progresspost
    • List Requirement Definitionsget
    • Create a new Requirement Definitionpost
    • Retrieve Requirement Definition by IDget
    • Update Requirement Definition by IDpatch
    • Delete Requirement Definition by IDdel
  • Verification
    • Get Beneficiary Verification by accountIdpost
  • Work Log Management
    • Convert a Work Log to an Invoicepost
  • Deprecated
    • Retrieve detailed information of a specific member-client relationshipget
    • Update information of a specific member-client relationshippatch
    • Remove a specific member-client relationship from the systemdel
    • Register New Custom Data for Collaborator-Member Relationshippost
    • Retrieve All Collaborator-Member Custom Data Pointsget
    • Retrieve Specific Collaborator Custom Dataget
    • Modify a Specific Collaborator-Member Custom Datapatch
    • Erase a Specific Collaborator-Member Custom Datadel
    • Register a New Deduction for a Collaboratorpost
    • Retrieve All Deductions for Collaboratorsget
    • Retrieve Specific Deduction Detailsget
    • Modify Details of a Specific Deductionpatch
    • Erase a Specific Deduction Entrydel
    • Retrieve Events Associated with a Collaboratorget
    • Retrieve Details of a Specific Collaboratorget
    • Modify Collaborator Detailspatch
    • Remove a Specific Collaborator Recorddel
    • Retrieve All Registered Collaboratorsget
    • Register a New Collaboratorpost
    • Associate Collaborator with a Specific Grouppatch
    • Disassociate Collaborator from a Specific Grouppatch
    • Retrieve Form 1099 PDF for a Collaborator by Year and Indexget
    • Retrieve Form W9 PDF for a Collaboratorget
    • Retrieve All Collaborators (Version 2)get
    • Retrieve Specific Collaborator Details (Version 2)get
    • Retrieve All Clients (Version 2)get
    • Retrieve Specific Client Details (Version 2)get
  • Payroll Settings
    • Retrieve Individual Payroll Settingsget
    • Modify Existing Payroll Settingspatch
  • Work Logs
    • Create a new Work Logpost
    • List Work Logsget
    • Retrieve Work Log by IDget
    • Update Work Logpatch
  • Work Definitions
    • List Work Definitionsget
    • Create a new Work Definitionpost
    • Retrieve Work Definition by IDget
    • Update Work Definition by IDpatch
  • Rate Cards
    • List Rate Cardsget
    • Create a new Rate Cardpost
    • Retrieve Rate Card by IDget
    • Update Rate Card by IDpatch

Wingspan Users API

  • User and Member Management
    • Health Check for User Serviceget
    • Register a new user with pending statuspost
    • Register a new userpost
    • Modify user account details using user IDpatch
    • Fetch user profile details using user IDget
    • Register a New Subscription for Memberpost
    • Retrieve Subscription Details by IDget
    • Modify Subscription Details for Memberpatch
    • Retrieve Advocate Information for the Specified Memberget
    • Initiate User Password Reset Processpost
    • Retrieve payment history for membershipget
    • Retrieve Client Details by IDget
    • Register a New Client with Specific IDpost
    • Modify Existing Client Details by IDpatch
    • Retrieve User by Tag IDget
    • Retrieve User by Email Addressget
    • Retrieve Public User Profile by IDget
    • Retrieve User's Occupation Detailsget
    • Retrieve User's Locationget
    • Health Check for User Serviceget
    • Register a new user with pending statuspost
    • Register a new userpost
    • Modify user account details using user IDpatch
    • Fetch user profile details using user IDget
    • Register a New Member with Specific IDpost
    • Retrieve Subscription Details by IDget
    • Modify Subscription Details for Memberpatch
    • Retrieve Advocate Information for the Specified Memberget
    • Initiate User Password Reset Processpost
    • Retrieve payment history for membershipget
    • Retrieve Client Details by IDget
    • Register a New Client with Specific IDpost
    • Modify Existing Client Details by IDpatch
    • Retrieve User by Tag IDget
    • Retrieve User by Email Addressget
    • Retrieve Public User Profile by IDget
    • Retrieve User's Occupation Detailsget
    • Retrieve User's Locationget
  • Session and Authentication
    • Initiate a new session with pending statuspost
    • Initiate a New User Sessionpost
    • Initiate OTP/2FA Verification Processpost
    • Confirm OTP/2FA Verificationpatch
    • Request to Sign-In on Behalf of Another Userpost
    • Create a New API Sessionpost
    • Retrieve All API Sessions Created by the Current Userget
    • Modify a Specific API Sessionpatch
    • Fetch Details of a Specific API Sessionget
    • Terminate a Specific API Sessiondel
    • Retrieve session details using token IDget
    • Terminate a user session using token IDdel
    • Retrieve Subscription Grants for a Granted Subscriberget
    • Authenticate using Googlepost
    • Initiate verification for an existing email addresspost
    • Initiate Email Verification Process for Userpost
    • Confirm Email Verification Statuspatch
    • Start Phone Verification Process for Userpost
    • Validate Phone Verification Statuspatch
    • Create a Single Sign-On (SSO) Sessionpost
    • Authenticate User Requestpost
    • Initiate a new session with pending statuspost
    • Initiate a New User Sessionpost
    • Initiate OTP/2FA Verification Processpost
    • Confirm OTP/2FA Verificationpatch
    • Request to Sign-In on Behalf of Another Userpost
    • Create a New API Sessionpost
    • Retrieve All API Sessions Created by the Current Userget
    • Modify a Specific API Sessionpatch
    • Fetch Details of a Specific API Sessionget
    • Terminate a Specific API Sessiondel
    • Retrieve session details using token IDget
    • Terminate a user session using token IDdel
    • Retrieve Subscription Grants for a Granted Subscriberget
    • Authenticate using Googlepost
    • Initiate verification for an existing email addresspost
    • Initiate Email Verification Process for Userpost
    • Confirm Email Verification Statuspatch
    • Start Phone Verification Process for Userpost
    • Validate Phone Verification Statuspatch
    • Create a Single Sign-On (SSO) Sessionpost
    • Authenticate User Requestpost
    • OAuth Authorization Endpointget
    • Process OAuth Authorizationpost
    • OAuth Token Exchangepost
    • Revoke OAuth Tokenpost
    • OAuth Token Introspectionpost
    • OAuth Server Metadataget
    • JSON Web Key Setget
  • Account and Banking Operations
    • Generate Plaid Link Token for Account Integrationpost
    • Retrieve All Linked Bank Accountsget
    • Add New Bank Accountpost
    • Fetch Specific Bank Account Detailsget
    • Unlink Bank Accountdel
    • Modify Bank Account Detailspatch
    • Verify an account for paymentspost
    • Get missing user fields for accountget
    • Retrieve Account Numbers for Guestspost
    • Fetch Necessary Account Detailspost
    • Fetch Available Payout Currencies for a Specific Countrypost
    • Generate Plaid Link Token for Account Integrationpost
    • Retrieve All Linked Bank Accountsget
    • Add New Bank Accountpost
    • Fetch Specific Bank Account Detailsget
    • Unlink Bank Accountdel
    • Modify Bank Account Detailspatch
    • Verify an account for paymentspost
    • Get missing user fields for accountget
    • Retrieve Account Numbers for Guestspost
    • Fetch Necessary Account Detailspost
    • Fetch Available Payout Currencies for a Specific Countrypost
  • Authorization and Permissions
    • Request User Authorizationpost
    • Retrieve All User Authorizationsget
    • Retrieve all authorized scopesget
    • Obtain all authorized scope-groupsget
    • Retrieve authorized scope-groups specific to a userget
    • Obtain authorized scopes specific to a userget
    • Retrieve Authorization Details by IDget
    • Modify Existing Authorization Detailspatch
    • Revoke and Remove Authorization Recorddel
    • Retrieve Accounts Authorized by Userget
    • Retrieve Authentication Token for Flatfilepost
    • Request User Authorizationpost
    • Retrieve All User Authorizationsget
    • Retrieve all authorized scopesget
    • Obtain all authorized scope-groupsget
    • Retrieve authorized scope-groups specific to a userget
    • Obtain authorized scopes specific to a userget
    • Retrieve Authorization Details by IDget
    • Modify Existing Authorization Detailspatch
    • Revoke and Remove Authorization Recorddel
    • Retrieve Accounts Authorized by Userget
    • Retrieve Authentication Token for Flatfilepost
  • Subscription Management
    • Retrieve Specific Nextgen Subscription Planget
    • Browse Available Nextgen Subscription Plansget
    • Initiate a New Nextgen Subscription for a Memberpost
    • Fetch All Nextgen Subscriptions for Memberget
    • Retrieve Details of a Specific Nextgen Subscriptionget
    • Modify an Existing Nextgen Subscription for Memberpatch
    • Revoke a Nextgen Subscription for Memberdel
    • Retrieve Specific Nextgen Subscription Planget
    • Browse Available Nextgen Subscription Plansget
    • Initiate a New Nextgen Subscription for a Memberpost
    • Fetch All Nextgen Subscriptions for Memberget
    • Retrieve Details of a Specific Nextgen Subscriptionget
    • Modify an Existing Nextgen Subscription for Memberpatch
    • Revoke a Nextgen Subscription for Memberdel
  • Activity and Usage Tracking
    • Retrieve All Activities of a Memberget
    • Log New Activity for Memberpost
    • Retrieve Specific Activity Details for a Memberget
    • Modify Specific Activity Details for a Memberpatch
    • Remove Specific Activity Record for a Memberdel
    • Retrieve All Activities of a Memberget
    • Log New Activity for Memberpost
    • Retrieve Specific Activity Details for a Memberget
    • Modify Specific Activity Details for a Memberpatch
    • Remove Specific Activity Record for a Memberdel
  • Organization Account Management
    • Register New User within Organizationpost
    • Retrieve All Organization User Accountsget
    • Retrieve Organization User Profileget
    • Modify Organization User Profilepatch
    • Initiate Session for Organization Userget
    • Link a Child User to a Parent Organization Accountpost
    • Modify the Association of Child User to Parent Organizationpatch
    • Register New User within Organizationpost
    • Retrieve All Organization User Accountsget
    • Retrieve Organization User Profileget
    • Modify Organization User Profilepatch
    • Initiate Session for Organization Userget
    • Link a Child User to a Parent Organization Accountpost
    • Modify the Association of Child User to Parent Organizationpatch
  • Deprecated
    • DEPRECATEDgetSubscriptionget
    • DEPRECATEDupdateSubscriptionpatch
    • DEPRECATEDdeleteSubscriptiondel
    • DEPRECATEDlist membership plansget
    • DEPRECATEDget membership planget
    • DEPRECATED Get Payment Methodget
    • DEPRECATED create Payment Methodpost
    • DEPRECATED Update Payment Methodpatch
  • Subscription and Grants Management
    • New Subscription Grantpost
    • Fetch All Subscription Grantsget
    • Modify subscription grant detailspatch
    • Retrieve subscription grant details by IDget
    • Terminate a specific subscription grant by IDdel
    • Register a New Subscription for Memberpost
    • Modify Subscription Details for Memberpatch
    • Retrieve Subscription Details by IDget
    • Remove Subscription for Memberdel
    • New Subscription Grantpost
    • Fetch All Subscription Grantsget
    • Modify subscription grant detailspatch
    • Retrieve subscription grant details by IDget
    • Terminate a specific subscription grant by IDdel
    • Register a New Subscription for Memberpost
    • Modify Subscription Details for Memberpatch
    • Retrieve Subscription Details by IDget
    • Remove Subscription for Memberdel
  • Invitation
    • Fetch a invitation details for provided invitation tokenget
    • Resend all user invitationspost
    • Fetch a invitation details for provided invitation tokenget
    • Resend all user invitationspost
  • Customization
    • Fetch a customization details for a userget
    • Update customization details for a userpatch
    • Fetch a customization details for a userget
    • Fetch a customization details for a userget
    • Update customization details for a userpatch
    • Fetch a customization details for a userget
  • Identity Verification
    • Get identity verification request detailsget
    • Start identity verification processpost
    • Get identity verification request detailsget
    • Start identity verification processpost

Wingspan Benefits API

  • Benefits Service
    • Retrieve Current Benefits Service Statusget
    • Modify Benefits Service Statuspatch
    • Retrieve Current Benefits Service Statusget
    • Modify Benefits Service Statuspatch
  • Benefits Enrollment
    • Retrieve Enrollment Details for a Specific Memberget
    • Get a particular plan enrollment by IDget
    • List all plan enrollmentsget
    • Retrieve Enrollment Details for a Specific Memberget
    • Get a particular plan enrollment by IDget

Wingspan Files API

  • Public File Management
    • Upload Publicly Viewable Filepost
    • Initialize Public File Creationpost
    • Retrieve List of Member's Public Filesget
    • Fetch Specific Public File Detailsget
    • Update Member's Public Filepatch
    • Remove Member's Public Filedel
    • Retrieve Summary of a Specific Public Fileget
    • Download a Specific Public Fileget
    • Upload Publicly Viewable Filepost
    • Initialize Public File Creationpost
    • Retrieve List of Member's Public Filesget
    • Fetch Specific Public File Detailsget
    • Update Member's Public Filepatch
    • Remove Member's Public Filedel
    • Retrieve Summary of a Specific Public Fileget
    • Download a Specific Public Fileget
  • Private File Management
    • Upload a Private Filepost
    • Generate Entry for a New Private Filepost
    • Fetch a List of All Private Files for the Memberget
    • Retrieve Specific Private File Detailsget
    • Modify Specific Private File's Metadatapatch
    • Remove a Specific Private Filedel
    • Download a Member's Private Fileget
    • Upload a Private Filepost
    • Generate Entry for a New Private Filepost
    • Fetch a List of All Private Files for the Memberget
    • Retrieve Specific Private File Detailsget
    • Modify Specific Private File's Metadatapatch
    • Remove a Specific Private Filedel
    • Download a Member's Private Fileget
  • E-Signature Document Templates
    • Create a New E-signature Document Templatepost
    • Retrieve All E-signature Document Templatesget
    • Retrieve Specific E-signature Document Template Detailsget
    • Remove a Specific E-signature Document Templatedel
    • Create a New E-signature Document Templatepost
    • Retrieve All E-signature Document Templatesget
    • Retrieve Specific E-signature Document Template Detailsget
    • Remove a Specific E-signature Document Templatedel
  • Document Management for E-Signatures
    • Retrieve All Documentsget
    • Retrieve Specific Document Detailsget
    • Obtain URLs for Document Signingget
    • Retrieve E-Signed Documents as PDFget
    • Retrieve All Documentsget
    • Retrieve Specific Document Detailsget
    • Obtain URLs for Document Signingget
    • Retrieve E-Signed Documents as PDFget

Wingspan Bookkeeping API

  • Tax and Financial Reporting
    • Retrieve Estimated Tax Details for a Memberpost
    • Obtain Profit and Loss Report for a Memberget
    • Retrieve a Specific Bookkeeping Reportget
    • Retrieve Estimated Tax Details for a Memberpost
    • Obtain Profit and Loss Report for a Memberget
    • Retrieve a Specific Bookkeeping Reportget
  • Transaction Management
    • Fetch Transaction Subcategories Based on Wingspan Categoryget
    • Retrieve All Member Transactionsget
    • Record a New Transactionpost
    • Retrieve Specific Transaction Detailsget
    • Remove a Specific Transactiondel
    • Modify a Specific Transactionpatch
    • Fetch Income Insights for Catch-Up Transactionsget
    • Fetch Expense Insights for Catch-Up Transactionsget
    • Fetch Transaction Subcategories Based on Wingspan Categoryget
    • Retrieve All Member Transactionsget
    • Record a New Transactionpost
    • Retrieve Specific Transaction Detailsget
    • Remove a Specific Transactiondel
    • Modify a Specific Transactionpatch
    • Fetch Income Insights for Catch-Up Transactionsget
    • Fetch Expense Insights for Catch-Up Transactionsget
    • Retrieve All Withholding Transactionsget
    • Obtain Current Tax Withholding Balanceget
  • Service Management
    • Check Bookkeeping Service Statusget
    • Modify Bookkeeping Service Enablement Statuspatch
    • Deactivate Bookkeeping Service for Memberdel
    • Check Bookkeeping Service Statusget
    • Modify Bookkeeping Service Enablement Statuspatch
    • Deactivate Bookkeeping Service for Memberdel
  • Banking and Account Management
    • Retrieve Business Banking Account Informationget
    • Obtain Current Balance of Business Banking Accountget
    • Retrieve Details of a Specific Pending Banking Transactionget
    • Modify a Specific Pending Banking Transactionpatch
    • Fetch All Pending Banking Transactionsget
    • Create a New Pending Banking Transactionpost
    • Retrieve Business Banking Account Informationget
    • Obtain Current Balance of Business Banking Accountget
    • Retrieve Details of a Specific Pending Banking Transactionget
    • Modify a Specific Pending Banking Transactionpatch
    • Fetch All Pending Banking Transactionsget
    • Create a New Pending Banking Transactionpost
  • Withholding Transactions
    • Get Withholding Transactionget
    • Retrieve Details of a Specific Pending Withholding Transactionget
    • Modify Details of a Pending Withholding Transactionpatch
    • Retrieve All Pending Withholding Transactionsget
    • Start a New Withholding Transactionpost
    • Retrieve Pending Cashback Amountget
    • Retrieve All Withholding Transactionsget
    • Obtain Current Tax Withholding Balanceget
    • Get Withholding Transactionget
    • Retrieve Details of a Specific Pending Withholding Transactionget
    • Modify Details of a Pending Withholding Transactionpatch
    • Retrieve All Pending Withholding Transactionsget
    • Start a New Withholding Transactionpost
    • Retrieve Pending Cashback Amountget
  • Cashback Rewards Management
    • Retrieve Approved Cashback Amountget
    • Redeem Available Cashbackpost
    • Check User's Eligibility for Cashback Rewardsget
    • Retrieve Approved Cashback Amountget
    • Redeem Available Cashbackpost
    • Check User's Eligibility for Cashback Rewardsget
  • Deprecated

Wingspan Customer Data Onboarding API

  • Verifications
    • Get verification levels for a customerget
    • Perform a verification for a specific levelpost
    • Lists missing fields or documents for a specific verification levelget
  • Banking Accounts
    • List Internal Account Statementsget
    • Retrieve Internal Account Statementget
    • List Internal Accountsget
    • Create Internal Accountpost
    • Retrieve Internal Accountget
    • Retrieve Internal Account Balanceget
    • List Internal Account Statementsget
    • Retrieve Internal Account Statementget
    • List Internal Accountsget
    • Create Internal Accountpost
    • Retrieve Internal Accountget
    • Retrieve Internal Account Balanceget
  • Banking Transactions
    • List transactions for a specific internal accountget
    • Create Internal Account Transferpost
    • Create Internal Account Transferpost
    • List transactions for a specific internal accountget
  • Payment Cards
    • List Payment Cardsget
    • Create Payment Cardpost
    • Retrieve Payment Cardget
    • Activate Payment Cardpost
    • Set Card PINpost
    • Get Card Embed URLget
    • Get Card Limitsget
    • Set Card Limitspost
    • Cancel Payment Cardpost
    • Suspend Payment Cardpost
    • List Payment Cardsget
    • Create Payment Cardpost
    • Retrieve Payment Cardget
    • Activate Payment Cardpost
    • Set Card PINpost
    • Get Card Embed URLget
    • Get Card Limitsget
    • Set Card Limitspost
    • Cancel Payment Cardpost
    • Suspend Payment Cardpost
  • Customer Entity
    • Get current customer entityget
    • Creates a new customer entitypost
    • Update customer datapatch
    • Request a material or immaterial change to the customer entitypost
  • Acknowledgements
    • Acknowledge an agreement or policypost
    • Get acknowledgement detailsget
  • Insurance Coverage
    • List insurance policies and Master Policy enrollmentsget
    • Get insurance policy detailsget
  • Insurance Coverage Monitor
    • Get insurance coverage monitorget
    • Set coverage on insurance coverage monitorpatch
    • Download insurance coverage fileget
  • Resource-Event-History
    • List resource eventsget
  • Revenue
    • Get all custom prices for the authenticated customerget
    • Get specific price for the authenticated customer and SKUget
  • Insurance Coverage Monitor Settings
    • Create insurance coverage monitor settingspost
    • Get insurance coverage monitor settingsget
  • Insurance Import
    • Create insurance importpost
    • Get insurance importget
    • Update insurance importpatch
    • Submit insurance importpost
  • Plan Enrollment
    • List plan enrollmentsget
    • Enroll in a planpost
    • Get a plan enrollmentget
    • Cancel a plan enrollmentpost
    • Withdraw a plan enrollment cancellationpost
  • Payouts
    • Get list of payoutsget
    • Get details of a particular payoutget
    • Get currency exchange ratepost
    • Get list of payoutsget
    • Get details of a particular payoutget
    • Get currency exchange ratepost

User Onboarding

  • Verifications
    • Get verification levels for a customerget
    • Perform a verification for a specific levelpost
    • Lists missing fields or documents for a specific verification levelget
  • Customer Entity
    • Get current customer entityget
    • Creates a new customer entitypost
    • Update customer datapatch
    • Request a material or immaterial change to the customer entitypost
  • Acknowledgements
    • Acknowledge an agreement or policypost
    • Get acknowledgement detailsget

Wingspan Banking API

  • Forms
  • Payables
    • List payables for the authenticated userget
    • Create a bulk action for a payable result setpost
    • List bulk action batches for the authenticated userget
  • Meridio Plan Enrollment
    • List health plan catalogget
    • List health plan enrollmentsget
    • Enroll in health planspost
  • User
    • Get current user profileget
  • Organizations
    • Provision a partner SSO platform accountpost
Powered by 

Deprecated

Deprecated Endpoints.

Updated 3 months ago


Check User's Eligibility for Cashback Rewards
Verifications
Did this page help you?

Updated 3 months ago


Check User's Eligibility for Cashback Rewards
Verifications
Did this page help you?