ob-payment-initiation

Payment Initiation API

v3.1.0OAS 2.0

Swagger for Payment Initiation API Specification

API Base URL
  • Server 1:https://https/mocking/api/v1/links/e7d1e0dd-c7c8-4408-a5a3-6bd7273e00c2/open-banking/v3.1/pisp
Security
PSUOAuth2Security (oauth2)

OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU

TPPOAuth2Security (oauth2)

TPP client credential authorisation flow with the ASPSP

Create Domestic Payment Consents

post
https://https/mocking/api/v1/links/e7d1e0dd-c7c8-4408-a5a3-6bd7273e00c2/open-banking/v3.1/pisp/domestic-payment-consents

Headers

x-fapi-financial-idstringrequired

The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.

x-fapi-customer-last-logged-timestring

The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC

Match pattern:^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$

x-fapi-customer-ip-addressstring

The PSU’s IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-idstring

An RFC4122 UID used as a correlation id.

Authorizationstringrequired

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-idempotency-keystringrequired

Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.

Match pattern:^(?!\s)(.*)(\S)$

<= 40 characters

x-jws-signaturestringrequired

A detached JWS signature of the body of the payload.

x-customer-user-agentstring

Indicates the user-agent that the PSU is using.

Body

application/json

Default

OBWriteDomesticConsent2

* Additional properties are NOT allowed.
Dataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
Riskobjectrequired

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

Domestic Payment Consents Created

OBWriteDomesticConsentResponse2

* Additional properties are NOT allowed.
Dataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
Riskobjectrequired

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

* Additional properties are NOT allowed.
Show Child Parameters
Linksobjectrequired

Links relevant to the payload

* Additional properties are NOT allowed.
Show Child Parameters
Metaobjectrequired

Meta Data relevant to the payload

* Additional properties are NOT allowed.
Show Child Parameters
 
application/json

Get Domestic Payment Consents

get
https://https/mocking/api/v1/links/e7d1e0dd-c7c8-4408-a5a3-6bd7273e00c2/open-banking/v3.1/pisp/domestic-payment-consents/{ConsentId}

Path Parameters

ConsentIdstringrequired

ConsentId

Headers

x-fapi-financial-idstringrequired

The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.

x-fapi-customer-last-logged-timestring

The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC

Match pattern:^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$

x-fapi-customer-ip-addressstring

The PSU’s IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-idstring

An RFC4122 UID used as a correlation id.

Authorizationstringrequired

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agentstring

Indicates the user-agent that the PSU is using.

Response

application/json

Domestic Payment Consents Read

OBWriteDomesticConsentResponse2

* Additional properties are NOT allowed.
Dataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
Riskobjectrequired

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

* Additional properties are NOT allowed.
Show Child Parameters
Linksobjectrequired

Links relevant to the payload

* Additional properties are NOT allowed.
Show Child Parameters
Metaobjectrequired

Meta Data relevant to the payload

* Additional properties are NOT allowed.
Show Child Parameters
 
application/json

Get Domestic Payment Consents Funds Confirmation

get
https://https/mocking/api/v1/links/e7d1e0dd-c7c8-4408-a5a3-6bd7273e00c2/open-banking/v3.1/pisp/domestic-payment-consents/{ConsentId}/funds-confirmation

Path Parameters

ConsentIdstringrequired

ConsentId

Headers

x-fapi-financial-idstringrequired

The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.

x-fapi-customer-last-logged-timestring

The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC

Match pattern:^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$

x-fapi-customer-ip-addressstring

The PSU’s IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-idstring

An RFC4122 UID used as a correlation id.

Authorizationstringrequired

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agentstring

Indicates the user-agent that the PSU is using.

Response

application/json

Domestic Payment Consents Funds Confirmation Read

OBWriteFundsConfirmationResponse1

* Additional properties are NOT allowed.
Dataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
Linksobjectrequired

Links relevant to the payload

* Additional properties are NOT allowed.
Show Child Parameters
Metaobjectrequired

Meta Data relevant to the payload

* Additional properties are NOT allowed.
Show Child Parameters
 
application/json

Create Domestic Payments

post
https://https/mocking/api/v1/links/e7d1e0dd-c7c8-4408-a5a3-6bd7273e00c2/open-banking/v3.1/pisp/domestic-payments

Headers

x-fapi-financial-idstringrequired

The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.

x-fapi-customer-last-logged-timestring

The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC

Match pattern:^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$

x-fapi-customer-ip-addressstring

The PSU’s IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-idstring

An RFC4122 UID used as a correlation id.

Authorizationstringrequired

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-idempotency-keystringrequired

Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.

Match pattern:^(?!\s)(.*)(\S)$

<= 40 characters

x-jws-signaturestringrequired

A detached JWS signature of the body of the payload.

x-customer-user-agentstring

Indicates the user-agent that the PSU is using.

Body

application/json

Default

OBWriteDomestic2

* Additional properties are NOT allowed.
Dataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
Riskobjectrequired

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

Domestic Payments Created

OBWriteDomesticResponse2

* Additional properties are NOT allowed.
Dataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
Linksobjectrequired

Links relevant to the payload

* Additional properties are NOT allowed.
Show Child Parameters
Metaobjectrequired

Meta Data relevant to the payload

* Additional properties are NOT allowed.
Show Child Parameters
 
application/json