Create a payment batch beta

Creates a new payment batch.

SecurityCommonAuth
Request
query Parameters
accountId
required
string

The ID of the account to work with.

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

Body

name
string <= 256 characters

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

visible
boolean

Whether the payment batch is visible to other API users

object
Responses
201

Created

202

Accepted

post/payment-batches
Request samples
application/json
{
  • "name": "string",
  • "visible": true,
  • "payments": {
    }
}
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": {
    }
}