This documentation is for WSO2 Open Banking version 1.4.0. View documentation for the latest release.
Skip to end of metadata
Go to start of metadata

This document explains the flow of events related to File Payments - Payment Initiation API v3.1.1.

Before you begin

You need to deploy the Payment Initiation API in <WSO2_OB_APIM_HOME>/repository/resources/finance/apis/openbanking.org.uk/Payments/3.1.1/payment-swagger-3.1.1.yaml. Click here to see how to deploy APIs for WSO2 Open Banking UK.

If you have already deployed v3.1 APIs:

According to OBIE, the v3.1 and v3.1.1 APIs have the same context values. Therefore, if you have already deployed v3.1 APIs, the v3.1.1 APIs cannot be deployed as new versions of existing APIs. You have to update the swagger file content.

If you have integrated with OBIE you can use the Dynamic Client Registration v3.2 API. Click here to see how to deploy DCR v3.2 API. Once you deploy the API you can continue from the Generate application access token step.


Step 1 - Sign up as a TPP

A Third-Party Provider(TPP), is an authorized third-party that allows merchants to accept a wide variety of payments through a single channel/third-party application, and manage the entire payment flow from start to finish. For more information on the role, see TPP roles.

The TPP needs to register its Payment Initiation Service Provider (PISP) application in WSO2 API store in order to access the data.

 Click here to see how it is done...
  1. Navigate to the API Store at https://<WSO2_OB_APIM_HOST>:9443/store

  2. Select Sign-up that is on the top left corner of the homepage.

  3. Provide the requested details on the Sign Up page.

     Click here for more information..

    a. Generic details:

    Field

    Description

    Username/Email

    The username/email that the TPP uses to sign in to the API Store.

    Password

    The password that the TPP uses to sign in to the API Store.

    Retype Password

    This is to prevent the TPP from accidentally setting an incorrect password.

    Last Name

    This is the last name of the TPP.

    First Name

    This is the first name of the TPP.


    b. Company details:

    Field

    Description

    Legal Entity Name

    The official name of the TPP.

    Country of Registration

    The country in which the TPP is registered.

    Legal Identifier Number (LEI)

    This identifies the TPP.

    Company Register

    The organization that registered the TPP.

    Company Registration Number

    Identifier issued at the TPP registration.

    Address Line 1

    Address of the TPP.

    Address Line 2

    Address of the TPP.

    City

    City in which the TPP is located.

    Postal Code

    Postal code of the geographical location of the TPP.

    Country

    The country in which the TPP is located.


    c. Competent authority registration details:

    Field

    Description

    Competent Authority

    The regulatory body that authorises and supervises the open banking services delivered by the TPP.

    Competent Authority Country

    Country of the competent authority that authorised the TPP to provide open banking services.

    Competent Authority Registration Number

    The registration number issued by the Competent Authority to the TPP.

    URL of the Competent Authority Register Page

    URL of the page that has the list of organizations authorised by the competent authority.

    Open Banking Roles

    Captures the open banking roles the TPP is willing to take up:

    • Account Information Service Provider: An Account Information Service Provider (AISP) provides an aggregated view of all the accounts and past transactions that a customer has with different banks. To provide this view to the customer, the AISP should have authorisation from the customer to view the corresponding transaction and balance information of all the payment accounts. The AISPs can also provide the facility to analyze the customer's spending patterns, expenses, and financial needs. Unlike a PISP, an AISP cannot transfer funds from a payment account.

    • Payment Initiation Service Provider: A Payment Initiation Service Provider (PISP) initiates credit transfers on behalf of a bank's customer.

    After selecting PISP, indicate whether the TPP is authorised by a competent authority to provide the services of the selected roles.

    If the TPP is not yet registered to provide the services of the selected roles, indicate whether the TPP has applied for registration or not.

  4. Read terms and conditions. Click the checkbox to agree to the terms and conditions.

  5. Click Sign Up. A request to approve the TPP sign up is now sent to the Approver users.




Step 2 - Approve the TPP

Now that you have signed up as a TPP, an admin who overlooks all TPP sign-up forms must approve it. 


It is not mandatory to include the approval step for approving the TPP. In order to add this step, you need to configure workflows in the WSO2 Open Banking solution.

 Click here to see how it is done...
  1. Sign in to the WSO2 Open Banking API Manager Admin portal as an Approver at https://<WSO2_OB_APIM_HOST>:9443/admin

  2. Locate the approval request and click Assign To Me.

  3. Click Start to start the approval process.
  4. Select Approve then Complete.

Now the TPP can sign in to the API store. 


Step 3 - Sign in to the API store as the TPP

Users can sign in to the API store and proceed with the steps mentioned below.


 Click here to see how it is done...
  1. Sign in to the API Store as the TPP at https://<WSO2_OB_APIM_HOST>:9443/store

  2. Click Sign In and navigate to the Sign In page.

  3. Enter the username and the password you entered when signing up as a TPP.

  4. Click Sign In

The homepage of the API store is now displayed along with the APIs.


Step 4 - Create an application

The TPP with a PISP application needs to create an application using WSO2 API store. The application created via WSO2 API store allows to observe statistics of APIs, subscribe to APIs, and access the subscribed APIs.
 Click here to see how it is done...
  1. Go to the Applications tab in the API Store.


  2. Click Add Application.

  3. Enter application details.

    Field

    Description

    Name

    Application name.

    Per Token Quota

    Determines the maximum number of API requests accepted within a given duration.

    Description

    This describes the purpose of the application.

  4. Click Add

An application can be used to subscribe to multiple APIs. See Subscribe to an API for the instructions.


Step 5 - Subscribe to API

The TPP user needs to subscribe to the PaymentInitiationAPI - v3.1 API in order to access API resources. Once subscribed, the users can access all the supported services of the API resources. 


 Click here to see how it is done...
  1. Go to the APIs tab in the API Store.

  2. Select the API.

  3. Select the application you created in the Create an application section.

  4. Set the throttling policy to Unlimited.

  5. Click Subscribe.

Now that you have subscribed to the API, generate access tokens and invoke the API.


Step 6 - Create and upload certificates

The TPP user needs to create certificates to validate whether the TPP is registered in a governing entity. It is verified in the TPP Onboarding process. For example, in Dynamic Client Registration, the TPP is dynamically registered with ASPSPs when the client sends a registration request with its metadata. Therefore, the ASPSP is required to upload the root and issuer certificates obtained from Open Banking Implementation Entity. For more information, see  Dynamic Client Registration v3.2.

You can also create a self-signed certificate the following instructions given below and try out the API flow:

When you are using self-signed certificates, make sure to disable the certificate revocation validation:

  1. Open the <WSO2_OB_KM_HOME>/repository/conf/finance/open-banking.xml file
  2. Navigate to the certificate revocation validation configuration and disable it as follows:

    <CertificateManagement>
        <!-- Enable certificate OCSP and CRL validation -->
        <CertificateRevocationValidationEnabled>true</CertificateRevocationValidationEnabled>
    /CertificateManagement>
 Click here to see a self-signed certificate is created...

In order to use self-signed certificates as mentioned in the below steps, disable the <CertificateRevocationValidationEnabled> configuration under <CertificateManagement> in the <WSO2_OB_KM_HOME>/repository/conf/finance/open-banking.xml and <WSO2_OB_APIM_HOME>/repository/conf/finance/open-banking.xml files.

  1. A keystore file is used to store the trusted certificates of the TPP in the WSO2 Open Banking solution. Use the commands given below in a command-line interface in order to create a keystore file as a TPP.

    Make sure to update the following placeholders:

    <alias>A preferred alias for the keystore file.
    <filename>A preferred name for the keystore file.
    keytool -genkey -alias <alias> -keyalg RSA -keystore <filename>.jks

    During the command execution, the TPP user requires to;

    1. Set a password for the keystore.
    2. Provide information, acquired when registering with a governing entity.
    3. Set a password for user-defined alias (<alias>).
  2. Convert the keystore from the .jks format to .PKCS12.  Make sure to update the following placeholders:

    <keyStoreName>This is the name of the <filename>, given above.
    <PKCS12FileName>This is the name of the keystore in the .PKCS12 format.
    keytool -importkeystore -srckeystore <keystoreStoreName>.jks -destkeystore <PKCS12FileName>.p12 -deststoretype PKCS12

    During the command execution, the TPP user requires to;

    1. Set a password for the destination keystore.
    2. Enter the source keystore password, as defined in the above step .
  3. Create the application certificate (.pem) file in the PKCS12 format using the keystore. e.g: tpp.p12.

    Make sure to update the following placeholders:

    <PKCS12FileName>This is the name of the keystore in the PKCS12 format, as mentioned above for the <PKCS12FileName>.
    <PEMFileName>This is the name of the application certificate that is created in the .pem format.
    openssl pkcs12 -in <PKCS12FileName>.p12 -nokeys -out <PEMFileName>.pem

    During the command execution, the TPP user requires to;

    1. Set a password to import the .pem file.

 Once you create a self-signed certificate, upload it to the client trust stores of WSO2 OB APIM and WSO2 OB KM. 

  • Locate the client trust stores in WSO2 OB APIM and WSO2 OB KM in the following directory paths:
    • <WSO2_OB_APIM>/repository/resources/security/client-truststore.jks
    • <WSO2_OB_KM>/repository/resources/security/client-truststore.jks
  • Use the following command to upload the self-signed certificate:

keytool -import -alias <alias> -keystore cacerts -file <PEMFileName>.pem

Step 7 - Generate keys

The TPP user requires a Client ID(Consumer Key) and a Client Secret(Consumer Secret) to access the subscribed APIs.

 Click here to see how it is done...
  1. Sign in to the API store as a TPP user and click either of the following on the Applications tab.

    1. Production Keys: Generates access tokens in the production environment.

    2. Sandbox Keys: Generates access tokens in the sandbox environment.

  2. Provide the requested information as defined below:  

    Field

    Description

    Grant Types

    These determine the credentials that are used to generate the access token.

    • Refresh Token: This is to renew an expired access token.

    • Client Credential: This relates to the client credentials grant type and is applicable when consuming the API as an application.

    • Code: This relates to the authorisation code grant type and is applicable when consuming the API as a user.

    Client ID

    OrganizationIdentifier as provided in the EIDAS certificate. The organizationIdentifier attribute contains information using the following structure in the presented order:

    • PSD as the 3-character legal person identity type reference;

    • 2-character ISO 3166 country code representing the NCA country;

    • hyphen-minus (-)

    • 2-8 character NCA identifier (A-Z upper case only, no separator)

    • hyphen-minus (-)

    • PSP (Payment Service Provider) identifier (authorisation number as specified by NCA)

    Callback URL

    This is the URL used by the Account Information Service Provider (AISP) / Payment Initiation Service Provider (PISP) to receive the authorisation code sent from the Account Servicing Payment Service Provider (ASPSP), e.g: bank. The authorisation code can be used later to generate an OAuth2 access token.

    Application Certificate

    This is the content between the BEGIN CERTIFICATE and END CERTIFICATE strings of the application certificate (.PEM) that you created above.

  3. Click Request Access if you are generating production keys. If workflows are configured in the solution, it sends a request to Approver user to approve the token generation. Otherwise, it generates consumer key and consumer secret.

  4. Click Generate Keys if you are generating sandbox keys. It generates consumer key and consumer secret.


Step 8 - Approve Production Key generation

This step includes instructions to an Approver user to review and approve a request to generate production keys for an application.

It is not mandatory to include the approval step for the Production Key generation. In order to add this step, you need to configure workflows in the WSO2 Open Banking solution.

 Click here to see how it is done...
  1. Sign in to the WSO2 Open Banking API Manager Admin portal as an Approver at https://<WSO2_OB_APIM_HOST>:9443/admin.

  2. Click Tasks and then Application Registration.

  3. Locate the approval request and click Assign To Me.

  4. Click Start to start the approval process.

  5. Select Approve and then click Complete.
  6. Navigate back to the API Store and click Applications.
  7. On the Applications tab in the API Store, click View of the application that you created.
  8. Click Production Keys tab to find the generated keys.

  9. It includes the consumer key and consumer secret as follows:

Step 9 - Generate application access token

When invoking APIs in the payment flow, application access tokens must be generated using the client credential grant type. The generated application access token is used to invoke the PaymentInitiationAPI - v3.1 API.

 Click here to see how it is done...

You can skip the above steps and use DCR v3.2 API to dynamically register the clients.

  1. Once the client is successfully registered, sign in to the API Store and go to the Applications tab.

  2. Select your client application from the Application List. Click View of the application that you created.

  3. Choose the Production Keys or Sandbox Keys tab based on your environment.

  4. The Consumer Key shown above is the client ID of your application.

  5. Generate the client assertion by signing the following JSON payload using the supported algorithms.

    { 
    "alg": "<<This will be the algorithm used for signing>>", 
    "kid": "<<This will be the certificate fingerprint>>", 
    "typ": "JWT" 
    } 
    
    { 
    "iss": "<<This is the issuer of the token, e.g., client ID of your application>>", 
    "sub": "<<This is the subject identifier of the issuer, e.g., client ID of your application>>", 
    "exp": <<This is epoch time of the token expiration date/time>>, 
    "iat": <<This is epoch time of the token issuance date/time>>, 
    "jti": "<<This is an incremental unique value>>", 
    "aud": "<<This is the audience that the ID token is intended for, e.g., https://<<OB_HOST>>:8243/token>>" 
    } 
    
    <signature>
    eyJraWQiOiJoY2dleHVndVZiNXJZU1lWQnNsLWM5aEJQdlkiLCJhbGciOiJQUzI1NiJ9.eyJzdWIiOiJpMkJmbFJyeWIxVkdsRUpHNlpTMDR0bTNHaGNhIiwiYXVkIjoiaHR0cHM6Ly9sb2NhbGhvc3Q6ODI0My90b2tlbiIsImlzcyI6ImkyQmZsUnJ5YjFWR2xFSkc2WlMwNHRtM0doY2EiLCJleHAiOjE1OTkxODcyMDEsImlhdCI6MTU2NTcyMDUzNywianRpIjoiMTU2NTcyMTUzOCJ9.THAG1Ox8hAoGe3hXUvX8rrsIoU7SJfcfSWOxNkdnERb827hxDx2FbVN2wrNhe4A93AYMaCYsHqq8s6p4gkeREWGbJ_IGSjmzJPATWC0oAfAP8hRqdFNUfnTufN7lNlWwySJ7OyBgqorq_ABOx1i741bnld4Jyz8e58gi9UPRi7lFuWnvO-6RwlZY771B1qYNQFTULitV5jX38XJXTX2jrdc_2OkoAS3cL_2x05zZqNFpIvtoK-6XJP1HgRrlDdYx3jzuhAk9F5Q-4BlrbdiUS6QP0PFA_by4y-1vScBAGBhCH4_ViUuGdT9c0FSBGE9_3sLkyj_4SLJRPiQwn6NLbg

    The value of the aud claim should contain the same value as the Identity Provider Entity ID.

     Click here to view the Identity Provider Entity ID:
    1. Sign in to the Identity and Access Management console at  https://localhost:9446/carbon
    2. In the Main menu, go to Home > Identity > Identity Providers > Resident.
    3. View the value in Resident Identity Provider > Inbound Authentication Configuration > OAuth2/OpenID Connect Configuration > Identity Provider Entity ID. By default this value is set to  https://localhost:8243/token .
  6. Run the following cURL command in a command prompt to generate the access token. Update the placeholders with the relevant values.

    curl  POST \
      https://<WSO2_OB_APIM_HOST>:8243/token \ 
      -H 'Cache-Control: no-cache' \
      -H 'Content-Type: application/x-www-form-urlencoded' \ 
      --cert <PUBLIC_KEY_FILE_PATH> --key <PRIVATE_KEY_FILE_PATH> \
    -d 'grant_type=client_credentials&scope=payments%20openid%20&client_assertion=<CLIENT_ASSERTION_JWT>&client_assertion_type=urn%3Aietf%3Aparams%3Aoauth%3Aclient-assertion-type%3Ajwt-bearer&redirect_uri=<APPLICATION_CALLBACK_URL>'

    The access token is now generated.


    You can use the same cURL command to regenerate the access token.




Step 10 - Initiate file payment consent

In this step, the TPP creates a request to get the consent of the PSU to access the payment account and create a new payment-order. This informs the bank(ASPSP) that one of its PSUs intends to make a payment-order.

WSO2 Open Banking supports only the file type UK.OBIE.pain.001.001.08 for file paments.

 Click here to see how it is done

POST /file-payment-consents

The API endpoint allows the PISP to ask an ASPSP to create a new file-payment-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.

    {
      "Data": {
        "Initiation": {
          "FileType": "UK.OBIE.pain.001.001.08",
          "FileHash": "m5ah/h1UjLvJYMxqAoZmj9dKdjZnsGNm+yMkJp/KuqQ",
          "FileReference": "GB2OK238",
          "NumberOfTransactions": "100",
          "ControlSum": 3459.30
        }
      }
    }
  • 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.

    curl POST \
      https://<WSO2_OB_APIM_HOST>:8243/open-banking/v3.1/pisp/file-payment-consents \
      -H 'Authorization: Bearer <APPLICATION_ACCESS_TOKEN>' \
      -H 'x-idempotency-key: FRESCO.21302.GFX.20'
      -H 'x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==' \
      -H 'x-fapi-financial-id: open-bank' \
      -H 'x-fapi-customer-last-logged-time: Sun, 10 Sep 2017 19:43:31 UTC' \
      -H 'x-fapi-customer-ip-address: 104.25.212.99' \
      -H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d' \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      --cert <PUBLIC_KEY_FILE_PATH> --key <PRIVATE_KEY_FILE_PATH> \
    -d '{
      "Data": {
        "Initiation": {
          "FileType": "UK.OBIE.pain.001.001.08",
          "FileHash": "m5ah/h1UjLvJYMxqAoZmj9dKdjZnsGNm+yMkJp/KuqQ",
          "FileReference": "GB2OK238",
          "NumberOfTransactions": "100",
          "ControlSum": 3459.30
        }
      }
    }'
  • The response will bear the ConsentId.

    {
      "Data": {
        "ConsentId" : "512345",
        "Status": "AwaitingUpload",
        "CreationDateTime": "2018-06-05T15:15:13+00:00",
        "StatusUpdateDateTime": "2018-06-05T15:15:13+00:00",
        "Initiation": {
          "FileType": "UK.OBIE.pain.001.001.08",
          "FileHash": "m5ah/h1UjLvJYMxqAoZmj9dKdjZnsGNm+yMkJp/KuqQ",
          "FileReference": "GB2OK238",
          "NumberOfTransactions": "100",
          "ControlSum": 3459.30
        }
      },
      "Links":{
        "Self":"https://api.alphabank.com/open-banking/v3.1/pisp/file-payment-consents/512345"
      },
      "Meta":{}
    }

GET /file-payment-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.

    curl GET 
      https://<WSO2_OB_APIM_HOST>:8243/open-banking/v3.1/pisp/file-payment-consents/<ConsentId> \
      -H 'Authorization: Bearer <APPLICATION_ACCESS_TOKEN>' \
      -H 'x-fapi-financial-id: OB/2017/001' \
      -H 'x-fapi-customer-last-logged-time:  Sun, 10 Sep 2017 19:43:31 GMT' \
      -H 'x-fapi-customer-ip-address: 104.25.212.99' \
      -H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d' \
      -H 'Accept: application/json' \
      --cert <PUBLIC_KEY_FILE_PATH> --key <PRIVATE_KEY_FILE_PATH> \

Step 11 - Upload payment file

The PISP must upload the payment file against the ConsentId before redirecting the PSU to authorise the consent. 

The file structure must match the FileType in the file-payment-consent request. The metadata for the file-payment-consent must match the contents of the uploaded file. If the content of the metadata does not match the content of the file, the ASPSP must reject the file-payment-consent.

 Click here to see how it is done

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

The API endpoint allows the PISP to upload a file to an ASPSP, against a file-payment-consent resource.

The file is sent in the request body.

  • 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.

    curl POST \
      https://<WSO2_OB_APIM_HOST>:8243/open-banking/v3.1/pisp/file-payment-consents/<CONSENT_ID>/file \
      -H 'x-fapi-financial-id: open-bank' \
      -H 'x-idempotency-key: 543510' \
      -H 'Authorization: Bearer <APPLICATION_ACCESS_TOKEN>' \
      -H 'Accept: application/json' \      
      -H 'x-jws-signature: eyJhbGciOiJQUzI1NiIsImtpZCI6Imp5UlVjeXQxa1ZDbGNJdmxVbGNEdWtWWjN0VSIsImNyaXQiOlsiaHR0cDovL29wZW5iYW5raW5nLm9yZy51ay9pYXQiLCJodHRwOi8vb3BlbmJhbmtpbmcub3JnLnVrL3RhbiIsImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaXNzIl0sImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaWF0IjoxNjAxOTYyODA0LCJodHRwOi8vb3BlbmJhbmtpbmcub3JnLnVrL3RhbiI6Im9wZW5iYW5raW5nLm9yZy51ayIsImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaXNzIjoiQ049U0NtRXY5R1FlQnJuZFBaTlo1QVdObiwgT1U9MDAxNTgwMDAwMUhRUXJaQUFYLCBPPU9wZW5CYW5raW5nLCBDPUdCIn0..m2YaEJzfugu2RdNyoZu9gCmJBagEkRkyV3pKc2GyzyeKS82y3oSM0vGF2YwQFUM6UpAw8G_lsiULcinovbhsQJWM1FCkikRD28hUKzMN4qrPpabBjTdCV9nGWhahJsbFPeSGXFIioaVqqHk9xIpMD_NyVig7xPN9eT5ockzH18FTauDKZ84WUd1ta3wkLr3COP27eCFVfzVVXD7pYMSIcxMXnZd0iDCaJjlmhF5WaiacbYSjFE77bN7hHIy0Q2w97HrTPdyutOiz4QIb08iEcQdtKZPQOJE-EOkXJpMXu-eO0YE5SavqlLNKMjNkDHVDNECWvBCtSMUD-ZLs0ABj3Q' \
      -H 'charset: UTF-8' \
      -H 'Content-Type: text/xml; charset=ISO-8859-1' \
      --cert <PUBLIC_KEY_FILE_PATH> --key <PRIVATE_KEY_FILE_PATH> \
     
    [File-Data]

    A sample file with 3 Domestic Payments - CHAPS, BACS and one unspecified is available here.


  • The response will bear the ConsentId.

    HTTP/1.1 200 OK
    x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d

Step 12 - Authorizing payment consents

The PISP redirects the bank customer to authenticate and approve/deny application-provided consents.

 Click here to see how it is done
  1. Generate the request object by signing the following JSON payload using the supported algorithms.

    {
      "kid": "<CERTIFICATE_FINGERPRINT>",
      "alg": "<SUPPORTED_ALGORITHM>",
      "typ": "JWT"
    }
    {
      "max_age": 86400,
      "aud": "<This is the audience that the ID token is intended for. e.g., https://<WSO2_OB_APIM_HOST>:8243/token>",
      "scope": "accounts openid",
      "iss": "<APPLICATIONT_ID>",
      "claims": {
        "id_token": {
          "acr": {
            "values": [
              "urn:openbanking:psd2:sca",
              "urn:openbanking:psd2:ca"
            ],
            "essential": true
          },
          "openbanking_intent_id": {
            "value": "<CONSENTID>",
            "essential": true
          }
        },
        "userinfo": {
          "openbanking_intent_id": {
            "value": "<CONSENTID>",
            "essential": true
          }
        }
      },
      "response_type": "<code:Retrieves authorize code/code id_token: Retrieves authorize token and ID token>",   
      "redirect_uri": "<CLIENT_APPLICATION_REDIRECT_URI>",
      "state": "YWlzcDozMTQ2",
      "exp": <EPOCH_TIME_OF_TOKEN_EXPIRATION>,
      "nonce": "<PREVENTS_REPLAY_ATTACKS>",
      "client_id": "<APPLICATION_ID>"
    }

  2. Run the following in a browser to prompt the invocation of the authorize API. Make sure you update the placeholders with the relevant values:

    https://<WSO2_OB_APIM_HOST>:8243/authorize/?response_type=<RESPONSE_TYPE>&client_id=<APPLICATION_ID>&scope=payments%20openid&redirect_uri=<APPLICATION_REDIRECT_URI>&state=YWlzcDozMTQ2&request=<REQUEST_OBJECT>&prompt=login&nonce=<REQUEST_OBJECT_NONCE>

  3. You are directed to a login page. Log in with the credentials of a user that has a subscriber role.
  4. If a secondary factor is required, e.g. SMSOTP, provide the relevant values. Upon successful authentication, the user is redirected to the consent management page.
  5. Upon providing consent, an authorization code is generated.



Step 13 - Generate user access token

In this section, you will be generating an access token using the authorization code generated in the section above.

 Click here to see how it is done

Run the following cURL command in a command prompt to generate the access token as a TPP user:

curl POST \
  https://<WSO2_OB_APIM_HOST>:8243/token \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  --cert <PUBLIC_KEY_FILE_PATH> --key <PRIVATE_KEY_FILE_PATH> \
  -d 'client_id=<APPLICATION_ID>&grant_type=authorization_code&code=<CODE_GENERATED>&redirect_uri=<APPLICATION_REDIRECT_URI>&client_assertion_type=urn%3Aietf%3Aparams%3Aoauth%3Aclient-assertion-type%3Ajwt-bearer&client_assertion=<CLIENT_ASSERTION>'

The response contains an access token and a refresh token.

The access tokens have an expiration period, once an access token expires, you need to regenerate it. Run the following cURL command to call the refresh_token endpoint and regenerate a new access token as a PISP:

curl POST \
 https://<WSO2_OB_APIM_HOST>:8243/token \
 -H 'Authorization: Basic <APPLICATION CLIENTID:CLIENT_SECRET_BASE64_ENCODED>' \
 -H 'Content-Type: application/x-www-form-urlencoded' \
 -H 'cache-control: no-cache' \
 --cert <PUBLIC_KEY_FILE_PATH> --key <PRIVATE_KEY_FILE_PATH> \
 -d 'grant_type=refresh_token&refresh_token=<REFRESH_TOKEN>'

Step 14 - Invoke payment submission API

POST /file-payments

Once the file-payment-consent has been authorised by the PSU, the PISP can proceed to submit the file-payment for processing. This request is an instruction to the ASPSP to begin the process of the file payments. 

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

The response contains FilePaymentId along with the payment submission details. 


curl POST \
  https://<WSO2_OB_APIM_HOST>:8243/open-banking/v3.1/pisp/file-payments \
  -H 'Authorization: Bearer <USER_ACCESS_TOKEN>' \
  -H 'x-idempotency-key: FRESCO.21302.GFX.20' \
  -H 'x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==' \
  -H 'x-fapi-financial-id: OB/2017/001' \
  -H 'x-fapi-customer-last-logged-time: Sun, 10 Sep 2017 19:43:31 UTC' \
  -H 'x-fapi-customer-ip-address: 104.25.212.99' \
  -H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  --cert <PUBLIC_KEY_FILE_PATH> --key <PRIVATE_KEY_FILE_PATH> \
-d '{
  "Data": {
    "ConsentId":"512345",
    "Initiation": {
      "FileType": "UK.OBIE.pain.001.001.08",
      "FileHash": "64EC88CA00B268E5BA1A35678A1B5316D212F4F366B2477232534A8AECA37F3C",
      "FileReference": "GB2OK238",
      "NumberOfTransactions": "100",
      "ControlSum": 3459.30
    }
  }
}'
{
  "Data": {
    "ConsentId" : "512345",
    "FilePaymentId":"FP1-512345",
    "Status": "InitiationPending",
    "CreationDateTime": "2018-06-05T15:15:13+00:00",
    "StatusUpdateDateTime": "2018-06-05T15:15:13+00:00",
    "Initiation": {
      "FileType": "UK.OBIE.pain.001.001.08",
      "FileHash": "m5ah/h1UjLvJYMxqAoZmj9dKdjZnsGNm+yMkJp/KuqQ",
      "FileReference": "GB2OK238",
      "NumberOfTransactions": "100",
      "ControlSum": 3459.30
    }
  },
  "Links":{
     "Self":"https://obank.com/open-banking/v3.1/pisp/file-payments/FP1-512345"
  },
  "Meta":{}
}

GET /file-payments/{FilePaymentId}

The PISP retrieves the file-payments resource to check its status.

curl GET \
  https://<WSO2_OB_APIM_HOST>:8243/open-banking/v3.1/pisp/file-payments/<FilePaymentId> \
  -H 'Authorization: Bearer <USER_ACCESS_TOKEN>' \
  -H 'x-fapi-financial-id: OB/2017/001' \
  -H 'x-fapi-customer-last-logged-time:  Sun, 10 Sep 2017 19:43:31 GMT' \
  -H 'x-fapi-customer-ip-address: 104.25.212.99' \
  -H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d' \
  -H 'Accept: application/json' \
  --cert <PUBLIC_KEY_FILE_PATH> --key <PRIVATE_KEY_FILE_PATH> \
{
    "Meta": {
          
    },
    "Links": {
        "Self": "/file-payments/fe994801-606a-4df9-a0e1-e44efdbf594b-78"
    },
    "Data": {
        "Status": "InitiationCompleted",
        "StatusUpdateDateTime": "2020-10-06T05:40:52Z",
        "CreationDateTime": "2020-10-06T05:40:52Z",
        "FilePaymentId": "fe994801-606a-4df9-a0e1-e44efdbf594b-78",
        "ConsentId": "fe994801-606a-4df9-a0e1-e44efdbf594b",
        "Initiation": {
            "ControlSum": 10,
            "LocalInstrument": "UK.OBIE.BACS",
            "DebtorAccount": {
                "SecondaryIdentification": 30080098763459,
                "SchemeName": "UK.OBIE.SortCodeAccountNumber",
                "Identification": 30080012343456,
                "Name": "test user"
            },
            "RemittanceInformation": {
                "Unstructured": "Internal ops code 5120101",
                "Reference": "FRESCO-101"
            },
            "FileType": "UK.OBIE.pain.001.001.08",
            "FileHash": "lf3fXV8cnSmjQPCYVfCE4BBXBXrO3tsksNk1rg73oeY=",
            "NumberOfTransactions": 10,
            "FileReference": "test",
            "RequestedExecutionDateTime": "2020-10-11T05:39:56.705Z"
        }
    },
    "File": "<?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>"
}

GET /file-payments/{FilePaymentId}/report-file

This API endpoint allows the PISP to download a payment report file from an ASPSP. The file structure matches a payment execution report for the corresponding FileType in the file-payment-consent request. 

curl GET \
  https://<WSO2_OB_APIM_HOST>:8243/open-banking/v3.1/pisp/file-payment-consents/<FILE_PAYMENT_ID>/file
  -H 'Authorization: Bearer <USER_ACCESS_TOKEN>' \
  -H 'x-fapi-financial-id: OB/2017/001' \
  -H 'x-fapi-customer-last-logged-time:  Sun, 10 Sep 2017 19:43:31 GMT' \
  -H 'x-fapi-customer-ip-address: 104.25.212.99' \
  -H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d' \
  -H 'Accept: application/json' \
  --cert <PUBLIC_KEY_FILE_PATH> --key <PRIVATE_KEY_FILE_PATH> \
  • No labels