EQequalsmoney
Payment Batches

Upload payments

Uploads payments to an existing payment batch.

post/payment-batches/{paymentBatchId}/payments

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

Headers

content-typestring required

Format for the payments upload.

Request body

OR

Example request

{
  "rows": [
    {
      "currencyCode": "USD",
      "reference": "Invoice INV-12345 for Q1 consulting services",
      "recipient": {
        "address": {
          "countryCode": "GB"
        },
        "bankAddress": {
          "countryCode": "GB"
        }
      }
    }
  ]
}

Response

Accepted

format'json' | 'csv' required

The format that the payments were uploaded in.

status'accepted' | 'uploaded' | 'validated' | 'failed' required

The status of the upload

createdAtstring date-time required

The date the Resource was initially created. ISO 8601 format without milliseconds.

updatedAtstring date-time required

The date the Resource was last modified. ISO 8601 format without milliseconds.

Example response

{
  "format": "json",
  "status": "accepted",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Changes

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