Payment Batches

Update a payment batch

Replaces the batch's name and funding method. Send both: the batch is updated whole. Requires the PAYMENT_BATCH.UPDATE key permission.

patch/api/v1/payment-batch/{batchId}

Request

Request body

namestring required

A label for the batch.

Example request

{
  "sourcePaymentMethod": {
    "currencyCode": "USD"
  }
}

Response

The updated batch

Example response

{
  "data": {
    "sourcePaymentMethod": {
      "currencyCode": "USD"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.