Batch Applications
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
Follow the process to use the API and launch the partner's merchant onboarding.
| API Request | Used To | Endpoint Pattern |
|---|---|---|
| Create Batch Applications | Partner can submit the batch request of applications | POST/merchant/v1/applicationbatches |
| Get Batch Application by Batch Id | Merchant can identify the transaction by submitting the batchid | GET/merchant/v1/applicationbatches/{batchid} |
| Get Batch Application by Merchant Reference Number | Merchant can identify the transaction by submitting the merchantRefNumber | GET/merchant/v1/applicationbatches?merchantRefNum=976559030 |
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
Request Attributes
- For a detailed description of the mandatory and optional parameters needed to create a Batch Application request, refer to the API Reference.
Constraints
- All applications in a batch request must use a single valid config id.