Payment Initiation APIs

Download
(0 reviews)

Payment Consents Examples

This section provides examples of requests and responses for the individual Payment Consents APIs:

Domestic Payment Consents APIs

POST request: domestic payment consents request

This API endpoint allows the PISP to ask an ASPSP to create a new domestic payment consent resource.The POST action indicates to the ASPSP that a domestic payment consent has been staged. At this point, the PSU may not have been identified by the ASPSP, and the request payload may not contain any information of the account that should be debited.

The endpoint allows the PISP to send a copy of the consent (between PSU and PISP) to the ASPSP for the PSU to authorise. The ASPSP creates the domestic payment consent resource and responds with a unique Consent ID to refer to the resource.

POST /domestic-payment-consents HTTP/1.1

curl -X POST \
 https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/domestic-payment-consents \
  -H 'Authorization: Bearer VS6VAWqqfI2sKOh4iuwgEgPPgduw' \
  -H 'Content-Type: application/json' \
  -H 'cache-control: no-cache' \
  -H 'x-fapi-customer-ip-address: 104.25.212.99' \
  -H 'x-fapi-customer-last-logged-time: Sun, 10 Sep 2017 19:43:31 UTC' \
  -H 'x-fapi-financial-id: 0015800000jfQ9aAAE' \
  -H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e' \
  -H 'x-idempotency-key: FRESCO.21302.GFX.20' \
  -H 'x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==' \
  -d '{
  "Data": {
    "Initiation": {
      "InstructionIdentification": "ABDDCF",
      "EndToEndIdentification": "DEMO USER",
      "InstructedAmount": {
        "Amount": "300.00",
        "Currency": "EUR"
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.IBAN",
        "Identification": "IE40BOFI90123968920165",
        "Name": "Test user",
        "SecondaryIdentification": "TPP Provided Value"
      },
      "RemittanceInformation": {
        "Unstructured": "Internal ops code 5120101",
        "Reference": "FRESCO-101"
      }
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2019-12-30T06:06:06.777"
    }
  },
  "Risk": {
    "PaymentContextCode": "EcommerceGoods",
    "MerchantCategoryCode": "5967",
    "MerchantCustomerIdentification": "053598653254",
    "DeliveryAddress": {
      "AddressLine": [
        "Flat 7",
        "Acacia Lodge"
      ],
      "StreetName": "AcaciaAvenue",
      "BuildingNumber": "27",
      "PostCode": "7U31 2ZZ",
      "TownName": "Sparsholt",
      "Country": "IE"
    }
  }
}'

Header parameters :

Parameter Example value Description
authorization Bearer yncA2hqqUbR8Wf86J3plfw2o5A4d The token obtained in step 1(Get access token).
x-jws-signature TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw== Header containing a detached JWS of the payload. Mandatory for requests that contain a payload. Please refer to the processes of generating one here.

POST response: domestic payment consents

HTTP/1.1 201 Created

x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODIwOSwiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..UzSO4Yw97FrpdpoxwOWqYPpi3kftH-wMclXXhh-2jpJc3hqPzQFkgyovr3uciTUGClY88DknV-ZwhyO3DJitboEX6su8K1REbLbtnX22EXmj1LIw9WYNYSmmf2D5TobHSzRvIsToUg-Tn2v7tl6asmjGYh1HUBF4JUUwgcrBiwlUBELNT_wlpXMe5lDpAcpDnXHYkvR2bZkcu995BEu31rCn4QppTxU7Aq82c0XuRsiOABuGExYbJWh55cSlVCBXt7ZKlGTf2ypXTFeeoDK48-ves6bOJYoTKQ8ywMkJf38tgtDsXdIpbwFT3rBTB6_N70F_DgM-dvCGj2jvS0PB9A
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json

{
    "Data": {
        "ConsentId": "c4cd37de-aa69-4fbe-83aa-198b807948d6",
        "CreationDateTime": "2019-02-06T10:24:02+00:00",
        "Status": "AwaitingAuthorisation",
        "StatusUpdateDateTime": "2019-02-06T10:24:02+00:00",
        "CutOffDateTime": "2019-02-09T10:24:02+00:00",
        "ExpectedExecutionDateTime": "2019-02-07T10:24:02+00:00",
        "ExpectedSettlementDateTime": "2019-02-08T10:24:02+00:00",
        "Initiation": {
            "InstructionIdentification": "ABDDCF",
            "EndToEndIdentification": "DEMO USER",
            "InstructedAmount": {
                "Amount": "300.00",
                "Currency": "EUR"
            },
            "CreditorAccount": {
                "SchemeName": "UK.OBIE.IBAN",
                "Identification": "IE40BOFI90123968920165",
                "Name": "Test user",
                "SecondaryIdentification": "TPP Provided Value"
            },
            "RemittanceInformation": {
                "Unstructured": "Internal ops code 5120101",
                "Reference": "FRESCO-101"
            }
        },
        "Authorisation": {
            "AuthorisationType": "Any",
            "CompletionDateTime": "2019-12-30T06:06:06.777+00:00"
        }
    },
    "Risk": {
        "PaymentContextCode": "EcommerceGoods",
        "MerchantCategoryCode": "5967",
        "MerchantCustomerIdentification": "053598653254",
        "DeliveryAddress": {
            "AddressLine": [
                "Flat 7",
                "Acacia Lodge"
            ],
            "StreetName": "AcaciaAvenue",
            "BuildingNumber": "27",
            "PostCode": "7U31 2ZZ",
            "TownName": "Sparsholt",
            "Country": "IE"
        }
    },
    "Links": {
        "Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/domestic-payment-consents/c4cd37de-aa69-4fbe-83aa-198b807948d6"
    },
    "Meta": {}
}

GET request: domestic payment consents

A PISP can optionally retrieve a payment consent resource that they have created to check its status. The available status codes for the domestic payment consent resource are:

Status Description
AwaitingAuthorisation Before the PSU authorises the payment-consent resource
Rejected If the PSU rejects the consent or the domestic-payment-consent has failed some other ASPSP validation
Authorised Once the PSU authorises the payment-consent resource
Consumed Once a domestic-payment has been successfully created using the domestic-payment-consent
GET /domestic-payment-consents/5d2b8ce5-681a-4679-a79a-e64ef1f99ab7 HTTP/1.1

curl -X GET \
  https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/domestic-payment-consents/c4cd37de-aa69-4fbe-83aa-198b807948d6 \
  -H 'Authorization: Bearer MSdQrRyLqftG6NbSfOdSGntgPeTQ' \
  -H 'Content-Type: application/json' \
  -H 'cache-control: no-cache' \
  -H 'x-fapi-customer-ip-address: 104.25.212.99' \
  -H 'x-fapi-customer-last-logged-time: Sun, 10 Sep 2017 19:43:31 UTC' \
  -H 'x-fapi-financial-id: 0015800000jfQ9aAAE' \
  -H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e' \
  -H 'x-idempotency-key: FRESCO.21302.GFX.21 ' \

GET response: domestic payment consents

HTTP/1.1 200 OK
x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODU4MCwiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..S9-ZingkHVC0WgDujBxQmztpuI-Fbr-qCYZU7iqGuYWADXMDPhP4_XO_tb5geTGdAT6JADDM9LaOG0J038ax1nPvT0MZMKYJ7mW7eiX8ZKtcwPWFMVlJLvYhG0lYSEJwNcuV0nkQQjVeqeCjiLM8CqkTmfVgdOdayAQgGgMEkxGRKsvX3ED8JWmqHuiiDlH-jrMjK-YtLf_QlUHV_WN-mHSywXJIJHpZFLMUO2bL59QgMcyIl5UuGJBPQCmpvAEGcHQSKGbOIJfJCAYyZREhs9ZoLbqIClJ7eUAbZO8h70u6aah2_pb0pv-b-yDSODb_Twot6_phQ-zOJI32RK87yg
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json
{
    "Data": {
        "ConsentId": "c4cd37de-aa69-4fbe-83aa-198b807948d6",
        "CreationDateTime": "2019-02-06T10:24:02+00:00",
        "Status": "AwaitingAuthorisation",
        "StatusUpdateDateTime": "2019-02-06T10:24:02+00:00",
        "CutOffDateTime": "2019-02-09T10:24:02+00:00",
        "ExpectedExecutionDateTime": "2019-02-07T10:24:02+00:00",
        "ExpectedSettlementDateTime": "2019-02-08T10:24:02+00:00",
        "Initiation": {
            "InstructionIdentification": "ABDDCF",
            "EndToEndIdentification": "DEMO USER",
            "InstructedAmount": {
                "Amount": "300.00",
                "Currency": "EUR"
            },
            "CreditorAccount": {
                "SchemeName": "UK.OBIE.IBAN",
                "Identification": "IE40BOFI90123968920165",
                "Name": "Test user",
                "SecondaryIdentification": "TPP Provided Value"
            },
            "RemittanceInformation": {
                "Unstructured": "Internal ops code 5120101",
                "Reference": "FRESCO-101"
            }
        },
        "Authorisation": {
            "AuthorisationType": "Any",
            "CompletionDateTime": "2019-12-30T06:06:06.777+00:00"
        }
    },
    "Risk": {
        "PaymentContextCode": "EcommerceGoods",
        "MerchantCategoryCode": "5967",
        "MerchantCustomerIdentification": "053598653254",
        "DeliveryAddress": {
            "AddressLine": [
                "Flat 7",
                "Acacia Lodge"
            ],
            "StreetName": "AcaciaAvenue",
            "BuildingNumber": "27",
            "PostCode": "7U31 2ZZ",
            "TownName": "Sparsholt",
            "Country": "IE"
        }
    },
    "Links": {
        "Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/domestic-payment-consents/c4cd37de-aa69-4fbe-83aa-198b807948d6"
    },
    "Meta": {}
}

Domestic scheduled payment consents API

POST request: domestic scheduled payment consents

curl -X POST \
 https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/domestic-scheduled-payment-consents \
  -H 'Authorization: Bearer VS6VAWqqfI2sKOh4iuwgEgPPgduw' \
  -H 'Content-Type: application/json' \
  -H 'cache-control: no-cache' \
  -H 'x-fapi-customer-ip-address: 104.25.212.99' \
  -H 'x-fapi-customer-last-logged-time: Sun, 10 Sep 2017 19:43:31 UTC' \
  -H 'x-fapi-financial-id: 0015800000jfQ9aAAE' \
  -H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e' \
  -H 'x-idempotency-key: FRESCO.21302.GFX.22' \
  -H 'x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==' \
  -d '{
  "Data": {
    "Permission": "Create",
    "Initiation": {
      "InstructionIdentification": "abcdefghijklmnop",
      "EndToEndIdentification": "DEMO USER",
      "RequestedExecutionDateTime": "2019-05-01T19:00:00-05:00",
      "LocalInstrument": "UK.OBIE.FPS",
      "InstructedAmount": {
        "Amount": "710.33",
        "Currency": "EUR"
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.IBAN",
        "Identification": "IE40BOFI90123968920165",
        "Name": "Tom Kirkman"
      },
      "RemittanceInformation": {
        "Reference": "DSR-037qwertyuiotrye",
        "Unstructured": "Internal ops code 5120103"
      }
    }
  },
  "Risk": {
    "PaymentContextCode": "PartyToParty"
  }
}'

This API endpoint allows the PISP to ask BOI to create a new domestic scheduled payment consents resource and the API responds with a unique Consent ID to refer to the resource.

POST response:domestic scheduled payment consents

HTTP/1.1 201 Created

x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODIwOSwiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..UzSO4Yw97FrpdpoxwOWqYPpi3kftH-wMclXXhh-2jpJc3hqPzQFkgyovr3uciTUGClY88DknV-ZwhyO3DJitboEX6su8K1REbLbtnX22EXmj1LIw9WYNYSmmf2D5TobHSzRvIsToUg-Tn2v7tl6asmjGYh1HUBF4JUUwgcrBiwlUBELNT_wlpXMe5lDpAcpDnXHYkvR2bZkcu995BEu31rCn4QppTxU7Aq82c0XuRsiOABuGExYbJWh55cSlVCBXt7ZKlGTf2ypXTFeeoDK48-ves6bOJYoTKQ8ywMkJf38tgtDsXdIpbwFT3rBTB6_N70F_DgM-dvCGj2jvS0PB9A
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json

{
    "Data": {
        "ConsentId": "58f09fb4-e6a0-4897-953f-a5a0a927d7ea",
        "CreationDateTime": "2019-02-06T11:12:10+00:00",
        "Status": "AwaitingAuthorisation",
        "StatusUpdateDateTime": "2019-02-06T11:12:10+00:00",
        "Permission": "Create",
        "ExpectedExecutionDateTime": "2019-02-07T11:12:10+00:00",
        "ExpectedSettlementDateTime": "2019-02-08T11:12:10+00:00",
        "Initiation": {
            "InstructionIdentification": "abcdefghijklmnop",
            "EndToEndIdentification": "DEMO USER",
            "LocalInstrument": "UK.OBIE.FPS",
            "RequestedExecutionDateTime": "2019-05-01T19:00:00-05:00",
            "InstructedAmount": {
                "Amount": "710.33",
                "Currency": "EUR"
            },
            "CreditorAccount": {
                "SchemeName": "UK.OBIE.IBAN",
                "Identification": "IE40BOFI90123968920165",
                "Name": "Tom Kirkman"
            },
            "RemittanceInformation": {
                "Unstructured": "Internal ops code 5120103",
                "Reference": "DSR-037qwertyuiotrye"
            }
        }
    },
    "Risk": {
        "PaymentContextCode": "PartyToParty"
    },
    "Links": {
        "Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/domestic-scheduled-payment-consents/58f09fb4-e6a0-4897-953f-a5a0a927d7ea"
    },
    "Meta": {}
}

Domestic standing order consents API

POST request:domestic standing order consents

curl -X POST \
 https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/domestic-standing-order-consents \
  -H 'Authorization: Bearer VS6VAWqqfI2sKOh4iuwgEgPPgduw' \
  -H 'Content-Type: application/json' \
  -H 'cache-control: no-cache' \
  -H 'x-fapi-customer-ip-address: 104.25.212.99' \
  -H 'x-fapi-customer-last-logged-time: Sun, 10 Sep 2017 19:43:31 UTC' \
  -H 'x-fapi-financial-id: 0015800000jfQ9aAAE' \
  -H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e' \
  -H 'x-idempotency-key: FRESCO.21302.GFX.23' \
  -H 'x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==' \
  -d '{
  "Data": {
    "Permission": "Create",
    "Initiation": {
      "Frequency": "IntrvlWkDay:01:03",
      "Reference": "3asdfaasg43534534653463",
      "FirstPaymentDateTime": "2019-03-01T06:06:06.777Z",
      "FirstPaymentAmount": {
        "Amount": "400.00",
        "Currency": "EUR"
      },
      "RecurringPaymentAmount": {
        "Amount": "400.00",
        "Currency": "EUR"
      },
      "FinalPaymentAmount": {
        "Amount": "400.00",
        "Currency": "EUR"
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.IBAN",
        "Identification": "IE40BOFI90123968920165",
        "Name": "Bob Clements",
        "SecondaryIdentification": "00e"
      }
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2020-12-31T06:06:06.777Z"
    }
  },
  "Risk": {
    "PaymentContextCode": "EcommerceServices",
    "MerchantCategoryCode": "0122",
    "MerchantCustomerIdentification": "Test",
    "DeliveryAddress": {
      "AddressLine": [
        "Test",
        "Test"
      ],
      "StreetName": "Test2",
      "BuildingNumber": "8",
      "PostCode": "ABCDEF 123456&&0",
      "CountrySubDivision": "Testsubdivision",
      "TownName": "Townname6780",
      "Country": "IE"
    }
  }
}'

This API endpoint allows the PISP to ask BOI to create a new domestic standing order consents resource and the API responds with a unique Consent ID to refer to the resource.

POST response:domestic standing order consents

x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODU4MCwiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..S9-ZingkHVC0WgDujBxQmztpuI-Fbr-qCYZU7iqGuYWADXMDPhP4_XO_tb5geTGdAT6JADDM9LaOG0J038ax1nPvT0MZMKYJ7mW7eiX8ZKtcwPWFMVlJLvYhG0lYSEJwNcuV0nkQQjVeqeCjiLM8CqkTmfVgdOdayAQgGgMEkxGRKsvX3ED8JWmqHuiiDlH-jrMjK-YtLf_QlUHV_WN-mHSywXJIJHpZFLMUO2bL59QgMcyIl5UuGJBPQCmpvAEGcHQSKGbOIJfJCAYyZREhs9ZoLbqIClJ7eUAbZO8h70u6aah2_pb0pv-b-yDSODb_Twot6_phQ-zOJI32RK87yg
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json

{
    "Data": {
        "ConsentId": "85484c7e-0442-4b14-b50d-c85fbbd9c89a",
        "CreationDateTime": "2019-02-06T12:54:59+00:00",
        "Status": "AwaitingAuthorisation",
        "StatusUpdateDateTime": "2019-02-06T12:54:59+00:00",
        "Permission": "Create",
        "CutOffDateTime": "2019-02-09T12:54:59+00:00",
        "Initiation": {
            "Frequency": "IntrvlWkDay:01:03",
            "Reference": "3asdfaasg43534534653463",
            "FirstPaymentDateTime": "2019-03-01T06:06:06.777Z",
            "FirstPaymentAmount": {
                "Amount": "400.00",
                "Currency": "EUR"
            },
            "RecurringPaymentAmount": {
                "Amount": "400.00",
                "Currency": "EUR"
            },
            "FinalPaymentAmount": {
                "Amount": "400.00",
                "Currency": "EUR"
            },
            "CreditorAccount": {
                "SchemeName": "UK.OBIE.IBAN",
                "Identification": "IE40BOFI90123968920165",
                "Name": "Bob Clements",
                "SecondaryIdentification": "00e"
            }
        },
        "Authorisation": {
            "AuthorisationType": "Any",
            "CompletionDateTime": "2020-12-31T06:06:06.777Z"
        }
    },
    "Risk": {
        "PaymentContextCode": "EcommerceServices",
        "MerchantCategoryCode": "0122",
        "MerchantCustomerIdentification": "Test",
        "DeliveryAddress": {
            "AddressLine": [
                "Test",
                "Test"
            ],
            "StreetName": "Test2",
            "BuildingNumber": "8",
            "PostCode": "ABCDEF 123456&&0",
            "TownName": "Townname6780",
            "CountrySubDivision": "Testsubdivision",
            "Country": "IE"
        }
    },
    "Links": {
        "Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/domestic-standing-order-consents/85484c7e-0442-4b14-b50d-c85fbbd9c89a"
    },
    "Meta": {}
}

International payment consents APIs'

POST request:international payment consents

This API endpoint allows the PISP to ask an ASPSP to create a new international payment consent resource.The POST action indicates to the ASPSP that an international payment consent has been staged. At this point, the PSU may not have been identified by the ASPSP, and the request payload may not contain any information of the account that should be debited.

The endpoint allows the PISP to send a copy of the consent (between PSU and PISP) to the ASPSP for the PSU to authorise. The ASPSP creates the international payment consent resource and responds with a unique Consent ID to refer to the resource.

POST /international-payment-consents HTTP/1.1

curl -X POST \
  https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/international-payment-consents \
  -H 'Authorization: Bearer JDosEEzJE0sJ15Wi01PEBJQGYpaB' \
  -H 'Content-Type: application/json' \
  -H 'cache-control: no-cache' \
  -H 'x-fapi-customer-ip-address: 104.25.212.99' \
  -H 'x-fapi-customer-last-logged-time: Sun, 10 Sep 2017 19:43:31 UTC' \
  -H 'x-fapi-financial-id: 0015800000jfQ9aAAE' \
  -H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e' \
  -H 'x-idempotency-key: FRESCO.21302.GFX.24' \
  -H 'x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==' \
  -d '{
  "Data": {
    "Initiation": {
      "InstructionIdentification": "International",
      "EndToEndIdentification": "FRESCO.21302.GFX.20",
      "InstructionPriority": "Normal",
      "Purpose": "Test",
      "CurrencyOfTransfer": "EUR",
      "ChargeBearer": "BorneByCreditor",
      "InstructedAmount": {
        "Amount": "910.22",
        "Currency": "EUR"
      },
      "ExchangeRateInformation": {
        "UnitCurrency": "GBP",
        "RateType": "Actual"
      },
      "Creditor": {
        "Name": "test",
        "PostalAddress": {
          "AddressType": "Business",
          "Department": "ABC",
          "SubDepartment": "DEF",
          "StreetName": "Test Street",
          "BuildingNumber": "Test Bldg Number",
          "PostCode": "Test Code",
          "TownName": "Test Town",
          "Country": "IE",
          "AddressLine": [
            "Flat 7",
            "Acacia Lodge"
          ]
        }
      },
      "RemittanceInformation": {
        "Unstructured": "Internal ops code 5120101",
        "Reference": "FRESCO-101"
      },
      "CreditorAgent": {
        "SchemeName": "BICFI",
        "Identification": "BOFIIE2DXXX",
        "Name": "test User",
        "PostalAddress": {
          "AddressType": "Business",
          "Department": "ABC",
          "SubDepartment": "DEF",
          "StreetName": "Test Street",
          "BuildingNumber": "Test Bldg Number",
          "PostCode": "Test Code",
          "TownName": "Test Town",
          "Country": "IE",
          "AddressLine": [
            "Flat 7",
            "Acacia Lodge"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.IBAN",
        "Identification": "IE40BOFI90123968920165",
        "Name": "Test user",
        "SecondaryIdentification": "2"
      }
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2019-12-29T18:00:00-06:00"
    }
  },
  "Risk": {
    "PaymentContextCode": "PartyToParty",
    "MerchantCategoryCode": "5967",
    "MerchantCustomerIdentification": "053598653254",
    "DeliveryAddress": {
      "StreetName": "AcaciaAvenue",
      "BuildingNumber": "27",
      "PostCode": "7U31 2ZZ",
      "TownName": "Sparsholt",
      "Country": "IE",
      "AddressLine": [
        "Flat 7",
        "Acacia Lodge"
      ]
    }
  }
}'

POST response: international payment consents

HTTP/1.1 201 Created

x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODIwOSwiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..UzSO4Yw97FrpdpoxwOWqYPpi3kftH-wMclXXhh-2jpJc3hqPzQFkgyovr3uciTUGClY88DknV-ZwhyO3DJitboEX6su8K1REbLbtnX22EXmj1LIw9WYNYSmmf2D5TobHSzRvIsToUg-Tn2v7tl6asmjGYh1HUBF4JUUwgcrBiwlUBELNT_wlpXMe5lDpAcpDnXHYkvR2bZkcu995BEu31rCn4QppTxU7Aq82c0XuRsiOABuGExYbJWh55cSlVCBXt7ZKlGTf2ypXTFeeoDK48-ves6bOJYoTKQ8ywMkJf38tgtDsXdIpbwFT3rBTB6_N70F_DgM-dvCGj2jvS0PB9A
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json

{
    "Data": {
        "ConsentId": "d4f92364-e27f-4c9f-b583-89a84bdf1b47",
        "CreationDateTime": "2019-02-06T10:52:50+00:00",
        "Status": "AwaitingAuthorisation",
        "StatusUpdateDateTime": "2019-02-06T10:52:50+00:00",
        "CutOffDateTime": "2019-02-09T10:52:50+00:00",
        "ExpectedExecutionDateTime": "2019-02-07T10:52:50+00:00",
        "ExpectedSettlementDateTime": "2019-02-08T10:52:50+00:00",
        "Charges": [
            {
                "ChargeBearer": "BorneByCreditor",
                "Type": "Type1",
                "Amount": {
                    "Amount": "5.00",
                    "Currency": "GBP"
                }
            }
        ],
        "ExchangeRateInformation": {
            "UnitCurrency": "GBP",
            "ExchangeRate": 1.2,
            "RateType": "Actual",
            "ContractIdentification": "mockedIdentification",
            "ExpirationDateTime": "2019-02-06T11:02:50+00:00"
        },
        "Initiation": {
            "InstructionIdentification": "International",
            "EndToEndIdentification": "FRESCO.21302.GFX.20",
            "InstructionPriority": "Normal",
            "Purpose": "Test",
            "ChargeBearer": "BorneByCreditor",
            "CurrencyOfTransfer": "EUR",
            "InstructedAmount": {
                "Amount": "910.22",
                "Currency": "EUR"
            },
            "ExchangeRateInformation": {
                "UnitCurrency": "GBP",
                "RateType": "Actual"
            },
            "Creditor": {
                "Name": "test",
                "PostalAddress": {
                    "AddressType": "Business",
                    "Department": "ABC",
                    "SubDepartment": "DEF",
                    "StreetName": "Test Street",
                    "BuildingNumber": "Test Bldg Number",
                    "PostCode": "Test Code",
                    "TownName": "Test Town",
                    "Country": "IE",
                    "AddressLine": [
                        "Flat 7",
                        "Acacia Lodge"
                    ]
                }
            },
            "CreditorAgent": {
                "SchemeName": "BICFI",
                "Identification": "BOFIIE2DXXX",
                "Name": "test User",
                "PostalAddress": {
                    "AddressType": "Business",
                    "Department": "ABC",
                    "SubDepartment": "DEF",
                    "StreetName": "Test Street",
                    "BuildingNumber": "Test Bldg Number",
                    "PostCode": "Test Code",
                    "TownName": "Test Town",
                    "Country": "IE",
                    "AddressLine": [
                        "Flat 7",
                        "Acacia Lodge"
                    ]
                }
            },
            "CreditorAccount": {
                "SchemeName": "UK.OBIE.IBAN",
                "Identification": "IE40BOFI90123968920165",
                "Name": "Test user",
                "SecondaryIdentification": "2"
            },
            "RemittanceInformation": {
                "Unstructured": "Internal ops code 5120101",
                "Reference": "FRESCO-101"
            }
        },
        "Authorisation": {
            "AuthorisationType": "Any",
            "CompletionDateTime": "2019-12-29T18:00:00-06:00"
        }
    },
    "Risk": {
        "PaymentContextCode": "PartyToParty",
        "MerchantCategoryCode": "5967",
        "MerchantCustomerIdentification": "053598653254",
        "DeliveryAddress": {
            "AddressLine": [
                "Flat 7",
                "Acacia Lodge"
            ],
            "StreetName": "AcaciaAvenue",
            "BuildingNumber": "27",
            "PostCode": "7U31 2ZZ",
            "TownName": "Sparsholt",
            "Country": "IE"
        }
    },
    "Links": {
        "Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/international-payment-consents/d4f92364-e27f-4c9f-b583-89a84bdf1b47"
    },
    "Meta": {}
}

GET request: international payment consents

A PISP can optionally retrieve a payment consent resource that they have created to check its status. The available status codes for the international payment consent resource are:

Status Description
AwaitingAuthorisation Before the PSU authorises the payment consent resource
Rejected If the PSU rejects the consent or the international payment consent has failed some other ASPSP validation
Authorised Once the PSU authorises the paymentconsent resource
Consumed Once aa international-payment has been successfully created using the international payment consent
GET /international-payment-consents/40eb0d07-2b8e-486e-b9a4-0e5404a1bd8a HTTP/1.1

curl -X GET \
  https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/international-payment-consents/d4f92364-e27f-4c9f-b583-89a84bdf1b47 \
  -H 'Authorization: Bearer JDosEEzJE0sJ15Wi01PEBJQGYpaB' \
  -H 'Content-Type: application/json' \
  -H 'cache-control: no-cache' \
  -H 'x-fapi-customer-ip-address: 104.25.212.99' \
  -H 'x-fapi-customer-last-logged-time: Sun, 10 Sep 2017 19:43:31 UTC' \
  -H 'x-fapi-financial-id: 0015800000jfQ9aAAE' \
  -H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e' \
  -H 'x-idempotency-key: FRESCO.21302.GFX.20' \

GET response: international-payment-consents

HTTP/1.1 200 OK
x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODU4MCwiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..S9-ZingkHVC0WgDujBxQmztpuI-Fbr-qCYZU7iqGuYWADXMDPhP4_XO_tb5geTGdAT6JADDM9LaOG0J038ax1nPvT0MZMKYJ7mW7eiX8ZKtcwPWFMVlJLvYhG0lYSEJwNcuV0nkQQjVeqeCjiLM8CqkTmfVgdOdayAQgGgMEkxGRKsvX3ED8JWmqHuiiDlH-jrMjK-YtLf_QlUHV_WN-mHSywXJIJHpZFLMUO2bL59QgMcyIl5UuGJBPQCmpvAEGcHQSKGbOIJfJCAYyZREhs9ZoLbqIClJ7eUAbZO8h70u6aah2_pb0pv-b-yDSODb_Twot6_phQ-zOJI32RK87yg
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json
{
    "Data": {
        "ConsentId": "d4f92364-e27f-4c9f-b583-89a84bdf1b47",
        "CreationDateTime": "2019-02-06T10:52:50+00:00",
        "Status": "AwaitingAuthorisation",
        "StatusUpdateDateTime": "2019-02-06T10:52:50+00:00",
        "CutOffDateTime": "2019-02-09T10:52:50+00:00",
        "ExpectedExecutionDateTime": "2019-02-07T10:52:50+00:00",
        "ExpectedSettlementDateTime": "2019-02-08T10:52:50+00:00",
        "Charges": [
            {
                "ChargeBearer": "BorneByCreditor",
                "Type": "Type1",
                "Amount": {
                    "Amount": "5.00",
                    "Currency": "GBP"
                }
            }
        ],
        "ExchangeRateInformation": {
            "UnitCurrency": "GBP",
            "ExchangeRate": 1.2,
            "RateType": "Actual",
            "ContractIdentification": "mockedIdentification",
            "ExpirationDateTime": "2019-02-06T11:02:50+00:00"
        },
        "Initiation": {
            "InstructionIdentification": "International",
            "EndToEndIdentification": "FRESCO.21302.GFX.20",
            "InstructionPriority": "Normal",
            "Purpose": "Test",
            "ChargeBearer": "BorneByCreditor",
            "CurrencyOfTransfer": "EUR",
            "InstructedAmount": {
                "Amount": "910.22",
                "Currency": "EUR"
            },
            "ExchangeRateInformation": {
                "UnitCurrency": "GBP",
                "RateType": "Actual"
            },
            "Creditor": {
                "Name": "test",
                "PostalAddress": {
                    "AddressType": "Business",
                    "Department": "ABC",
                    "SubDepartment": "DEF",
                    "StreetName": "Test Street",
                    "BuildingNumber": "Test Bldg Number",
                    "PostCode": "Test Code",
                    "TownName": "Test Town",
                    "Country": "IE",
                    "AddressLine": [
                        "Flat 7",
                        "Acacia Lodge"
                    ]
                }
            },
            "CreditorAgent": {
                "SchemeName": "BICFI",
                "Identification": "BOFIIE2DXXX",
                "Name": "test User",
                "PostalAddress": {
                    "AddressType": "Business",
                    "Department": "ABC",
                    "SubDepartment": "DEF",
                    "StreetName": "Test Street",
                    "BuildingNumber": "Test Bldg Number",
                    "PostCode": "Test Code",
                    "TownName": "Test Town",
                    "Country": "IE",
                    "AddressLine": [
                        "Flat 7",
                        "Acacia Lodge"
                    ]
                }
            },
            "CreditorAccount": {
                "SchemeName": "UK.OBIE.IBAN",
                "Identification": "IE40BOFI90123968920165",
                "Name": "Test user",
                "SecondaryIdentification": "2"
            },
            "RemittanceInformation": {
                "Unstructured": "Internal ops code 5120101",
                "Reference": "FRESCO-101"
            }
        },
        "Authorisation": {
            "AuthorisationType": "Any",
            "CompletionDateTime": "2019-12-29T18:00:00-06:00"
        }
    },
    "Risk": {
        "PaymentContextCode": "PartyToParty",
        "MerchantCategoryCode": "5967",
        "MerchantCustomerIdentification": "053598653254",
        "DeliveryAddress": {
            "AddressLine": [
                "Flat 7",
                "Acacia Lodge"
            ],
            "StreetName": "AcaciaAvenue",
            "BuildingNumber": "27",
            "PostCode": "7U31 2ZZ",
            "TownName": "Sparsholt",
            "Country": "IE"
        }
    },
    "Links": {
        "Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/international-payment-consents/d4f92364-e27f-4c9f-b583-89a84bdf1b47"
    },
    "Meta": {}
}

International scheduled payment consents API

POST request:international scheduled payment consents

POST /international-scheduled-payment-consents HTTP/1.1

curl -X POST \
  https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/international-scheduled-payment-consents \
  -H 'Authorization: Bearer JDosEEzJE0sJ15Wi01PEBJQGYpaB' \
  -H 'Content-Type: application/json' \
  -H 'cache-control: no-cache' \
  -H 'x-fapi-customer-ip-address: 104.25.212.99' \
  -H 'x-fapi-customer-last-logged-time: Sun, 10 Sep 2017 19:43:31 UTC' \
  -H 'x-fapi-financial-id: 0015800000jfQ9aAAE' \
  -H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e' \
  -H 'x-idempotency-key: FRESCO.21302.GFX.24' \
  -H 'x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==' \
  -d '{
  "Data": {
    "Permission": "Create",
    "Initiation": {
      "InstructionIdentification": "ACME412331",
      "EndToEndIdentification": "FRESCO.21302.GFX.20",
      "LocalInstrument": "UK.OBIE.SEPAInstantCreditTransfer",
      "InstructionPriority": "Normal",
      "Purpose": "",
      "RequestedExecutionDateTime": "2019-02-10T05:00:00Z",
      "CurrencyOfTransfer": "EUR",
      "InstructedAmount": {
        "Amount": "300.00",
        "Currency": "EUR"
      },
      "ExchangeRateInformation": {
        "UnitCurrency": "GBP",
        "RateType": "Actual"
      },
      "Creditor": {
        "Name": "NameTest",
        "PostalAddress": {
          "AddressType": "Business",
          "Department": "ABC",
          "SubDepartment": "DEF",
          "StreetName": "Test Street",
          "BuildingNumber": "Test Bldg Number",
          "PostCode": "Test Code",
          "TownName": "Test Town",
          "Country": "IE",
          "CountrySubDivision": "Test",
          "AddressLine": []
        }
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.IBAN",
        "Identification": "IE40BOFI90123968920165",
        "Name": "ACME Inc",
        "SecondaryIdentification": "ee"
      },
      "CreditorAgent": {
        "SchemeName": "UK.OBIE.BICFI",
        "Identification": "BOFIIE2DXXX",
        "Name": "Test",
        "PostalAddress": {
          "AddressType": "Residential",
          "Department": "ABC",
          "SubDepartment": "DEF",
          "StreetName": "Test Street",
          "BuildingNumber": "Test Bldg Number",
          "PostCode": "Test Code",
          "TownName": "Test",
          "Country": "IE",
          "CountrySubDivision": "Test1",
          "AddressLine": [
            "Test2",
            "Test3",
            "Test4"
          ]
        }
      },
      "RemittanceInformation": {
        "Reference": "FRESCO-101",
        "Unstructured": "Internal ops code 5120101"
      }
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2019-12-30T04:06:06.777-06:00"
    }
  },
  "Risk": {
    "PaymentContextCode": "PartyToParty",
    "MerchantCategoryCode": "0222",
    "MerchantCustomerIdentification": "Test",
    "DeliveryAddress": {
      "AddressLine": [
        "Test",
        "Acacia Lodge"
      ],
      "StreetName": "AcaciaAvenue",
      "BuildingNumber": "27",
      "PostCode": "7U31 2ZZ",
      "TownName": "Test",
      "Country": "IE",
      "CountrySubDivision": "Test"
    }
  }
}'

This API endpoint allows the PISP to ask BOI to create a new international scheduled payment consents resource and the API responds with a unique Consent ID to refer to the resource.

POST response: international scheduled payment consents


x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODIwOSwiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..UzSO4Yw97FrpdpoxwOWqYPpi3kftH-wMclXXhh-2jpJc3hqPzQFkgyovr3uciTUGClY88DknV-ZwhyO3DJitboEX6su8K1REbLbtnX22EXmj1LIw9WYNYSmmf2D5TobHSzRvIsToUg-Tn2v7tl6asmjGYh1HUBF4JUUwgcrBiwlUBELNT_wlpXMe5lDpAcpDnXHYkvR2bZkcu995BEu31rCn4QppTxU7Aq82c0XuRsiOABuGExYbJWh55cSlVCBXt7ZKlGTf2ypXTFeeoDK48-ves6bOJYoTKQ8ywMkJf38tgtDsXdIpbwFT3rBTB6_N70F_DgM-dvCGj2jvS0PB9A
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json

{
    "Data": {
        "ConsentId": "20ae99ae-7a47-4e8a-a117-adf3199d8a1e",
        "CreationDateTime": "2019-02-06T13:12:33+00:00",
        "Status": "AwaitingAuthorisation",
        "StatusUpdateDateTime": "2019-02-06T13:12:33+00:00",
        "Permission": "Create",
        "CutOffDateTime": "2019-02-09T13:12:33+00:00",
        "ExpectedExecutionDateTime": "2019-02-07T13:12:33+00:00",
        "ExpectedSettlementDateTime": "2019-02-08T13:12:33+00:00",
        "Charges": [
            {
                "ChargeBearer": "FollowingServiceLevel",
                "Type": "Type1",
                "Amount": {
                    "Amount": "3.00",
                    "Currency": "EUR"
                }
            }
        ],
        "ExchangeRateInformation": {
            "UnitCurrency": "GBP",
            "ExchangeRate": 1.2,
            "RateType": "Actual",
            "ContractIdentification": "mockedIdentification",
            "ExpirationDateTime": "2019-02-06T13:22:33+00:00"
        },
        "Initiation": {
            "InstructionIdentification": "ACME412331",
            "EndToEndIdentification": "FRESCO.21302.GFX.20",
            "LocalInstrument": "UK.OBIE.SEPAInstantCreditTransfer",
            "InstructionPriority": "Normal",
            "Purpose": "",
            "RequestedExecutionDateTime": "2019-02-10T05:00:00Z",
            "CurrencyOfTransfer": "EUR",
            "InstructedAmount": {
                "Amount": "300.00",
                "Currency": "EUR"
            },
            "ExchangeRateInformation": {
                "UnitCurrency": "GBP",
                "RateType": "Actual"
            },
            "Creditor": {
                "Name": "NameTest",
                "PostalAddress": {
                    "AddressType": "Business",
                    "Department": "ABC",
                    "SubDepartment": "DEF",
                    "StreetName": "Test Street",
                    "BuildingNumber": "Test Bldg Number",
                    "PostCode": "Test Code",
                    "TownName": "Test Town",
                    "CountrySubDivision": "Test",
                    "Country": "IE",
                    "AddressLine": []
                }
            },
            "CreditorAgent": {
                "SchemeName": "UK.OBIE.BICFI",
                "Identification": "BOFIIE2DXXX",
                "Name": "Test",
                "PostalAddress": {
                    "AddressType": "Residential",
                    "Department": "ABC",
                    "SubDepartment": "DEF",
                    "StreetName": "Test Street",
                    "BuildingNumber": "Test Bldg Number",
                    "PostCode": "Test Code",
                    "TownName": "Test",
                    "CountrySubDivision": "Test1",
                    "Country": "IE",
                    "AddressLine": [
                        "Test2",
                        "Test3",
                        "Test4"
                    ]
                }
            },
            "CreditorAccount": {
                "SchemeName": "UK.OBIE.IBAN",
                "Identification": "IE40BOFI90123968920165",
                "Name": "ACME Inc",
                "SecondaryIdentification": "ee"
            },
            "RemittanceInformation": {
                "Unstructured": "Internal ops code 5120101",
                "Reference": "FRESCO-101"
            }
        },
        "Authorisation": {
            "AuthorisationType": "Single",
            "CompletionDateTime": "2019-12-30T04:06:06.777-06:00"
        }
    },
    "Risk": {
        "PaymentContextCode": "PartyToParty",
        "MerchantCategoryCode": "0222",
        "MerchantCustomerIdentification": "Test",
        "DeliveryAddress": {
            "AddressLine": [
                "Test",
                "Acacia Lodge"
            ],
            "StreetName": "AcaciaAvenue",
            "BuildingNumber": "27",
            "PostCode": "7U31 2ZZ",
            "TownName": "Test",
            "CountrySubDivision": "Test",
            "Country": "IE"
        }
    },
    "Links": {
        "Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/international-scheduled-payment-consents/20ae99ae-7a47-4e8a-a117-adf3199d8a1e"
    },
    "Meta": {}
}

File payment consents API

POST request:file payment consents

This API endpoint allows the PISP to ask BOI to create a new file payment consent resource. The API endpoint allows the PISP to upload a file onto BOI against a file payment consent resource. BOI accepts JSON and XML format for the files. The supported file types are:

  • UK.OBIE.pain.001.001.08
  • UK.OBIE.PaymentInitiation.3.0
curl -X POST \
  https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/file-payment-consents \
  -H 'Authorization: Bearer jplwuoVyzqRi4UIzB2xvT0b3cGBy' \
  -H 'Content-Type: application/json' \
  -H 'Postman-Token: a7efd838-a81f-433f-8d5b-b01888e9ca32' \
  -H 'cache-control: no-cache' \
  -H 'x-fapi-financial-id: 0015800000jfQ9aAAE' \
  -H 'x-idempotency-key: FRESCO.21302.GFX.20' \
  -H 'x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0OTQ0NzQzMiwiY3JpdCI6WyJiNjQiLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCIsImh0dHA6XC9cL29wZW5iYW5raW5nLm9yZy51a1wvaXNzIl0sImtpZCI6IkNiRnhjLVRFbkNTRmMwcnhsMGN6TldTZXlwSSIsImN0eSI6ImFwcGxpY2F0aW9uXC9qc29uIiwidHlwIjoiSk9TRSIsImh0dHA6XC9cL29wZW5iYW5raW5nLm9yZy51a1wvaXNzIjoiQ049MWlKRmdVS3ZiSFdmVzFnN1FQOG4zNSxPVT0wMDE1ODAwMDAwamZROWFBQUUsTz1PcGVuQmFua2luZyxDPUdCIiwiYWxnIjoiUlMyNTYifQ..pdAgI6rYCIqRwqJPznSaQ0g6cq-oXzcM5eOcxHauB5z_aQGmvXqOVAsncj7pKd1_P-OOhxY_K0gRfBIvOn9uXkOgV12Gkne8PxDsNY_fC8py_nXI-YKA87l3tlI2uHETAJRnhdPRPE2EytfgPEkEtL6w8vLS5cTBneOkKMPYI-50K-4XH1ZDJqIy1G8JwSD6vZtZFi97_By-U4QSm53Lw3vJFIi2q0kV0cdV0u0FXyIEPZiBvYkJ_OF9ErerT3y6eE_zstIvTSb_7LndVV1npzxf6WSGtW7hYklu2n9dKc9YQNF4RggEAMFJIPbqMJTMkhNak2_MFiI2Wphb39FKbg' \
  -d '{
  "Data": {
    "Initiation": {
      "FileType": "UK.OBIE.pain.001.001.08",
      "FileHash": "CCiFOEK4V/cU/z0wNKs4MC1ElwBf0qQf23qVzNC/tHU=",
      "FileReference": "GB2OK238",
      "NumberOfTransactions": "101",
      "ControlSum": 444.0,
      "RequestedExecutionDateTime": "2019-12-30T18:00:00-06:00",
      "LocalInstrument": "UK.OBIE.BACS",
      "RemittanceInformation": {
        "Reference": "FRESCO-101",
        "Unstructured": "Internal ops code 5120101"
      }
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2019-12-30T18:00:00-06:00"
    }
  }
}'

POST response: /file payment consents

{
    "Data": {
        "ConsentId": "8cab7d3b-f759-4e65-847c-b1006d393be1",
        "CreationDateTime": "2019-02-06T13:22:36+00:00",
        "Status": "AwaitingUpload",
        "StatusUpdateDateTime": "2019-02-06T13:22:36+00:00",
        "CutOffDateTime": "2019-02-09T13:22:36+00:00",
        "Initiation": {
            "FileType": "UK.OBIE.pain.001.001.08",
            "FileHash": "CCiFOEK4V/cU/z0wNKs4MC1ElwBf0qQf23qVzNC/tHU=",
            "FileReference": "GB2OK238",
            "NumberOfTransactions": "101",
            "ControlSum": 444,
            "RequestedExecutionDateTime": "2019-12-30T18:00:00-06:00",
            "LocalInstrument": "UK.OBIE.BACS",
            "RemittanceInformation": {
                "Unstructured": "Internal ops code 5120101",
                "Reference": "FRESCO-101"
            }
        },
        "Authorisation": {
            "AuthorisationType": "Any",
            "CompletionDateTime": "2019-12-30T18:00:00-06:00"
        }
    },
    "Links": {
        "Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/file-payment-consents/8cab7d3b-f759-4e65-847c-b1006d393be1"
    },
    "Meta": {}
}

POST request: /file-payment consents/{ConsentId}/file

curl -X POST \
  https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/file-payment-consents/8cab7d3b-f759-4e65-847c-b1006d393be1/file \
  -H 'Authorization: Bearer jplwuoVyzqRi4UIzB2xvT0b3cGBy' \
  -H 'Content-Type: application/json' \
  -H 'Postman-Token: 3b1a7ad4-25b9-4be0-b315-92a417d6a482' \
  -H 'cache-control: no-cache' \
  -H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
  -H 'x-fapi-financial-id: 0015800000jfQ9aAAE' \
  -H 'x-idempotency-key: FRESCO.21302.GFX.21' \
  -H 'x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0OTI2MTQwNSwiY3JpdCI6WyJiNjQiLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCIsImh0dHA6XC9cL29wZW5iYW5raW5nLm9yZy51a1wvaXNzIl0sImtpZCI6IkNiRnhjLVRFbkNTRmMwcnhsMGN6TldTZXlwSSIsImN0eSI6ImFwcGxpY2F0aW9uXC9qc29uIiwidHlwIjoiSk9TRSIsImh0dHA6XC9cL29wZW5iYW5raW5nLm9yZy51a1wvaXNzIjoiQ049MWlKRmdVS3ZiSFdmVzFnN1FQOG4zNSxPVT0wMDE1ODAwMDAwamZROWFBQUUsTz1PcGVuQmFua2luZyxDPUdCIiwiYWxnIjoiUlMyNTYifQ..hSYgnvUB1CGCj7USo6fFonRO13iL9Wj3q2z6MRpVXFwtdKgXCrZmW1w60oy1qyFtT6zW4-WOf9tC0ikarMwPcgy6kn2A-7dV8tYMreoz3E-cHY7YrNl3koX2acFJm5Ljx9CLzWYVl85XMoqRIF9IKoz7zm3UHCJf8ty7lTfEM1vZEx7T7QDG7YoRRBllDxlksX2SNaIYBk-ND1OBkWGr5v17WLRL4YgWJeFdgq-ZFIVDNJaUlvccYKrp6IYSm2W-SWSq548YW7MWxzRe2aq7rmcS6RsH-lvyqujjcSdal9q6uXua4BD19iqVSNU28dxUCBgr_zd8v9kTy-gOVce14w' \
  -F 'FileParam=@C:\filepath\transaction.xml'

POST response: /file payment consents/{ConsentId}/file

200 OK

GET /file-payment-consents/{ConsentId} request

A PISP can retrieve a file payment consents resource that they have created to check its status.

curl -X GET \
  https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/file-payment-consents/8cab7d3b-f759-4e65-847c-b1006d393be1 \
  -H 'Authorization: Bearer jplwuoVyzqRi4UIzB2xvT0b3cGBy' \
  -H 'Content-Type: application/json' \
  -H 'Postman-Token: 45abbba4-c0dc-45b7-8a36-2f4e2c094dbd' \
  -H 'cache-control: no-cache' \
  -H 'x-fapi-financial-id: 0015800000jfQ9aAAE' \
  -H 'x-idempotency-key: 3453423' \

GET /file-payment-consents/{ConsentId} response

{
  "Data": {
      "ConsentId": "8cab7d3b-f759-4e65-847c-b1006d393be1",
      "CreationDateTime": "2019-02-06T13:22:36+00:00",
      "Status": "Consumed",
      "StatusUpdateDateTime": "2019-02-06T13:31:12+00:00",
      "CutOffDateTime": "2019-02-09T13:22:36+00:00",
      "Initiation": {
          "FileType": "UK.OBIE.pain.001.001.08",
          "FileHash": "CCiFOEK4V/cU/z0wNKs4MC1ElwBf0qQf23qVzNC/tHU=",
          "FileReference": "GB2OK238",
          "NumberOfTransactions": "101",
          "ControlSum": 444,
          "RequestedExecutionDateTime": "2019-12-30T18:00:00-06:00",
          "LocalInstrument": "UK.OBIE.BACS",
          "RemittanceInformation": {
              "Unstructured": "Internal ops code 5120101",
              "Reference": "FRESCO-101"
          }
      },
      "Authorisation": {
          "AuthorisationType": "Any",
          "CompletionDateTime": "2019-12-30T18:00:00-06:00"
      }
  },
  "Links": {
      "Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/file-payment-consents/8cab7d3b-f759-4e65-847c-b1006d393be1"
  },
  "Meta": {}
}

GET /file-payment-consents/{ConsentId}/file request

This endpoint returns the file in the same format as the one uploaded by the TPP.

curl -X GET \
  https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/file-payment-consents/8cab7d3b-f759-4e65-847c-b1006d393be1/file \
  -H 'Authorization: Bearer jplwuoVyzqRi4UIzB2xvT0b3cGBy' \
  -H 'Content-Type: application/json' \
  -H 'Postman-Token: c6da3771-03f2-4331-bb46-f0f8f1203aa8' \
  -H 'cache-control: no-cache' \
  -H 'x-fapi-financial-id: 0015800000jfQ9aAAE' \
  -H 'x-idempotency-key: FRESCO.21302.GFX.26' \

The API endpoint allows the PISP to download a file (that had been uploaded against a file-payment-consent resource) from BOI.

GET /file-payment-consents/{ConsentId}/file response

<?xml version="1.0" encoding="UTF-8" ?>
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:pain.001.001.08" xmlns:xsi="http://www.w3.org/2001/XMLSchema- instance">
    <CstmrCdtTrfInitn>
        <GrpHdr>
            <MsgId>ABC/120928/CCT001</MsgId>
            <CreDtTm>2012-09-28T14:07:00</CreDtTm>
            <NbOfTxs>3</NbOfTxs>
            <CtrlSum>11500000</CtrlSum>
            <InitgPty>
                <Nm>ABC 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>ABC/086</PmtInfId>
            <PmtMtd>TRF</PmtMtd>
            <BtchBookg>false</BtchBookg>
            <ReqdExctnDt>
                <Dt>2012-09-29</Dt>
            </ReqdExctnDt>
            <Dbtr>
                <Nm>ABC 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>
                    <Othr>
                        <Id>00125574999</Id>
                    </Othr>
                </Id>
            </DbtrAcct>
            <DbtrAgt>
                <FinInstnId>
                    <BICFI>BBBBUS33</BICFI>
                </FinInstnId>
            </DbtrAgt>
            <CdtTrfTxInf>
                <PmtId>
                    <InstrId>ABC/120928/CCT001/01</InstrId>
                    <EndToEndId>ABC/4562/2012-09-08</EndToEndId>
                </PmtId>
                <Amt>
                    <InstdAmt Ccy="JPY">10000000</InstdAmt>
                </Amt>
                <ChrgBr>SHAR</ChrgBr>
                <CdtrAgt>
                    <FinInstnId>
                        <BICFI>AAAAGB2L</BICFI>
                    </FinInstnId>
                </CdtrAgt>
                <Cdtr>
                    <Nm>DEF Electronics</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>GDDS</Cd>
                </Purp>
                <RmtInf>
                    <Strd>
                        <RfrdDocInf>
                            <Tp>
                                <CdOrPrtry>
                                    <Cd>CINV</Cd>
                                </CdOrPrtry>
                            </Tp>
                            <Nb>4562</Nb>
                            <RltdDt>2012-09-08</RltdDt>
                        </RfrdDocInf>
                    </Strd>
                </RmtInf>
            </CdtTrfTxInf>
            <CdtTrfTxInf>
                <PmtId>
                    <InstrId>ABC/120928/CCT001/2</InstrId>
                    <EndToEndId>ABC/ABC-13679/2012-09-15</EndToEndId>
                </PmtId>
                <Amt>
                    <InstdAmt Ccy="EUR">500000</InstdAmt>
                </Amt>
                <ChrgBr>CRED</ChrgBr>
                <CdtrAgt>
                    <FinInstnId>
                        <BICFI>DDDDBEBB</BICFI>
                    </FinInstnId>
                </CdtrAgt>
                <Cdtr>
                    <Nm>GHI Semiconductors</Nm>
                    <PstlAdr>
                        <StrtNm>Avenue Brugmann</StrtNm>
                        <BldgNb>415</BldgNb>
                        <PstCd>1180</PstCd>
                        <TwnNm>Brussels</TwnNm>
                        <Ctry>BE</Ctry>
                    </PstlAdr>
                </Cdtr>
                <CdtrAcct>
                    <Id>
                        <IBAN>BE30001216371411</IBAN>
                    </Id>
                </CdtrAcct>
                <InstrForCdtrAgt>
                    <Cd>PHOB</Cd>
                    <InstrInf>+32/2/2222222</InstrInf>
                </InstrForCdtrAgt>
                <Purp>
                    <Cd>GDDS</Cd>
                </Purp>
                <RmtInf>
                    <Strd>
                        <RfrdDocInf>
                            <Tp>
                                <CdOrPrtry>
                                    <Cd>CINV</Cd>
                                </CdOrPrtry>
                            </Tp>
                            <Nb>ABC-13679</Nb>
                            <RltdDt>2012-09-15</RltdDt>
                        </RfrdDocInf>
                    </Strd>
                </RmtInf>
            </CdtTrfTxInf>
            <CdtTrfTxInf>
                <PmtId>
                    <InstrId>ABC/120928/CCT001/3</InstrId>
                    <EndToEndId>ABC/987-AC/2012-09-27</EndToEndId>
                </PmtId>
                <Amt>
                    <InstdAmt Ccy="USD">1000000</InstdAmt>
                </Amt>
                <ChrgBr>SHAR</ChrgBr>
                <CdtrAgt>
                    <FinInstnId>
                        <BICFI>BBBBUS66</BICFI>
                    </FinInstnId>
                </CdtrAgt>
                <Cdtr>
                    <Nm>ABC Corporation</Nm>
                    <PstlAdr>
                        <Dept>Treasury department</Dept>
                        <StrtNm>Bush Street</StrtNm>
                        <BldgNb>13</BldgNb>
                        <PstCd>CA 94108</PstCd>
                        <TwnNm>San Francisco</TwnNm>
                        <Ctry>US</Ctry>
                    </PstlAdr>
                </Cdtr>
                <CdtrAcct>
                    <Id>
                        <Othr>
                            <Id>4895623</Id>
                        </Othr>
                    </Id>
                </CdtrAcct>
                <Purp>
                    <Cd>INTC</Cd>
                </Purp>
                <RmtInf>
                    <Strd>
                        <RfrdDocInf>
                            <Tp>
                                <CdOrPrtry>
                                    <Cd>CINV</Cd>
                                </CdOrPrtry>
                            </Tp>
                            <Nb>987-AC</Nb>
                            <RltdDt>2012-09-27</RltdDt>
                        </RfrdDocInf>
                    </Strd>
                </RmtInf>
            </CdtTrfTxInf>
        </PmtInf>
    </CstmrCdtTrfInitn>
</Document>

Reviews

Payment Initiation APIs doesn't have any reviews yet