v1

latestOpenAPI 3.1.0UNLICENSED2026-07-2613101.1 MB

Payment Batches

Create a payment batch

Creates a new payment batch.

post/payment-batches

Query parameters

accountIdstring required

The ID of the account to work with.

Example:F50091

Request body

namestring

The name of the Payment Batch, if one is not provided then a default name will be generated.

visibleboolean

Whether the payment batch is visible to other API users

Example request

{
  "name": "string",
  "visible": true,
  "payments": {
    "defaultFundingBudgetId": "771967a7-f0f7-4137-a6bf-494452ba6549",
    "rows": [
      {
        "amount": "string",
        "currencyCode": "USD",
        "fundingBudgetId": "6ee672f6-226f-4a72-8592-0f8dc5284ab1",
        "purposeCode": "string",
        "purpose": "string",
        "reference": "Invoice INV-12345 for Q1 consulting services",
        "externalId": "string",
        "recipient": {
          "id": "string",
          "defaultReference": "string",
          "type": "individual",
          "name": "string",
          "displayName": "string",
          "subscribedEmails": [
            {
              "name": "string",
              "email": "user@example.com"
            }
          ],
          "accountIdentifier": "string",
          "bankIdentifier": "string",
          "secondaryBankIdentifier": "string",
          "intermediaryBankIdentifier": "string",
          "paymentNetwork": "SWIFT",
          "address": {
            "addressType": "ADDR",
            "streetName": "string",
            "buildingNumber": "string",
            "buildingName": "string",
            "postcode": "string",
            "city": "string",
            "region": "string",
            "countryCode": "GB"
          },
          "bankAddress": {
            "countryCode": "GB"
          }
        }
      }
    ]
  }
}

Response

Created

idstring uuid required

The unique ID of the Payment Batch.

accountIdstring required

The ID of the account the Payment Batch belongs.

namestring nullable required

The name of the Payment Batch.

The status of the Payment Batch.

visibleboolean nullable required

Whether the payment batch is visible to other API users

visibleAtstring date-time nullable required

Timestamp indicating when the payment batch was made visible. UTC.

confirmedAtstring date-time nullable required

Timestamp indicating when the payment batch was confirmed. UTC.

passedMfaCheckAtstring date-time nullable required

Timestamp indicating when the payment batch passed MFA check. UTC.

riskCheckedAtstring date-time nullable required

Timestamp indicating when the payment batch was risk checked. UTC.

ordersSentAtstring date-time nullable required

Timestamp indicating when the orders were sent. UTC.

createdAtstring date-time required

Timestamp indicating when the payment batch was created. UTC.

updatedAtstring date-time required

Timestamp indicating when the payment batch was updated. UTC.

Example response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "accountId": "string",
  "name": "string",
  "createdBy": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "type": "person"
  },
  "product": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "status": "draft",
  "visible": true,
  "visibleAt": "2019-08-24T14:15:22Z",
  "confirmedBy": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "type": "person"
  },
  "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": [
    {
      "timestamp": "2019-08-24T14:15:22Z",
      "type": "Error",
      "code": "string",
      "message": "string"
    }
  ],
  "ordersSummary": {
    "numberOfOrders": 0,
    "uniqueCurrencyCodes": [
      "USD"
    ]
  },
  "input": {
    "format": "json",
    "status": "accepted",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}