The Payment Initiation API Profile describes the flows and common functionality for the Payment Initiation API, which allows a Payment Initiation Service Provider ('PISP') to:

Register an intent to stage a payment-order consent.
Optionally confirm available funds for a payment-order
Domestic immediate, international immediate and international scheduled (immediate debit) payments only.
Subsequently submit the payment-order for processing.
Optionally retrieve the status of a payment-order consent or payment-order resource.
This profile should be read in conjunction with a compatible Read/Write Data API Profile which provides a description of the elements that are common across all the Read/Write Data APIs, and compatible individual resources.

 

Documentation

  • Contents
    Check on the OpenAPI Documentation carefully to understand the required request and structure.
     
  • Security
    Remember to retrieve the credentials of your App in "My Apps" checking on the Consumer Key and Consumer Secret.

Error Format

All OpenBanking APIs throw errors in following JSON format:

{"Id": "123",
"Code": "123", 
"Message":"Message example",
"Description": "Description of error", 
"Errors":[
{
 "ErrorCode":"AC17",
 "Message":"Message Example",
 "Path":"/accounts",
 "Url":"url.example.com"
}]
}