Versions Compared

Key

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

...

Name

Occurrence

XPath

Definition

Class/ Datatype

Codes

Pattern

OBWriteFileConsentResponse

 

OBWriteFileConsentResponse

 

OBWriteFileConsentResponse

 

 

Data

1..1

OBWriteFileConsentResponse/Data

 

OBWriteFileConsentResponse/Data

 

 

ConsentId

1..1

OBWriteFileConsentResponse/Data/ConsentId

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

String

 

 

CreationDateTime

1..1

OBWriteFileConsentResponse/Data/CreationDateTime

Date and time at which the resource was created.

DateTime

 

 

Status

1..1

OBWriteFileConsentResponse/Data/Status

Specifies the status of consent resource in code form.

String

Enum:

  • Authorised

  • AwaitingAuthorisation

  • AwaitingUpload

  • Consumed

  • Rejected

 

StatusUpdateDateTime

1..1

OBWriteFileConsentResponse/Data/StatusUpdateDateTime

Date and time at which the consent resource status was updated.

DateTime

 

 

CutOffDateTime

0..1

OBWriteFileConsentResponse/Data/CutOffDateTime

Specified cut-off date and time for the payment consent.

DateTime

 

 

Charges

0..n

OBWriteFileConsentResponse/Data/Charges

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

OBCharge

 

 

Initiation

1..1

OBWriteFileConsentResponse/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

 

 

Authorisation

0..1

OBWriteFileConsentResponse/Data/Authorisation

The authorisation type request from the TPP.

OBAuthorisation

 

 

SCASupportData

0..1

OBWriteFileConsentResponse/Data/SCASupportData

Supporting Data provided by TPP, when requesting SCA Exemption.

OBSCASupportData

 

 

Debtor

0..1

OBWriteFileConsentResponse/Data/Debtor

Set of elements used to identify a person or an organisation

OBWriteFileConsentResponse/Data/Debtor

 

 

Name

1..1

OBWriteFileConsentResponse/Data/Debtor/Name

The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.

Note: The account name is not the product name or the nickname of the account.

String

 

 

4.  Swagger Code

The swagger code for the Bulk/Batch Payment Consents API can be found on this link.

5.Usage Example 

...

5.1 POST /file-payment-consents

...

5.1.1 Request

POST / file-payment-consents

Authorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL

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

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

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

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

    "Initiation": {

      "FileContextFormat": "BH.OBF.pain.001.001.08",

      "FileHash": "jhkgas5768a/s78as",

      "FileReference": "41536789",

      "NumberOfTransactions": "10",

      "ControlSum": 10,

      "RequestedExecutionDateTime": "2020-03-20T09:14:32.115+03:00",

      "LocalInstrument": "BH.OBF.DNS",

      "DebtorAccount": {

        "SchemeName": "BH.OBF.IBAN",

        "Identification": "BH10CBBU00100000008876",

        "Name": "Albert John",

      },

      "RemittanceInformation": {

        "RemittanceDescription": "External Ops Code 34251",

        "Reference": "XYZ-101"

      },

    },

    "Authorisation": {

      "AuthorisationType": "Single",

      "CompletionDateTime": "2020-03-20T09:14:32.115+03:00"

    },

    "SCASupportData": {

      "RequestedSCAExemptionType": "TO_BE_CONFIRMED",

      "AppliedAuthenticationApproach": "SCA",

      "ReferencePaymentOrderId": "936427-2"

    }

  }

}

...

5.1.2 Response

201 Created

x-jws-signature: LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=

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

Content-Type: application/json

{

  "Data": {

    "ConsentId": "309782",

    "CreationDateTime": "2020-03-20T09:14:32.153+03:00",

    "Status": "Authorised",

    "StatusUpdateDateTime": "2020-03-20T09:14:32.153+03:00",

    "CutOffDateTime": "2020-03-20T09:14:32.153+03:00",

    "Charges": [

      {

        "ChargeBearer": "BorneByCreditor",

        "Type": "TO_BE_CONFIRMED"",

        "Amount": {

          "Amount": "5.53",

          "Currency": "BHD"

        }

      }

    ],

    "Initiation": {

      "FileContextFormat": "BH.OBF.pain.001.001.08",

      "FileHash": "jhkgas5768a/s78as",

      "FileReference": "41536789",

      "NumberOfTransactions": "10",

      "ControlSum": 10,

      "RequestedExecutionDateTime": "2020-03-20T09:14:32.115+03:00",

      "LocalInstrument": "BH.OBF.DNS",

      "DebtorAccount": {

        "SchemeName": "BH.OBF.IBAN",

        "Identification": "BH10CBBU00100000008876",

        "Name": "Albert John",

      },

      "RemittanceInformation": {

        "RemittanceDescription": "External Ops Code 34251",

        "Reference": "XYZ-101"

      },

    },

    "Authorisation": {

      "AuthorisationType": "Single",

      "CompletionDateTime": "2020-03-20T09:14:32.115+03:00"

    },

    "SCASupportData": {

      "RequestedSCAExemptionType": "TO_BE_CONFIRMED",

      "AppliedAuthenticationApproach": "SCA",

      "ReferencePaymentOrderId": "936427-2"

    }

  },

  "Links": {

    "Self": " www.TBC.com"   

  },

  "Meta": {

    "TotalPages": 01,

    "FirstAvailableDateTime": "2020-03-20T09:14:32.153+03:00",

    "LastAvailableDateTime": "2020-03-20T09:14:32.153+03:00"

  }

}

...

5.2  POST /file-payment-consents/{ConsentId}/file

...

5.2.1 Request

POST / file-payment-consents/309782/file

Authorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL

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

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

x-fapi-auth-date: Tue, 19 Mar 2020 19:43:31 GMT+03:00

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

 

[File-Data]

...

5.2.2 Response

200 OK

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

...