Overview
- The Share A Refund Merchant API lets you manage account-level details and preferences for individual shippers. You can develop applications that integrate with Share A Refund to configure merchant settings, update contact information, and align system behavior with specific business requirements.
- View Doc →
- The following figure shows the relationship between your Share A Refund app, the Share A Refund API, and Merchant services.
Share A Refund App
Share A Refund’s merchant services give users a central location to maintain profile data to ensure that communication, billing, and operational settings reflect the current state of the business.
Share A Refund API
The REST API that allows users to retrieve profile details, update addresses, and modify account configurations from within your app.
Profile Management
A system that stores essential identity information, such as company name, tax ID, and primary contact details.
Account Configuration
A mechanism that controls global settings and preferences that allows customization of how the platform handles data and services for the specific merchant.
What can users do with the Share A Refund Merchant API?
Users can use the Share A Refund Merchant API to perform common workflows, such as:
- Retrieve current merchant profile details
- Update business address and contact information
- Configure notification preferences
- Manage associated payment methods
- View account status and subscription tier
- Link multiple sub-accounts for consolidated reporting
Merchant properties available to create, modify, update and delete through the Share A Refund Merchant API:
- Account Settings
- Business Profiles
- Contact Information
- Preferences
- Subscriptions
Additional info
- Learn more about developing with Share A Refund Merchant API, including handling authentication, authorization, reference the Develop on Share A Refund API for your workspace.
- More →
- Learn more about how to launch and run a Share A Refund Merchant API app, read the Developer Getting Started Guide.
- More →
