-
Account Access Consents
-
Create Account Access Consents
-
Get Account Access Consents by ConsentId
-
Update Account Access Consent Status by ConsentId
-
Create Account Access Consents
-
Accounts
-
Balances
-
Beneficiaries
-
Direct Debits
-
Domestic Future Dated Payment Consents
-
Create Domestic Future Dated Payment Cancellation Consents
-
Create Domestic Future Dated Payment Consents
-
Get Domestic Future Dated Payment Cancellation Consents by ConsentId
-
Get Domestic Future Dated Payment Consents by ConsentId
-
Create Domestic Future Dated Payment Cancellation Consents
-
Domestic Future Dated Payments
-
Create Domestic Future Dated Payments
-
Get Domestic Future Dated Payment Details by DomesticFutureDatedPaymentId
-
Get Domestic Future Dated Payments by DomesticFutureDatedPaymentId
-
Patch Domestic Future Dated Payments by DomesticFutureDatedPaymentId
-
Create Domestic Future Dated Payments
-
Domestic Payments
-
Create Domestic Payments
-
Get Domestic Payment details by DomesticPaymentId
-
Get Domestic Payments by DomesticPaymentId
-
Create Domestic Payments
-
Domestic Payments Consents
-
Create Domestic Payment Consents
-
Get Domestic Payment Consents Funds Confirmation by ConsentId
-
Get Domestic Payment Consents by ConsentId
-
Create Domestic Payment Consents
-
Event Notification
-
File Payment Consents
-
Create File Payment Consents
-
Create File Payment Consents File by ConsentId
-
Get File Payment Consents File by ConsentId
-
Get File Payment Consents by ConsentId
-
Create File Payment Consents
-
File Payments
-
Create File Payments
-
Get File Payment Details by FilePaymentId
-
Get File Payments Report File by FilePaymentId
-
Get File Payments by FilePaymentId
-
Create File Payments
-
Future Dated Payments
-
International Payment Consents
-
Create International Payment Consents
-
Get International Payment Consents Funds Confirmation by ConsentId
-
Get International Payment Consents by ConsentId
-
Create International Payment Consents
-
International Payments
-
Create International Payments
-
Get International Payment Details by InternationalPaymentId
-
Get International Payments by InternationalPaymentId
-
Create International Payments
-
Offers
-
Parties
-
Standing Orders
-
Statements
-
Get Accounts Statement Tranactions by AccountId and StatementId
-
Get Accounts Statement by AccountId and StatementId
-
Get Accounts Statements File by AccountId and StatementId
-
Get Accounts Statements by AccountId
-
Get Statements
-
Get Accounts Statement Tranactions by AccountId and StatementId
-
Supplementary Account Info
-
Transactions
MXOFv1.0.0 (57 APIs)
Get Accounts Parties by AccountId
NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
URL Parameters:
- ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
JSON response body fields:
-
AccountRole: AccountRole
-
AddressLine: AddressLine
-
AddressType: AddressType
-
BeneficialOwnership: BeneficialOwnership
-
BuildingNumber: BuildingNumber
-
Country: Country
-
CountrySubDivision: CountrySubDivision
-
[Data](/glossary#Scenario 6: Update credit score based on transaction and device data.): Data
-
EmailAddress: EmailAddress
-
First: First
-
FirstAvailableDateTime: FirstAvailableDateTime
-
FullLegalName: FullLegalName
-
Last: Last
-
LegalStructure: LegalStructure
-
[Links](/glossary#User Customer Links): Links
-
Mobile: Mobile
-
Name: ACCOUNT_MANAGEMENT_FEE
-
Next: Next
-
[Party](/glossary#Scenario 3: Create counterparty and make payment): Party
-
PartyId: PartyId
-
PartyNumber: PartyNumber
-
PartyType: PartyType
-
Prev: Prev
-
Related: Related
-
Relationships: Relationships
-
Self: Self
-
StreetName: StreetName
-
TotalPages: TotalPages
-
TownName: TownName
{
"Meta":{
"FirstAvailableDateTime":{
},
"TotalPages":0
},
"Links":{
"Last":"http://example.com/aeiou",
"Prev":"http://example.com/aeiou",
"Next":"http://example.com/aeiou",
"First":"http://example.com/aeiou",
"Self":"http://example.com/aeiou"
},
"Data":{
"Party":[{
"BeneficialOwnership":true,
"Address":[{
"CountrySubDivision":{
},
"StreetName":{
},
"AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
"BuildingNumber":{
},
"TownName":{
},
"Country":{
},
"AddressType":{
},
"PostCode":{
}
},{
"CountrySubDivision":{
},
"StreetName":{
},
"AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
"BuildingNumber":{
},
"TownName":{
},
"Country":{
},
"AddressType":{
},
"PostCode":{
}
}],
"AccountRole":{
},
"Mobile":{
},
"EmailAddress":{
},
"LegalStructure":{
},
"Name":{
},
"PartyNumber":{
},
"Relationships":{
"Account":{
"Related":"http://example.com/aeiou",
"Id":"Id"
}
},
"FullLegalName":{
},
"PartyId":{
},
"Phone":{
},
"PartyType":{
}
},{
"BeneficialOwnership":true,
"Address":[{
"CountrySubDivision":{
},
"StreetName":{
},
"AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
"BuildingNumber":{
},
"TownName":{
},
"Country":{
},
"AddressType":{
},
"PostCode":{
}
},{
"CountrySubDivision":{
},
"StreetName":{
},
"AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
"BuildingNumber":{
},
"TownName":{
},
"Country":{
},
"AddressType":{
},
"PostCode":{
}
}],
"AccountRole":{
},
"Mobile":{
},
"EmailAddress":{
},
"LegalStructure":{
},
"Name":{
},
"PartyNumber":{
},
"Relationships":{
"Account":{
"Related":"http://example.com/aeiou",
"Id":"Id"
}
},
"FullLegalName":{
},
"PartyId":{
},
"Phone":{
},
"PartyType":{
}
}]
}
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get Accounts Party by AccountId
NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
URL Parameters:
- ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
JSON response body fields:
-
AccountRole: AccountRole
-
AddressLine: AddressLine
-
AddressType: AddressType
-
BeneficialOwnership: BeneficialOwnership
-
BuildingNumber: BuildingNumber
-
Country: Country
-
CountrySubDivision: CountrySubDivision
-
[Data](/glossary#Scenario 6: Update credit score based on transaction and device data.): Data
-
EmailAddress: EmailAddress
-
First: First
-
FirstAvailableDateTime: FirstAvailableDateTime
-
FullLegalName: FullLegalName
-
Last: Last
-
LegalStructure: LegalStructure
-
[Links](/glossary#User Customer Links): Links
-
Mobile: Mobile
-
Name: ACCOUNT_MANAGEMENT_FEE
-
Next: Next
-
[Party](/glossary#Scenario 3: Create counterparty and make payment): Party
-
PartyId: PartyId
-
PartyNumber: PartyNumber
-
PartyType: PartyType
-
Prev: Prev
-
Related: Related
-
Relationships: Relationships
-
Self: Self
-
StreetName: StreetName
-
TotalPages: TotalPages
-
TownName: TownName
{
"Meta":{
"FirstAvailableDateTime":{
},
"TotalPages":0
},
"Links":{
"Last":"http://example.com/aeiou",
"Prev":"http://example.com/aeiou",
"Next":"http://example.com/aeiou",
"First":"http://example.com/aeiou",
"Self":"http://example.com/aeiou"
},
"Data":{
"Party":{
"BeneficialOwnership":true,
"Address":[{
"CountrySubDivision":{
},
"StreetName":{
},
"AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
"BuildingNumber":{
},
"TownName":{
},
"Country":{
},
"AddressType":{
},
"PostCode":{
}
},{
"CountrySubDivision":{
},
"StreetName":{
},
"AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
"BuildingNumber":{
},
"TownName":{
},
"Country":{
},
"AddressType":{
},
"PostCode":{
}
}],
"AccountRole":{
},
"Mobile":{
},
"EmailAddress":{
},
"LegalStructure":{
},
"Name":{
},
"PartyNumber":{
},
"Relationships":{
"Account":{
"Related":"http://example.com/aeiou",
"Id":"Id"
}
},
"FullLegalName":{
},
"PartyId":{
},
"Phone":{
},
"PartyType":{
}
}
}
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get Party
NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
JSON response body fields:
-
AccountRole: AccountRole
-
AddressLine: AddressLine
-
AddressType: AddressType
-
BeneficialOwnership: BeneficialOwnership
-
BuildingNumber: BuildingNumber
-
Country: Country
-
CountrySubDivision: CountrySubDivision
-
[Data](/glossary#Scenario 6: Update credit score based on transaction and device data.): Data
-
EmailAddress: EmailAddress
-
First: First
-
FirstAvailableDateTime: FirstAvailableDateTime
-
FullLegalName: FullLegalName
-
Last: Last
-
LegalStructure: LegalStructure
-
[Links](/glossary#User Customer Links): Links
-
Mobile: Mobile
-
Name: ACCOUNT_MANAGEMENT_FEE
-
Next: Next
-
[Party](/glossary#Scenario 3: Create counterparty and make payment): Party
-
PartyId: PartyId
-
PartyNumber: PartyNumber
-
PartyType: PartyType
-
Prev: Prev
-
Related: Related
-
Relationships: Relationships
-
Self: Self
-
StreetName: StreetName
-
TotalPages: TotalPages
-
TownName: TownName
{
"Meta":{
"FirstAvailableDateTime":{
},
"TotalPages":0
},
"Links":{
"Last":"http://example.com/aeiou",
"Prev":"http://example.com/aeiou",
"Next":"http://example.com/aeiou",
"First":"http://example.com/aeiou",
"Self":"http://example.com/aeiou"
},
"Data":{
"Party":{
"BeneficialOwnership":true,
"Address":[{
"CountrySubDivision":{
},
"StreetName":{
},
"AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
"BuildingNumber":{
},
"TownName":{
},
"Country":{
},
"AddressType":{
},
"PostCode":{
}
},{
"CountrySubDivision":{
},
"StreetName":{
},
"AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
"BuildingNumber":{
},
"TownName":{
},
"Country":{
},
"AddressType":{
},
"PostCode":{
}
}],
"AccountRole":{
},
"Mobile":{
},
"EmailAddress":{
},
"LegalStructure":{
},
"Name":{
},
"PartyNumber":{
},
"Relationships":{
"Account":{
"Related":"http://example.com/aeiou",
"Id":"Id"
}
},
"FullLegalName":{
},
"PartyId":{
},
"Phone":{
},
"PartyType":{
}
}
}
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.