title: TransfersPostRequest
type: object
description: The object sent in the POST /transfers request.
properties:
  transferId:
    type: string
    description: >-
      The common ID between the FSPs and the optional Switch for the transfer
      object, decided by the Payer FSP. The ID should be reused for resends of
      the same transfer. A new ID should be generated for each new transfer.
    example: b51ec534-ee48-4575-b6a9-ead2955b8069
  payeeFsp:
    type: string
    description: Payee FSP in the proposed financial transaction.
    example: 1234
  payerFsp:
    type: string
    description: Payer FSP in the proposed financial transaction.
    example: 5678
  amount:
    $ref: ./Money.yaml
    description: The transfer amount to be sent.
  ilpPacket:
    type: string
    description: >-
      The ILP Packet containing the amount delivered to the Payee and the ILP
      Address of the Payee and any other end-to-end data.
    example: >-
      AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
  condition:
    type: string
    description: The condition that must be fulfilled to commit the transfer.
    example: f5sqb7tBTWPd5Y8BDFdMm9BJR_MNI4isf8p8n4D5pHA
  expiration:
    type: string
    description: >-
      Expiration can be set to get a quick failure expiration of the transfer.
      The transfer should be rolled back if no fulfilment is delivered before
      this time.
    example: '2016-05-24T08:38:08.699-04:00'
  extensionList:
    $ref: ./ExtensionList.yaml
    description: 'Optional extension, specific to deployment.'
required:
  - transferId
  - payeeFsp
  - payerFsp
  - amount
  - ilpPacket
  - condition
  - expiration