Patch Batch

patch

https://api-sandbox.paymentlabs.io/batches/{batchId}

Edits the properties of a batch

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

batchId

string

required

Body Params

name

string

An easily identifiable label for both the payor and payee - e.g. Weekly Pay-Run, Weekend Tournament, etc.
Changing this field will not retroactively affect the payments' description in the batch

referenceId

string

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

defaultPaymentCategory

string

enum

The type of payment

!note: Don't forget to update the CSV/XLSX templates for import

archived

boolean

A flag determining if this batch is archived

Responses

204

The changes have been done

404

The batch could not be found

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

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.

423 The record is in an state that cannot be edited, check the message and code for more information on why the record cannot be edited. e.g,: When a payment has already been paid, it's value cannot be changed.