-
Account Access
-
Account Access governs access to Bank Accounts by end Users. It is an intersecting entity between tMore...
- Create Account Access Consents
- Delete Account Access Consents
- Get Account Access Consents
-
-
Account Access
-
Accounts
-
Balances
-
Beneficiaries
-
Direct Debits
-
Domestic Payments
-
Create Domestic Payment Consents
-
Create Domestic Payments
-
Get Domestic Payment Consents
-
Get Domestic Payment Consents Funds Confirmation
-
Get Domestic Payments
-
Create Domestic Payment Consents
-
Domestic Scheduled Payments
-
Create Domestic Scheduled Payment Consents
-
Create Domestic Scheduled Payments
-
Get Domestic Scheduled Payment Consents
-
Get Domestic Scheduled Payments
-
Create Domestic Scheduled Payment Consents
-
Domestic Standing Orders
-
Create Domestic Standing Order Consents
-
Create Domestic Standing Orders
-
Get Domestic Standing Order Consents
-
Get Domestic Standing Orders
-
Create Domestic Standing Order Consents
-
Dynamic Resource Doc
-
Example Title
-
File Payments
-
Create File Payment Consents
-
Create File Payment Consents
-
Create File Payments
-
Get File Payment Consents
-
Get File Payment Consents
-
Get File Payments
-
Get File Payments
-
Create File Payment Consents
-
Funds Confirmations
-
Create Funds Confirmation
-
Create Funds Confirmation Consent
-
Delete Funds Confirmation Consent
-
Get Funds Confirmation Consent
-
Create Funds Confirmation
-
International Payments
-
Create International Payment Consents
-
Create International Payments
-
Get International Payment Consents
-
Get International Payment Consents Funds Confirmation
-
Get International Payments
-
Create International Payment Consents
-
International Scheduled Payments
-
Create International Scheduled Payment Consents
-
Create International Scheduled Payments
-
Get International Scheduled Payment Consents
-
Get International Scheduled Payment Consents Funds Confirmation
-
Get International Scheduled Payments
-
Create International Scheduled Payment Consents
-
International Standing Orders
-
Create International Standing Order Consents
-
Create International Standing Orders
-
Get International Standing Order Consents
-
Get International Standing Orders
-
Create International Standing Order Consents
-
Offers
-
Partys
-
Products
-
Scheduled Payments
-
Standing Orders
-
Statements
-
Swagger Call getBanks
-
Transactions
-
_Credit Application Form
-
Create new Credit Application Form
-
Delete Credit Application Form by id
-
Get Credit Application Form List
-
Get Credit Application Form by id
-
Update Credit Application Form
-
Create new Credit Application Form
-
_TESTING
v3.1 (83 APIs)
Create File Payment Consents
NOTE: This endpoint currently only returns example data.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
CONSENTID: CONSENTID
JSON request body fields:
JSON response body fields:
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Create File Payment Consents
NOTE: This endpoint currently only returns example data.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
JSON request body fields:
JSON response body fields:
{
"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",
"CreationDateTime":"2000-01-23T04:56:07.000+00:00",
"CutOffDateTime":"2000-01-23T04:56:07.000+00:00",
"Authorisation":{
"CompletionDateTime":"2000-01-23T04:56:07.000+00:00",
"AuthorisationType":{
}
},
"Charges":[{
"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],
"Amount":{
"Amount":{
},
"Currency":"Currency"
},
"ChargeBearer":{
}
},{
"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],
"Amount":{
"Amount":{
},
"Currency":"Currency"
},
"ChargeBearer":{
}
}],
"ConsentId":"ConsentId",
"Initiation":{
"SupplementaryData":{
},
"ControlSum":0.8008281904610115,
"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"],
"DebtorAccount":{
"SecondaryIdentification":"SecondaryIdentification",
"SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
"Identification":"Identification",
"Name":"Name"
},
"RemittanceInformation":{
"Unstructured":"Unstructured",
"Reference":"Reference"
},
"FileType":["UK.OBIE.PaymentInitiation.3.1","UK.OBIE.pain.001.001.08"],
"FileHash":"FileHash",
"NumberOfTransactions":"NumberOfTransactions",
"FileReference":"FileReference",
"RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00"
}
}
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Create File Payments
NOTE: This endpoint currently only returns example data.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
JSON request body fields:
JSON response body fields:
{
"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",
"CreationDateTime":"2000-01-23T04:56:07.000+00:00",
"FilePaymentId":"FilePaymentId",
"Charges":[{
"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],
"Amount":{
"Amount":{
},
"Currency":"Currency"
},
"ChargeBearer":{
}
},{
"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],
"Amount":{
"Amount":{
},
"Currency":"Currency"
},
"ChargeBearer":{
}
}],
"ConsentId":"ConsentId",
"Initiation":{
"SupplementaryData":{
},
"ControlSum":0.8008281904610115,
"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"],
"DebtorAccount":{
"SecondaryIdentification":"SecondaryIdentification",
"SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
"Identification":"Identification",
"Name":"Name"
},
"RemittanceInformation":{
"Unstructured":"Unstructured",
"Reference":"Reference"
},
"FileType":["UK.OBIE.PaymentInitiation.3.1","UK.OBIE.pain.001.001.08"],
"FileHash":"FileHash",
"NumberOfTransactions":"NumberOfTransactions",
"FileReference":"FileReference",
"RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00"
},
"MultiAuthorisation":{
"Status":{
},
"NumberReceived":6,
"LastUpdateDateTime":"2000-01-23T04:56:07.000+00:00",
"ExpirationDateTime":"2000-01-23T04:56:07.000+00:00",
"NumberRequired":0
}
}
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get File Payment Consents
NOTE: This endpoint currently only returns example data.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
CONSENTID: CONSENTID
JSON response body fields:
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get File Payment Consents
NOTE: This endpoint currently only returns example data.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
CONSENTID: CONSENTID
JSON response body fields:
{
"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",
"CreationDateTime":"2000-01-23T04:56:07.000+00:00",
"CutOffDateTime":"2000-01-23T04:56:07.000+00:00",
"Authorisation":{
"CompletionDateTime":"2000-01-23T04:56:07.000+00:00",
"AuthorisationType":{
}
},
"Charges":[{
"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],
"Amount":{
"Amount":{
},
"Currency":"Currency"
},
"ChargeBearer":{
}
},{
"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],
"Amount":{
"Amount":{
},
"Currency":"Currency"
},
"ChargeBearer":{
}
}],
"ConsentId":"ConsentId",
"Initiation":{
"SupplementaryData":{
},
"ControlSum":0.8008281904610115,
"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"],
"DebtorAccount":{
"SecondaryIdentification":"SecondaryIdentification",
"SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
"Identification":"Identification",
"Name":"Name"
},
"RemittanceInformation":{
"Unstructured":"Unstructured",
"Reference":"Reference"
},
"FileType":["UK.OBIE.PaymentInitiation.3.1","UK.OBIE.pain.001.001.08"],
"FileHash":"FileHash",
"NumberOfTransactions":"NumberOfTransactions",
"FileReference":"FileReference",
"RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00"
}
}
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get File Payments
NOTE: This endpoint currently only returns example data.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
FILEPAYMENTID: FILEPAYMENTID
JSON response body fields:
{
"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",
"CreationDateTime":"2000-01-23T04:56:07.000+00:00",
"FilePaymentId":"FilePaymentId",
"Charges":[{
"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],
"Amount":{
"Amount":{
},
"Currency":"Currency"
},
"ChargeBearer":{
}
},{
"Type":["UK.OBIE.CHAPSOut","UK.OBIE.BalanceTransferOut","UK.OBIE.MoneyTransferOut"],
"Amount":{
"Amount":{
},
"Currency":"Currency"
},
"ChargeBearer":{
}
}],
"ConsentId":"ConsentId",
"Initiation":{
"SupplementaryData":{
},
"ControlSum":0.8008281904610115,
"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"],
"DebtorAccount":{
"SecondaryIdentification":"SecondaryIdentification",
"SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
"Identification":"Identification",
"Name":"Name"
},
"RemittanceInformation":{
"Unstructured":"Unstructured",
"Reference":"Reference"
},
"FileType":["UK.OBIE.PaymentInitiation.3.1","UK.OBIE.pain.001.001.08"],
"FileHash":"FileHash",
"NumberOfTransactions":"NumberOfTransactions",
"FileReference":"FileReference",
"RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00"
},
"MultiAuthorisation":{
"Status":{
},
"NumberReceived":6,
"LastUpdateDateTime":"2000-01-23T04:56:07.000+00:00",
"ExpirationDateTime":"2000-01-23T04:56:07.000+00:00",
"NumberRequired":0
}
}
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get File Payments
NOTE: This endpoint currently only returns example data.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
FILEPAYMENTID: FILEPAYMENTID
JSON response body fields:
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.