Step 2: Create Bulk Payment Request
You can pass up to 5000 payment requests per Bulk API request using this API request. Please view payment request fields to see valid column names and what data is expected by the API.
You will receive a response immediately after submitting the request which will indicate whether the job has been accepted for processing. The links and results will be returned after the job is completed to the notification endpoint specified in the originating request.
Url | secure/bulkpaymentrequests/create | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method | POST | ||||||||||||||||
Headers | See common headers | ||||||||||||||||
URL Params | N/A | ||||||||||||||||
Data Params |
|
||||||||||||||||
Response Object |
|
||||||||||||||||
Request Example |
|
||||||||||||||||
Response Example (Successful) |
|
||||||||||||||||
Response Example (Unsuccessful) |
|
Request Validation
Once bulk payment request has been received, the system will carry out an initial high-level validation before creating a job for processing. Examples of checks that will be performed in the request validation include:
- A valid absolute notification url was specified
- Compressed data can be decompressed using GZIP
- Decompressed data is valid json
- Json data can be serialised into a request fields array
Updated 11 months ago