Finish Import

Creates the payments of an import in its batch. The payments are created in the background.

Call it when the import is ready or processed_with_errors. errorHandling decides what happens to invalid rows:

  • allOrNone: create the payments only if every row is valid. An import with invalid rows is refused with 400.
  • importValid: create a payment for each valid row and skip the invalid ones.

The import moves to finishing, then finished when every payment exists; poll Get Import. The payments are DRAFT and are
not sent: submit them with Submit Batch, Submit Payments or Submit Payment.

Requires the Write permission.

Errors

  • 400: errorHandling is allOrNone and the import has invalid rows. Fix the file and import it again, or finish with importValid.
  • 400 VALIDATION_ERROR: errorHandling is missing or invalid.
  • 404 NOT_FOUND: the batch or the import does not exist.
  • 423: the import is not ready or processed_with_errors, or the batch does not accept payments.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the batch, as returned by Create Batch.

string
required

ID of the import, as returned by Create Import.

Body Params

Body of Finish Import.

string
enum
required

What to do with invalid rows: allOrNone refuses the import if any row is invalid; importValid creates payments for the valid rows and skips the rest.

Allowed:
Responses
202

The payments are being created. Poll Get Import until status is finished.

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