Page Comparison

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

Multiexcerpt

MultiExcerptName	Notes

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 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 to see how to deploy DCR v3.2 API. Once you deploy the API you can continue from the step.

Table of Contents

maxLevel	3
minLevel	3

Multiexcerpt

MultiExcerptName	InitialSteps

3topINLINE

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 .

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

Navigate to the API Store at https://<WSO2_OB_APIM_HOST>:9443/store
Select Sign-up that is on the top left corner of the homepage.

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.

Read terms and conditions. Click the checkbox to agree to the terms and conditions.
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...

Sign in to the WSO2 Open Banking API Manager Admin portal as an Approver at https://<WSO2_OB_APIM_HOST>:9443/admin
Locate the approval request and click Assign To Me.
Click Start to start the approval process.
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...

Sign in to the API Store as the TPP at https://<WSO2_OB_APIM_HOST>:9443/store
Click Sign In and navigate to the Sign In page.
Enter the username and the password you entered when signing up as a TPP.
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...

Go to the Applications tab in the API Store.
Click Add Application.
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.
Click Add.

An application can be used to subscribe to multiple APIs. See 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...

Go to the APIs tab in the API Store.
Select the API.
Select the application you created in the Create an application section.
Set the throttling policy to Unlimited.
Click Subscribe.

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

Step 6 - Create certificates

The TPP user needs to create certificates to validate whether the TPP is registered in a governing entity.

Click here to see how it is done...

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.
During the command execution, the TPP user requires to;
1. sourcekeystorePSSet a password for the keystore.
2. Provide information, acquired when registering with a governing entity.
3. Set a password for user-defined alias (<alias>).
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.
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 .

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.

During the command execution, the TPP user requires to;

Set a password to import the .pem file.

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

Sign in to the API store as a TPP user and click either of the following on the Applications tab.

Production Keys: Generates access tokens in the production environment.
Sandbox Keys: Generates access tokens in the sandbox environment.

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.

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

Sign in to the WSO2 Open Banking API Manager Admin portal as an Approver at https://<WSO2_OB_APIM_HOST>:9443/admin.
Click Tasks and then Application Registration.
Locate the approval request and click Assign To Me.
Click Start to start the approval process.
Select Approve and then click Complete.
Navigate back to the API Store and click Applications.
On the Applications tab in the API Store, click View of the application that you created.
Click Production Keys tab to find the generated keys.
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 to dynamically register the clients.

Once the client is successfully registered, sign in to the and go to the Applications tab.
Select your client application from the Application List. Click View of the application that you created.
Choose the Production Keys or Sandbox Keys tab based on your environment.
The Consumer Key shown above is the client ID of your application.
Generate the client assertion by signing the following JSON payload using the supported algorithms.
client_assertion formatsample client_assertion
Run the following cURL command in a command prompt to generate the access token. Update the placeholders with the relevant values.
applicatinAccesstokenINLINE
The access token is now generated.

You can use the same cURL command to re-generate the access token.

Step 10 - Initiate domestic 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.

Expand

title	Click here to see how it is done

POST /domestic-payment-consents

This endpoint allows the PISP to ask an ASPSP to create a new domestic-payment-consent resource. The ASPSP creates the domestic-payment-consent resource and responds with a unique ConsentId to refer to the resource.

Use the following format in the request body.

Code Block

{
  "Data": {
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": [
        "UK.OBIE.BACS",
        "UK.OBIE.BalanceTransfer",
        "UK.OBIE.CHAPS",
        "UK.OBIE.Euro1",
        "UK.OBIE.FPS",
        "UK.OBIE.Link",
        "UK.OBIE.MoneyTransfer",
        "UK.OBIE.Paym",
        "UK.OBIE.SEPACreditTransfer",
        "UK.OBIE.SEPAInstantCreditTransfer",
        "UK.OBIE.SWIFT",
        "UK.OBIE.Target2"
      ],
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": [
          "UK.OBIE.BBAN",
          "UK.OBIE.IBAN",
          "UK.OBIE.PAN",
          "UK.OBIE.Paym",
          "UK.OBIE.SortCodeAccountNumber"
        ],
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorAccount": {
        "SchemeName": [
          "UK.OBIE.BBAN",
          "UK.OBIE.IBAN",
          "UK.OBIE.PAN",
          "UK.OBIE.Paym",
          "UK.OBIE.SortCodeAccountNumber"
        ],
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      },
      "CreditorPostalAddress": {
        "AddressType": "Business",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "string",
        "AddressLine": [
          "string"
        ]
      },
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "SupplementaryData": {}
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2019-07-26T06:03:44.272Z"
    }
  },
  "Risk": {
    "PaymentContextCode": "BillPayment",
    "MerchantCategoryCode": "string",
    "MerchantCustomerIdentification": "string",
    "DeliveryAddress": {
      "AddressLine": [
        "string"
      ],
      "StreetName": "string",
      "BuildingNumber": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": [
        "string"
      ],
      "Country": "string"
    }
  }
}

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 -X POST \
  https://<WSO2_OB_APIM_HOST>:8243/open-banking/v3.1/pisp/domestic-payment-consents \
  -H 'Authorization: Bearer <APPLICATION_ACCESS_TOKEN>' \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json' \
  -H 'x-fapi-financial-id: open-bank' \
  -H 'x-idempotency-key: 188610727' \
  -H 'x-jws-signature: fdffv' \
  -d '{
  "Data": {
    "Initiation": {
      "InstructionIdentification": "ACME412",
      "EndToEndIdentification": "FRESCO.21302.GFX.20",
      "InstructedAmount": {
        "Amount": "165.88",
        "Currency": "GBP"
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "08080021325698",
        "Name": "ACME Inc",
        "SecondaryIdentification": "0002"
      },
      "DebtorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "11280001234567",
        "Name": "Andrea Smith"
      },
      "RemittanceInformation": {
        "Reference": "FRESCO-101",
        "Unstructured": "Internal ops code 5120101"
      }
    }
  },
  "Risk": {
    "PaymentContextCode": "EcommerceGoods",
    "MerchantCategoryCode": "5967",
    "MerchantCustomerIdentification": "053598653254",
    "DeliveryAddress": {
      "AddressLine": [
        "Flat 7",
        "Acacia Lodge"
      ],
      "StreetName": "Acacia Avenue",
      "BuildingNumber": "27",
      "PostCode": "GU31 2ZZ",
      "TownName": "Sparsholt",
      "CountrySubDivision": [
        "Wessex"
      ],
      "Country": "UK"
    }
  }
}'

The response will bear the ConsentId.

Code Block

{
    "Data": {
        "Status": "AwaitingAuthorisation",
        "StatusUpdateDateTime": "2019-07-26T08:08:12Z",
        "CreationDateTime": "2019-07-26T08:08:12Z",
        "ConsentId": "4a40cde1-e596-4612-93dc-85e2aa083dbb",
        "Initiation": {
            "DebtorAccount": {
                "SchemeName": "UK.OBIE.SortCodeAccountNumber",
                "Identification": "11280001234567",
                "Name": "Andrea Smith"
            },
            "RemittanceInformation": {
                "Unstructured": "Internal ops code 5120101",
                "Reference": "FRESCO-101"
            },
            "EndToEndIdentification": "FRESCO.21302.GFX.20",
            "InstructionIdentification": "ACME412",
            "CreditorAccount": {
                "SecondaryIdentification": "0002",
                "SchemeName": "UK.OBIE.SortCodeAccountNumber",
                "Identification": "08080021325698",
                "Name": "ACME Inc"
            },
            "InstructedAmount": {
                "Amount": "165.88",
                "Currency": "GBP"
            }
        }
    },
    "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://localhost:8243/open-banking/v3.1/pisp/domestic-payment-consents/4a40cde1-e596-4612-93dc-85e2aa083dbb"
    },
    "Meta": {}
}

GET /domestic-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.

Code Block

curl -X GET \
  https://<WSO2_OB_APIM_HOST>:8243/open-banking/v3.1/pisp/domestic-payment-consents/<ConsentId> \
  -H 'Authorization: Bearer <APPLICATION_ACCESS_TOKEN>' -k \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json' \
  -H 'x-fapi-financial-id: open-bank'

Following is a sample response.

Code Block

{
    "Data": {
        "Status": "AwaitingAuthorisation",
        "StatusUpdateDateTime": "2019-07-26T08:08:12Z",
        "CreationDateTime": "2019-07-26T08:08:12Z",
        "ConsentId": "4a40cde1-e596-4612-93dc-85e2aa083dbb",
        "Initiation": {
            "DebtorAccount": {
                "SchemeName": "UK.OBIE.SortCodeAccountNumber",
                "Identification": "11280001234567",
                "Name": "Andrea Smith"
            },
            "RemittanceInformation": {
                "Unstructured": "Internal ops code 5120101",
                "Reference": "FRESCO-101"
            },
            "EndToEndIdentification": "FRESCO.21302.GFX.20",
            "InstructionIdentification": "ACME412",
            "CreditorAccount": {
                "SecondaryIdentification": "0002",
                "SchemeName": "UK.OBIE.SortCodeAccountNumber",
                "Identification": "08080021325698",
                "Name": "ACME Inc"
            },
            "InstructedAmount": {
                "Amount": "165.88",
                "Currency": "GBP"
            }
        }
    },
    "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://localhost:8243/open-banking/v3.1/pisp/domestic-payment-consents4a40cde1-e596-4612-93dc-85e2aa083dbb"
    },
    "Meta": {}
}

Multiexcerpt

MultiExcerptName	UserAccessToken

Step 11 - 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

Generate the request object by signing the following JSON payload using the supported algorithms.
Run the following in a browser to prompt the invocation of the authorize API. Make sure you update the placeholders with the relevant values:
You are directed to a login page. Log in with the credentials of a user that has a subscriber role.
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.
Upon providing consent, an authorization code is generated.

Step 12 - 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:

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 generate a new access token as a PISP:

Step 13 - Invoke payment submission API

Once the domestic-payment-consent has been authorised by the PSU, the PISP can proceed to submitting the domestic-payment for processing. This request is an instruction to the ASPSP to begin the process of domestic payment and creates a domestic-payments resource.

Expand

title	Click here to see how it is done

POST /domestic-payments

The PISP must ensure that the Initiation and Risk sections of the domestic-payment match the corresponding Initiation and Risk sections of the domestic-payment-consent resource. If the two do not match, the ASPSP must not process. Any operations on the domestic-payment resource do not result in a status change for the domestic-payment resource.

The response contains DomesticPaymentId along with the payment submission details.

Localtabgroup

Localtab

title	Request

Code Block

POST /domestic-payments HTTP/1.1
Authorization: Bearer <USER_ACCESS_TOKEN>
x-idempotency-key: FRESNO.1317.GFX.22
x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==
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
Content-Type: application/json
Accept: application/json
 
{
  "Data": {
    "ConsentId": "58923",
    "Initiation": {
      "InstructionIdentification": "ACME412",
      "EndToEndIdentification": "FRESCO.21302.GFX.20",
      "InstructedAmount": {
        "Amount": "165.88",
        "Currency": "GBP"
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "08080021325698",
        "Name": "ACME Inc",
        "SecondaryIdentification": "0002"
      },
      "RemittanceInformation": {
        "Reference": "FRESCO-101",
        "Unstructured": "Internal ops code 5120101"
      }
    }
  },
  "Risk": {
    "PaymentContextCode": "EcommerceGoods",
    "MerchantCategoryCode": "5967",
    "MerchantCustomerIdentification": "053598653254",
    "DeliveryAddress": {
      "AddressLine": [
        "Flat 7",
        "Acacia Lodge"
      ],
      "StreetName": "Acacia Avenue",
      "BuildingNumber": "27",
      "PostCode": "GU31 2ZZ",
      "TownName": "Sparsholt",
      "CountySubDivision": [
        "Wessex"
      ],
      "Country": "UK"
    }
  }
}

Localtab

title	Response

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": {
    "DomesticPaymentId": "58923-001",
    "ConsentId": "58923",
    "Status": "AcceptedSettlementInProcess",
    "CreationDateTime": "2017-06-05T15:15:22+00:00",
    "StatusUpdateDateTime": "2017-06-05T15:15:13+00:00",
    "Initiation": {
      "InstructionIdentification": "ACME412",
      "EndToEndIdentification": "FRESCO.21302.GFX.20",
      "InstructedAmount": {
        "Amount": "165.88",
        "Currency": "GBP"
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "08080021325698",
        "Name": "ACME Inc",
        "SecondaryIdentification": "0002"
      },
      "RemittanceInformation": {
        "Reference": "FRESCO-101",
        "Unstructured": "Internal ops code 5120101"
      }
    }
  },
  "Links": {
    "Self": "https://api.alphabank.com/open-banking/v3.1/pisp/domestic-payments/58923-001"
  },
  "Meta": {}
}

The following API functionalities are also available in the Domestic Payments v3.1.1 API.

Expand

title	Confirmation of funds on a domestic-payment-consent resource

GET /domestic-payment-consents/{ConsentId}/funds-confirmation

The API endpoint allows the PISP to ask an ASPSP to confirm funds on a domestic-payment-consent resource.

An ASPSP can only respond to a funds confirmation request if the domestic-payment-consent resource has an Authorised status. The confirmation of funds requests do not affect the status of the domestic-payment-consent resource.

Localtabgroup

Localtab

title	Request

Code Block

GET /domestic-payment-consents/<ConsentId>/funds-confirmation HTTP/1.1Authorization: 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/json

Localtab

title	Response

Code Block

HTTP/1.1 200 OKx-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
 
{
    "Data": {
        "FundsAvailableResult": {
            "FundsAvailableDateTime": "2017-06-05T15:15:23+00:00",
            "FundsAvailable": true
        }
    },
    "Links": {
        "Self": "https://api.alphabank.com/open-banking/v3.1/pisp/domestic-payment-consents/58923/funds-confirmation"
    },
    "Meta": {}
}

Expand

title	Retrieval of a domestic-payment resource

GET /domestic-payments/{DomesticPaymentId}

The PISP retrieves the domestic-payment resource to check its status.

Localtabgroup

Localtab

title	Request

Code Block

GET /domestic-payments/<DomesticPaymentId> 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/json

Localtab

title	Response

Code Block

HTTP/1.1 200 OK
x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
 
{
  "Data": {
    "DomesticPaymentId": "58923-001",
    "ConsentId": "58923",
    "Status": "AcceptedSettlementInProcess",
    "CreationDateTime": "2017-06-05T15:15:22+00:00",
    "StatusUpdateDateTime": "2017-06-05T15:15:22+00:00",
    "Initiation": {
      "InstructionIdentification": "ACME412",
      "EndToEndIdentification": "FRESCO.21302.GFX.20",
      "InstructedAmount": {
        "Amount": "165.88",
        "Currency": "GBP"
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "08080021325698",
        "Name": "ACME Inc",
        "SecondaryIdentification": "0002"
      },
      "RemittanceInformation": {
        "Reference": "FRESCO-101",
        "Unstructured": "Internal ops code 5120101"
      }
    }
  },
  "Links": {
    "Self": "https://api.alphabank.com/open-banking/v3.1/pisp/domestic-payments/58923-001"
  },
  "Meta": {}
}

Versions Compared

Old Version 55

New Version 56

Key

Step 1 - Sign up as a TPP

Step 2 - Approve the TPP

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

Step 4 - Create an application

Step 5 - Subscribe to API

Step 6 - Create certificates

Step 7 - Generate keys

Step 8 - Approve Production Key generation

Step 9 - Generate application access token

Step 10 - Initiate domestic payment consent

POST /domestic-payment-consents

GET /domestic-payment-consents/{ConsentId}

Step 11 - Authorizing payment consents

Step 12 - Generate user access token

Step 13 - Invoke payment submission API

POST /domestic-payments

GET /domestic-payment-consents/{ConsentId}/funds-confirmation

GET /domestic-payments/{DomesticPaymentId}