right logo image
right logo image
Log on
⯆

API Explorer

Log off

v3.1 (144 APIs)

API Host: https://apisandbox.openbankproject.com
Bank
Accounts
Views
Counterparties
Transactions

Create Funds Confirmation

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

JSON request body fields:

JSON response body fields:

Typical Successful Response: 

								
									
{
  "Meta":{
    "FirstAvailableDateTime":{
      
    },
    "TotalPages":0
  },
  "Links":{
    "Last":"http://example.com/aeiou",
    "Prev":"http://example.com/aeiou",
    "Next":"http://example.com/aeiou",
    "Self":"http://example.com/aeiou",
    "First":"http://example.com/aeiou"
  },
  "Data":{
    "FundsConfirmationId":"FundsConfirmationId",
    "CreationDateTime":"2000-01-23T04:56:07.000+00:00",
    "Reference":"Reference",
    "FundsAvailable":true,
    "ConsentId":"ConsentId",
    "InstructedAmount":{
      "Amount":{
        
      },
      "Currency":"Currency"
    }
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: UKv3.1, function_name: by createFundsConfirmations, operation_id: UKv3.1-createFundsConfirmations Tags: Funds Confirmations, Mocked-Data,

Create Funds Confirmation Consent

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

JSON request body fields:

JSON response body fields:

Typical Successful Response: 

								
									
{
  "Meta":{
    "FirstAvailableDateTime":{
      
    },
    "TotalPages":0
  },
  "Links":{
    "Last":"http://example.com/aeiou",
    "Prev":"http://example.com/aeiou",
    "Next":"http://example.com/aeiou",
    "Self":"http://example.com/aeiou",
    "First":"http://example.com/aeiou"
  },
  "Data":{
    "Status":{
      
    },
    "StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00",
    "DebtorAccount":{
      "SecondaryIdentification":"SecondaryIdentification",
      "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
      "Identification":"Identification",
      "Name":"Name"
    },
    "CreationDateTime":"2000-01-23T04:56:07.000+00:00",
    "ExpirationDateTime":"2000-01-23T04:56:07.000+00:00",
    "ConsentId":"ConsentId"
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: UKv3.1, function_name: by createFundsConfirmationConsents, operation_id: UKv3.1-createFundsConfirmationConsents Tags: Funds Confirmations, Mocked-Data,

Delete Funds Confirmation Consent

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

URL Parameters:

CONSENTID: CONSENTID

JSON response body fields:

Typical Successful Response: 

								
									
{
  "jsonString":"{}"
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: UKv3.1, function_name: by deleteFundsConfirmationConsentsConsentId, operation_id: UKv3.1-deleteFundsConfirmationConsentsConsentId Tags: Funds Confirmations, Mocked-Data,

Get Funds Confirmation Consent

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

URL Parameters:

CONSENTID: CONSENTID

JSON response body fields:

Typical Successful Response: 

								
									
{
  "Meta":{
    "FirstAvailableDateTime":{
      
    },
    "TotalPages":0
  },
  "Links":{
    "Last":"http://example.com/aeiou",
    "Prev":"http://example.com/aeiou",
    "Next":"http://example.com/aeiou",
    "Self":"http://example.com/aeiou",
    "First":"http://example.com/aeiou"
  },
  "Data":{
    "Status":{
      
    },
    "StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00",
    "DebtorAccount":{
      "SecondaryIdentification":"SecondaryIdentification",
      "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
      "Identification":"Identification",
      "Name":"Name"
    },
    "CreationDateTime":"2000-01-23T04:56:07.000+00:00",
    "ExpirationDateTime":"2000-01-23T04:56:07.000+00:00",
    "ConsentId":"ConsentId"
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: UKv3.1, function_name: by getFundsConfirmationConsentsConsentId, operation_id: UKv3.1-getFundsConfirmationConsentsConsentId Tags: Funds Confirmations, Mocked-Data,