Bulk/Batch Payment API allows customer initiation of domestic payment bulk/batch including EFTS NRT, DNS and BIL payments.
The API endpoint allows the PISP to ask an ASPSP to create a new file-payment-consents resource.
Request to create payment consent:
https://host:port/api/bobf/release1.0.0/file-payment-consents
Authorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL
x-idempotency-key: XYZ.51403.MLT.30
x-jws-signature: LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date: Tue, 18 Mar 2022 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
{
"Data": {
"Initiation": {
"FileContextFormat": "BH.OBF.pain.001.001.08",
"FileHash": "YTM2N2IzZmEzZTBiMGY4NGQ1OGZiMDJjYWIzZWMwNDQyNGZmODNiMTBjNWJlY2JhYmE2NDhjOGM3MWZkZjAyZQ==",
"FileReference": "20220629_01",
"NumberOfTransactions": "2",
"RequestedExecutionDateTime": "2022-06-29T09:14:32.115+03:00",
"LocalInstrument": "BH.OBF.DNS",
"DebtorAccount": {
"SchemeName": "BH.OBF.IBAN",
"Identification": "BH81BBKU00100000005211",
"Name": "BBK Corporation"
},
"RemittanceInformation": {
"RemittanceDescription": "External Ops Code 34251",
"Reference": "XYZ-101"
}
},
"Authorisation": {
"AuthorisationType": "Single",
"CompletionDateTime": "2022-06-29T09:14:32.115+03:00"
},
"SCASupportData": {
"RequestedSCAExemptionType": " ",
"AppliedAuthenticationApproach": "SCA",
"ReferencePaymentOrderId": "936427-2"
}
}
}
Response:
201 Created
x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
{
"Data": {
"ConsentId": "69T3AjdtRZuDvmpiRbrQJQ",
"CreationDateTime": "2022-06-29T17:12:36.993+03:00",
"Status": "AwaitingUpload",
"StatusUpdateDateTime": "2022-06-29T17:12:36.993+03:00",
"Initiation": {
"FileContextFormat": "BH.OBF.pain.001.001.08",
"FileHash": "YTM2N2IzZmEzZTBiMGY4NGQ1OGZiMDJjYWIzZWMwNDQyNGZmODNiMTBjNWJlY2JhYmE2NDhjOGM3MWZkZjAyZQ==",
"FileReference": "20220629_01",
"NumberOfTransactions": "2",
"RequestedExecutionDateTime": "2022-06-29T09:14:32.115+03:00",
"LocalInstrument": "BH.OBF.DNS",
"DebtorAccount": {
"SchemeName": "BH.OBF.IBAN",
"Identification": "BH81BBKU00100000005211",
"Name": "BBK Corporation"
},
"RemittanceInformation": {
"Reference": "XYZ-101",
"RemittanceDescription": "External Ops Code 34251"
}
},
"SCASupportData": {
"RequestedSCAExemptionType": " ",
"AppliedAuthenticationApproach": "SCA",
"ReferencePaymentOrderId": "936427-2"
},
"Authorisation": {
"AuthorisationType": "Single",
"CompletionDateTime": "2022-06-29T09:14:32.115+03:00"
}
},
"Links": {
"Self": "https://host:port/authpage/bulkConsentId/69T3AjdtRZuDvmpiRbrQJQ"
}
}
A PISP sends pain.001 file with payment details to Bank’s using POST /file-payment-consents/{ConsentId}/file.
https://host:port/api/bobf/release1.0.0/file-payment-consents/TufcXCA-SqOI1sILBAqNfw/file
Request:
Authorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL
x-idempotency-key: XYZ.51403.MLT.30
x-jws-signature: LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date: Tue, 18 Mar 2022 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
pain.001.xml
Response:
200 OK
x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
Once the file-payment-consents has been authorised by the user/customer, the PISP should proceed to submit the file-payments for processing.
Request to initiate bulk/batch payment:
https://host:port/api/bobf/release1.0.0/file-payments
Authorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL
x-idempotency-key: XYZ.51403.MLT.30
x-jws-signature: LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date: Tue, 18 Mar 2022 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
{
"Data": {
"Initiation": {
"FileContextFormat": "BH.OBF.pain.001.001.08",
"FileHash": "YTM2N2IzZmEzZTBiMGY4NGQ1OGZiMDJjYWIzZWMwNDQyNGZmODNiMTBjNWJlY2JhYmE2NDhjOGM3MWZkZjAyZQ==",
"FileReference": "20220629_01",
"NumberOfTransactions": "2",
"RequestedExecutionDateTime": "2022-06-29T09:14:32.115+03:00",
"LocalInstrument": "BH.OBF.DNS",
"DebtorAccount": {
"SchemeName": "BH.OBF.IBAN",
"Identification": "BH81BBKU00100000005211",
"Name": "BBK Corporation"
},
"RemittanceInformation": {
"RemittanceDescription": "External Ops Code 34251",
"Reference": "XYZ-101"
}
},
"Authorisation": {
"AuthorisationType": "Single",
"CompletionDateTime": "2022-06-29T09:14:32.115+03:00"
},
"SCASupportData": {
"RequestedSCAExemptionType": " ",
"AppliedAuthenticationApproach": "SCA",
"ReferencePaymentOrderId": "936427-2"
}
}
}
Response:
201 Created
x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
{
"Data": {
"ConsentId": "69T3AjdtRZuDvmpiRbrQJQ",
"CreationDateTime": "2022-06-29T17:12:36.993+03:00",
"Status": "AwaitingUpload",
"StatusUpdateDateTime": "2022-06-29T17:12:36.993+03:00",
"Initiation": {
"FileContextFormat": "BH.OBF.pain.001.001.08",
"FileHash": "YTM2N2IzZmEzZTBiMGY4NGQ1OGZiMDJjYWIzZWMwNDQyNGZmODNiMTBjNWJlY2JhYmE2NDhjOGM3MWZkZjAyZQ==",
"FileReference": "20220629_01",
"NumberOfTransactions": "2",
"RequestedExecutionDateTime": "2022-06-29T09:14:32.115+03:00",
"LocalInstrument": "BH.OBF.DNS",
"DebtorAccount": {
"SchemeName": "BH.OBF.IBAN",
"Identification": "BH81BBKU00100000005211",
"Name": "BBK Corporation"
},
"RemittanceInformation": {
"Reference": "XYZ-101",
"RemittanceDescription": "External Ops Code 34251"
}
},
"SCASupportData": {
"RequestedSCAExemptionType": " ",
"AppliedAuthenticationApproach": "SCA",
"ReferencePaymentOrderId": "936427-2"
},
"Authorisation": {
"AuthorisationType": "Single",
"CompletionDateTime": "2022-06-29T09:14:32.115+03:00"
}
},
"Links": {
"Self": "https://host:port/authpage/bulkConsentId/69T3AjdtRZuDvmpiRbrQJQ"
}
}
A PISP can optionally retrieve a payment consent data to check its status.
Request:
https://host:port/api/bobf/release1.0.0/file-payment-consents/69T3AjdtRZuDvmpiRbrQJQ
Authorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL
x-idempotency-key: XYZ.51403.MLT.30
x-jws-signature: LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date: Tue, 18 Mar 2022 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
Response:
200 OK
x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
{
"Data": {
"ConsentId": "69T3AjdtRZuDvmpiRbrQJQ",
"CreationDateTime": "2022-06-29T17:12:36+03:00",
"Status": "Consumed",
"StatusUpdateDateTime": "2022-06-29T17:35:47+03:00",
"Initiation": {
"FileContextFormat": "BH.OBF.pain.001.001.08",
"FileHash": "YTM2N2IzZmEzZTBiMGY4NGQ1OGZiMDJjYWIzZWMwNDQyNGZmODNiMTBjNWJlY2JhYmE2NDhjOGM3MWZkZjAyZQ==",
"FileReference": "20220629_01",
"NumberOfTransactions": "2",
"RequestedExecutionDateTime": "2022-06-29T09:14:32.115+03:00",
"LocalInstrument": "BH.OBF.DNS",
"DebtorAccount": {
"SchemeName": "IBAN",
"Identification": "BH81BBKU00100000005211",
"Name": "BBK Corporation"
},
"RemittanceInformation": {
"Reference": "XYZ-101",
"RemittanceDescription": "External Ops Code 34251"
}
},
"SCASupportData": {
"RequestedSCAExemptionType": " ",
"AppliedAuthenticationApproach": "SCA",
"ReferencePaymentOrderId": "936427-2"
},
"Authorisation": {
"AuthorisationType": "Single",
"CompletionDateTime": "2022-06-29T09:14:32.115+03:00"
}
},
"Links": {
"Self": "https://host:port/authpage/bulkConsentId/69T3AjdtRZuDvmpiRbrQJQ"
}
}
A PISP can optionally retrieve a file data to check its content.
Request:
https://host:port/api/bobf/release1.0.0/file-payment-consents/69T3AjdtRZuDvmpiRbrQJQ/file
Authorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL
x-idempotency-key: XYZ.51403.MLT.30
x-jws-signature: LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date: Tue, 18 Mar 2022 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
Response:
200 OK
x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:pain.001.001.08" >
<CstmrCdtTrfInitn>
<GrpHdr>
<MsgId>MsgId-0001</MsgId>
<CreDtTm>2022-06-29T14:07:00</CreDtTm>
<NbOfTxs>2</NbOfTxs>
<CtrlSum>5</CtrlSum>
<InitgPty>
<Nm>BBK Corporation</Nm>
<PstlAdr>
<StrtNm>Times Square</StrtNm>
<BldgNb>7</BldgNb>
<PstCd>NY 10036</PstCd>
<TwnNm>New York</TwnNm>
<Ctry>US</Ctry>
</PstlAdr>
</InitgPty>
</GrpHdr>
<PmtInf>
<PmtInfId>PmtInf/001</PmtInfId>
<PmtMtd>TRF</PmtMtd>
<BtchBookg>false</BtchBookg>
<ReqdExctnDt>
<Dt>2022-06-29</Dt>
</ReqdExctnDt>
<Dbtr>
<Nm>BBK Corporation</Nm>
<PstlAdr>
<StrtNm>Times Square</StrtNm>
<BldgNb>7</BldgNb>
<PstCd>NY 10036</PstCd>
<TwnNm>New York</TwnNm>
<Ctry>US</Ctry>
</PstlAdr>
</Dbtr>
<DbtrAcct>
<Id>
<IBAN>BH81BBKU00100000005211</IBAN>
</Id>
</DbtrAcct>
<DbtrAgt>
<FinInstnId>
<BICFI>BBKUBHBM</BICFI>
</FinInstnId>
</DbtrAgt>
<CdtTrfTxInf>
<PmtId>
<InstrId>PmtInf/001/InstrId/01</InstrId>
<EndToEndId>PmtInf/001/e2e/01</EndToEndId>
</PmtId>
<Amt>
<InstdAmt Ccy="BHD">1</InstdAmt>
</Amt>
<ChrgBr>SHAR</ChrgBr>
<CdtrAgt>
<FinInstnId>
<BICFI>ABCOBHBM</BICFI>
</FinInstnId>
</CdtrAgt>
<Cdtr>
<Nm>BBK Corporation</Nm>
<PstlAdr>
<AdrLine>Corn Exchange 5th Floor</AdrLine>
<AdrLine>Mark Lane 55</AdrLine>
<AdrLine>EC3R7NE London</AdrLine>
<AdrLine>GB</AdrLine>
</PstlAdr>
</Cdtr>
<CdtrAcct>
<Id>
<Othr>
<Id>23683707994125</Id>
</Othr>
</Id>
</CdtrAcct>
<Purp>
<Cd>001</Cd>
</Purp>
<RmtInf>
<Strd>
<RfrdDocInf>
<Tp>
<CdOrPrtry>
<Cd>CINV</Cd>
</CdOrPrtry>
</Tp>
<Nb>4562</Nb>
<RltdDt>2022-06-29</RltdDt>
</RfrdDocInf>
</Strd>
</RmtInf>
</CdtTrfTxInf>
</PmtInf>
<PmtInf>
<PmtInfId>PmtInf/002</PmtInfId>
<PmtMtd>TRF</PmtMtd>
<BtchBookg>false</BtchBookg>
<ReqdExctnDt>
<Dt>2022-06-29</Dt>
</ReqdExctnDt>
<Dbtr>
<Nm>BBK Corporation</Nm>
<PstlAdr>
<StrtNm>Times Square</StrtNm>
<BldgNb>7</BldgNb>
<PstCd>NY 10036</PstCd>
<TwnNm>New York</TwnNm>
<Ctry>US</Ctry>
</PstlAdr>
</Dbtr>
<DbtrAcct>
<Id>
<IBAN>BH81BBKU00100000005211</IBAN>
</Id>
</DbtrAcct>
<DbtrAgt>
<FinInstnId>
<BICFI>BBKUBHBM</BICFI>
</FinInstnId>
</DbtrAgt>
<CdtTrfTxInf>
<PmtId>
<InstrId>PmtInf/002/InstrId/01</InstrId>
<EndToEndId>PmtInf/002/e2e/01</EndToEndId>
</PmtId>
<Amt>
<InstdAmt Ccy="BHD">4</InstdAmt>
</Amt>
<ChrgBr>SHAR</ChrgBr>
<CdtrAgt>
<FinInstnId>
<BICFI>ABCOBHBM</BICFI>
</FinInstnId>
</CdtrAgt>
<Cdtr>
<Nm>BBK Corporation</Nm>
<PstlAdr>
<AdrLine>Corn Exchange 5th Floor</AdrLine>
<AdrLine>Mark Lane 55</AdrLine>
<AdrLine>EC3R7NE London</AdrLine>
<AdrLine>GB</AdrLine>
</PstlAdr>
</Cdtr>
<CdtrAcct>
<Id>
<Othr>
<Id>23683707994125</Id>
</Othr>
</Id>
</CdtrAcct>
<Purp>
<Cd>001</Cd>
</Purp>
<RmtInf>
<Strd>
<RfrdDocInf>
<Tp>
<CdOrPrtry>
<Cd>CINV</Cd>
</CdOrPrtry>
</Tp>
<Nb>4562</Nb>
<RltdDt>2022-06-29</RltdDt>
</RfrdDocInf>
</Strd>
</RmtInf>
</CdtTrfTxInf>
</PmtInf>
</CstmrCdtTrfInitn>
</Document>
A PISP can optionally retrieve a payment data to check its status.
Request:
https://host:port/api/bobf/release1.0.0/file-payments/69T3AjdtRZuDvmpiRbrQJQ
Authorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL
x-idempotency-key: XYZ.51403.MLT.30
x-jws-signature: LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date: Tue, 18 Mar 2022 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
Response:
200 OK
x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
{
"Data": {
"FilePaymentId": "69T3AjdtRZuDvmpiRbrQJQ",
"ConsentId": "69T3AjdtRZuDvmpiRbrQJQ",
"CreationDateTime": "2022-06-29T17:12:36+03:00",
"Status": "InitiationCompleted",
"StatusUpdateDateTime": "2022-06-29T17:12:36+03:00",
"Initiation": {
"FileContextFormat": "BH.OBF.pain.001.001.08",
"FileHash": "YTM2N2IzZmEzZTBiMGY4NGQ1OGZiMDJjYWIzZWMwNDQyNGZmODNiMTBjNWJlY2JhYmE2NDhjOGM3MWZkZjAyZQ==",
"FileReference": "20220629_01",
"NumberOfTransactions": "2",
"RequestedExecutionDateTime": "2022-06-29T09:14:32.115+03:00",
"LocalInstrument": "BH.OBF.DNS",
"DebtorAccount": {
"SchemeName": "IBAN",
"Identification": "BH81BBKU00100000005211",
"Name": "BBK Corporation"
},
"RemittanceInformation": {
"Reference": "XYZ-101",
"RemittanceDescription": "External Ops Code 34251"
}
}
}
}
A PISP can retrieve report file pain.002 with status details.
Request:
https://host:port/api/bobf/release1.0.0/file-payments/69T3AjdtRZuDvmpiRbrQJQ/report-file
Authorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL
x-idempotency-key: XYZ.51403.MLT.30
x-jws-signature: LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date: Tue, 18 Mar 2022 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
Response:
200 OK
x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:pain.002.001.09">
<CstmrPmtStsRpt>
<GrpHdr>
<MsgId>M000000000022122</MsgId>
<CreDtTm>2022-06-29T17:40:58</CreDtTm>
<InitgPty>
<Nm>BBK Corporation</Nm>
</InitgPty>
</GrpHdr>
<OrgnlGrpInfAndSts>
<OrgnlMsgId>MsgId-0001</OrgnlMsgId>
<OrgnlMsgNmId>pain.001.001.08</OrgnlMsgNmId>
<OrgnlCreDtTm>2022-06-29T17:12:57</OrgnlCreDtTm>
<GrpSts>ACCP</GrpSts>
</OrgnlGrpInfAndSts>
</CstmrPmtStsRpt>
</Document>
A PISP can retrieve payment details data to check each payment status.
Request:
https://host:port/api/bobf/release1.0.0/file-payments/69T3AjdtRZuDvmpiRbrQJQ/payment-details
Authorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL
x-idempotency-key: XYZ.51403.MLT.30
x-jws-signature: LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date: Tue, 18 Mar 2022 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
Response:
200 OK
x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
{
"Data": {
"PaymentStatus": [
{
"PaymentTransactionId": "OBT2206290000101",
"Status": "AcceptedCreditSettlementCompleted",
"StatusUpdateDateTime": "2022-06-29T17:41:03.314+03:00"
},
{
"PaymentTransactionId": "OBT2206290000102",
"Status": "AcceptedCreditSettlementCompleted",
"StatusUpdateDateTime": "2022-06-29T17:41:03.415+03:00"
}
]
}
}