# Payment Run Update

Notification that the status of a Payment Run has been updated.

Endpoint: POST paymentRunWatch
Version: v1
Security: 

## Header parameters:

  - `call-ref` (string)
    A call reference generated by the caller and unique to the caller
to provide correlation between the caller and system with a maximum length
of 255

  - `published-timestamp` (integer, required)
    The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.

  - `signature` (string, required)
    The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the published-timestamp using your API key.

  - `signature-v2` (string, required)
    The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the call-ref header, the request body, and the published-timestamp header, all concatenated without spaces, and signed using your API key.

## Request fields (application/json):

  - `type` (string)
    Enum: "paymentRunWatch"

  - `payload` (object)

  - `payload.paymentRunRef` (string)
    A unique identifier by which you identify the payment run with on your system.
    Example: "94fddfb2-297d-423d-9157-4200b7beb834"

  - `payload.tag` (string)
    The tag field is a custom field that can be used to search and filter.

  - `payload.description` (string)
    The long form description of the payment run
    Example: "September payment run 01"

  - `payload.statusReason` (string)

  - `payload.payments` (array, required)

  - `payload.payments.externalRef` (string)
    The unique identifier by which you identify the associated payable on your system.
    Example: "c99cd66c-82fc-4a01-977b-61a2f5a247a1"

  - `payload.payments.paymentRef` (string)
    The unique identifier by which you identify this payment on your system.
    Example: "c99cd66c-82fc-4a01-977b-61a2f5a247a1"

  - `payload.payments.paymentAmount` (object, required)
    The currency and amount to be paid to the supplier.

  - `payload.payments.paymentAmount.currency` (string, required)
    The currency expressed in ISO-4217 code.
    Enum: "GBP", "EUR"

  - `payload.payments.paymentAmount.amount` (integer, required)
    The monetary amount, scaled to the lowest denomination of the currency.

Example, an amount of 1000 for a GBP currency is actually 1000 pennies or GBP 10.00.
    Example: 454321

  - `payload.payments.reference` (string, required)
    The long form description of the payment. This information is also shared with the supplier. The allowed length is dependent on the payment type:
SEPA and SWIFT <= 35 characters
Faster Payments <= 18 characters

  - `payload.payments.supplier` (object, required)
    Represent the supplier bank account typically used in Outgoing Wire Transfer transactions.

  - `payload.payments.supplier.name` (string, required)
    The supplier name. The allowed length and pattern is dependent on the bankAccountDetails type:
 with SepaBankDetails: >= 1 character and = 1 character and ;{@\r\n]$
(please note that the ’` symbol is the unicode value U+2019 (right single quotation mark) and not the unicode value U+0027 (apostrophe))

  - `payload.payments.supplier.address` (string)
    The supplier's address.

  - `payload.payments.supplier.bankName` (string)
    The supplier's bank name.

  - `payload.payments.supplier.bankAddress` (string)
    The supplier's bank address.

  - `payload.payments.supplier.bankCountry` (string)
    The supplier's bank country in ISO 3166 alpha-2 format.

  - `payload.payments.supplier.type` (string)
    The type of supplier account. Required only when FasterPaymentsBankDetails are specified.
    Enum: "PERSONAL", "BUSINESS"

  - `payload.payments.supplier.bankAccountDetails` (any, required)
    Details of the supplier bank account, depending on the type of transfer chosen.

  - `payload.payments.validationOutcomes` (array)

  - `payload.payments.validationOutcomes.category` (string)
    Enum: "UK_CONFIRMATION_OF_PAYEE"

  - `payload.payments.validationOutcomes.categoryResult` (object)

  - `payload.payments.validationOutcomes.categoryResult.match` (string)
    The result of matching performed by the UK Confirmation of Payee responder
    Enum: "EXACT_MATCH", "CLOSE_MATCH", "NO_MATCH"

  - `payload.payments.validationOutcomes.categoryResult.reasonCode` (string)
    The reason why the matching failed at the UK Confirmation of Payee responder:

  - ANNM: The CoP responder confirms that the account name provided does not match;
  - MBAM: The CoP responder indicates that the account name provided closely matches the actual account in its records, the actual account name is returned in the accountName field;
  - BANM: The account type that the user specified is 'PERSONAL', but the CoP responder indicates that the actual account matching the name provided is actually BUSINESS;
  - PANM: The account type that the user specified is 'BUSINESS', but the CoP responder indicates that the actual account matching the name provided is actually PERSONAL;
  - BAMM: The account type that the user specified is 'PERSONAL', but the CoP responder indicates that an account closely matching the name provided is BUSINESS;
  - PAMM: The account type that the user specified is 'BUSINESS', but the CoP responder indicates that an account closely matching the name provided is PERSONAL;
  - AC01: The account does not exist in the CoP responders books, the accountNumber specified is likely incorrect; 
  - IVCR: The CoP responder was unable to locate an account based on the secondaryReference field;
  - ACNS: The account is not supported for CoP by the CoP responder;
  - OPTO: The owner of the account has opted out of CoP service by the CoP responder;
  - CASS: The account has been switched using the Current Account Switch Service;
  - SCNS: The sortCode provided is not supported at endpoint;
    Enum: "ANNM", "MBAM", "BANM", "PANM", "BAMM", "PAMM", "AC01", "IVCR", "ACNS", "OPTO", "CASS", "SCNS"

  - `payload.payments.validationOutcomes.categoryResult.accountName` (string)
    Returned when there is match is a CLOSE_MATCH and the reasonCode is MBAM, BAMM or PAMM


## Response 200 fields