Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

1.        Overview

The File Payment resource is used by a PISP to initiate a File Payment.

...

Endpoints for the resource - and available methods.

S.No.

Resource

HTTP Operation

Endpoint

Mandatory

Scope

Grant Type

Message Signing

Idempotency Key

Request Object

Response Object

2.1

file-payments

POST

POST /file-payments

Conditional

payments

Authorization Code

Signed Request Signed Response

Yes

OBWriteFile

OBWriteFileResponse

2.2

file-payments

GET

GET /file-payments/{FilePaymentId}

Mandatory (if resource POST implemented)

payments

Client Credentials

Signed Response

No

NA

OBWriteFileResponse

2.3

file-payments

GET

GET /file-payments/{FilePaymentId}/report-file

Conditional

payments

Client Credentials

Signed Response

No

NA

File

2.4

payment-details

GET

GET /file-payments/{FilePaymentId}/payment-details

Optional

payments

Client Credentials

Signed Response

No

NA

OBWritePaymentDetailsResponse

...

The file-payments resource must have one of the following Status codes:

Status

InitiationPending

InitiationFailed

InitiationCompleted

...

The file-payments - payment-details must have one of the following PaymentStatusCode code-set enumerations:

Status

Accepted

AcceptedCancellationRequest

AcceptedTechnicalValidation

AcceptedCustomerProfile

AcceptedFundsChecked

AcceptedWithChange

Pending

Rejected

AcceptedSettlementInProcess

AcceptedSettlementCompleted

AcceptedWithoutPosting

AcceptedCreditSettlementCompleted

Cancelled

NoCancellationProcess

PartiallyAcceptedCancellationRequest

PartiallyAcceptedTechnicalCorrect

PaymentCancelled

PendingCancellationRequest

Received

RejectedCancellationRequest

...

The definitions for the Status:

 S.No.

Status

Payment Status Description

1

InitiationPending

The initiation of the payment order is pending.

2

InitiationFailed

The initiation of the payment order has failed.

3

InitiationCompleted

The initiation of the payment order is complete.

...

The OBFileInitiation class is defined in the filethe file-payment-consents pageconsents page.

3.2     File Payment - Request

...

3.2.3        Data Dictionary

 

Name

Occurrence

XPath

EnhancedDefinition

Class

Codes

Pattern

OBWriteFile

 

OBWriteFile

 

OBWriteFile

 

 

Data

1..1

OBWriteFile/Data

 

OBWriteFile/Data

 

 

ConsentId

1..1

OBWriteFile/Data/ConsentId

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

String

 

 

Initiation

1..1

OBWriteFile/Data/Initiation

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.

OBFileInitiation

 

 

...

3.3.1        UML Diagram

   

...

3.3.2        Notes

The file-payment response object contains the:

...

3.3.3        Data Dictionary

 

Name

Occurrence

XPath

EnhancedDefinition

Class

Codes

Pattern

OBWriteFileResponse

 

OBWriteFileResponse

 

OBWriteFileResponse

 

 

Data

1..1

OBWriteFileResponse/Data

 

OBWriteFileResponse/Data

 

 

FilePaymentId

1..1

OBWriteFileResponse/Data/FilePaymentId

OB: Unique identification as assigned by the ASPSP to uniquely identify the file payment resource.

String

 

 

ConsentId

1..1

OBWriteFileResponse/Data/ConsentId

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

String

 

 

CreationDateTime

1..1

OBWriteFileResponse/Data/CreationDateTime

Date and time at which the message was created.

DateTime

 

 

Status

1..1

OBWriteFileResponse/Data/Status

Specifies the status of the payment order resource.

String

Enum:

  • InitiationCompleted

  • InitiationFailed

  • InitiationPending

 

StatusUpdateDateTime

1..1

OBWriteFileResponse/Data/StatusUpdateDateTime

Date and time at which the resource status was updated.

DateTime

 

 

Charges

0..n

OBWriteFileResponse/Data/Charges

Set of elements used to provide details of a charge for the payment initiation.

OBCharge

 

 

Initiation

1..1

OBWriteFile/Data/Initiation

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.

OBFileInitiation

 

 

...

3.4.1        UML Diagram

 

 

3.4.2        Data Dictionary

 

Name

Occurrence

XPath

EnhancedDefinition

Class

Codes

Pattern

OBWritePaymentDetailsResponse

 

OBWritePaymentDetailsResponse

 

OBWritePaymentDetailsResponse

 

 

Data

1..1

OBWritePaymentDetailsResponse/Data

 

OBWritePaymentDetailsResponse/Data

 

 

PaymentStatus

0..unbounded

OBWritePaymentDetailsResponse/Data/PaymentStatus

Payment status details.

OBWritePaymentDetails

 

 

 

 

...

4.        Usage Examples

4.1        POST /file-payments

4.1.

...

1     Request

POST /file-payments

Authorization: Bearer 4ZopnFZFKjr5zDsicSQpLL

x-idempotency-key: XYZ.51403.MLT.30

x-jws-signature: LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==

x-fapi-auth-date: Tue, 18 Mar 2020 19:43:31 GMT

x-fapi-customer-ip-address: 204.35.213.15

x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f

Content-Type: application/json

Accept: application/json

{
  "Data": {
    "ConsentId": "565656",
    "Initiation": {
      "FileType": "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"
      }
    }
  }

4.1.2      Response

201 Created

x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K

x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d

Content-Type: application/json

{
  "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": {
      "FileType": "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"
  }
}