-
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)
Create Domestic Future Dated Payment Cancellation Consents
NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
JSON request body fields:
-
[Data](/glossary#Scenario 6: Update credit score based on transaction and device data.): Data
-
DomesticFutureDatedPaymentId: DomesticFutureDatedPaymentId
-
ExpectedExecutionDateTime: ExpectedExecutionDateTime
-
ExpectedSettlementDateTime: ExpectedSettlementDateTime
-
Permission: Permission
JSON response body fields:
-
Amount: 10.12
-
ChargeBearer: ChargeBearer
-
Charges: Charges
-
ConsentId: ConsentId
-
Currency: EUR
-
[Data](/glossary#Scenario 6: Update credit score based on transaction and device data.): Data
-
DomesticFutureDatedPaymentId: DomesticFutureDatedPaymentId
-
ExpectedExecutionDateTime: ExpectedExecutionDateTime
-
ExpectedSettlementDateTime: ExpectedSettlementDateTime
-
Permission: Permission
{
"Data":{
"ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00",
"DomesticFutureDatedPaymentId":"DomesticFutureDatedPaymentId",
"Permission":"Create",
"Charges":[{
"Type":{
},
"Amount":{
"Amount":{
},
"Currency":{
}
},
"ChargeBearer":{
}
},{
"Type":{
},
"Amount":{
"Amount":{
},
"Currency":{
}
},
"ChargeBearer":{
}
}],
"ConsentId":"ConsentId",
"ExpectedSettlementDateTime":"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 Domestic Future Dated Payment Consents
NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
JSON request body fields:
-
AddressLine: AddressLine
-
AddressType: AddressType
-
Amount: 10.12
-
AppliedAuthenticationApproach: AppliedAuthenticationApproach
-
Authorisation: Authorisation
-
AuthorisationType: AuthorisationType
-
BuildingNumber: BuildingNumber
-
CompletionDateTime: CompletionDateTime
-
Country: Country
-
CountrySubDivision: CountrySubDivision
-
CreditorPostalAddress: CreditorPostalAddress
-
Currency: EUR
-
[Data](/glossary#Scenario 6: Update credit score based on transaction and device data.): Data
-
DeliveryAddress: DeliveryAddress
-
Department: Department
-
EndToEndIdentification: EndToEndIdentification
-
Identification: Identification
-
Initiation: Initiation
-
InstructedAmount: 100
-
InstructionIdentification: InstructionIdentification
-
LocalInstrument: LocalInstrument
-
MerchantCategoryCode: MerchantCategoryCode
-
MerchantCustomerIdentification: MerchantCustomerIdentification
-
Name: ACCOUNT_MANAGEMENT_FEE
-
PaymentContextCode: PaymentContextCode
-
Permission: Permission
-
ReadRefundAccount: ReadRefundAccount
-
Reference: Reference
-
ReferencePaymentOrderId: ReferencePaymentOrderId
-
RemittanceDescription: RemittanceDescription
-
RemittanceInformation: RemittanceInformation
-
RequestedExecutionDateTime: RequestedExecutionDateTime
-
RequestedSCAExemptionType: RequestedSCAExemptionType
-
Risk: Risk
-
SCASupportData: SCASupportData
-
SchemeName: SchemeName
-
StreetName: StreetName
-
SubDepartment: SubDepartment
-
SupplementaryData: SupplementaryData
-
TownName: TownName
JSON response body fields:
-
AddressLine: AddressLine
-
AddressType: AddressType
-
Amount: 10.12
-
AppliedAuthenticationApproach: AppliedAuthenticationApproach
-
Authorisation: Authorisation
-
AuthorisationType: AuthorisationType
-
BuildingNumber: BuildingNumber
-
ChargeBearer: ChargeBearer
-
Charges: Charges
-
CompletionDateTime: CompletionDateTime
-
ConsentId: ConsentId
-
Country: Country
-
CountrySubDivision: CountrySubDivision
-
CreationDateTime: CreationDateTime
-
CreditorPostalAddress: CreditorPostalAddress
-
Currency: EUR
-
CutOffDateTime: CutOffDateTime
-
[Data](/glossary#Scenario 6: Update credit score based on transaction and device data.): Data
-
Debtor: Debtor
-
DeliveryAddress: DeliveryAddress
-
Department: Department
-
EndToEndIdentification: EndToEndIdentification
-
ExpectedExecutionDateTime: ExpectedExecutionDateTime
-
ExpectedSettlementDateTime: ExpectedSettlementDateTime
-
First: First
-
FirstAvailableDateTime: FirstAvailableDateTime
-
Identification: Identification
-
Initiation: Initiation
-
InstructedAmount: 100
-
InstructionIdentification: InstructionIdentification
-
Last: Last
-
[Links](/glossary#User Customer Links): Links
-
LocalInstrument: LocalInstrument
-
MerchantCategoryCode: MerchantCategoryCode
-
MerchantCustomerIdentification: MerchantCustomerIdentification
-
Name: ACCOUNT_MANAGEMENT_FEE
-
Next: Next
-
PaymentContextCode: PaymentContextCode
-
Permission: Permission
-
Prev: Prev
-
ReadRefundAccount: ReadRefundAccount
-
Reference: Reference
-
ReferencePaymentOrderId: ReferencePaymentOrderId
-
RemittanceDescription: RemittanceDescription
-
RemittanceInformation: RemittanceInformation
-
RequestedExecutionDateTime: RequestedExecutionDateTime
-
RequestedSCAExemptionType: RequestedSCAExemptionType
-
Risk: Risk
-
SCASupportData: SCASupportData
-
SchemeName: SchemeName
-
Self: Self
-
StatusUpdateDateTime: StatusUpdateDateTime
-
StreetName: StreetName
-
SubDepartment: SubDepartment
-
SupplementaryData: SupplementaryData
-
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"
},
"Risk":{
"DeliveryAddress":{
"CountrySubDivision":["CountrySubDivision","CountrySubDivision"],
"AddressLine":["AddressLine","AddressLine"],
"Country":"Country"
},
"PaymentContextCode":"BillPayment",
"MerchantCategoryCode":"MerchantCategoryCode",
"MerchantCustomerIdentification":"MerchantCustomerIdentification"
},
"Data":{
"Status":"Authorised",
"ConsentId":"ConsentId",
"SCASupportData":{
"RequestedSCAExemptionType":"BillPayment",
"AppliedAuthenticationApproach":"CA",
"ReferencePaymentOrderId":"ReferencePaymentOrderId"
},
"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00",
"Debtor":{
"Name":"Name"
},
"CreationDateTime":"2000-01-23T04:56:07.000+00:00",
"ExpectedExecutionDateTime":"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":"Single"
},
"Permission":"Create",
"Charges":[{
"Type":{
},
"Amount":{
"Amount":{
},
"Currency":{
}
},
"ChargeBearer":{
}
},{
"Type":{
},
"Amount":{
"Amount":{
},
"Currency":{
}
},
"ChargeBearer":{
}
}],
"ReadRefundAccount":"No",
"Initiation":{
"SupplementaryData":{
},
"LocalInstrument":{
},
"DebtorAccount":{
"Name":"Name"
},
"RemittanceInformation":{
"RemittanceDescription":"RemittanceDescription",
"Reference":"Reference"
},
"EndToEndIdentification":"EndToEndIdentification",
"InstructionIdentification":"InstructionIdentification",
"CreditorAccount":{
"Identification":{
},
"SchemeName":{
},
"Name":"Name"
},
"CreditorPostalAddress":{
"CountrySubDivision":{
},
"StreetName":{
},
"Department":{
},
"AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
"BuildingNumber":{
},
"TownName":{
},
"Country":{
},
"SubDepartment":{
},
"AddressType":{
},
"PostCode":{
}
},
"InstructedAmount":{
"Amount":{
},
"Currency":{
}
},
"RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00"
},
"ExpectedSettlementDateTime":"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 Domestic Future Dated Payment Cancellation Consents by ConsentId
NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
URL Parameters:
JSON response body fields:
-
Amount: 10.12
-
ChargeBearer: ChargeBearer
-
Charges: Charges
-
ConsentId: ConsentId
-
Currency: EUR
-
[Data](/glossary#Scenario 6: Update credit score based on transaction and device data.): Data
-
DomesticFutureDatedPaymentId: DomesticFutureDatedPaymentId
-
ExpectedExecutionDateTime: ExpectedExecutionDateTime
-
ExpectedSettlementDateTime: ExpectedSettlementDateTime
-
Permission: Permission
{
"Data":{
"ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00",
"DomesticFutureDatedPaymentId":"DomesticFutureDatedPaymentId",
"Permission":"Create",
"Charges":[{
"Type":{
},
"Amount":{
"Amount":{
},
"Currency":{
}
},
"ChargeBearer":{
}
},{
"Type":{
},
"Amount":{
"Amount":{
},
"Currency":{
}
},
"ChargeBearer":{
}
}],
"ConsentId":"ConsentId",
"ExpectedSettlementDateTime":"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 Domestic Future Dated Payment Consents by ConsentId
NOTE: This endpoint currently only returns example data.
Authentication is Mandatory
URL Parameters:
JSON response body fields:
-
AddressLine: AddressLine
-
AddressType: AddressType
-
Amount: 10.12
-
AppliedAuthenticationApproach: AppliedAuthenticationApproach
-
Authorisation: Authorisation
-
AuthorisationType: AuthorisationType
-
BuildingNumber: BuildingNumber
-
ChargeBearer: ChargeBearer
-
Charges: Charges
-
CompletionDateTime: CompletionDateTime
-
ConsentId: ConsentId
-
Country: Country
-
CountrySubDivision: CountrySubDivision
-
CreationDateTime: CreationDateTime
-
CreditorPostalAddress: CreditorPostalAddress
-
Currency: EUR
-
CutOffDateTime: CutOffDateTime
-
[Data](/glossary#Scenario 6: Update credit score based on transaction and device data.): Data
-
Debtor: Debtor
-
DeliveryAddress: DeliveryAddress
-
Department: Department
-
EndToEndIdentification: EndToEndIdentification
-
ExpectedExecutionDateTime: ExpectedExecutionDateTime
-
ExpectedSettlementDateTime: ExpectedSettlementDateTime
-
First: First
-
FirstAvailableDateTime: FirstAvailableDateTime
-
Identification: Identification
-
Initiation: Initiation
-
InstructedAmount: 100
-
InstructionIdentification: InstructionIdentification
-
Last: Last
-
[Links](/glossary#User Customer Links): Links
-
LocalInstrument: LocalInstrument
-
MerchantCategoryCode: MerchantCategoryCode
-
MerchantCustomerIdentification: MerchantCustomerIdentification
-
Name: ACCOUNT_MANAGEMENT_FEE
-
Next: Next
-
PaymentContextCode: PaymentContextCode
-
Permission: Permission
-
Prev: Prev
-
ReadRefundAccount: ReadRefundAccount
-
Reference: Reference
-
ReferencePaymentOrderId: ReferencePaymentOrderId
-
RemittanceDescription: RemittanceDescription
-
RemittanceInformation: RemittanceInformation
-
RequestedExecutionDateTime: RequestedExecutionDateTime
-
RequestedSCAExemptionType: RequestedSCAExemptionType
-
Risk: Risk
-
SCASupportData: SCASupportData
-
SchemeName: SchemeName
-
Self: Self
-
StatusUpdateDateTime: StatusUpdateDateTime
-
StreetName: StreetName
-
SubDepartment: SubDepartment
-
SupplementaryData: SupplementaryData
-
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"
},
"Risk":{
"DeliveryAddress":{
"CountrySubDivision":["CountrySubDivision","CountrySubDivision"],
"AddressLine":["AddressLine","AddressLine"],
"Country":"Country"
},
"PaymentContextCode":"BillPayment",
"MerchantCategoryCode":"MerchantCategoryCode",
"MerchantCustomerIdentification":"MerchantCustomerIdentification"
},
"Data":{
"Status":"Authorised",
"ConsentId":"ConsentId",
"SCASupportData":{
"RequestedSCAExemptionType":"BillPayment",
"AppliedAuthenticationApproach":"CA",
"ReferencePaymentOrderId":"ReferencePaymentOrderId"
},
"StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00",
"Debtor":{
"Name":"Name"
},
"CreationDateTime":"2000-01-23T04:56:07.000+00:00",
"ExpectedExecutionDateTime":"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":"Single"
},
"Permission":"Create",
"Charges":[{
"Type":{
},
"Amount":{
"Amount":{
},
"Currency":{
}
},
"ChargeBearer":{
}
},{
"Type":{
},
"Amount":{
"Amount":{
},
"Currency":{
}
},
"ChargeBearer":{
}
}],
"ReadRefundAccount":"No",
"Initiation":{
"SupplementaryData":{
},
"LocalInstrument":{
},
"DebtorAccount":{
"Name":"Name"
},
"RemittanceInformation":{
"RemittanceDescription":"RemittanceDescription",
"Reference":"Reference"
},
"EndToEndIdentification":"EndToEndIdentification",
"InstructionIdentification":"InstructionIdentification",
"CreditorAccount":{
"Identification":{
},
"SchemeName":{
},
"Name":"Name"
},
"CreditorPostalAddress":{
"CountrySubDivision":{
},
"StreetName":{
},
"Department":{
},
"AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
"BuildingNumber":{
},
"TownName":{
},
"Country":{
},
"SubDepartment":{
},
"AddressType":{
},
"PostCode":{
}
},
"InstructedAmount":{
"Amount":{
},
"Currency":{
}
},
"RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00"
},
"ExpectedSettlementDateTime":"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.