/
Funds Confirmation Usage Examples v3.1

Funds Confirmation Usage Examples v3.1

Nov 30, 2018

Version Control

Version

Date

Author

Comments

Version

Date

Author

Comments

3.0

Sep 7, 2018 

OB R/W API Team

This is the baseline version. No change from RC3.

3.1-draft1

Sep 12, 2018 

OB R/W API Team

This is the initial draft version for 3.1

Errata

  • Added Meta element in Usage Examples for correctness of the payload

3.1-draft2

Oct 5, 2018 

OB R/W API Team

Draft2 Changes:

  • Updated example URLs to version 3.1.

3.1

Nov 30, 2018

OB R/W API Team

Version 3.1 final release.

No changes from Version 3.1 RC1.

Usage Examples

No additional Sequence Diagrams are given for the Usage Examples - as they do not differ from the Sequence Diagram in the Overview.

POST - Funds Confirmation Consent

Example with all permitted fields

Request

Post Funds Confirmation Consent
POST /funds-confirmation-consents HTTP/1.1 Content-Type: application/json Authorization: Bearer 1t1satruthun1v3rs4lly Accept: application/json; charset=utf-8 x-fapi-financial-id: I4mth3R3-4p3r-411t-hing-5withh33dfu1 x-fapi-customer-last-logged-time: Mon, 13 Nov 2017 19:49:37 GMT x-fapi-customer-ip-address: 92.11.92.11 x-fapi-interaction-id: hook5i13-ntIg-4th3-rP41-3ro535touch3 { "Data": { "DebtorAccount": { "SchemeName": "UK.OBIE.IBAN", "Identification": "GB76LOYD30949301273801", "SecondaryIdentification": "Roll 56988" }, "ExpirationDateTime": "2017-05-02T00:00:00+00:00" } }

Response

Post Funds Confirmation Consent Response
HTTP/1.1 201 Created Content-Type: application/json x-fapi-interaction-id: hook5i13-ntIg-4th3-rP41-3ro535touch3 { "Data": { "ConsentId": "88379", "CreationDateTime": "2017-05-02T00:00:00+00:00", "Status": "AwaitingAuthorisation", "StatusUpdateDateTime": "2017-05-02T00:00:00+00:00", "ExpirationDateTime": "2017-05-02T00:00:00+00:00", "DebtorAccount": { "SchemeName": "UK.OBIE.IBAN", "Identification": "GB76LOYD30949301273801", "SecondaryIdentification": "Roll 56988" } }, "Links": { "Self": "https://api.alphabank.com/open-banking/v3.1/cbpii/funds-confirmation-consents/88379" }, "Meta": {} }

GET - Funds Confirmation Consent

Example with all permitted fields

Request

GET Funds Confirmation Consent Request
GET /funds-confirmation-consents/88379 HTTP/1.1 Authorization: Bearer Jhingapulaav x-fapi-financial-id: OB/2017/001 x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d Accept: application/json

Response

GET Funds Confirmation Consent Response
HTTP/1.1 200 OK x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d Content-Type: application/json { "Data": { "ConsentId": "88379", "CreationDateTime": "2017-05-02T00:00:00+00:00", "Status": "AwaitingAuthorisation", "StatusUpdateDateTime": "2017-05-02T00:00:00+00:00", "ExpirationDateTime": "2017-05-02T00:00:00+00:00", "DebtorAccount": { "SchemeName": "UK.OBIE.IBAN", "Identification": "GB76LOYD30949301273801", "SecondaryIdentification": "Roll 56988" } }, "Links": { "Self": "https://api.alphabank.com/open-banking/v3.1/cbpii/funds-confirmation-consents/88379" }, "Meta": {} }

Funds Confirmation

Example with all permitted fields

Request

Post Funds Confirmation Request
POST /funds-confirmations HTTP/1.1 Content-Type: application/json Authorization: Bearer 1t1satruthun1v3rs4lly Accept: application/json; charset=utf-8 x-fapi-financial-id: I4mth3R3-4p3r-411t-hing-5withh33dfu1 x-fapi-interaction-id: hook5i13-ntIg-4th3-rP41-3ro535touch3 { "Data": { "ConsentId": "88379", "Reference": "Purchase01", "InstructedAmount": { "Amount": "20.00", "Currency": "GBP" } } }

Response

Post Funds Confirmation Response
HTTP/1.1 201 Created Content-Type: application/json x-fapi-interaction-id: hook5i13-ntIg-4th3-rP41-3ro535touch3 { "Data": { "FundsConfirmationId": "123456", "ConsentId": "88379", "CreationDateTime": "2017-05-02T00:00:00+00:00", "FundsAvailable": true, "Reference": "Purchase01", "InstructedAmount": { "Amount": "20.00", "Currency": "GBP" } }, "Links": { "Self": "https://api.alphabank.com/open-banking/v3.1/cbpii/funds-confirmations/123456" }, "Meta": {} }

DELETE - Funds Confirmation Consent

Example with all permitted fields

Request

DELETE Funds Confirmation Consent Request
DELETE /funds-confirmation-consents/88379 HTTP/1.1 Authorization: Bearer Jhingapulaav x-fapi-financial-id: OB/2017/001 x-fapi-customer-last-logged-time: Sun, 10 Sep 2017 19:43:31 GMT x-fapi-customer-ip-address: 104.25.212.99 x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d

Response

DELETE Funds Confirmation Consent Response
HTTP/1.1 204 No Content x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d

Funds Confirmation

Example with a USD account

A funds confirmation check can be made in a currency other than GBP as long as the InstructedAmount is in the currency of the payment account.

In this example, a USD funds check is made on a USD payment account.

Request

Post Funds Confirmation Request
POST /funds-confirmations HTTP/1.1 Content-Type: application/json Authorization: Bearer 1t1satruthun1v3rs4lly Accept: application/json; charset=utf-8 x-fapi-financial-id: I4mth3R3-4p3r-411t-hing-5withh33dfu1 x-fapi-interaction-id: hook5i13-ntIg-4th3-rP41-3ro535touch3 { "Data": { "ConsentId": "912304", "Reference": "Purchase02", "InstructedAmount": { "Amount": "20.00", "Currency": "USD" } } }

Response

Post Funds Confirmation Response
HTTP/1.1 201 Created Content-Type: application/json x-fapi-interaction-id: hook5i13-ntIg-4th3-rP41-3ro535touch3 { "Data": { "FundsConfirmationId": "836403", "ConsentId": "912304", "CreationDateTime": "2017-06-02T00:00:00+00:00", "FundsAvailable": true, "Reference": "Purchase02", "InstructedAmount": { "Amount": "20.00", "Currency": "USD" } }, "Links": { "Self": "https://api.alphabank.com/open-banking/v3.1/cbpii/funds-confirmations/836403" }, "Meta": {} }

© Open Banking Limited 2019 | https://www.openbanking.org.uk/open-licence | https://www.openbanking.org.uk