Jump to Content
Home
Guides
Recipes
API Reference
v1.0
v2.0
Log In
API Reference
Log In
v1.0
Home
Guides
Recipes
API Reference
Payer Payee Management
All
Pages
Start typing to search…
JUMP TO
Wingspan Payments API
Payables Management
Retrieve Summary of All Payables
get
Retrieve Approved Payables Ready for Immediate Payroll
get
List All Payables Associated with a Client
get
Create a New Payable for a Member on Behalf of a Client
post
Retrieve Payable Details by Payable ID
get
Update Client Payable Information by Payable ID
patch
Delete Client Payable by Payable ID
del
Execute Approved Payroll Transactions
post
Retrieve Summary of All Payables
get
Retrieve Approved Payables Ready for Immediate Payroll
get
List All Payables Associated with a Client
get
Create a New Payable for a Member on Behalf of a Client
post
Retrieve Payable Details by Payable ID
get
Update Client Payable Information by Payable ID
patch
Delete Client Payable by Payable ID
del
Execute Approved Payroll Transactions
post
Invoice Management
Retrieve All Member Invoices
get
Initiate New Invoice for a Member
post
Fetch Invoice by ID
get
Modify Existing Invoice Details
patch
Remove Invoice Record by ID
del
Retrieve All Invoices Generated by a Client
get
Generate a New Invoice on Behalf of the Client
post
Fetch Specific Client-Generated Invoice by ID
get
Modify an Existing Client-Generated Invoice
patch
Execute Payment for a Client-Generated Invoice
post
Retrieve all available invoice templates
get
Create a new invoice template
post
Retrieve a specific invoice template by ID
get
Modify details of an existing invoice template
patch
Remove a specific invoice template
del
Retrieve all client-generated invoice templates
get
Create a new client-generated invoice template
post
Fetch a specific client-generated invoice template by ID
get
Modify a client-generated invoice template
patch
Generate a PDF for a specific invoice
post
Send an invoice by email
post
Refund a deposited invoice
post
Try to pay an invoice using the Client's autopay settings
post
Retrieve Fees Associated with a Client's Invoice
get
Generate Test Invoice for a Client
post
Retrieve All Member Invoices
get
Initiate New Invoice for a Member
post
Fetch Invoice by ID
get
Modify Existing Invoice Details
patch
Remove Invoice Record by ID
del
Retrieve All Invoices Generated by a Client
get
Generate a New Invoice on Behalf of the Client
post
Fetch Specific Client-Generated Invoice by ID
get
Modify an Existing Client-Generated Invoice
patch
Execute Payment for a Client-Generated Invoice
post
Retrieve all available invoice templates
get
Create a new invoice template
post
Retrieve a specific invoice template by ID
get
Modify details of an existing invoice template
patch
Remove a specific invoice template
del
Retrieve all client-generated invoice templates
get
Create a new client-generated invoice template
post
Fetch a specific client-generated invoice template by ID
get
Modify a client-generated invoice template
patch
Generate a PDF for a specific invoice
post
Send an invoice by email
post
Refund a deposited invoice
post
Try to pay an invoice using the Client's autopay settings
post
Retrieve Fees Associated with a Client's Invoice
get
Generate Test Invoice for a Client
post
Collaborator Management
Retrieve All Collaborator Groups
get
Generate New Collaborator Group
post
Register a New Deduction for a Collaborator
post
Retrieve All Deductions for Collaborators
get
Retrieve Specific Deduction Details
get
Modify Details of a Specific Deduction
patch
Erase a Specific Deduction Entry
del
Retrieve Events Associated with a Collaborator
get
Retrieve Details of a Specific Collaborator
get
Modify Collaborator Details
patch
Remove a Specific Collaborator Record
del
Retrieve All Registered Collaborators
get
Register a New Collaborator
post
Associate Collaborator with a Specific Group
patch
Disassociate Collaborator from a Specific Group
patch
Retrieve All Collaborators (Version 2)
get
Retrieve Specific Collaborator Details (Version 2)
get
Retrieve All Collaborator Groups
get
Generate New Collaborator Group
post
Client Management
Retrieve detailed information of a specific member-client relationship
get
Register a New Client Deduction
post
Update information of a specific member-client relationship
patch
Retrieve All Client Deductions
get
Remove a specific member-client relationship from the system
del
Fetch Specific Client Deduction Details
get
Modify a Client Deduction
patch
Remove a Client Deduction
del
Retrieve All Clients (Version 2)
get
Retrieve Specific Client Details (Version 2)
get
Register a New Client Deduction
post
Retrieve All Client Deductions
get
Fetch Specific Client Deduction Details
get
Modify a Client Deduction
patch
Remove a Client Deduction
del
Banking Management
Retrieve All Bank Statements
get
Retrieve Specific Bank Statement
get
Download a specific bank statement as a PDF
get
Deprecated Retrieve Instant Payout Information
get
Fetch the application link for setting up a clearing bank account
get
Deprecated Remove Instant Payout Configuration
del
Retrieve banking institution details by its routing number
get
Deprecated Set Up Instant Payout Configuration
post
Fetch all registered payout debit cards for a member
get
Register a new payout debit card for a member
post
Retrieve a specific payout debit card linked to a member
get
Unlink and delete a specific payout debit card from a member's profile
del
Retrieve payout settings for a specific member
get
Modify and update payout settings for a specific member
patch
Retrieve All Bank Statements
get
Retrieve Specific Bank Statement
get
Download a specific bank statement as a PDF
get
Fetch the application link for setting up a clearing bank account
get
Retrieve banking institution details by its routing number
get
Fetch all registered payout debit cards for a member
get
Register a new payout debit card for a member
post
Retrieve a specific payout debit card linked to a member
get
Unlink and delete a specific payout debit card from a member's profile
del
Retrieve payout settings for a specific member
get
Modify and update payout settings for a specific member
patch
Reporting and Analytics
Retrieve detailed information on all collaborators
get
Obtain a summarized report of payable amounts for each collaborator
get
Retrieve Aging Report for Payables
get
Retrieve Aging Report for Invoices
get
Obtain Aging Report for Line Items
get
Retrieve detailed information on all collaborators
get
Obtain a summarized report of payable amounts for each collaborator
get
Retrieve Aging Report for Payables
get
Retrieve Aging Report for Invoices
get
Obtain Aging Report for Line Items
get
Service Settings
Check Service Status
get
Check Service Status
get
Payroll Settings
Retrieve Individual Payroll Settings
get
Modify Existing Payroll Settings
patch
Bulk Operations
Retrieve All Bulk Payable Batches
get
Initiate a New Bulk Payable Batch
post
Retrieve Details of a Specific Bulk Payable Batch
get
Modify a Specific Bulk Payable Batch
patch
Remove a Specific Bulk Payable Batch
del
Retrieve all items from a specific bulk payable batch
get
Add a new item to a specific bulk payable batch
post
Fetch the import summary for a specific bulk payable batch
get
Retrieve a Specific Item from a Bulk Payable Batch
get
Modify a Specific Item in a Bulk Payable Batch
patch
Retrieve All Bulk Invoice Batches
get
Initiate a New Bulk Invoice Batch
post
Retrieve details of a specific bulk invoice batch
get
Modify the details of a specific bulk invoice batch
patch
Fetch all items from a specific bulk invoice batch
get
Add a new item to a specific bulk invoice batch
post
Retrieve a specific item from a bulk invoice batch
get
Modify a specific item within a bulk invoice batch
patch
Fetch all bulk collaborator batches
get
Initiate a new bulk collaborator batch.
post
Retrieve Details of a Specific Collaborator Batch
get
Modify Details of a Bulk Collaborator Batch
patch
Remove a Specific Collaborator Batch
del
Retrieve all items from a specific collaborator batch
get
Append a new item to a specific collaborator batch
post
Retrieve details of a specific item from a collaborator batch
get
Modify the details of a specific item within a collaborator batch
patch
Retrieve all bulk client batches
get
Create a new bulk client batch
post
Fetch Details of a Specific Item from a Client Batch
get
Modify Details of a Specific Item in a Client Batch
patch
Retrieve All Items from a Client Batch
get
Add a New Item to a Client Batch
post
Fetch Details of a Specific Item from a Client Batch
get
Modify Details of a Specific Item in a Client Batch
patch
Retrieve All Bulk Payable Batches
get
Initiate a New Bulk Payable Batch
post
Retrieve Details of a Specific Bulk Payable Batch
get
Modify a Specific Bulk Payable Batch
patch
Remove a Specific Bulk Payable Batch
del
Retrieve all items from a specific bulk payable batch
get
Add a new item to a specific bulk payable batch
post
Fetch the import summary for a specific bulk payable batch
get
Retrieve a Specific Item from a Bulk Payable Batch
get
Modify a Specific Item in a Bulk Payable Batch
patch
Retrieve All Bulk Invoice Batches
get
Initiate a New Bulk Invoice Batch
post
Retrieve details of a specific bulk invoice batch
get
Modify the details of a specific bulk invoice batch
patch
Fetch all items from a specific bulk invoice batch
get
Add a new item to a specific bulk invoice batch
post
Retrieve a specific item from a bulk invoice batch
get
Modify a specific item within a bulk invoice batch
patch
Fetch all bulk collaborator batches
get
Initiate a new bulk collaborator batch.
post
Retrieve Details of a Specific Collaborator Batch
get
Modify Details of a Bulk Collaborator Batch
patch
Remove a Specific Collaborator Batch
del
Retrieve all items from a specific collaborator batch
get
Append a new item to a specific collaborator batch
post
Retrieve details of a specific item from a collaborator batch
get
Modify the details of a specific item within a collaborator batch
patch
Retrieve all bulk client batches
get
Create a new bulk client batch
post
Fetch Details of a Specific Item from a Client Batch
get
Modify Details of a Specific Item in a Client Batch
patch
Retrieve All Items from a Client Batch
get
Add a New Item to a Client Batch
post
Fetch Details of a Specific Item from a Client Batch
get
Modify Details of a Specific Item in a Client Batch
patch
Custom Field Management
Add a New Custom Field
post
Retrieve All Custom Fields
get
Fetch Details of a Specific Custom Field
get
Modify Details of a Specific Custom Field
patch
Remove a Specific Custom Field
del
Add a New Custom Field
post
Retrieve All Custom Fields
get
Fetch Details of a Specific Custom Field
get
Modify Details of a Specific Custom Field
patch
Remove a Specific Custom Field
del
Merchant Category Codes
Retrieve Merchant Category Codes (MCC)
get
Retrieve Merchant Category Codes (MCC)
get
1099 Operations
Determine 1099 Amounts for Collaborators
post
Request a new mailing of the 1099 form for a collaborator
post
Indicate a collaborator's 1099 form was returned undelivered
post
Retrieve all bulk calculation 1099 batches
get
Initialize a new batch for bulk calculation 1099
post
Retrieve specific details of a bulk calculation 1099 batch
get
Modify the details of a specific bulk calculation 1099 batch
patch
Retrieve all items from a calculation 1099 batch
get
Add a new item to a calculation 1099 batch
post
Fetch details of a specific item from a calculation 1099 batch
get
Revise the attributes of an item in a calculation 1099 batch
patch
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 Identity
post
Re-deliver a tax form by mail or electronic methods.
post
Submit or request a tax form correction.
post
Update recipient correction from payer side
patch
Reject a requested tax form correction.
post
Accepts and submits a pending tax form correction.
post
Downloads tax form submission PDF
post
Retrieve Form 1099 PDF for a Collaborator by Year and Index
get
Retrieve Form W9 PDF for a Collaborator
get
Determine 1099 Amounts for Collaborators
post
Request a new mailing of the 1099 form for a collaborator
post
Indicate a collaborator's 1099 form was returned undelivered
post
Retrieve all bulk calculation 1099 batches
get
Initialize a new batch for bulk calculation 1099
post
Retrieve specific details of a bulk calculation 1099 batch
get
Modify the details of a specific bulk calculation 1099 batch
patch
Retrieve all items from a calculation 1099 batch
get
Add a new item to a calculation 1099 batch
post
Fetch details of a specific item from a calculation 1099 batch
get
Revise the attributes of an item in a calculation 1099 batch
patch
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 Identity
post
Re-deliver a tax form by mail or electronic methods.
post
Submit or request a tax form correction.
post
Update recipient correction from payer side
patch
Reject a requested tax form correction.
post
Accepts and submits a pending tax form correction.
post
Downloads tax form submission PDF
post
Invoicing config
Get invoicing config configured by given client/payer
get
Get configured invoicing settings
get
Update invoicing config
patch
Get invoicing config configured by given client/payer
get
Get configured invoicing settings
get
Update invoicing config
patch
Payer Payee Management
Fetch a list of payers
get
Establish a new association between a payer and payee
post
Retrieve detailed information of a specific payer relationship
get
Update information of a specific payer
patch
Fetch a list of payees
get
Establish a new association between a payer and payee
post
Retrieve detailed information of a specific payee relationship
get
Update information of a specific payee
patch
Retrieve Form W9 PDF for a payee
get
Retrieve Form W9 PDF for a payee
get
Re-sends payee invite email to the payee if they have not registered yet
post
Preview the results of changing a payee's email
get
Update a payee's email address
post
Fetch entity history for a payee
get
Fetch a list of payers
get
Establish a new association between a payer and payee
post
Retrieve detailed information of a specific payer relationship
get
Update information of a specific payer
patch
Fetch a list of payees
get
Establish a new association between a payer and payee
post
Retrieve detailed information of a specific payee relationship
get
Update information of a specific payee
patch
Retrieve Form W9 PDF for a payee
get
Retrieve Form W9 PDF for a payee
get
Re-sends payee invite email to the payee if they have not registered yet
post
Preview the results of changing a payee's email
get
Update a payee's email address
post
Fetch entity history for a payee
get
Payer Engagements Management
Add new engagement for payer
post
Fetch a list of payer engagements
get
Get details of single payer engagement
get
Update information of a specific payer engagement
patch
Add new engagement for payer
post
Fetch a list of payer engagements
get
Get details of single payer engagement
get
Update information of a specific payer engagement
patch
Payee Engagements Management
Add new engagement for payee
post
Fetch a list of payee engagements
get
Get details of single payee engagement
get
Update information of a specific payee engagement
patch
Override an engagement's requirement status
patch
Add new engagement for payee
post
Fetch a list of payee engagements
get
Get details of single payee engagement
get
Update information of a specific payee engagement
patch
Override an engagement's requirement status
patch
Wingspan Wallet
Request a verification code for card authentication
post
Validate verification code to receive a token
patch
Request a verification code for card authentication
post
Validate verification code to receive a token
patch
Document Signing and Eligibility
Add a New Payment Eligibility Requirement
post
Retrieve All Payment Eligibility Requirements
get
Retrieve details of a specific Payment Eligibility Requirement
get
Modify a specific Payment Eligibility Requirement
patch
Remove a specific Payment Eligibility Requirement
del
Remove Eligibility Requirement from Collaborator Group
del
Modify Eligibility Requirement for Collaborator Group
patch
Retrieve Specific Collaborator Group Configuration
get
Modify Collaborator Group Configuration
patch
Add a New Payment Eligibility Requirement
post
Retrieve All Payment Eligibility Requirements
get
Retrieve details of a specific Payment Eligibility Requirement
get
Modify a specific Payment Eligibility Requirement
patch
Remove a specific Payment Eligibility Requirement
del
Remove Eligibility Requirement from Collaborator Group
del
Modify Eligibility Requirement for Collaborator Group
patch
Retrieve Specific Collaborator Group Configuration
get
Modify Collaborator Group Configuration
patch
Payment methods
Initiate Payment Card Create
post
List Payment Cards on the User Account
get
Complete Payment Card Create
post
Get Payment Card by ID
get
Remove Payment Card by ID
del
Initiate Single-Use Payment Card Create
post
Complete Payment Card Create
post
Initiate Payment Card Create
post
List Payment Cards on the User Account
get
Complete Payment Card Create
post
Get Payment Card by ID
get
Remove Payment Card by ID
del
Initiate Single-Use Payment Card Create
post
Complete Payment Card Create
post
Engagements
Create a new Engagement
post
List Engagements
get
Retrieve Engagement by ID
get
Update Engagement by ID
patch
Add Requirement To Engagement
post
Remove Requirement From Engagement
del
Migration from Collaborator Groups to Engagements
Create a new Engagement
post
List Engagements
get
Retrieve Engagement by ID
get
Update Engagement by ID
patch
Add Requirement To Engagement
post
Remove Requirement From Engagement
del
Requirements
List Requirements
get
Create a new Requirement
post
Retrieve Requirement by ID
get
Update Requirement by ID
patch
List Requirements
get
Create a new Requirement
post
Retrieve Requirement by ID
get
Update Requirement by ID
patch
Renew a Requirement by ID
post
Verification
Get Beneficiary Verification by accountId
post
Get Beneficiary Verification by accountId
post
Work Log Management
Convert a Work Log to an Invoice
post
Convert a Work Log to an Invoice
post
Deprecated
Retrieve detailed information of a specific member-client relationship
get
Update information of a specific member-client relationship
patch
Remove a specific member-client relationship from the system
del
Deprecated Retrieve Instant Payout Information
get
Deprecated Remove Instant Payout Configuration
del
Deprecated Set Up Instant Payout Configuration
post
Register New Custom Data for Collaborator-Member Relationship
post
Retrieve All Collaborator-Member Custom Data Points
get
Retrieve Specific Collaborator Custom Data
get
Modify a Specific Collaborator-Member Custom Data
patch
Erase a Specific Collaborator-Member Custom Data
del
Register a New Deduction for a Collaborator
post
Retrieve All Deductions for Collaborators
get
Retrieve Specific Deduction Details
get
Modify Details of a Specific Deduction
patch
Erase a Specific Deduction Entry
del
Retrieve Events Associated with a Collaborator
get
Retrieve Details of a Specific Collaborator
get
Modify Collaborator Details
patch
Remove a Specific Collaborator Record
del
Retrieve All Registered Collaborators
get
Register a New Collaborator
post
Associate Collaborator with a Specific Group
patch
Disassociate Collaborator from a Specific Group
patch
Retrieve Form 1099 PDF for a Collaborator by Year and Index
get
Retrieve Form W9 PDF for a Collaborator
get
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 Settings
get
Modify Existing Payroll Settings
patch
Wingspan Users API
User and Member Management
Health Check for User Service
get
Register a new user with pending status
post
Register a new user
post
Modify user account details using user ID
patch
Fetch user profile details using user ID
get
Register a New Subscription for Member
post
Retrieve Subscription Details by ID
get
Modify Subscription Details for Member
patch
Retrieve Advocate Information for the Specified Member
get
Initiate User Password Reset Process
post
Retrieve payment history for membership
get
Retrieve Client Details by ID
get
Register a New Client with Specific ID
post
Modify Existing Client Details by ID
patch
Retrieve User by Tag ID
get
Retrieve User by Email Address
get
Retrieve Public User Profile by ID
get
Retrieve User's Occupation Details
get
Retrieve User's Location
get
Health Check for User Service
get
Register a new user with pending status
post
Register a new user
post
Modify user account details using user ID
patch
Fetch user profile details using user ID
get
Register a New Subscription for Member
post
Retrieve Subscription Details by ID
get
Modify Subscription Details for Member
patch
Retrieve Advocate Information for the Specified Member
get
Initiate User Password Reset Process
post
Retrieve payment history for membership
get
Retrieve Client Details by ID
get
Register a New Client with Specific ID
post
Modify Existing Client Details by ID
patch
Retrieve User by Tag ID
get
Retrieve User by Email Address
get
Retrieve Public User Profile by ID
get
Retrieve User's Occupation Details
get
Retrieve User's Location
get
Session and Authentication
Initiate a new session with pending status
post
Initiate a New User Session
post
Initiate OTP/2FA Verification Process
post
Confirm OTP/2FA Verification
patch
Request to Sign-In on Behalf of Another User
post
Create a New API Session
post
Retrieve All API Sessions Created by the Current User
get
Modify a Specific API Session
patch
Fetch Details of a Specific API Session
get
Terminate a Specific API Session
del
Retrieve session details using token ID
get
Terminate a user session using token ID
del
Retrieve Subscription Grants for a Granted Subscriber
get
Authenticate using Google
post
Initiate verification for an existing email address
post
Initiate Email Verification Process for User
post
Confirm Email Verification Status
patch
Start Phone Verification Process for User
post
Validate Phone Verification Status
patch
Create a Single Sign-On (SSO) Session
post
Authenticate User Request
post
Initiate a new session with pending status
post
Initiate a New User Session
post
Initiate OTP/2FA Verification Process
post
Confirm OTP/2FA Verification
patch
Request to Sign-In on Behalf of Another User
post
Create a New API Session
post
Retrieve All API Sessions Created by the Current User
get
Modify a Specific API Session
patch
Fetch Details of a Specific API Session
get
Terminate a Specific API Session
del
Retrieve session details using token ID
get
Terminate a user session using token ID
del
Retrieve Subscription Grants for a Granted Subscriber
get
Authenticate using Google
post
Initiate verification for an existing email address
post
Initiate Email Verification Process for User
post
Confirm Email Verification Status
patch
Start Phone Verification Process for User
post
Validate Phone Verification Status
patch
Create a Single Sign-On (SSO) Session
post
Authenticate User Request
post
OAuth Authorization Endpoint
get
Process OAuth Authorization
post
OAuth Token Exchange
post
Revoke OAuth Token
post
OAuth Token Introspection
post
OAuth Server Metadata
get
JSON Web Key Set
get
Account and Banking Operations
Generate Plaid Link Token for Account Integration
post
Retrieve All Linked Bank Accounts
get
Add New Bank Account
post
Fetch Specific Bank Account Details
get
Unlink Bank Account
del
Modify Bank Account Details
patch
Verify an account for payments
post
Get missing user fields for account
get
Retrieve Account Numbers for Guests
post
Fetch Necessary Account Details
post
Fetch Available Payout Currencies for a Specific Country
post
Generate Plaid Link Token for Account Integration
post
Retrieve All Linked Bank Accounts
get
Add New Bank Account
post
Fetch Specific Bank Account Details
get
Unlink Bank Account
del
Modify Bank Account Details
patch
Verify an account for payments
post
Get missing user fields for account
get
Retrieve Account Numbers for Guests
post
Fetch Necessary Account Details
post
Fetch Available Payout Currencies for a Specific Country
post
Authorization and Permissions
Request User Authorization
post
Retrieve All User Authorizations
get
Retrieve all authorized scopes
get
Obtain all authorized scope-groups
get
Retrieve authorized scope-groups specific to a user
get
Obtain authorized scopes specific to a user
get
Retrieve Authorization Details by ID
get
Modify Existing Authorization Details
patch
Revoke and Remove Authorization Record
del
Retrieve Accounts Authorized by User
get
Retrieve Authentication Token for Flatfile
post
Request User Authorization
post
Retrieve All User Authorizations
get
Retrieve all authorized scopes
get
Obtain all authorized scope-groups
get
Retrieve authorized scope-groups specific to a user
get
Obtain authorized scopes specific to a user
get
Retrieve Authorization Details by ID
get
Modify Existing Authorization Details
patch
Revoke and Remove Authorization Record
del
Retrieve Accounts Authorized by User
get
Retrieve Authentication Token for Flatfile
post
Subscription Management
Retrieve Specific Nextgen Subscription Plan
get
Browse Available Nextgen Subscription Plans
get
Initiate a New Nextgen Subscription for a Member
post
Fetch All Nextgen Subscriptions for Member
get
Retrieve Details of a Specific Nextgen Subscription
get
Modify an Existing Nextgen Subscription for Member
patch
Revoke a Nextgen Subscription for Member
del
Retrieve Specific Nextgen Subscription Plan
get
Browse Available Nextgen Subscription Plans
get
Initiate a New Nextgen Subscription for a Member
post
Fetch All Nextgen Subscriptions for Member
get
Retrieve Details of a Specific Nextgen Subscription
get
Modify an Existing Nextgen Subscription for Member
patch
Revoke a Nextgen Subscription for Member
del
Activity and Usage Tracking
Retrieve All Activities of a Member
get
Log New Activity for Member
post
Retrieve Specific Activity Details for a Member
get
Modify Specific Activity Details for a Member
patch
Remove Specific Activity Record for a Member
del
Retrieve All Activities of a Member
get
Log New Activity for Member
post
Retrieve Specific Activity Details for a Member
get
Modify Specific Activity Details for a Member
patch
Remove Specific Activity Record for a Member
del
Organization Account Management
Register New User within Organization
post
Retrieve All Organization User Accounts
get
Retrieve Organization User Profile
get
Modify Organization User Profile
patch
Initiate Session for Organization User
get
Link a Child User to a Parent Organization Account
post
Modify the Association of Child User to Parent Organization
patch
Register New User within Organization
post
Retrieve All Organization User Accounts
get
Retrieve Organization User Profile
get
Modify Organization User Profile
patch
Initiate Session for Organization User
get
Link a Child User to a Parent Organization Account
post
Modify the Association of Child User to Parent Organization
patch
Subscription and Grants Management
New Subscription Grant
post
Fetch All Subscription Grants
get
Modify subscription grant details
patch
Retrieve subscription grant details by ID
get
Terminate a specific subscription grant by ID
del
Register a New Subscription for Member
post
Modify Subscription Details for Member
patch
Retrieve Subscription Details by ID
get
Remove Subscription for Member
del
New Subscription Grant
post
Fetch All Subscription Grants
get
Modify subscription grant details
patch
Retrieve subscription grant details by ID
get
Terminate a specific subscription grant by ID
del
Register a New Subscription for Member
post
Modify Subscription Details for Member
patch
Retrieve Subscription Details by ID
get
Remove Subscription for Member
del
Invitation
Fetch a invitation details for provided invitation token
get
Resend all user invitations
post
Fetch a invitation details for provided invitation token
get
Resend all user invitations
post
Customization
Fetch a customization details for a user
get
Update customization details for a user
patch
Fetch a customization details for a user
get
Fetch a customization details for a user
get
Update customization details for a user
patch
Fetch a customization details for a user
get
Identity Verification
Get identity verification request details
get
Start identity verification process
post
Get identity verification request details
get
Start identity verification process
post
Deprecated
DEPRECATEDgetSubscription
get
DEPRECATEDupdateSubscription
patch
DEPRECATEDdeleteSubscription
del
DEPRECATEDlist membership plans
get
DEPRECATEDget membership plan
get
DEPRECATED Get Payment Method
get
DEPRECATED create Payment Method
post
DEPRECATED Update Payment Method
patch
Wingspan Benefits API
Benefits Service
Retrieve Current Benefits Service Status
get
Modify Benefits Service Status
patch
Retrieve Current Benefits Service Status
get
Modify Benefits Service Status
patch
Benefits Enrollment
Retrieve Enrollment Details for a Specific Member
get
Get a particular plan enrollment by ID
get
List all plan enrollments
get
Retrieve Enrollment Details for a Specific Member
get
Get a particular plan enrollment by ID
get
Wingspan Files API
Public File Management
Upload Publicly Viewable File
post
Initialize Public File Creation
post
Retrieve List of Member's Public Files
get
Fetch Specific Public File Details
get
Update Member's Public File
patch
Remove Member's Public File
del
Retrieve Summary of a Specific Public File
get
Download a Specific Public File
get
Upload Publicly Viewable File
post
Initialize Public File Creation
post
Retrieve List of Member's Public Files
get
Fetch Specific Public File Details
get
Update Member's Public File
patch
Remove Member's Public File
del
Retrieve Summary of a Specific Public File
get
Download a Specific Public File
get
Private File Management
Upload a Private File
post
Generate Entry for a New Private File
post
Fetch a List of All Private Files for the Member
get
Retrieve Specific Private File Details
get
Modify Specific Private File's Metadata
patch
Remove a Specific Private File
del
Download a Member's Private File
get
Upload a Private File
post
Generate Entry for a New Private File
post
Fetch a List of All Private Files for the Member
get
Retrieve Specific Private File Details
get
Modify Specific Private File's Metadata
patch
Remove a Specific Private File
del
Download a Member's Private File
get
E-Signature Document Templates
Create a New E-signature Document Template
post
Retrieve All E-signature Document Templates
get
Retrieve Specific E-signature Document Template Details
get
Remove a Specific E-signature Document Template
del
Create a New E-signature Document Template
post
Retrieve All E-signature Document Templates
get
Retrieve Specific E-signature Document Template Details
get
Remove a Specific E-signature Document Template
del
Document Management for E-Signatures
Retrieve All Documents
get
Retrieve Specific Document Details
get
Obtain URLs for Document Signing
get
Retrieve E-Signed Documents as PDF
get
Retrieve All Documents
get
Retrieve Specific Document Details
get
Obtain URLs for Document Signing
get
Retrieve E-Signed Documents as PDF
get
Wingspan Bookkeeping API
Tax and Financial Reporting
Retrieve Estimated Tax Details for a Member
post
Obtain Profit and Loss Report for a Member
get
Retrieve a Specific Bookkeeping Report
get
Retrieve Estimated Tax Details for a Member
post
Obtain Profit and Loss Report for a Member
get
Retrieve a Specific Bookkeeping Report
get
Transaction Management
Fetch Transaction Subcategories Based on Wingspan Category
get
Retrieve All Member Transactions
get
Record a New Transaction
post
Retrieve Specific Transaction Details
get
Remove a Specific Transaction
del
Modify a Specific Transaction
patch
Fetch Income Insights for Catch-Up Transactions
get
Fetch Expense Insights for Catch-Up Transactions
get
Fetch Transaction Subcategories Based on Wingspan Category
get
Retrieve All Member Transactions
get
Record a New Transaction
post
Retrieve Specific Transaction Details
get
Remove a Specific Transaction
del
Modify a Specific Transaction
patch
Fetch Income Insights for Catch-Up Transactions
get
Fetch Expense Insights for Catch-Up Transactions
get
Retrieve All Withholding Transactions
get
Obtain Current Tax Withholding Balance
get
Service Management
Check Bookkeeping Service Status
get
Modify Bookkeeping Service Enablement Status
patch
Deactivate Bookkeeping Service for Member
del
Check Bookkeeping Service Status
get
Modify Bookkeeping Service Enablement Status
patch
Deactivate Bookkeeping Service for Member
del
Banking and Account Management
Retrieve Business Banking Account Information
get
Obtain Current Balance of Business Banking Account
get
Retrieve Details of a Specific Pending Banking Transaction
get
Modify a Specific Pending Banking Transaction
patch
Fetch All Pending Banking Transactions
get
Create a New Pending Banking Transaction
post
Retrieve Business Banking Account Information
get
Obtain Current Balance of Business Banking Account
get
Retrieve Details of a Specific Pending Banking Transaction
get
Modify a Specific Pending Banking Transaction
patch
Fetch All Pending Banking Transactions
get
Create a New Pending Banking Transaction
post
Withholding Transactions
Get Withholding Transaction
get
Retrieve Details of a Specific Pending Withholding Transaction
get
Modify Details of a Pending Withholding Transaction
patch
Retrieve All Pending Withholding Transactions
get
Start a New Withholding Transaction
post
Retrieve Pending Cashback Amount
get
Retrieve All Withholding Transactions
get
Obtain Current Tax Withholding Balance
get
Get Withholding Transaction
get
Retrieve Details of a Specific Pending Withholding Transaction
get
Modify Details of a Pending Withholding Transaction
patch
Retrieve All Pending Withholding Transactions
get
Start a New Withholding Transaction
post
Retrieve Pending Cashback Amount
get
Cashback Rewards Management
Retrieve Approved Cashback Amount
get
Redeem Available Cashback
post
Check User's Eligibility for Cashback Rewards
get
Retrieve Approved Cashback Amount
get
Redeem Available Cashback
post
Check User's Eligibility for Cashback Rewards
get
Deprecated
Wingspan Customer Data Onboarding API
Banking Accounts
List Internal Account Statements
get
Retrieve Internal Account Statement
get
List Internal Accounts
get
Create Internal Account
post
Retrieve Internal Account
get
Retrieve Internal Account Balance
get
List Internal Account Statements
get
Retrieve Internal Account Statement
get
List Internal Accounts
get
Create Internal Account
post
Retrieve Internal Account
get
Retrieve Internal Account Balance
get
Banking Transactions
List transactions for a specific internal account
get
Create Internal Account Transfer
post
Create Internal Account Transfer
post
List transactions for a specific internal account
get
Payment Cards
List Payment Cards
get
Create Payment Card
post
Retrieve Payment Card
get
Activate Payment Card
post
Set Card PIN
post
Get Card Embed URL
get
Get Card Limits
get
Set Card Limits
post
Cancel Payment Card
post
Suspend Payment Card
post
List Payment Cards
get
Create Payment Card
post
Retrieve Payment Card
get
Activate Payment Card
post
Set Card PIN
post
Get Card Embed URL
get
Get Card Limits
get
Set Card Limits
post
Cancel Payment Card
post
Suspend Payment Card
post
Payouts
Get list of payouts
get
Get details of a particular payout
get
Get currency exchange rate
post
Get list of payouts
get
Get details of a particular payout
get
Get currency exchange rate
post
Verifications
Get verification levels for a customer
get
Perform a verification for a specific level
post
Lists missing fields or documents for a specific verification level
get
Customer Entity
Get current customer entity
get
Creates a new customer entity
post
Update customer data
patch
Request a material or immaterial change to the customer entity
post
Acknowledgements
Acknowledge an agreement or policy
post
Get acknowledgement details
get
Insurance Coverage
List insurance policies and Master Policy enrollments
get
Get insurance policy details
get
Insurance Coverage Monitor
Get insurance coverage monitor
get
Set coverage on insurance coverage monitor
patch
Download insurance coverage file
get
Insurance Coverage Monitor Settings
Create insurance coverage monitor settings
post
Get insurance coverage monitor settings
get
Insurance Import
Create insurance import
post
Get insurance import
get
Update insurance import
patch
Submit insurance import
post
Plan Enrollment
List plan enrollments
get
Enroll in a plan
post
Get a plan enrollment
get
Cancel a plan enrollment
post
Withdraw a plan enrollment cancellation
post
Resource-Event-History
List resource events
get
Revenue
Get all custom prices for the authenticated customer
get
Get specific price for the authenticated customer and SKU
get
User Onboarding
Verifications
Get verification levels for a customer
get
Perform a verification for a specific level
post
Lists missing fields or documents for a specific verification level
get
Customer Entity
Get current customer entity
get
Creates a new customer entity
post
Update customer data
patch
Request a material or immaterial change to the customer entity
post
Acknowledgements
Acknowledge an agreement or policy
post
Get acknowledgement details
get
Powered by
Payer Payee Management
Ask AI
