API Explorer

⯆

API Explorer

My Collections

Account Access
- Create Account Access Consents
- Delete Account Access Consents
- Get Account Access Consents
Accounts
- Get Accounts
- Get Accounts
Balances
- Get Balances
- Get Balances
Beneficiaries
- Get Beneficiaries
- Get Beneficiaries
Direct Debits
- Get Direct Debits
- Get Direct Debits
Domestic Payments
- Create Domestic Payment Consents
- Create Domestic Payments
- Get Domestic Payment Consents
- Get Domestic Payment Consents Funds Confirmation
- Get Domestic Payments
Domestic Scheduled Payments
- Create Domestic Scheduled Payment Consents
- Create Domestic Scheduled Payments
- Get Domestic Scheduled Payment Consents
- Get Domestic Scheduled Payments
Domestic Standing Orders
- Create Domestic Standing Order Consents
- Create Domestic Standing Orders
- Get Domestic Standing Order Consents
- Get Domestic Standing Orders
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
Funds Confirmations
- Create Funds Confirmation
- Create Funds Confirmation Consent
- Delete Funds Confirmation Consent
- Get Funds Confirmation Consent
International Payments
- Create International Payment Consents
- Create International Payments
- Get International Payment Consents
- Get International Payment Consents Funds Confirmation
- Get International Payments
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
International Standing Orders
- Create International Standing Order Consents
- Create International Standing Orders
- Get International Standing Order Consents
- Get International Standing Orders
Offers
- Get Offers
- Get Offers
Partys
- Get Party
- Get Party
Products
- Get Products
- Get Products
Scheduled Payments
- Get Scheduled Payments
- Get Scheduled Payments
Standing Orders
- Get Standing Orders
- Get Standing Orders
Statements
- Get Statements
- Get Statements
- Get Statements
- Get Statements
- Get Transactions
- Get Transactions
Transactions
- Get Transactions
- Get Transactions

Log off

v3.1 (67 APIs)

API Host: https://api3.openbankproject.com

Create International Payment Consents

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

JSON request body fields:

JSON response body fields:

AddressLine: AddressLine
AddressType: AddressType
Amount: 10.12
Authorisation: Authorisation
AuthorisationType: AuthorisationType
BuildingNumber: BuildingNumber
ChargeBearer: ChargeBearer
Charges: Charges
CompletionDateTime: CompletionDateTime
ConsentId: ConsentId
ContractIdentification: ContractIdentification
Country: Country
CountrySubDivision: CountrySubDivision
CreationDateTime: CreationDateTime
Creditor: Creditor
CreditorAgent: CreditorAgent
Currency: EUR
CurrencyOfTransfer: CurrencyOfTransfer
CutOffDateTime: CutOffDateTime
[Data](/glossary#Scenario 6: Update credit score based on transaction and device data.): Data
DeliveryAddress: DeliveryAddress
Department: Department
EndToEndIdentification: EndToEndIdentification
ExchangeRate: ExchangeRate
ExchangeRateInformation: ExchangeRateInformation
ExpectedExecutionDateTime: ExpectedExecutionDateTime
ExpectedSettlementDateTime: ExpectedSettlementDateTime
ExpirationDateTime: ExpirationDateTime
First: First
FirstAvailableDateTime: FirstAvailableDateTime
Identification: Identification
Initiation: Initiation
InstructedAmount: 100
InstructionIdentification: InstructionIdentification
InstructionPriority: InstructionPriority
Last: Last
[Links](/glossary#User Customer Links): Links
LocalInstrument: LocalInstrument
MerchantCategoryCode: MerchantCategoryCode
MerchantCustomerIdentification: MerchantCustomerIdentification
Name: ACCOUNT_MANAGEMENT_FEE
Next: Next
PaymentContextCode: PaymentContextCode
PostalAddress: PostalAddress
Prev: Prev
Purpose: Purpose
RateType: RateType
Reference: Reference
RemittanceInformation: RemittanceInformation
Risk: Risk
SchemeName: SchemeName
SecondaryIdentification: SecondaryIdentification
Self: Self
StatusUpdateDateTime: StatusUpdateDateTime
StreetName: StreetName
SubDepartment: SubDepartment
SupplementaryData: SupplementaryData
TotalPages: TotalPages
TownName: TownName
UnitCurrency: UnitCurrency
Unstructured: Unstructured

Typical Successful Response:

								
									{
  "Meta":{
    "FirstAvailableDateTime":{
      
    },
    "TotalPages":0
  },
  "Risk":{
    "PaymentContextCode":{
      
    },
    "DeliveryAddress":{
      "StreetName":"StreetName",
      "CountrySubDivision":["CountrySubDivision","CountrySubDivision"],
      "AddressLine":["AddressLine","AddressLine"],
      "BuildingNumber":"BuildingNumber",
      "TownName":"TownName",
      "Country":"Country",
      "PostCode":"PostCode"
    },
    "MerchantCategoryCode":"MerchantCategoryCode",
    "MerchantCustomerIdentification":"MerchantCustomerIdentification"
  },
  "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",
    "ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00",
    "CutOffDateTime":"2000-01-23T04:56:07.000+00:00",
    "ExchangeRateInformation":{
      "ExchangeRate":0.8008281904610115,
      "ExpirationDateTime":"2000-01-23T04:56:07.000+00:00",
      "RateType":{
        
      },
      "UnitCurrency":"UnitCurrency",
      "ContractIdentification":"ContractIdentification"
    },
    "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":{
        
      },
      "DebtorAccount":{
        "SecondaryIdentification":"SecondaryIdentification",
        "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
        "Identification":"Identification",
        "Name":"Name"
      },
      "CreditorAgent":{
        "PostalAddress":{
          "StreetName":"StreetName",
          "CountrySubDivision":"CountrySubDivision",
          "Department":"Department",
          "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
          "BuildingNumber":"BuildingNumber",
          "TownName":"TownName",
          "Country":"Country",
          "SubDepartment":"SubDepartment",
          "AddressType":{
            
          },
          "PostCode":"PostCode"
        },
        "SchemeName":["UK.OBIE.BICFI"],
        "Identification":"Identification",
        "Name":"Name"
      },
      "EndToEndIdentification":"EndToEndIdentification",
      "InstructionIdentification":"InstructionIdentification",
      "CurrencyOfTransfer":"CurrencyOfTransfer",
      "CreditorAccount":{
        "SecondaryIdentification":"SecondaryIdentification",
        "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
        "Identification":"Identification",
        "Name":"Name"
      },
      "Purpose":{
        
      },
      "ChargeBearer":{
        
      },
      "InstructionPriority":{
        
      },
      "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"],
      "RemittanceInformation":{
        "Unstructured":"Unstructured",
        "Reference":"Reference"
      },
      "ExchangeRateInformation":{
        "ExchangeRate":6.027456183070403,
        "UnitCurrency":"UnitCurrency",
        "ContractIdentification":"ContractIdentification"
      },
      "Creditor":{
        "PostalAddress":{
          "StreetName":"StreetName",
          "CountrySubDivision":"CountrySubDivision",
          "Department":"Department",
          "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
          "BuildingNumber":"BuildingNumber",
          "TownName":"TownName",
          "Country":"Country",
          "SubDepartment":"SubDepartment",
          "AddressType":{
            
          },
          "PostCode":"PostCode"
        },
        "Name":"Name"
      },
      "InstructedAmount":{
        "Currency":"Currency"
      }
    },
    "ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00"
  }
}

Request Headers:

Response Headers:

Required Roles:

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:

obp.getBankAccountsForUser

Version: UKv3.1, function_name: by createInternationalPaymentConsents, operation_id: UKv3.1-createInternationalPaymentConsents Tags: International Payments, Mocked-Data,

Create International Payments

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

JSON request body fields:

JSON response body fields:

AddressLine: AddressLine
AddressType: AddressType
Amount: 10.12
BuildingNumber: BuildingNumber
ChargeBearer: ChargeBearer
Charges: Charges
ConsentId: ConsentId
ContractIdentification: ContractIdentification
Country: Country
CountrySubDivision: CountrySubDivision
CreationDateTime: CreationDateTime
Creditor: Creditor
CreditorAgent: CreditorAgent
Currency: EUR
CurrencyOfTransfer: CurrencyOfTransfer
[Data](/glossary#Scenario 6: Update credit score based on transaction and device data.): Data
Department: Department
EndToEndIdentification: EndToEndIdentification
ExchangeRate: ExchangeRate
ExchangeRateInformation: ExchangeRateInformation
ExpectedExecutionDateTime: ExpectedExecutionDateTime
ExpectedSettlementDateTime: ExpectedSettlementDateTime
ExpirationDateTime: ExpirationDateTime
First: First
FirstAvailableDateTime: FirstAvailableDateTime
Identification: Identification
Initiation: Initiation
InstructedAmount: 100
InstructionIdentification: InstructionIdentification
InstructionPriority: InstructionPriority
InternationalPaymentId: InternationalPaymentId
Last: Last
LastUpdateDateTime: LastUpdateDateTime
[Links](/glossary#User Customer Links): Links
LocalInstrument: LocalInstrument
MultiAuthorisation: MultiAuthorisation
Name: ACCOUNT_MANAGEMENT_FEE
Next: Next
NumberReceived: NumberReceived
NumberRequired: NumberRequired
PostalAddress: PostalAddress
Prev: Prev
Purpose: Purpose
RateType: RateType
Reference: Reference
RemittanceInformation: RemittanceInformation
SchemeName: SchemeName
SecondaryIdentification: SecondaryIdentification
Self: Self
StatusUpdateDateTime: StatusUpdateDateTime
StreetName: StreetName
SubDepartment: SubDepartment
SupplementaryData: SupplementaryData
TotalPages: TotalPages
TownName: TownName
UnitCurrency: UnitCurrency
Unstructured: Unstructured

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",
    "CreationDateTime":"2000-01-23T04:56:07.000+00:00",
    "ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00",
    "ExchangeRateInformation":{
      "ExchangeRate":0.8008281904610115,
      "ExpirationDateTime":"2000-01-23T04:56:07.000+00:00",
      "RateType":{
        
      },
      "UnitCurrency":"UnitCurrency",
      "ContractIdentification":"ContractIdentification"
    },
    "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":{
        
      }
    }],
    "InternationalPaymentId":"InternationalPaymentId",
    "ConsentId":"ConsentId",
    "Initiation":{
      "SupplementaryData":{
        
      },
      "DebtorAccount":{
        "SecondaryIdentification":"SecondaryIdentification",
        "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
        "Identification":"Identification",
        "Name":"Name"
      },
      "CreditorAgent":{
        "PostalAddress":{
          "StreetName":"StreetName",
          "CountrySubDivision":"CountrySubDivision",
          "Department":"Department",
          "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
          "BuildingNumber":"BuildingNumber",
          "TownName":"TownName",
          "Country":"Country",
          "SubDepartment":"SubDepartment",
          "AddressType":{
            
          },
          "PostCode":"PostCode"
        },
        "SchemeName":["UK.OBIE.BICFI"],
        "Identification":"Identification",
        "Name":"Name"
      },
      "EndToEndIdentification":"EndToEndIdentification",
      "InstructionIdentification":"InstructionIdentification",
      "CurrencyOfTransfer":"CurrencyOfTransfer",
      "CreditorAccount":{
        "SecondaryIdentification":"SecondaryIdentification",
        "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
        "Identification":"Identification",
        "Name":"Name"
      },
      "Purpose":{
        
      },
      "ChargeBearer":{
        
      },
      "InstructionPriority":{
        
      },
      "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"],
      "RemittanceInformation":{
        "Unstructured":"Unstructured",
        "Reference":"Reference"
      },
      "ExchangeRateInformation":{
        "ExchangeRate":6.027456183070403,
        "UnitCurrency":"UnitCurrency",
        "ContractIdentification":"ContractIdentification"
      },
      "Creditor":{
        "PostalAddress":{
          "StreetName":"StreetName",
          "CountrySubDivision":"CountrySubDivision",
          "Department":"Department",
          "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
          "BuildingNumber":"BuildingNumber",
          "TownName":"TownName",
          "Country":"Country",
          "SubDepartment":"SubDepartment",
          "AddressType":{
            
          },
          "PostCode":"PostCode"
        },
        "Name":"Name"
      },
      "InstructedAmount":{
        "Currency":"Currency"
      }
    },
    "ExpectedSettlementDateTime":"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
    }
  }
}

Request Headers:

Response Headers:

Required Roles:

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:

obp.getBankAccountsForUser

Version: UKv3.1, function_name: by createInternationalPayments, operation_id: UKv3.1-createInternationalPayments Tags: International Payments, Mocked-Data,

Get International Payment Consents

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

URL Parameters:

CONSENTID: CONSENTID

JSON response body fields:

AddressLine: AddressLine
AddressType: AddressType
Amount: 10.12
Authorisation: Authorisation
AuthorisationType: AuthorisationType
BuildingNumber: BuildingNumber
ChargeBearer: ChargeBearer
Charges: Charges
CompletionDateTime: CompletionDateTime
ConsentId: ConsentId
ContractIdentification: ContractIdentification
Country: Country
CountrySubDivision: CountrySubDivision
CreationDateTime: CreationDateTime
Creditor: Creditor
CreditorAgent: CreditorAgent
Currency: EUR
CurrencyOfTransfer: CurrencyOfTransfer
CutOffDateTime: CutOffDateTime
[Data](/glossary#Scenario 6: Update credit score based on transaction and device data.): Data
DeliveryAddress: DeliveryAddress
Department: Department
EndToEndIdentification: EndToEndIdentification
ExchangeRate: ExchangeRate
ExchangeRateInformation: ExchangeRateInformation
ExpectedExecutionDateTime: ExpectedExecutionDateTime
ExpectedSettlementDateTime: ExpectedSettlementDateTime
ExpirationDateTime: ExpirationDateTime
First: First
FirstAvailableDateTime: FirstAvailableDateTime
Identification: Identification
Initiation: Initiation
InstructedAmount: 100
InstructionIdentification: InstructionIdentification
InstructionPriority: InstructionPriority
Last: Last
[Links](/glossary#User Customer Links): Links
LocalInstrument: LocalInstrument
MerchantCategoryCode: MerchantCategoryCode
MerchantCustomerIdentification: MerchantCustomerIdentification
Name: ACCOUNT_MANAGEMENT_FEE
Next: Next
PaymentContextCode: PaymentContextCode
PostalAddress: PostalAddress
Prev: Prev
Purpose: Purpose
RateType: RateType
Reference: Reference
RemittanceInformation: RemittanceInformation
Risk: Risk
SchemeName: SchemeName
SecondaryIdentification: SecondaryIdentification
Self: Self
StatusUpdateDateTime: StatusUpdateDateTime
StreetName: StreetName
SubDepartment: SubDepartment
SupplementaryData: SupplementaryData
TotalPages: TotalPages
TownName: TownName
UnitCurrency: UnitCurrency
Unstructured: Unstructured

Typical Successful Response:

								
									{
  "Meta":{
    "FirstAvailableDateTime":{
      
    },
    "TotalPages":0
  },
  "Risk":{
    "PaymentContextCode":{
      
    },
    "DeliveryAddress":{
      "StreetName":"StreetName",
      "CountrySubDivision":["CountrySubDivision","CountrySubDivision"],
      "AddressLine":["AddressLine","AddressLine"],
      "BuildingNumber":"BuildingNumber",
      "TownName":"TownName",
      "Country":"Country",
      "PostCode":"PostCode"
    },
    "MerchantCategoryCode":"MerchantCategoryCode",
    "MerchantCustomerIdentification":"MerchantCustomerIdentification"
  },
  "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",
    "ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00",
    "CutOffDateTime":"2000-01-23T04:56:07.000+00:00",
    "ExchangeRateInformation":{
      "ExchangeRate":0.8008281904610115,
      "ExpirationDateTime":"2000-01-23T04:56:07.000+00:00",
      "RateType":{
        
      },
      "UnitCurrency":"UnitCurrency",
      "ContractIdentification":"ContractIdentification"
    },
    "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":{
        
      },
      "DebtorAccount":{
        "SecondaryIdentification":"SecondaryIdentification",
        "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
        "Identification":"Identification",
        "Name":"Name"
      },
      "CreditorAgent":{
        "PostalAddress":{
          "StreetName":"StreetName",
          "CountrySubDivision":"CountrySubDivision",
          "Department":"Department",
          "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
          "BuildingNumber":"BuildingNumber",
          "TownName":"TownName",
          "Country":"Country",
          "SubDepartment":"SubDepartment",
          "AddressType":{
            
          },
          "PostCode":"PostCode"
        },
        "SchemeName":["UK.OBIE.BICFI"],
        "Identification":"Identification",
        "Name":"Name"
      },
      "EndToEndIdentification":"EndToEndIdentification",
      "InstructionIdentification":"InstructionIdentification",
      "CurrencyOfTransfer":"CurrencyOfTransfer",
      "CreditorAccount":{
        "SecondaryIdentification":"SecondaryIdentification",
        "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
        "Identification":"Identification",
        "Name":"Name"
      },
      "Purpose":{
        
      },
      "ChargeBearer":{
        
      },
      "InstructionPriority":{
        
      },
      "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"],
      "RemittanceInformation":{
        "Unstructured":"Unstructured",
        "Reference":"Reference"
      },
      "ExchangeRateInformation":{
        "ExchangeRate":6.027456183070403,
        "UnitCurrency":"UnitCurrency",
        "ContractIdentification":"ContractIdentification"
      },
      "Creditor":{
        "PostalAddress":{
          "StreetName":"StreetName",
          "CountrySubDivision":"CountrySubDivision",
          "Department":"Department",
          "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
          "BuildingNumber":"BuildingNumber",
          "TownName":"TownName",
          "Country":"Country",
          "SubDepartment":"SubDepartment",
          "AddressType":{
            
          },
          "PostCode":"PostCode"
        },
        "Name":"Name"
      },
      "InstructedAmount":{
        "Currency":"Currency"
      }
    },
    "ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00"
  }
}

Request Headers:

Response Headers:

Required Roles:

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:

obp.getBankAccountsForUser

Version: UKv3.1, function_name: by getInternationalPaymentConsentsConsentId, operation_id: UKv3.1-getInternationalPaymentConsentsConsentId Tags: International Payments, Mocked-Data,

Get International Payment Consents Funds Confirmation

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

URL Parameters:

CONSENTID: CONSENTID

JSON response body fields:

[Data](/glossary#Scenario 6: Update credit score based on transaction and device data.): Data
First: First
FirstAvailableDateTime: FirstAvailableDateTime
FundsAvailable: FundsAvailable
FundsAvailableDateTime: FundsAvailableDateTime
FundsAvailableResult: FundsAvailableResult
Last: Last
[Links](/glossary#User Customer Links): Links
Next: Next
Prev: Prev
Self: Self
SupplementaryData: SupplementaryData
TotalPages: TotalPages

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":{
    "SupplementaryData":{
      
    },
    "FundsAvailableResult":{
      "FundsAvailableDateTime":"2000-01-23T04:56:07.000+00:00",
      "FundsAvailable":true
    }
  }
}

Request Headers:

Response Headers:

Required Roles:

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:

obp.getBankAccountsForUser

Version: UKv3.1, function_name: by getInternationalPaymentConsentsConsentIdFundsConfirmation, operation_id: UKv3.1-getInternationalPaymentConsentsConsentIdFundsConfirmation Tags: International Payments, Mocked-Data,

Get International Payments

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

URL Parameters:

INTERNATIONALPAYMENTID: INTERNATIONALPAYMENTID

JSON response body fields:

AddressLine: AddressLine
AddressType: AddressType
Amount: 10.12
BuildingNumber: BuildingNumber
ChargeBearer: ChargeBearer
Charges: Charges
ConsentId: ConsentId
ContractIdentification: ContractIdentification
Country: Country
CountrySubDivision: CountrySubDivision
CreationDateTime: CreationDateTime
Creditor: Creditor
CreditorAgent: CreditorAgent
Currency: EUR
CurrencyOfTransfer: CurrencyOfTransfer
[Data](/glossary#Scenario 6: Update credit score based on transaction and device data.): Data
Department: Department
EndToEndIdentification: EndToEndIdentification
ExchangeRate: ExchangeRate
ExchangeRateInformation: ExchangeRateInformation
ExpectedExecutionDateTime: ExpectedExecutionDateTime
ExpectedSettlementDateTime: ExpectedSettlementDateTime
ExpirationDateTime: ExpirationDateTime
First: First
FirstAvailableDateTime: FirstAvailableDateTime
Identification: Identification
Initiation: Initiation
InstructedAmount: 100
InstructionIdentification: InstructionIdentification
InstructionPriority: InstructionPriority
InternationalPaymentId: InternationalPaymentId
Last: Last
LastUpdateDateTime: LastUpdateDateTime
[Links](/glossary#User Customer Links): Links
LocalInstrument: LocalInstrument
MultiAuthorisation: MultiAuthorisation
Name: ACCOUNT_MANAGEMENT_FEE
Next: Next
NumberReceived: NumberReceived
NumberRequired: NumberRequired
PostalAddress: PostalAddress
Prev: Prev
Purpose: Purpose
RateType: RateType
Reference: Reference
RemittanceInformation: RemittanceInformation
SchemeName: SchemeName
SecondaryIdentification: SecondaryIdentification
Self: Self
StatusUpdateDateTime: StatusUpdateDateTime
StreetName: StreetName
SubDepartment: SubDepartment
SupplementaryData: SupplementaryData
TotalPages: TotalPages
TownName: TownName
UnitCurrency: UnitCurrency
Unstructured: Unstructured

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",
    "CreationDateTime":"2000-01-23T04:56:07.000+00:00",
    "ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00",
    "ExchangeRateInformation":{
      "ExchangeRate":0.8008281904610115,
      "ExpirationDateTime":"2000-01-23T04:56:07.000+00:00",
      "RateType":{
        
      },
      "UnitCurrency":"UnitCurrency",
      "ContractIdentification":"ContractIdentification"
    },
    "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":{
        
      }
    }],
    "InternationalPaymentId":"InternationalPaymentId",
    "ConsentId":"ConsentId",
    "Initiation":{
      "SupplementaryData":{
        
      },
      "DebtorAccount":{
        "SecondaryIdentification":"SecondaryIdentification",
        "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
        "Identification":"Identification",
        "Name":"Name"
      },
      "CreditorAgent":{
        "PostalAddress":{
          "StreetName":"StreetName",
          "CountrySubDivision":"CountrySubDivision",
          "Department":"Department",
          "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
          "BuildingNumber":"BuildingNumber",
          "TownName":"TownName",
          "Country":"Country",
          "SubDepartment":"SubDepartment",
          "AddressType":{
            
          },
          "PostCode":"PostCode"
        },
        "SchemeName":["UK.OBIE.BICFI"],
        "Identification":"Identification",
        "Name":"Name"
      },
      "EndToEndIdentification":"EndToEndIdentification",
      "InstructionIdentification":"InstructionIdentification",
      "CurrencyOfTransfer":"CurrencyOfTransfer",
      "CreditorAccount":{
        "SecondaryIdentification":"SecondaryIdentification",
        "SchemeName":["UK.OBIE.BBAN","UK.OBIE.IBAN","UK.OBIE.PAN","UK.OBIE.Paym","UK.OBIE.SortCodeAccountNumber"],
        "Identification":"Identification",
        "Name":"Name"
      },
      "Purpose":{
        
      },
      "ChargeBearer":{
        
      },
      "InstructionPriority":{
        
      },
      "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"],
      "RemittanceInformation":{
        "Unstructured":"Unstructured",
        "Reference":"Reference"
      },
      "ExchangeRateInformation":{
        "ExchangeRate":6.027456183070403,
        "UnitCurrency":"UnitCurrency",
        "ContractIdentification":"ContractIdentification"
      },
      "Creditor":{
        "PostalAddress":{
          "StreetName":"StreetName",
          "CountrySubDivision":"CountrySubDivision",
          "Department":"Department",
          "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"],
          "BuildingNumber":"BuildingNumber",
          "TownName":"TownName",
          "Country":"Country",
          "SubDepartment":"SubDepartment",
          "AddressType":{
            
          },
          "PostCode":"PostCode"
        },
        "Name":"Name"
      },
      "InstructedAmount":{
        "Currency":"Currency"
      }
    },
    "ExpectedSettlementDateTime":"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
    }
  }
}

Request Headers:

Response Headers:

Required Roles:

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:

obp.getBankAccountsForUser

Version: UKv3.1, function_name: by getInternationalPaymentsInternationalPaymentId, operation_id: UKv3.1-getInternationalPaymentsInternationalPaymentId Tags: International Payments, Mocked-Data,

Get documentation about the selected endpoints as:

Resource Docs JSON
Swagger 2 JSON
中文版本
Partial Functions

Note: You can list just the APIs that are implemented in a certain version by appending &native=true to the index URL.
API_Explorer Commit

Featured APIs

API Explorer

v3.1 (67 APIs)

Create International Payment Consents

Create International Payments

Get International Payment Consents

Get International Payment Consents Funds Confirmation

Get International Payments