EQequalsmoney
Payment Batches

Validates a payment batch

Validates a payment batch.

get/payment-batches/{paymentBatchId}/validate

Request

Path parameters

paymentBatchIdstring uuid required

The unique ID of the Payment Batch.

Query parameters

accountIdstring required

The ID of the account to work with.

Example:F50091

Response

OK

isValidboolean required

Example response

{
  "isValid": true,
  "paymentBatchStatus": {
    "isValid": true,
    "issues": [
      {
        "code": "string",
        "message": "string",
        "data": {
          "status": "draft"
        }
      }
    ]
  },
  "ordersBalances": {
    "isValid": true,
    "issues": [
      {
        "code": "string",
        "message": "string",
        "data": {
          "orderId": "string",
          "budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
          "currencyCode": "USD",
          "availableBalance": "string"
        }
      }
    ]
  }
}

Changes

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