Payment Initiation APIs

This section provides example of different requests and responses for the different Payments Submission APIs:

Domestic Payments APIs

Once the domestic payment consent has been authorised by the PSU, the PISP can proceed to submitting the domestic payments for processing by making a POST request to the domestic payments endpoint.

POST request: Domestic Payments submission

POST /domestic-payments HTTP/1.1

curl -X POST \
  https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/domestic-payments \
  -H 'Authorization: Bearer GExRm6odmyvi4KkLLPQ6gkZl5Vwc' \
  -H 'Content-Type: application/json' \
  -H 'Postman-Token: cadecc27-5c16-46c0-bbcc-00b7f9fcd219' \
  -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": {
    "ConsentId": "c4cd37de-aa69-4fbe-83aa-198b807948d6",
    "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"
      }
    }
  },
  "Risk": {
    "PaymentContextCode": "EcommerceGoods",
    "MerchantCategoryCode": "5967",
    "MerchantCustomerIdentification": "053598653254",
    "DeliveryAddress": {
      "AddressLine": [
        "Flat 7",
        "Acacia Lodge"
      ],
      "StreetName": "AcaciaAvenue",
      "BuildingNumber": "27",
      "PostCode": "7U31 2ZZ",
      "TownName": "Sparsholt",
      "Country": "IE"
    }
  }
}'

POST response: Domestic Payments submission

The following optional field(s) is/are not populated by BOI for this API:

• MultiAuthorisation.NumberRequired
• MultiAuthorisation.NumberReceived
• MultiAuthorisation.LastUpdateDateTime
• MultiAuthorisation.ExpirationDateTime

HTTP/1.1 201 Created

x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODcxNywiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..KLhgqQrAcYMugeVzd5-hFHwY40dmVpqwbt658alSHYTWi80JxiZXt5yiIHNMSJuO6eOKBXCjfl23FHtXkt-qSomv--r1orvYQGAV50Hux0zwNQT0FN7Lo43HjpuocWNKNbHF9asyz3z7D7spUFnBQm0zlmRRGqa3iOzWtCtpB7X9A58aBb1LLhNOk8KhMvF09SBh_5R1LSnqJB-vNlcBXInUDJFsiIsZxyUhU33Lsc7eW5mOdzwHPAiJnqzTlwzlJ689o4ZzYX0m7GL6QUl1pGIbZxFbESwgecN_QR5LN8pUZJ9Av9b8WJdz6M9aCOVVN6ZzRI82A-24o2lHNS20wg
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json

{
    "Data": {
        "DomesticPaymentId": "9fb620fe-9145-4594-81c0-39c82b30cb42",
        "ConsentId": "c4cd37de-aa69-4fbe-83aa-198b807948d6",
        "CreationDateTime": "2019-02-06T10:33:36+00:00",
        "Status": "AcceptedSettlementInProcess",
        "StatusUpdateDateTime": "2019-02-06T10:33:36+00:00",
        "ExpectedExecutionDateTime": "2019-02-07T10:33:36+00:00",
        "ExpectedSettlementDateTime": "2019-02-08T10:33:36+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"
            }
        },
        "MultiAuthorisation": {
            "Status": "Authorised",

        }
    },
    "Links": {
        "Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/domestic-payments/9fb620fe-9145-4594-81c0-39c82b30cb42"
    },
    "Meta": {}
}

A PISP can retrieve the domestic payment to check its status by making a GET request to the domestic payments endpoint with the DomesticPaymentId generated from the POST request.

GET request:Domestic Payments submission

GET /domestic-payments/b199886e-e661-488e-9313-f4062a8698c9 HTTP/1.1

curl -X GET \
  https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/domestic-payments/9fb620fe-9145-4594-81c0-39c82b30cb42 \
  -H 'Authorization: Bearer VS6VAWqqfI2sKOh4iuwgEgPPgduw' \
  -H 'Content-Type: application/json' \
  -H 'Postman-Token: c74aafda-b8b6-4308-9ec3-1190c55332b9' \
  -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: Domestic Payments submission

HTTP/1.1 200 OK

x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODcxNywiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..KLhgqQrAcYMugeVzd5-hFHwY40dmVpqwbt658alSHYTWi80JxiZXt5yiIHNMSJuO6eOKBXCjfl23FHtXkt-qSomv--r1orvYQGAV50Hux0zwNQT0FN7Lo43HjpuocWNKNbHF9asyz3z7D7spUFnBQm0zlmRRGqa3iOzWtCtpB7X9A58aBb1LLhNOk8KhMvF09SBh_5R1LSnqJB-vNlcBXInUDJFsiIsZxyUhU33Lsc7eW5mOdzwHPAiJnqzTlwzlJ689o4ZzYX0m7GL6QUl1pGIbZxFbESwgecN_QR5LN8pUZJ9Av9b8WJdz6M9aCOVVN6ZzRI82A-24o2lHNS20wg
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json

{
    "Data": {
        "DomesticPaymentId": "9fb620fe-9145-4594-81c0-39c82b30cb42",
        "ConsentId": "c4cd37de-aa69-4fbe-83aa-198b807948d6",
        "CreationDateTime": "2019-02-06T10:33:36+00:00",
        "Status": "AcceptedSettlementInProcess",
        "StatusUpdateDateTime": "2019-02-06T10:33:36+00:00",
        "ExpectedExecutionDateTime": "2019-02-07T10:33:36+00:00",
        "ExpectedSettlementDateTime": "2019-02-08T10:33:36+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"
            }
        },
        "MultiAuthorisation": {
            "Status": "Authorised",

        }
    },
    "Links": {
        "Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/domestic-payments/9fb620fe-9145-4594-81c0-39c82b30cb42"
    },
    "Meta": {}
}

Domestic scheduled payments APIs

POST request: Domestic scheduled payments

POST /domestic-scheduled-payments HTTP/1.1

curl -X POST \
  https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/domestic-scheduled-payments \
  -H 'Authorization: Bearer GExRm6odmyvi4KkLLPQ6gkZl5Vwc' \
  -H 'Content-Type: application/json' \
  -H 'Postman-Token: cadecc27-5c16-46c0-bbcc-00b7f9fcd219' \
  -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": {
    "ConsentId": "58f09fb4-e6a0-4897-953f-a5a0a927d7ea",
    "Initiation": {
      "InstructionIdentification": "abcdefghijklmnop",
      "EndToEndIdentification": "DEMO USER",
      "RequestedExecutionDateTime": "2019-05-01T19:00:00-05:00",
      "LocalInstrument": "UK.OBIE.FPS",
      "InstructedAmount": {
        "Amount": "300.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"
  }
}'

POST reponse: Domestic scheduled payments

x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODcxNywiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..KLhgqQrAcYMugeVzd5-hFHwY40dmVpqwbt658alSHYTWi80JxiZXt5yiIHNMSJuO6eOKBXCjfl23FHtXkt-qSomv--r1orvYQGAV50Hux0zwNQT0FN7Lo43HjpuocWNKNbHF9asyz3z7D7spUFnBQm0zlmRRGqa3iOzWtCtpB7X9A58aBb1LLhNOk8KhMvF09SBh_5R1LSnqJB-vNlcBXInUDJFsiIsZxyUhU33Lsc7eW5mOdzwHPAiJnqzTlwzlJ689o4ZzYX0m7GL6QUl1pGIbZxFbESwgecN_QR5LN8pUZJ9Av9b8WJdz6M9aCOVVN6ZzRI82A-24o2lHNS20wg
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json

{
    "Data": {
        "DomesticScheduledPaymentId": "a7cc1990-9c58-4a68-9f43-dc9025ffd825",
        "ConsentId": "58f09fb4-e6a0-4897-953f-a5a0a927d7ea",
        "CreationDateTime": "2019-02-06T11:22:08+00:00",
        "Status": "InitiationCompleted",
        "StatusUpdateDateTime": "2019-02-06T11:22:08+00:00",
        "ExpectedExecutionDateTime": "2019-02-07T11:22:08+00:00",
        "ExpectedSettlementDateTime": "2019-02-08T11:22:08+00:00",
        "Initiation": {
            "InstructionIdentification": "abcdefghijklmnop",
            "EndToEndIdentification": "DEMO USER",
            "LocalInstrument": "UK.OBIE.FPS",
            "RequestedExecutionDateTime": "2019-05-01T19:00:00-05:00",
            "InstructedAmount": {
                "Amount": "310.33",
                "Currency": "EUR"
            },
            "CreditorAccount": {
                "SchemeName": "UK.OBIE.IBAN",
                "Identification": "IE40BOFI90123968920165",
                "Name": "Tom Kirkman"
            },
            "RemittanceInformation": {
                "Unstructured": "Internal ops code 5120103",
                "Reference": "DSR-037qwertyuiotrye"
            }
        }
    },
    "Links": {
        "Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/domestic-scheduled-payments/a7cc1990-9c58-4a68-9f43-dc9025ffd825"
    },
    "Meta": {}
}

Domestic standing orders APIs

POST request: Domestic standing orders

POST /domestic-standing-orders HTTP/1.1

curl -X POST \
  https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/domestic-standing-orders \
  -H 'Authorization: Bearer GExRm6odmyvi4KkLLPQ6gkZl5Vwc' \
  -H 'Content-Type: application/json' \
  -H 'Postman-Token: cadecc27-5c16-46c0-bbcc-00b7f9fcd219' \
  -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": {
      "ConsentId": "85484c7e-0442-4b14-b50d-c85fbbd9c89a",
    "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"
      }
    }
  },
  "Risk": {
    "PaymentContextCode": "EcommerceServices",
    "MerchantCategoryCode": "0122",
    "MerchantCustomerIdentification": "Test",
    "DeliveryAddress": {
      "AddressLine": [
        "Test",
        "Test"
      ],
      "StreetName": "Test2",
      "BuildingNumber": "8",
      "PostCode": "ABCDEF 123456&",
      "CountrySubDivision": "Testsubdivision",
      "TownName": "Townname6780",
      "Country": "IE"
    }
  }
}'

POST response: Domestic standing orders

x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODcxNywiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..KLhgqQrAcYMugeVzd5-hFHwY40dmVpqwbt658alSHYTWi80JxiZXt5yiIHNMSJuO6eOKBXCjfl23FHtXkt-qSomv--r1orvYQGAV50Hux0zwNQT0FN7Lo43HjpuocWNKNbHF9asyz3z7D7spUFnBQm0zlmRRGqa3iOzWtCtpB7X9A58aBb1LLhNOk8KhMvF09SBh_5R1LSnqJB-vNlcBXInUDJFsiIsZxyUhU33Lsc7eW5mOdzwHPAiJnqzTlwzlJ689o4ZzYX0m7GL6QUl1pGIbZxFbESwgecN_QR5LN8pUZJ9Av9b8WJdz6M9aCOVVN6ZzRI82A-24o2lHNS20wg
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json
{
    "Data": {
        "DomesticStandingOrderId": "80c2bee9-304b-4052-94ba-f7578cc06e1e",
        "ConsentId": "85484c7e-0442-4b14-b50d-c85fbbd9c89a",
        "CreationDateTime": "2019-02-06T13:02:06+00:00",
        "Status": "InitiationPending",
        "StatusUpdateDateTime": "2019-02-06T13:02:06+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"
            }
        },
        "MultiAuthorisation": {
            "Status": "AwaitingFurtherAuthorisation",
            "NumberRequired": 2,
            "NumberReceived": 1,
            "LastUpdateDateTime": "2019-02-06T13:02:06+00:00",
            "ExpirationDateTime": "2019-02-09T13:02:06+00:00"
        }
    },
    "Links": {
        "Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/domestic-standing-orders/80c2bee9-304b-4052-94ba-f7578cc06e1e"
    },
    "Meta": {}
}

International Payments APIs

Once the international payment consent has been authorised by the PSU, the PISP can proceed to submitting the international payments for processing by making a POST request to the international payments endpoint. Note - The ExchangeRate and Charges block under Data block will be returned only if the Consent Status is "Authorised" or "Consumed".

POST request:International Payment submission

POST /international-payments HTTP/1.1

curl -X POST \
  https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/international-payments \
  -H 'Authorization: Bearer d4n2KALliFFjeTo6at1JhuKyB4Y7' \
  -H 'Content-Type: application/json' \
  -H 'Postman-Token: cadecc27-5c16-46c0-bbcc-00b7f9fcd219' \
  -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: 351' \
  -H 'x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==' \
  -d '{
  "Data": {
    "ConsentId": "d4f92364-e27f-4c9f-b583-89a84bdf1b47",
    "Initiation": {
      "InstructionIdentification": "International",
      "EndToEndIdentification": "FRESCO.21302.GFX.20",
      "InstructionPriority": "Normal",
      "Purpose": "Test",
      "CurrencyOfTransfer": "EUR",
      "ChargeBearer": "BorneByCreditor",
      "InstructedAmount": {
        "Amount": "300.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"
      }
    }
  },
  "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 Payments submission

HTTP/1.1 201 Created

x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODcxNywiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..KLhgqQrAcYMugeVzd5-hFHwY40dmVpqwbt658alSHYTWi80JxiZXt5yiIHNMSJuO6eOKBXCjfl23FHtXkt-qSomv--r1orvYQGAV50Hux0zwNQT0FN7Lo43HjpuocWNKNbHF9asyz3z7D7spUFnBQm0zlmRRGqa3iOzWtCtpB7X9A58aBb1LLhNOk8KhMvF09SBh_5R1LSnqJB-vNlcBXInUDJFsiIsZxyUhU33Lsc7eW5mOdzwHPAiJnqzTlwzlJ689o4ZzYX0m7GL6QUl1pGIbZxFbESwgecN_QR5LN8pUZJ9Av9b8WJdz6M9aCOVVN6ZzRI82A-24o2lHNS20wg
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json

{
    "Data": {
        "InternationalPaymentId": "325467fb-ac6f-48e0-b701-8415291de970",
        "ConsentId": "d4f92364-e27f-4c9f-b583-89a84bdf1b47",
        "CreationDateTime": "2019-02-06T11:09:52+00:00",
        "Status": "AcceptedSettlementInProcess",
        "StatusUpdateDateTime": "2019-02-06T11:09:52+00:00",
        "ExpectedExecutionDateTime": "2019-02-07T11:09:52+00:00",
        "ExpectedSettlementDateTime": "2019-02-08T11:09:52+00:00",
        "Charges": [
            {
                "ChargeBearer": "BorneByCreditor",
                "Type": "Type1",
                "Amount": {
                    "Amount": "3.00",
                    "Currency": "GBP"
                }
            }
        ],
        "ExchangeRateInformation": {
            "UnitCurrency": "GBP",
            "ExchangeRate": 1.2,
            "RateType": "Actual",
            "ContractIdentification": "mockedIdentification",
            "ExpirationDateTime": "2019-02-06T11:19:52+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"
            }
        },
        "MultiAuthorisation": {
            "Status": "Authorised",
            "NumberRequired": 2,
            "NumberReceived": 2,
            "LastUpdateDateTime": "2019-02-06T11:09:52+00:00",
            "ExpirationDateTime": "2019-02-09T11:09:52+00:00"
        }
    },
    "Links": {
        "Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/international-payments/325467fb-ac6f-48e0-b701-8415291de970"
    },
    "Meta": {}
}

A PISP can retrieve the international-payments to check its status by making a GET request to the international-payments endpoint with the internationalPaymentId generated from the POST request.

GET request: International Payments submission

GET /international-payments/7c64852c-53e3-4a00-99b4-608f1b525ba9 HTTP/1.1

curl -X GET \
  https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/international-payments/325467fb-ac6f-48e0-b701-8415291de970 \
  -H 'Authorization: Bearer MSdQrRyLqftG6NbSfOdSGntgPeTQ' \
  -H 'Content-Type: application/json' \
  -H 'Postman-Token: c74aafda-b8b6-4308-9ec3-1190c55332b9' \
  -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 International Payments submission response

HTTP/1.1 200 OK

x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODcxNywiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..KLhgqQrAcYMugeVzd5-hFHwY40dmVpqwbt658alSHYTWi80JxiZXt5yiIHNMSJuO6eOKBXCjfl23FHtXkt-qSomv--r1orvYQGAV50Hux0zwNQT0FN7Lo43HjpuocWNKNbHF9asyz3z7D7spUFnBQm0zlmRRGqa3iOzWtCtpB7X9A58aBb1LLhNOk8KhMvF09SBh_5R1LSnqJB-vNlcBXInUDJFsiIsZxyUhU33Lsc7eW5mOdzwHPAiJnqzTlwzlJ689o4ZzYX0m7GL6QUl1pGIbZxFbESwgecN_QR5LN8pUZJ9Av9b8WJdz6M9aCOVVN6ZzRI82A-24o2lHNS20wg
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json

{
    "Data": {
        "InternationalPaymentId": "325467fb-ac6f-48e0-b701-8415291de970",
        "ConsentId": "d4f92364-e27f-4c9f-b583-89a84bdf1b47",
        "CreationDateTime": "2019-02-06T11:09:52+00:00",
        "Status": "AcceptedSettlementInProcess",
        "StatusUpdateDateTime": "2019-02-06T11:09:52+00:00",
        "ExpectedExecutionDateTime": "2019-02-07T11:09:52+00:00",
        "ExpectedSettlementDateTime": "2019-02-08T11:09:52+00:00",
        "Charges": [
            {
                "ChargeBearer": "BorneByCreditor",
                "Type": "Type1",
                "Amount": {
                    "Amount": "3.00",
                    "Currency": "GBP"
                }
            }
        ],
        "ExchangeRateInformation": {
            "UnitCurrency": "GBP",
            "ExchangeRate": 1.2,
            "RateType": "Actual",
            "ContractIdentification": "mockedIdentification",
            "ExpirationDateTime": "2019-02-06T11:19:52+00:00"
        },
        "Initiation": {
            "InstructionIdentification": "International",
            "EndToEndIdentification": "FRESCO.21302.GFX.20",
            "InstructionPriority": "Normal",
            "Purpose": "Test",
            "ChargeBearer": "BorneByCreditor",
            "CurrencyOfTransfer": "EUR",
            "InstructedAmount": {
                "Amount": "300.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"
            }
        },
        "MultiAuthorisation": {
            "Status": "Authorised",
            "NumberRequired": 2,
            "NumberReceived": 2,
            "LastUpdateDateTime": "2019-02-06T11:09:52+00:00",
            "ExpirationDateTime": "2019-02-09T11:09:52+00:00"
        }
    },
    "Links": {
        "Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/international-payments/325467fb-ac6f-48e0-b701-8415291de970"
    },
    "Meta": {}
}

International scheduled payments APIs

POST request: International scheduled payments . Note - The ExchangeRate and Charges block under Data block will be returned only if the Consent Status is "Authorised" or "Consumed".

POST /international-scheduled-payments HTTP/1.1

curl -X POST \
  https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/international-scheduled-payments \
  -H 'Authorization: Bearer d4n2KALliFFjeTo6at1JhuKyB4Y7' \
  -H 'Content-Type: application/json' \
  -H 'Postman-Token: cadecc27-5c16-46c0-bbcc-00b7f9fcd219' \
  -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": {
    "ConsentId": "20ae99ae-7a47-4e8a-a117-adf3199d8a1e",
    "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": "Test",
        "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"
      }
    }
  },
  "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"
    }
  }
}'

POST response: International scheduled payments

x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODcxNywiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..KLhgqQrAcYMugeVzd5-hFHwY40dmVpqwbt658alSHYTWi80JxiZXt5yiIHNMSJuO6eOKBXCjfl23FHtXkt-qSomv--r1orvYQGAV50Hux0zwNQT0FN7Lo43HjpuocWNKNbHF9asyz3z7D7spUFnBQm0zlmRRGqa3iOzWtCtpB7X9A58aBb1LLhNOk8KhMvF09SBh_5R1LSnqJB-vNlcBXInUDJFsiIsZxyUhU33Lsc7eW5mOdzwHPAiJnqzTlwzlJ689o4ZzYX0m7GL6QUl1pGIbZxFbESwgecN_QR5LN8pUZJ9Av9b8WJdz6M9aCOVVN6ZzRI82A-24o2lHNS20wg
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json
{
    "Data": {
        "InternationalScheduledPaymentId": "672d6dc9-bf61-4cfe-b14d-eecfc5c0970b",
        "ConsentId": "20ae99ae-7a47-4e8a-a117-adf3199d8a1e",
        "CreationDateTime": "2019-02-06T13:17:03+00:00",
        "Status": "InitiationCompleted",
        "StatusUpdateDateTime": "2019-02-06T13:17:03+00:00",
        "ExpectedExecutionDateTime": "2019-02-07T13:17:03+00:00",
        "ExpectedSettlementDateTime": "2019-02-08T13:17:03+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:27:03+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": "Test",
                "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"
            }
        },
        "MultiAuthorisation": {
            "Status": "Authorised",
            "NumberRequired": 2,
            "NumberReceived": 2,
            "LastUpdateDateTime": "2019-02-06T13:17:03+00:00",
            "ExpirationDateTime": "2019-02-09T13:17:03+00:00"
        }
    },
    "Links": {
        "Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/international-scheduled-payments/672d6dc9-bf61-4cfe-b14d-eecfc5c0970b"
    },
    "Meta": {}
}