Upload payments beta

Uploads payments to an existing payment batch.

SecurityCommonAuth
Request
path Parameters
paymentBatchId
required
string <uuid> <= 36 characters

The unique ID of the Payment Batch.

query Parameters
accountId
required
string

The ID of the account to work with.

Example: accountId=F50091
header Parameters
content-type
required
string

Format for the payments upload.

Request Body schema: application/json

Body

One of:
defaultFundingBudgetId
required
string <uuid> <= 36 characters

The ID of the budget that will fund each payment if one isn't specified per payment

required
Array of objects

Array of all the payments with optional fundingBudgetId.

Responses
202

Accepted

post/payment-batches/{paymentBatchId}/payments
Request samples
application/json
{
  • "paymentsFile": null,
  • "defaultFundingBudgetId": "771967a7-f0f7-4137-a6bf-494452ba6549",
  • "rows": [
    ]
}
Response samples
application/json
{
  • "format": "json",
  • "status": "accepted",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}