Update a payment batch beta

Updates attributes of a payment batch.

SecurityCommonAuth
Request
path Parameters
paymentBatchId
required
string <uuid> <= 36 characters

The unique ID of the Payment Batch.

query Parameters
accountId
required
string

The ID of the account to work with.

Example: accountId=F50091
Request Body schema: application/json

Body

name
string [ 1 .. 256 ] characters

The name of the Payment Batch.

visible
boolean

Whether the payment batch is visible to other API users

Responses
200

OK

patch/payment-batches/{paymentBatchId}
Request samples
application/json
{
  • "name": "string",
  • "visible": true
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "accountId": "string",
  • "name": "string",
  • "createdBy": {
    },
  • "product": {
    },
  • "status": "draft",
  • "visible": true,
  • "visibleAt": "2019-08-24T14:15:22Z",
  • "confirmedBy": {
    },
  • "confirmedAt": "2019-08-24T14:15:22Z",
  • "passedMfaCheckAt": "2019-08-24T14:15:22Z",
  • "riskCheckedAt": "2019-08-24T14:15:22Z",
  • "ordersSentAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "alerts": [
    ],
  • "ordersSummary": {
    },
  • "input": {
    }
}