Patch Batch

patch

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

Changes a batch's name, reference ID, default category, payout rules, or archived state.

Requires the Write permission. Send only the fields to change. taxJurisdiction cannot be changed.

Archiving. An archived batch refuses new payments, submissions and any other change. To change it again, first send
{"archived": false}. A payment that comes back (RETURNED) unarchives its batch automatically.

Side effects. name, archived, allowedPaymentMethods and deniedCountries are copied to the batch's payments in the
background; see deniedCountries for the effect on payments not yet sent. With updateExistingPayments: true, a new
defaultPaymentCategory is applied to the batch's DRAFT payments. The batch-changed webhook fires.

Errors

400 VALIDATION_ERROR: a field is invalid, or the body has a field that cannot be changed, such as taxJurisdiction.
404 NOT_FOUND: the batch does not exist.
423 NOT_EDITABLE: the batch is archived and the body does not set archived to false.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

batchId

string

required

ID of the batch, as returned by Create Batch.

Body Params

Body of Patch Batch. Send only the fields you want to change.

name

string

New name. Payments already in the batch keep the message they were created with.

referenceId

string

Your own identifier for the batch. Free text, not unique.

defaultPaymentCategory

string

enum

New default category for payments created from now on. Send updateExistingPayments: true to also apply it to the batch's DRAFT payments.

updateExistingPayments

boolean

With defaultPaymentCategory, also change the category of every DRAFT payment in the batch.

archived

boolean

true archives the batch; false unarchives it. An archived batch accepts no other change until it is unarchived.

allowedPaymentMethods

array of objects

Payout methods the batch's payees may receive its payments on. Applied to the batch's payments too.

allowedPaymentMethods

deniedCountries

array of strings

Countries the batch must not pay into, as ISO 3166-1 alpha-2 codes. The list replaces the previous one. Payments not yet sent
whose payee lives in a listed country become RESTRICTED; payments no longer covered by the list leave RESTRICTED.

deniedCountries

Responses

204

The operation succeeded. The response has no body.

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

404The resource does not exist in your account.

422The request body is not valid JSON, or is not a JSON object. Send Content-Type: application/json with a JSON object body.

423The resource is in a state that does not allow this change, for example a payment that has already been submitted or a batch that has been archived. Read the resource again to see its current state.