Batch Applications Overview
Partners can batch their queries with merchant reference number. Further, Paysafe would supply Batch ID for the given Merchant Reference Number.
- A batch request is a single API call that uploads a large number of Onboarding app queries at once
- Merchants can use the merchant reference number to batch their requests. Paysafe would also provide a Batch ID for the specified Merchant Reference Number if the batch was successfully submitted
- Once the batch has been approved, individual applications will be processed
Prerequisites
- Partner should have been onboarded
- Partner should request the API Key to authenticate the API calls. Accessible in the partner portal.
- Access to Applications API version should have been granted
- Partner should operate in the US
How to use Batch Applications
Following the process to use the API and launch the partner's merchant onboarding is listed
API to use:
API Request | Used To | Endpoint Pattern |
---|---|---|
Submit Application Batch | Partner can submit the batch request of applications | |
Get Application Batch by Id | Merchant can identify the transaction by submitting the batchid | |
Get Application Batch by Merchant Reference Number | Merchant can identify the transaction by submitting the merchantRefNumber |
Advantages
- Using the Batch Applications, user can submit multiple merchant applications within a single request. This will reduce the painful process of creating and referring multiple applications.
- Request for multiple Merchant Legal Entity (MLE) will be part of 1 batch request
- Request for multiple Locations for each MLE will be part of 1 batch request
- Request to configure multiple bank accounts for each MLE will be part of 1 batch request
- End to end automated underwriting is supported
- Automated account provisioning for the approved applications is supported
- API responses and Webhooks are triggered for errors occurred during application processing
Technical Details
- Refer Application Batch Operations for detailed list of available api's
Request Attributes
- The following tables include the mandatory and optional parameters to create Batch Application request. For a detailed description of the attributes listed in these tables, please refer to the Application Batch Object
Constraints
- All applications in bath request must be using single valid config id