PaymentInstructionFile

  • createdAt
    Type: stringFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • createdBy
    Type: object
    required
    Properties: 2
  • currency
    enum
    const:  
    GBP
    required
  • format
    const:  
    csv
    required
  • formatVersion
    Type: string
    required
  • id
    Type: string
    min length:  
    1
    max length:  
    200
    required
  • paymentCount
    Type: integer
    min:  
    1
    required

    Integer numbers.

  • paymentDate
    Type: stringFormat: date
    required

    full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

  • payRunId
    Type: string
    min length:  
    1
    max length:  
    200
    required
  • status
    Type: stringenum
    required

    File generation status. It is not bank acceptance, payment or settlement status.

    values
    queuedrunningavailablefailed
  • totalPence
    Type: integer
    min:  
    0
    max:  
    999999999999
    required

    Amount in pence. Inputs cannot be negative.

  • completedAt
    Type: stringFormat: date-time

    When generation completed or failed. Omitted while the file is queued or running.

  • download
    Type: object

    Send an unauthenticated GET request to the URL as supplied. Do not add the Partner API bearer token. Available Payslips use application/pdf; Payment Instruction Files and exports use text/csv; charset=utf-8. Downloads include a Content-Disposition: attachment filename. Treat the URL as sensitive and do not log or share it. After it expires, retrieve the output resource again to receive a fresh link.

    Properties: 2
  • issues
    Type: array of object

    Problems affecting file generation. Present when status is failed.

    Properties: 9