Generate CPA-005 Batch File

This request generates a batch file from a CPA-005 payment processor.

   Click here to learn more about this request

This request manually generates a CPA-005 batch file. Note the following when using this request:

CPA-005 batch files are automatically generated each day at the cutoff time specified by the processor's configuration. If you would like to generate a batch file before the cutoff time, this request will manually create one.

CPA-005 batch files include all transactions between the last cutoff time and the time of your request.

If you receive a 425 response, there were no transactions in the 'Pending' status for the selected processor.

For information regarding how creating batch files work within the UI, take a look at our CPA-005 Payment Processors article.

{
  "processor": 589
}

Results

Returns a response and the batch uuid after a successful CPA-005 batch file generation. An error results in a message indicating the type of error (e.g. no pending transactions).

Body Params
int32

This is the processor's Secure Payments ID.
> This field determines which processor is used to create a batch file.
> Secure Payments and the Loan Management System both create an ID for each processor. Make sure to use the Secure Payments ID here.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json