Create Batch

post

https://api-sandbox.paymentlabs.io/batches

Create a Batch, used to group payments

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Information to create a Batch

name

string

required

An easily identifiable label for both the payor and payee - e.g. Weekly Pay-Run, Weekend Tournament, etc.

referenceId

string

A unique identifier to cross reference between systems, this unique identifier should reference the payment grouping in your system

defaultPaymentCategory

string

enum

required

The default payment category to associate to payments being added to the batch. There may be tax implications depending on the value of the taxation jurisdiction and the payment category.

archived

boolean

A flag determining if this batch is archived

taxJurisdiction

string

enum

Tax rules to apply to each payment

Required if the you have multiple tax rules
validated against what jurisdictions are turned on for you

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Batch has been created

401Unauthorized response, when the user is not authenticated or the authentication token is missing in the header.

403 Forbidden response, when the user is authenticated but does not have the necessary permissions.