Page Comparison

...

Expand

title	Click here to see how it is done

POST /international-standing-order-consents

The API endpoint allows the PISP to ask an ASPSP to create a new international-standing-order-consent resource. The ASPSP creates the resource and responds with a unique ConsentId to refer to the resource.

Use the following format in the consent body.

Code Block

 "Data": {
    "Permission": "Create",
    "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"
    }
  }

Add all mandatory headers:
- x-fapi-financial-id - The unique id of the ASPSP to which the request is issued. This id will be issued by the OBIE.
- Authorization - An Authorisation Token as per https://tools.ietf.org/html/rfc6750. Enter the application access token, you generated from the above step.
- x-idempotency-key - Every request will be processed only once per x-idempotency-key. The Idempotency key will be valid for 24 hours.
- x-jws-signature - A detached JWS signature of the body of the payload.

A sample request follows the format given below.

Code Block

curl POST \
  https://<WSO2_OB_APIM_HOST>:8243/open-banking/v3.1/pisp/international-standing-order-consents HTTP/1.1
Authorization: Bearer <APPLICATION_ACCESS_TOKEN>
 \
  -H 'x-fapi-financial-id: open-bank' \
  -H 'x-idempotency-key: FRESCO.21302.GFX.20
x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==
x-fapi-financial-id: OB/2017/001
x-fapi-customer-last-logged-time:  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
 
{
  "284522' \
  -H 'Authorization: Bearer <APPLICATION_ACCESS-TOKEN>' \
  -H 'Accept: application/json' \
  -H x-jws-signature: eyJhbGciOiJQUzI1NiIsImtpZCI6Imp5UlVjeXQxa1ZDbGNJdmxVbGNEdWtWWjN0VSIsImNyaXQiOlsiaHR0cDovL29wZW5iYW5raW5nLm9yZy51ay9pYXQiLCJodHRwOi8vb3BlbmJhbmtpbmcub3JnLnVrL3RhbiIsImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaXNzIl0sImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaWF0IjoxNjAxOTYzNTY0LCJodHRwOi8vb3BlbmJhbmtpbmcub3JnLnVrL3RhbiI6Im9wZW5iYW5raW5nLm9yZy51ayIsImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaXNzIjoiQ049U0NtRXY5R1FlQnJuZFBaTlo1QVdObiwgT1U9MDAxNTgwMDAwMUhRUXJaQUFYLCBPPU9wZW5CYW5raW5nLCBDPUdCIn0..EgSyHe5LyLJK33HGSdLFjNl5ND6BULvPM7qrfllLKiYOPaq911LqCFsyX1-jLQqxrZdXrC5kq-Q3_u4IgN0iYjfCFilB7eIScKyClkHrv_6qLgOnSYR4kKPsBmzFFKfgF_Eg82LioERbTvEAB0eoBQ4sLJT1HCfdIuIj-U78WSSqUImDsPsPjaksIWwaEzTu-I-UFOghRoYrC59MVZ80WG07q2xIhV1q6ddt00kE9-EdLqnt-7dJL3jHnM7dstidLCYRz5NyO5aK0FUnFPEc8MaO8-PaQu1X99M7qPlUv659-M6JMVJSzFntDgulYalJxo-P02hNDLKYIqNx2uujnQ' \
  -H 'charset: UTF-8' \
  -H 'Content-Type: application/json; charset=UTF-8' \
  --cert <PUBLIC_KEY_FILE_PATH> --key <PRIVATE_KEY_FILE_PATH> \
-d '{
  "Data": {
    "Permission": "Create",
    "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"
  }
}'

The response will bear the ConsentId.

Code Block

HTTP/1.1 201 Createdx-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
 
 
{
  "Data": {
    "ConsentId": "ISOC-100",
    "CreationDateTime": "2018-01-01T06:06:06+00:00",
    "Status": "AwaitingAuthorisation",
    "StatusUpdateDateTime": "2018-01-01T06:06:06+00:00",
    "Permission": "Create",
    "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://obank.com/open-banking/v3.1/pisp/international-standing-order-consents/ISOC-100"
  },
  "Meta": {}
}

GET /international-standing-order-consents/{ConsentId}

A PISP is able to retrieve a payment consent resource that they have created to check its status. The PISP must have an access token issued by the ASPSP using a client credentials grant.

Add the mandatory headers.
- ConsentId - The unique id of the consent which you want to retrieve.
- x-fapi-financial-id - The unique id of the ASPSP to which the request is issued. This id will be issued by the OBIE.
- Authorization - An Authorisation Token as per https://tools.ietf.org/html/rfc6750. Enter the application access token, you generated from the above step.

A sample request follows the format given below.Following are the sample request and response:

Localtabgroup

Localtab

title	Request

Code Block
curl GET \https://<WSO2_OB_APIM_HOST>:8243/open-banking/v3.1/pisp/international-standing-order-consents/

<ConsentId> HTTP/1.1Authorization: Bearer <APPLICATION_ACCESS_TOKEN>

<CONSENT_ID> \
  -H 'x-fapi-financial-id

: OB/2017/001 x-fapi-customer-last-logged-time: Sun, 10 Sep 2017 19:43:31 GMT x-fapi-customer-ip-address: 104.25.212.99 x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d Accept: application/json

Multiexcerpt include

MultiExcerptName	UserAccessToken
PageWithExcerpt	Domestic Payments v3.1.1

Step 13 - Invoke payment submission API

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 request is an instruction to the ASPSP to begin the process of the international standing order.

The PISP must ensure that the Initiation and Risk sections of the international standing order match the corresponding Initiation and Risk sections of the international standing order consent resource.
Any operations on the domestic-standing-order resource will not result in a status change for the domestic-standing-order resource.

The response contains InternationalStandingOrderPaymentId along with the payment submission details.

...

title	Request

...

=open-bank' \
  -H 'Authorization=Bearer <APPLICATION_ACCESS_TOKEN>' \
  -H 'Accept=application/json' \
  -H 'charset=UTF-8' \
  -H 'Content-Type=application/json; charset=UTF-8' \
  --cert <PUBLIC_KEY_FILE_PATH> --key <PRIVATE_KEY_FILE_PATH> \

Localtab

title	Response

Code Block

{
    "Meta": {
         
    },
    "Risk": {
        "PaymentContextCode": "EcommerceGoods",
        "DeliveryAddress": {
            "StreetName": "Acacia Avenue",
            "CountrySubDivision": "Wessex",
            "AddressLine": [
                "Flat 7",
                "Acacia Lodge"
            ],
            "BuildingNumber": "27",
            "TownName": "Sparsholt",
            "Country": "UK",
            "PostCode": "GU31 2ZZ"
        },
        "MerchantCategoryCode": "5967",
        "MerchantCustomerIdentification": "053598653254"
    },
    "Links": {
        "Self": "https://<WSO2_OB_APIM_HOST>:8243/open-banking/v3.1/pisp/international-standing-order-consents/69115b8d-3a45-4d06-9613-f2bc9f532e1d"
    },
    "Data": {
        "Status": "Authorised",
        "StatusUpdateDateTime": "2020-10-06T05:56:15Z",
        "SCASupportData": {
            "RequestedSCAExemptionType": "BillPayment",
            "AppliedAuthenticationApproach": "CA",
            "ReferencePaymentOrderId": "string"
        },
        "CreationDateTime": "2020-10-06T05:52:45Z",
        "Authorisation": {
            "CompletionDateTime": "2020-10-11T05:52:37.236Z",
            "AuthorisationType": "Any"
        },
        "Permission": "Create",
        "ConsentId": "69115b8d-3a45-4d06-9613-f2bc9f532e1d",
        "ReadRefundAccount": "Yes",
        "Initiation": {
            "DebtorAccount": {
                "SecondaryIdentification": "30080012343456",
                "SchemeName": "UK.OBIE.SortCodeAccountNumber",
                "Identification": "30080012343456",
                "Name": "Andrea Smith"
            },
            "Reference": "Pocket money for Damien",
            "CurrencyOfTransfer": "USD",
            "CreditorAccount": {
                "SecondaryIdentification": "0002",
                "SchemeName": "UK.OBIE.SortCodeAccountNumber",
                "Identification": "08080021325698",
                "Name": "ACME Inc"
            },
            "Frequency": "EvryDay",
            "Purpose": "1234",
            "ChargeBearer": "BorneByCreditor",
            "FirstPaymentDateTime": "2020-10-07T05:52:37.102Z",
            "Creditor": {
                "PostalAddress": {
                    "StreetName": "Acacia Avenue",
                    "CountrySubDivision": "Wessex",
                    "Department": "department1",
                    "AddressLine": [
                        "Flat 7",
                        "Acacia Lodge"
                    ],
                    "BuildingNumber": "27",
                    "TownName": "Sparsholt",
                    "Country": "UK",
                    "SubDepartment": "sub dept",
                    "AddressType": "Correspondence",
                    "PostCode": "GU31 2ZZ"
                },
                "Name": "ACME Inc"
            },
            "FinalPaymentDateTime": "2020-10-11T05:52:37.102Z",
            "InstructedAmount": {
                "Amount": "30.80",
                "Currency": "GBP"
            }
        }
    }
}

Multiexcerpt include

MultiExcerptName	UserAccessToken
PageWithExcerpt	Domestic Payments v3.1.1

Step 13 - Invoke payment submission API

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 request is an instruction to the ASPSP to begin the process of the international standing order.

The PISP must ensure that the Initiation and Risk sections of the international standing order match the corresponding Initiation and Risk sections of the international standing order consent resource.
Any operations on the domestic-standing-order resource will not result in a status change for the domestic-standing-order resource.

The response contains InternationalStandingOrderPaymentId along with the payment submission details.

Localtabgroup

Localtab

title	Request

Code Block

curl POST \
  https://<WSO2_OB_APIM_HOST>:8243/open-banking/v3.1/pisp/international-standing-orders \
  -H 'x-fapi-financial-id: open-bank' \
  -H 'x-idempotency-key: 135953' \
  -H 'Authorization: Bearer <USER_ACCESS_TOKEN>' \
  -H 'Accept: application/json' \
  -H 'x-jws-signature: eyJhbGciOiJQUzI1NiIsImtpZCI6Imp5UlVjeXQxa1ZDbGNJdmxVbGNEdWtWWjN0VSIsImNyaXQiOlsiaHR0cDovL29wZW5iYW5raW5nLm9yZy51ay9pYXQiLCJodHRwOi8vb3BlbmJhbmtpbmcub3JnLnVrL3RhbiIsImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaXNzIl0sImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaWF0IjoxNjAxOTYzODI1LCJodHRwOi8vb3BlbmJhbmtpbmcub3JnLnVrL3RhbiI6Im9wZW5iYW5raW5nLm9yZy51ayIsImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaXNzIjoiQ049U0NtRXY5R1FlQnJuZFBaTlo1QVdObiwgT1U9MDAxNTgwMDAwMUhRUXJaQUFYLCBPPU9wZW5CYW5raW5nLCBDPUdCIn0..J60h0upifLqqAoVVQhyCvMUVmA17NFBof79AaZxlZ-Z_bviuRmiDGGP8bSg_iUn-H3Tf6PyLWvQaFmJsjG6Wj1rcosZhbVpySiAlH5iGLMioJCHSocFhsG-pIUeo7MHsibXK1n9aPdsoP3Enz-8t8_MHcs4V1tMLm9rE7QGw8pTEyV4P3SllgVClVeeeBKrG47sqjo0kuWqifm0e-BJ0zPmSdaMd6Rx4iWUpwJb1EfHMbg7_6fcE79w74xeKFTBLM67BEwA_yryIWDwdVd5rR123Rq2C_6dP6tR4-bMAkDvXN3z5nhnXMeXKJm5VCH86YqUit8ZmVVTtGiDa9hexSg' \
  -H 'charset: UTF-8' \
  -H 'Content-Type: application/json; charset=UTF-8' \
  --cert <PUBLIC_KEY_FILE_PATH> --key <PRIVATE_KEY_FILE_PATH> \
-d '{
  "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"
  }
}'

GET /international-standing-orders/{InternationalStandingOrderPaymentId}

The PISP retrieves the international standing orders resource to check its status.

Localtabgroup

Localtab

title	Request

Code Block

curl GET \
  https://<WSO2_OB_APIM_HOST>:8243/open-banking/v3.1/pisp/international-standing-orders/<INTERNATIONAL_STANDING_ORDER_PAYMENT_ID>
  -H 'x-fapi-financial-i: open-bank' \
  -H 'Authorization: Bearer <USER_ACCESS_TOKEN>' \
  -H 'Accept: application/json' \
  -H 'charset: UTF-8' \
  -H 'Content-Type: application/json; charset=UTF-8' \
  --cert <PUBLIC_KEY_FILE_PATH> --key <PRIVATE_KEY_FILE_PATH> \

Localtab

title	Response

Code Block

{
    "Meta": {
         
    },
    "Links": {
        "Self": "/international-standing-orders/69115b8d-3a45-4d06-9613-f2bc9f532e1d-57"
    },
    "Data": {
        "Status": "InitiationCompleted",
        "StatusUpdateDateTime": "2020-10-06T05:57:05Z",
        "CreationDateTime": "2020-10-06T05:57:05Z",
        "InternationalStandingOrderId": "69115b8d-3a45-4d06-9613-f2bc9f532e1d-57",
        "ConsentId": "69115b8d-3a45-4d06-9613-f2bc9f532e1d",
        "Initiation": {
            "DebtorAccount": {
                "SecondaryIdentification": "30080012343456",
                "SchemeName": "UK.OBIE.SortCodeAccountNumber",
                "Identification": "30080012343456",
                "Name": "Andrea Smith"
            },
            "Reference": "Pocket money for Damien",
            "CurrencyOfTransfer": "USD",
            "CreditorAccount": {
                "SecondaryIdentification": "0002",
                "SchemeName": "UK.OBIE.SortCodeAccountNumber",
                "Identification": "08080021325698",
                "Name": "ACME Inc"
            },
            "Frequency": "EvryDay",
            "Purpose": "1234",
            "ChargeBearer": "BorneByCreditor",
            "FirstPaymentDateTime": "2020-10-07T05:52:37.102Z",
            "NumberOfPayments": "10",
            "Creditor": {
                "PostalAddress": {
                    "StreetName": "Acacia Avenue",
                    "CountrySubDivision": "Wessex",
                    "Department": "department1",
                    "AddressLine": [
                        "Flat 7",
                        "Acacia Lodge"
                    ],
                    "BuildingNumber": "27",
                    "TownName": "Sparsholt",
                    "Country": "UK",
                    "SchemeNameSubDepartment": "UK.OBIE.SortCodeAccountNumbersub dept",
          "Identification": "11280001234567",         "NameAddressType": "Andrea FrostCorrespondence",
      },       "CreditorAccount": {
        "SchemeNamePostCode": "UK.OBIE.IBAN",GU31 2ZZ"
               "Identification": "DE89370400440532013000" },
        "Name": "Tom Kirkman"       },
"Name": "ACME Inc"
     "InstructedAmount": {      },
  "Amount": "20",         "CurrencyFinalPaymentDateTime": "EUR"2020-10-11T05:52:37.102Z",
      },
      "CurrencyOfTansferInstructedAmount":"EUR" {
    }   },   "Risk": {     "PaymentContextCodeAmount": "PartyToParty"
  }
}

Following API functionalities are available in the Payment Initiation API.

Table of Contents

minLevel	4

GET /international-standing-orders/{InternationalStandingOrderPaymentId}

The PISP retrieves the international standing orders resource to check its status.

Localtabgroup

Localtab

title	Request

Code Block

GET /international-standing-orders/<InternationalStandingOrderPaymentId> HTTP/1.1
Authorization: Bearer <USER_ACCESS_TOKEN>
x-fapi-financial-id: OB/2017/001
x-fapi-customer-last-logged-time:  Sun, 10 Sep 2017 19:43:31 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json30.80",
                "Currency": "GBP"
            }
        }
    }
}

Versions Compared

Old Version 7

New Version Current

Key

POST /international-standing-order-consents

GET /international-standing-order-consents/{ConsentId}

Step 13 - Invoke payment submission API

POST /international-standing-orders

Step 13 - Invoke payment submission API

POST /international-standing-orders

GET /international-standing-orders/{InternationalStandingOrderPaymentId}

GET /international-standing-orders/{InternationalStandingOrderPaymentId}