Validates a payment batch - Equals Documentation

GET

payment-batches

{paymentBatchId}

validate

cURL

curl --request GET \
  --url 'https://api.equalsmoney.com/v2/payment-batches/{paymentBatchId}/validate?accountId={{accountId}}' \
  --header 'Authorization: <api-key>'

{
  "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"
        }
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Path Parameters

paymentBatchId

string<uuid>

required

The unique ID of the Payment Batch.

Maximum string length: 36

Query Parameters

accountId

string

required

The ID of the account to work with.

Example:

"F50091"

Response

200 - application/json

isValid

boolean

required

paymentBatchStatus

object

required

Show child attributes

ordersBalances

object

required

Show child attributes

⌘I

cURL

curl --request GET \
  --url 'https://api.equalsmoney.com/v2/payment-batches/{paymentBatchId}/validate?accountId={{accountId}}' \
  --header 'Authorization: <api-key>'

{
  "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"
        }
      }
    ]
  }
}