Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • This endpoint enables ASPSP to return a report on the processing results of Payments in the file

  • The file is sent in the HTTP response body.

  • The file structure may match a payment execution report for the corresponding FileType FileContextFormat in the file-payment-consent request.

  • HTTP headers (e.g. Content-Type) are used to describe the file.

...

  • POST /file-payments

  • GET /file-payments/{FilePaymentId}

3.3.1        UML Diagram

...

  

...

3.3.2        Notes

The file-payment response object contains the:

...

{
  "Data": {
    "ConsentId": "565656",
    "Initiation": {
      "FileTypeFileContextFormat": "BH.OBF.PaymentInitiation",
      "FileHash": "jhkgas5768a/s78as",
      "FileReference": "41536789",
      "NumberOfTransactions": "10",
      "ControlSum": 0,
      "RequestedExecutionDateTime": "2020-03-20T09:14:32.115Z",
      "LocalInstrument": "EFT-CSCT-DNS",
      "DebtorAccount": {
        "SchemeName": "IBAN",
        "Identification": "BH10CBBU00100000008876",
        "Name": "Albert John",
        "SecondaryIdentification": "00023"
      },
      "RemittanceInformation": {
        "RemittanceDescription": "External Ops Code 34251",
        "Reference": "XYZ-101"
      }
    }
  }

...

{
  "Data": {
    "FilePaymentId": "764356",
    "ConsentId": "565656",
    "CreationDateTime": "2020-03-20T11:07:04.048Z",
    "Status": "InitiationCompleted",
    "StatusUpdateDateTime": "2020-03-20T11:07:04.048Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "TO_BE_CONFIRMED",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "Initiation": {
      "FileTypeFileContextFormat": "BH.OBF.PaymentInitiation",
      "FileHash": "jhkgas5768a/s78as",
      "FileReference": "41536789",
      "NumberOfTransactions": "10",
      "ControlSum": 0,
      "RequestedExecutionDateTime": "2020-03-20T09:14:32.115Z",
      "LocalInstrument": "EFT-CSCT-DNS",
      "DebtorAccount": {
        "SchemeName": "IBAN",
        "Identification": "BH10CBBU00100000008876",
        "Name": "Albert John",
        "SecondaryIdentification": "00023"
      },
      "RemittanceInformation": {
        "RemittanceDescription": "External Ops Code 34251",
        "Reference": "XYZ-101"
      },
    },
    
  "Links": {
    "Self": "www.TBC.com"
  },
  "Meta": {
    "TotalPages": 1,
    "FirstAvailableDateTime": "2020-03-20T09:10:17.596Z",
    "LastAvailableDateTime": "2020-03-20T09:10:17.596Z"
  }
}