Pause Bulk Transactions

Once you have uploaded a file of transactions, you can pause the upload to continue later.

The API endpoint is as follows:

POST /api/v2/bulk_transactions/:bulk_key:/pause

Request

curl -X POST https://secure.newtekgateway.com/api/v2/bulk_transactions/intn1h9ksrg8c4yrr/pause
-H "Authorization: Basic aGswTmVoV1lYbzdWbXd4MFM3OWJmMTdrMmJvVzJqVDc6czIvYTI2OTkzMjNhNGZlOWRhZjZkNWUzNTY2ODA5NDUyNTkvZjkxOGU3MTI0NmQyMjgyNmQ4ZTYwYjg1ZDdjMjM0NGY1ZGMwNWI1ODU5YWQ2NjEwOWM4Mzg0ZDE5ZjFiNWU4Yg=="

This cURL request is an example of pausing a group of bulk transactions.

Response

{
    "status": "success"
}

This is the sample response object sent back from the server.

Parameters

Request Parameters

Parameter Type Description
bulk_key string Unique identifier for group of transactions generated by gateway. You can also use current reference the group of transactions that is currently processing.

Response Parameters

Parameter Type Description
status string If the bulk transaction has been paused successfully then status will be returned as success. If not successful, an error will be returned.

Resume Bulk Transactions

This page will show you how to how to resume processing a group of bulk transactions after they were paused.

The API endpoint is as follows:

POST /api/v2/bulk_transactions/:bulk_key:/resume

Request

curl -X POST https://secure.newtekgateway.com/api/v2/bulk_transactions/intn1h9ksrg8c4yrr/resume
-H "Authorization: Basic aGswTmVoV1lYbzdWbXd4MFM3OWJmMTdrMmJvVzJqVDc6czIvYTI2OTkzMjNhNGZlOWRhZjZkNWUzNTY2ODA5NDUyNTkvZjkxOGU3MTI0NmQyMjgyNmQ4ZTYwYjg1ZDdjMjM0NGY1ZGMwNWI1ODU5YWQ2NjEwOWM4Mzg0ZDE5ZjFiNWU4Yg=="

This cURL request is an example of resuming a group of bulk transactions.

Response

{
    "status": "success"
}

This is the sample response object sent back from the server.

Parameters

Request Parameters

Parameter Type Description
bulk_key string Unique identifier for group of transactions generated by gateway.

Response Parameters

Parameter Type Description
status string If the bulk transaction have resumed successfully then status will be returned as success. If not successful, an error will be returned.

Change Log

Date Change
2017-09-04 Added page with code examples.

Click here for the full REST API change log.