International Standing Orders - v3.1.2

1. Overview
2. Endpoints
   1. POST /international-standing-orders
      1. Status
   2. GET /international-standing-orders/{InternationalStandingOrderPaymentId}
      1. Status
   3. GET /international-standing-orders/{InternationalStandingOrderPaymentId}/payment-details
      1. Status
   4. State Model
      1. Payment Order
         1. Multiple Authorisation
3. Data Model
   1. Reused Classes
      1. OBInternationalStandingOrder3
   2. International Standing Order - Request
      1. UML Diagram
      2. Notes
      3. Data Dictionary
   3. International Standing Order - Response
      1. UML Diagram
      2. Notes
      3. Data Dictionary
   4. International Standing Order - Payment Details - Response
      1. UML Diagram
      2. Data Dictionary
4. Usage Examples
   1. POST /international-standing-orders
      1. Request
      2. Response

Overview

The International Standing Orders resource is used by a PISP to initiate an International Standing Order.

This resource description should be read in conjunction with a compatible Payment Initiation API Profile.

Endpoints

POST /international-standing-orders

Once the international-standing-order-consent has been authorised by the PSU, the PISP can proceed to submit the international-standing-orders for processing:

• This is done by making a POST request to the international-standing-orders endpoint.
• This request is an instruction to the ASPSP to begin the international standing order journey. The PISP must submit the international standing order immediately, however, there are some scenarios where the ASPSP may not warehouse the international standing order immediately (e.g. busy periods at the ASPSP).
• The PISP must ensure that the Initiation and Risk sections of the international-standing-orders match the corresponding Initiation and Risk sections of the international-standing-order-consent resource. If the two do not match, the ASPSP must not process the request and must respond with a 400 (Bad Request).
• Any operations on the international-standing-orders resource will not result in a Status change for the international-standing-orders resource.

Status

An international-standing-orders can only be created if its corresponding international-standing-order-consent resource has the status of “Authorised”.

The international-standing-orders resource that is created successfully must have one of the following Status codes:

GET /international-standing-orders/{InternationalStandingOrderPaymentId}

A PISP can retrieve the international-standing-orders to check its status.

Status

The international-standing-orders resource must have one of the following Status codes:

GET /international-standing-orders/{InternationalStandingOrderPaymentId}/payment-details

A PISP can retrieve the Details of the underlying payment transaction via this endpoint. This resource allows ASPSPs to return richer list of Payment Statuses, and if available payment scheme related statuses.

Status

The international-standing-orders - payment-details must have one of the following PaymentStatusCode code-set enumerations:

State Model

Payment Order

The state model for the international-standing-orders resource describes the initiation status only. I.e., not the subsequent execution of the international-standing-orders.

The definitions for the Status:

Multiple Authorisation

If the payment-order requires multiple authorisations, the Status of the multiple authorisations will be updated in the MultiAuthorisation object.

The definitions for the Status:

Data Model

The data dictionary section gives the detail on the payload content for the International Standing Order API flows.

Reused Classes

OBInternationalStandingOrder3

The OBInternationalStandingOrder3 class is defined in the international-standing-order-consents page.

International Standing Order - Request

The OBWriteInternationalStandingOrder3 object will be used for a call to:

• POST /international-standing-orders

UML Diagram

Notes

The international-standing-orders request object contains the:

• ConsentId.
• The full Initiation and Risk objects from the international-standing-order-consent request.

The Initiation and Risk sections of the international-standing-orders request must match the Initiation and Risk sections of the corresponding international-standing-order-consent request.

Data Dictionary

International Standing Order - Response

The OBWriteInternationalStandingOrderResponse4 object will be used for a response to a call to:

• POST /international-standing-orders
• GET /international-standing-orders/{InternationalStandingOrderPaymentId}

UML Diagram

Notes

The international-standing-orders response object contains the:

• InternationalStandingOrderPaymentId.
• ConsentId.
• CreationDateTime the international-standing-orders resource was created.
• Status and StatusUpdateDateTime of the international-standing-orders resource.
• The Charges in the international-standing-order-consent response from the ASPSP.
• The Initiation object from the international-standing-order-consent.
• The MultiAuthorisation object if the international-standing-order resource requires multiple authorisations.

Data Dictionary

International Standing Order - Payment Details - Response

The OBWritePaymentDetailsResponse1 object will be used for a response to a call to:

• GET /international-standing-orders/{InternationalStandingOrderPaymentId}/payment-details

UML Diagram

Data Dictionary

Usage Examples

POST /international-standing-orders

Request

POST /international-standing-orders HTTP/1.1
Authorization: Bearer eYJQLMQLMQLM
x-idempotency-key: FRESNO.1317.GFX.22
x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==
x-fapi-auth-date:  Mon, 01 Jan 2018 02:43:31 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
Accept: application/json

{
  "Data": {
	"ConsentId": "ISOC-100",
    "Initiation": {
	  "Frequency": "EvryWorkgDay",
	  "FirstPaymentDateTime": "2018-06-06T06:06:06+00:00",
	  "FinalPaymentDateTime": "2020-03-20T06:06:06+00:00",
	  "DebtorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "11280001234567",
        "Name": "Andrea Frost"
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.IBAN",
        "Identification": "DE89370400440532013000",
        "Name": "Tom Kirkman"
      },
	  "InstructedAmount": {
        "Amount": "20",
        "Currency": "EUR"
	  },
	  "CurrencyOfTansfer":"EUR"
    }
  },
  "Risk": {
    "PaymentContextCode": "PartyToParty"
  }
}

Response

HTTP/1.1 201 Created
x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json

{
  "Data": {
    "InternationalStandingOrderId": "SO-ISOC-100",
    "ConsentId": "ISOC-100",
    "CreationDateTime": "2018-01-01T06:06:36+00:00",
    "Status": "InitiationCompleted",
    "StatusUpdateDateTime": "2018-01-01T06:36:06+00:00",
    "Initiation": {
      "Frequency": "EvryWorkgDay",
      "FirstPaymentDateTime": "2018-06-06T06:06:06+00:00",
      "FinalPaymentDateTime": "2020-03-20T06:06:06+00:00",
      "DebtorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "11280001234567",
        "Name": "Andrea Frost"
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.IBAN",
        "Identification": "DE89370400440532013000",
        "Name": "Tom Kirkman"
      },
      "InstructedAmount": {
        "Amount": "20",
        "Currency": "EUR"
      },
      "CurrencyOfTansfer":"EUR"
    }
  },
  "Risk": {
    "PaymentContextCode": "PartyToParty"
  },
  "Links": {
    "Self": "https://api.alphabank.com/open-banking/v3.1/pisp/international-standing-orders/SO-ISOC-100"
  },
  "Meta": {}
}