Fena Account and Transaction Data API Specification (1.0.1)

Download OpenAPI specification:Download

API Documentation for Fena Data Account and Transaction

Supported UK Banks

UK Banks	Provider Name	Status
Lloyds Personal	ob-lloyds-personal	Active
Revolut	ob-revolut	Active
Santander	ob-santander	Active
Halifax	ob-halifax-personal	Active
Natwest	ob-natwest	Active
TSB	ob-tsb	Active
HSBC Personal	ob-hsbc-personal	Active
Bank of Scotland Personal	ob-bos-personal	Active
Monzo	ob-monzo	Active
First Direct	ob-first-direct	Active
Royal Bank of Scotland	ob-rbs	Active
Ulster	ob-ulster	Active
Nationwide	ob-nationwide	Active
Starling	starling	Active
Lloyds Business	ob-lloyds-business	Active
Barclys Business	ob-barclays-business	Active
Bank of Scotland Business	ob-bos-business	Active
HSBC Business	ob-hsbc-business	Active
Virgin Money	ob-virgin-money	Active
Lloyds Sandbox	ob-sandbox-lloyds	Inactive
Metro Personal	ob-metro-personal	Inactive
Mettle	ob-mettle	Active
Tide	ob-tide	Active

Supported EU Banks

EU Banks	Provider Name	Status
UBB Bank	bg-ubb	Inactive
Raiffeisen Bank	bg-raiffeisen	Inactive
DSK Bank	bg-dskbank	Inactive
UniCredit Bank	bg-unicredit	Inactive
PostBank	bg-postbank	Inactive

Authentication

Fena only supports API Key authentication:

API Key

clientId

Security Scheme Type	API Key
Header parameter name:	client_id

clientSecret

Security Scheme Type	API Key
Header parameter name:	client_secret

Access Consent

Create Account Access Consents

Authorizations:

clientId

clientSecret

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Request Body schema: application/json

provider required	string Enum: "ob-sandbox-lloyds" "ob-lloyds-personal" "ob-barclays-personal" "ob-barclays-business" "ob-revolut" "ob-santander" "ob-halifax-personal" "ob-natwest" "ob-tsb" "ob-hsbc-personal" "ob-hsbc-business" "ob-bos-personal" "ob-lloyds-business" "ob-bos-business" "ob-monzo" "ob-virgin-money" "ob-first-direct" "ob-rbs" "ob-ulster" "ob-metro-personal" "ob-nationwide" "starling" Provider name
flow	string Enum: "accounts" "balances" "transactions" If supplied create consent call will automatically trigger the selected flow (after redirecting back from bank's consent authorization page) and return appropriate data in the response. All in one call.
accountId	string Required if 'flow' is supplied and 'balances' or 'transactions' is selected.
transactionStartDate	string May be supplied with 'transactions' flow to pinpoint the date beginning from which transactions should be returned. Otherwise, by default, will be set to 1970-01-01T00:00:00.000Z
transactionEndDate	string May be supplied with 'transactions' flow to pinpoint the date until which transactions should be returned. Otherwise, by default, will be set to the current date
starlingCategoryId	string May be supplied with 'transactions' flow if provider is set to 'starling'.
	object

Responses

Request samples

Payload

Content type

application/json

{"provider": "ob-sandbox-lloyds",
"flow": "accounts",
"accountId": "string",
"transactionStartDate": "2021-01-01T00:00:00.000Z",
"transactionEndDate": "2022-03-01T00:00:00.000Z",
"starlingCategoryId": "string",
"Option": {"RedirectUri": "string",
"WebhookUri": "string"
}
}

Response samples

201
400
500

Content type

application/json; charset=utf-8

{"result": {"consentID": "e51f2e48-5664-41f3-9d23-51874d9d38fd",
"authUrl": "string"
}
}

Get Account Access Consents

Authorizations:

clientId

clientSecret

path Parameters

consentId

required

string

ID of the consent created.

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200

Content type

application/json; charset=utf-8

{"Data": {"ConsentId": "string",
"CreationDateTime": "2019-08-24T14:15:22Z",
"Status": "Authorised",
"StatusUpdateDateTime": "2019-08-24T14:15:22Z",
"Permissions": ["ReadAccountsBasic"
],
"ExpirationDateTime": "2019-08-24T14:15:22Z",
"TransactionFromDateTime": "2019-08-24T14:15:22Z",
"TransactionToDateTime": "2019-08-24T14:15:22Z"
},
"Risk": { },
"Links": {"Self": "http://example.com",
"First": "http://example.com",
"Prev": "http://example.com",
"Next": "http://example.com",
"Last": "http://example.com"
},
"Meta": {"TotalPages": 0,
"FirstAvailableDateTime": "2019-08-24T14:15:22Z",
"LastAvailableDateTime": "2019-08-24T14:15:22Z"
}
}

Delete Account Access Consents

Authorizations:

clientId

clientSecret

path Parameters

consentId

required

string

ID of the consent created.

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200

Content type

application/json; charset=utf-8

{"result": {"message": "string"
}
}

Accounts

Get Accounts

Authorizations:

clientId

clientSecret

path Parameters

consentId

required

string

ID of the consent created.

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200
500

Content type

application/json; charset=utf-8

Example

UK Open Banking

{"Data": {"Account": [{"AccountId": "string",
"Status": "Deleted",
"StatusUpdateDateTime": "2019-08-24T14:15:22Z",
"Currency": "string",
"AccountType": "Business",
"AccountSubType": "string",
"Description": "string",
"Nickname": "string",
"OpeningDate": "2019-08-24T14:15:22Z",
"MaturityDate": "2019-08-24T14:15:22Z",
"SwitchStatus": "string",
"Account": [{"SchemeName": "string",
"Identification": "string",
"Name": "string",
"SecondaryIdentification": "string"
}
]
}
]
}
}

Balances

Get Balances

Authorizations:

clientId

clientSecret

path Parameters

consentId required	string ID of the consent created.
accountId required	string ID of the account.

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200
500

Content type

application/json; charset=utf-8

Example

UK Open Banking

{"Data": {"Balance": [{"AccountId": "string",
"CreditDebitIndicator": "Credit",
"Type": "ClosingAvailable",
"DateTime": "2019-08-24T14:15:22Z",
"Amount": {"Amount": 0,
"Currency": "string"
},
"CreditLine": [{"Included": true,
"Type": "Available",
"Amount": {"Amount": "string",
"Currency": "string"
}
}
]
}
]
}
}

Transactions

Get Transactions

Authorizations:

clientId

clientSecret

path Parameters

consentId required	string ID of the consent created.
accountId required	string ID of the account.

query Parameters

transactionStartDate	string <date-time> ID of the account.
transactionEndDate	string <date-time> ID of the account.

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200
500

Content type

application/json; charset=utf-8

{"Data": {"Transaction": [{"AccountId": "string",
"TransactionId": "string",
"TransactionReference": "string",
"StatementReference": ["string"
],
"CreditDebitIndicator": "Credit",
"Status": "Booked",
"TransactionMutability": "Mutable",
"BookingDateTime": "2019-08-24T14:15:22Z",
"ValueDateTime": "2019-08-24T14:15:22Z",
"TransactionInformation": "string",
"AddressLine": "string",
"Amount": {"Amount": "string",
"Currency": "string"
},
"ChargeAmount": {"Amount": "string",
"Currency": "string"
},
"CurrencyExchange": {"SourceCurrency": "string",
"TargetCurrency": "string",
"UnitCurrency": "string",
"ExchangeRate": 0,
"ContractIdentification": "string",
"QuotationDate": "2019-08-24T14:15:22Z",
"InstructedAmount": {"Amount": "string",
"Currency": "string"
}
},
"BankTransactionCode": {"Code": "string",
"SubCode": "string"
},
"ProprietaryBankTransactionCode": {"Code": "string",
"Issuer": "string"
},
"Balance": {"CreditDebitIndicator": "Credit",
"Type": "ClosingAvailable",
"Amount": {"Amount": "string",
"Currency": "string"
}
},
"MerchantDetails": {"MerchantName": "string",
"MerchantCategoryCode": "stri"
},
"CreditorAgent": {"SchemeName": "string",
"Identification": "string",
"Name": "string",
"PostalAddress": {"AddressType": "Business",
"Department": "string",
"SubDepartment": "string",
"StreetName": "string",
"BuildingNumber": "string",
"PostCode": "string",
"TownName": "string",
"CountrySubDivision": "string",
"Country": "string",
"AddressLine": ["string"
]
}
},
"CreditorAccount": {"SchemeName": "string",
"Identification": "string",
"Name": "string",
"SecondaryIdentification": "string"
},
"DebtorAgent": {"SchemeName": "string",
"Identification": "string",
"Name": "string",
"PostalAddress": {"AddressType": "Business",
"Department": "string",
"SubDepartment": "string",
"StreetName": "string",
"BuildingNumber": "string",
"PostCode": "string",
"TownName": "string",
"CountrySubDivision": "string",
"Country": "string",
"AddressLine": ["string"
]
}
},
"DebtorAccount": {"SchemeName": "string",
"Identification": "string",
"Name": "string",
"SecondaryIdentification": "string"
},
"CardInstrument": {"CardSchemeName": "AmericanExpress",
"AuthorisationType": "ConsumerDevice",
"Name": "string",
"Identification": "string"
},
"SupplementaryData": { }
}
]
}
}

EU Access Consent

Create EU Account Access Consents

Authorizations:

clientId

clientSecret

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Request Body schema: application/json

provider required	string Enum: "bg-ubb" "bg-postbank" "bg-dskbank" Provider name
psuId	string [ 1 .. 255 ] characters User's id used by a provider in its own system. It might be a username, phone number or email (depends on what provider requires). Needed for providers: bg-raiffeisen (username)
psuIpAddress	string IP Address of the user who sent the request to the customer. Needed for providers: bg-ubb, bg-raiffeisen, bg-unicredit, bg-postbank, bg-dskbank

Responses

Request samples

Payload

Content type

application/json

{"provider": "bg-ubb",
"psuId": "vasyagladush",
"psuIpAddress": "192.168.0.1"
}

Response samples

201
500

Content type

application/json; charset=utf-8

{"result": {"consentID": "e51f2e48-5664-41f3-9d23-51874d9d38fd",
"authUrl": "string",
"expiryDate": "2019-08-24T14:15:22Z"
}
}

Get EU Account Access Consents

Authorizations:

clientId

clientSecret

path Parameters

consentId

required

string

ID of the consent created.

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200
500

Content type

application/json; charset=utf-8

{"access": {"balances": [{"iban": "BG10STSA11223344556677"
}
],
"transactions": [{"iban": "BG52STSA99887766554433"
},
{"iban": "BG10STSA76543211234567"
}
]
},
"recurringIndicator": true,
"validUntil": "2018-12-25",
"frequencyPerDay": 2,
"consentStatus": "valid",
"_links": {"account": {"href": "/v1.0.1/accounts/"
}
}
}

Delete EU Account Access Consents

Authorizations:

clientId

clientSecret

path Parameters

consentId

required

string

ID of the consent created.

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200
500

Content type

application/json; charset=utf-8

{"result": {"message": "string"
}
}

EU Accounts

Get Accounts

Authorizations:

clientId

clientSecret

path Parameters

consentId

required

string

ID of the consent created.

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200
500

Content type

application/json; charset=utf-8

{"accounts": [{"resourceId": "BG10STSA11223344556677",
"iban": "BG10STSA11223344556677",
"currency": "BGN",
"product": "РС ЛИДЕР С РО 0406",
"name": "salary",
"_links": {"balances": {"href": "/v1.0.1/accounts/BG10STSA11223344556677/balances"
},
"transactions": {"href": "/v1.0.1/accounts/BG10STSA11223344556677/transactions"
}
}
},
{"resourceId": "BG52STSA99887766554433",
"iban": "BG52STSA99887766554433",
"currency": "EUR",
"product": "Ч-НО Б-НЕ ”123”",
"name": "за спестяване“",
"_links": {"balances": {"href": "/v1.0.1/accounts/BG52STSA99887766554433/balances"
}
}
}
]
}

Get Account

Authorizations:

clientId

clientSecret

path Parameters

consentId required	string ID of the consent created.
accountId required	string ID of the account.

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200
500

Content type

application/json; charset=utf-8

{"resourceId": "BG10STSA11223344556677",
"iban": "BG10STSA11223344556677",
"currency": "BGN",
"product": "РС ЛИДЕР С РО 0406",
"name": "salary",
"_links": {"balances": {"href": "/v1.0.1/accounts/BG10STSA11223344556677/balances"
},
"transactions": {"href": "/v1.0.1/accounts/BG10STSA11223344556677/transactions"
}
}
}

EU Balances

Get Balances

Authorizations:

clientId

clientSecret

path Parameters

consentId required	string ID of the consent created.
accountId required	string ID of the account.

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200
500

Content type

application/json; charset=utf-8

{"account": {"iban": "BG10STSA11223344556677"
},
"balances": [{"balanceType": "interimAvailable",
"balanceAmount": {"currency": "BGN",
"amount": "123.45"
}
}
]
}

EU Transactions

Get Transactions

Authorizations:

clientId

clientSecret

path Parameters

consentId required	string ID of the consent created.
accountId required	string ID of the account.

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200
500

Content type

application/json; charset=utf-8

{"account": {"iban": "BG10STSA11223344556677"
},
"transactions": {"booked": [{"creditorName": "Иван Иванов",
"creditorAccount": {"iban": "BG10STSA12345671234567"
},
"transactionAmount": {"currency": "BGN",
"amount": "200.00"
},
"bookingDate": "2018-07-02",
"valueDate": "2018-07-03",
"remittanceInformationUnstructured": "Захранване на сметка"
},
{"debtorName": "Фирма ЕООД",
"debtorAccount": {"iban": "BG10STSA76543211234567"
},
"transactionAmount": {"currency": "BGN",
"amount": "49.51"
},
"bookingDate": "2018-07-04",
"valueDate": "2018-07-05",
"remittanceInformationUnstructured": "Такса курс"
}
],
"pending": [{"creditorName": "Booking Co",
"creditorAccount": {"iban": "FR12345677654321"
},
"transactionAmount": {"currency": "BGN",
"amount": "1080.04"
},
"valueDate": "2017-10-26",
"remittanceInformationUnstructured": "hotel"
}
],
"_links": {"account": {"href": "/v1.0.1/accounts/BG10STSA11223344556677"
}
}
}
}

Get Transaction

Authorizations:

clientId

clientSecret

path Parameters

consentId required	string ID of the consent created.
accountId required	string ID of the account.
transactionId required	string ID of the transaction.

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200
500

Content type

application/json; charset=utf-8

{"transactionId": "string",
"bookingDate": "2019-08-24",
"valueDate": "2019-08-24",
"transactionAmount": {"currency": "string",
"amount": "string"
},
"creditorName": "string",
"creditorAccount": {"iban": "string",
"bban": "string"
},
"debtorName": "string",
"debtorAccount": {"iban": "string",
"bban": "string"
},
"remittanceInformationUnstructured": "string"
}

Domestic Standing Order Consents

Create Domestic Standing Order Consents

Authorizations:

clientId

clientSecret

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Request Body schema: application/json

One of

provider required	string Enum: "ob-sandbox-lloyds" "ob-lloyds-personal" "ob-barclays-personal" "ob-barclays-business" "ob-revolut" "ob-santander" "ob-halifax-personal" "ob-natwest" "ob-tsb" "ob-hsbc-personal" "ob-hsbc-business" "ob-bos-personal" "ob-lloyds-business" "ob-bos-business" "ob-monzo" "ob-virgin-money" "ob-first-direct" "ob-rbs" "ob-ulster" "ob-metro-personal" "ob-nationwide" Provider name
required	object
accountConsentId	string <uuid> Account consent ID of the bank account to which funds will be sent. Need for double-checking payment status.
customerPaymentId	string Optional identifier for the payment, generated on client side.
	object

Responses

Request samples

Payload

Content type

application/json

Example

UK Open Banking

{"provider": "ob-sandbox-lloyds",
"Data": {"Initiation": {"Frequency": "Weekly",
"Reference": "string",
"NumberOfPayments": "string",
"FirstPaymentDateTime": "2019-08-24T14:15:22Z",
"RecurringPaymentDateTime": "2019-08-24T14:15:22Z",
"FinalPaymentDateTime": "2019-08-24T14:15:22Z",
"FirstPaymentAmount": {"Amount": "string",
"Currency": "string"
},
"RecurringPaymentAmount": {"Amount": "string",
"Currency": "string"
},
"FinalPaymentAmount": {"Amount": "string",
"Currency": "string"
},
"CreditorAccount": {"SchemeName": "string",
"Identification": "string",
"Name": "string"
}
}
},
"accountConsentId": "9cc65f3b-41dd-47e0-870a-254a66cb4e54",
"customerPaymentId": "f929d718-1496-11eb-adc1-0242ac120002",
"Option": {"RedirectUri": "http://example.com"
}
}

Response samples

201
500

Content type

application/json; charset=utf-8

Example

UK Open Banking

{"result": {"consentId": "string",
"auth_flow": {"type": "redirect",
"uri": "http://example.com"
},
"domestic_standing_order_consent": {"Data": {"ConsentId": "string",
"CreationDateTime": "2019-08-24T14:15:22Z",
"Status": "Authorised",
"StatusUpdateDateTime": "2019-08-24T14:15:22Z",
"Permission": "Create",
"ReadRefundAccount": "No",
"CutOffDateTime": "2019-08-24T14:15:22Z",
"Charges": [{"ChargeBearer": "BorneByCreditor",
"Type": "string",
"Amount": {"Amount": "string",
"Currency": "string"
}
}
],
"Initiation": {"Frequency": "string",
"Reference": "string",
"NumberOfPayments": "string",
"FirstPaymentDateTime": "2019-08-24T14:15:22Z",
"RecurringPaymentDateTime": "2019-08-24T14:15:22Z",
"FinalPaymentDateTime": "2019-08-24T14:15:22Z",
"FirstPaymentAmount": {"Amount": "string",
"Currency": "string"
},
"RecurringPaymentAmount": {"Amount": "string",
"Currency": "string"
},
"FinalPaymentAmount": {"Amount": "string",
"Currency": "string"
},
"DebtorAccount": {"SchemeName": "string",
"Identification": "string",
"Name": "string",
"SecondaryIdentification": "string"
},
"CreditorAccount": {"SchemeName": "string",
"Identification": "string",
"Name": "string",
"SecondaryIdentification": "string"
},
"SupplementaryData": { }
},
"Authorisation": {"AuthorisationType": "Any",
"CompletionDateTime": "2019-08-24T14:15:22Z"
},
"SCASupportData": {"RequestedSCAExemptionType": "BillPayment",
"AppliedAuthenticationApproach": "CA",
"ReferencePaymentOrderId": "string"
},
"Debtor": {"SchemeName": "string",
"Identification": "string",
"Name": "string",
"SecondaryIdentification": "string"
}
},
"Risk": {"PaymentContextCode": "BillingGoodsAndServicesInAdvance",
"MerchantCategoryCode": "stri",
"MerchantCustomerIdentification": "string",
"ContractPresentInidicator": true,
"BeneficiaryPrepopulatedIndicator": true,
"PaymentPurposeCode": "stri",
"BeneficiaryAccountType": "Business",
"DeliveryAddress": {"AddressLine": ["string"
],
"StreetName": "string",
"BuildingNumber": "string",
"PostCode": "string",
"TownName": "string",
"CountrySubDivision": "string",
"Country": "string"
}
},
"Links": {"Self": "http://example.com",
"First": "http://example.com",
"Prev": "http://example.com",
"Next": "http://example.com",
"Last": "http://example.com"
},
"Meta": {"TotalPages": 0,
"FirstAvailableDateTime": "2019-08-24T14:15:22Z",
"LastAvailableDateTime": "2019-08-24T14:15:22Z"
}
}
}
}

Get Domestic Standing Order Consents

Authorizations:

clientId

clientSecret

path Parameters

consentId

required

string

ID of the consent created.

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

201
500

Content type

application/json; charset=utf-8

{"Data": {"ConsentId": "string",
"CreationDateTime": "2019-08-24T14:15:22Z",
"Status": "Authorised",
"StatusUpdateDateTime": "2019-08-24T14:15:22Z",
"Permission": "Create",
"ReadRefundAccount": "No",
"CutOffDateTime": "2019-08-24T14:15:22Z",
"Charges": [{"ChargeBearer": "BorneByCreditor",
"Type": "string",
"Amount": {"Amount": "string",
"Currency": "string"
}
}
],
"Initiation": {"Frequency": "string",
"Reference": "string",
"NumberOfPayments": "string",
"FirstPaymentDateTime": "2019-08-24T14:15:22Z",
"RecurringPaymentDateTime": "2019-08-24T14:15:22Z",
"FinalPaymentDateTime": "2019-08-24T14:15:22Z",
"FirstPaymentAmount": {"Amount": "string",
"Currency": "string"
},
"RecurringPaymentAmount": {"Amount": "string",
"Currency": "string"
},
"FinalPaymentAmount": {"Amount": "string",
"Currency": "string"
},
"DebtorAccount": {"SchemeName": "string",
"Identification": "string",
"Name": "string",
"SecondaryIdentification": "string"
},
"CreditorAccount": {"SchemeName": "string",
"Identification": "string",
"Name": "string",
"SecondaryIdentification": "string"
},
"SupplementaryData": { }
},
"Authorisation": {"AuthorisationType": "Any",
"CompletionDateTime": "2019-08-24T14:15:22Z"
},
"SCASupportData": {"RequestedSCAExemptionType": "BillPayment",
"AppliedAuthenticationApproach": "CA",
"ReferencePaymentOrderId": "string"
},
"Debtor": {"SchemeName": "string",
"Identification": "string",
"Name": "string",
"SecondaryIdentification": "string"
}
},
"Risk": {"PaymentContextCode": "BillingGoodsAndServicesInAdvance",
"MerchantCategoryCode": "stri",
"MerchantCustomerIdentification": "string",
"ContractPresentInidicator": true,
"BeneficiaryPrepopulatedIndicator": true,
"PaymentPurposeCode": "stri",
"BeneficiaryAccountType": "Business",
"DeliveryAddress": {"AddressLine": ["string"
],
"StreetName": "string",
"BuildingNumber": "string",
"PostCode": "string",
"TownName": "string",
"CountrySubDivision": "string",
"Country": "string"
}
},
"Links": {"Self": "http://example.com",
"First": "http://example.com",
"Prev": "http://example.com",
"Next": "http://example.com",
"Last": "http://example.com"
},
"Meta": {"TotalPages": 0,
"FirstAvailableDateTime": "2019-08-24T14:15:22Z",
"LastAvailableDateTime": "2019-08-24T14:15:22Z"
}
}

Domestic Standing Orders

Create Domestic Standing Orders

Authorizations:

clientId

clientSecret

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

201
500

Content type

application/json; charset=utf-8

Example

UK Open Banking

{"ConsentId": "79569aa8-49c6-435a-8037-6fc8226da8cb"
}

Get Domestic Standing Orders

Authorizations:

clientId

clientSecret

path Parameters

consentId

required

string

ID of the consent created.

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

201
500

Content type

application/json; charset=utf-8

{"Data": {"ConsentId": "string",
"CreationDateTime": "2019-08-24T14:15:22Z",
"Status": "Authorised",
"StatusUpdateDateTime": "2019-08-24T14:15:22Z",
"Permission": "Create",
"ReadRefundAccount": "No",
"CutOffDateTime": "2019-08-24T14:15:22Z",
"Charges": [{"ChargeBearer": "BorneByCreditor",
"Type": "string",
"Amount": {"Amount": "string",
"Currency": "string"
}
}
],
"Initiation": {"Frequency": "string",
"Reference": "string",
"NumberOfPayments": "string",
"FirstPaymentDateTime": "2019-08-24T14:15:22Z",
"RecurringPaymentDateTime": "2019-08-24T14:15:22Z",
"FinalPaymentDateTime": "2019-08-24T14:15:22Z",
"FirstPaymentAmount": {"Amount": "string",
"Currency": "string"
},
"RecurringPaymentAmount": {"Amount": "string",
"Currency": "string"
},
"FinalPaymentAmount": {"Amount": "string",
"Currency": "string"
},
"DebtorAccount": {"SchemeName": "string",
"Identification": "string",
"Name": "string",
"SecondaryIdentification": "string"
},
"CreditorAccount": {"SchemeName": "string",
"Identification": "string",
"Name": "string",
"SecondaryIdentification": "string"
},
"SupplementaryData": { }
},
"Authorisation": {"AuthorisationType": "Any",
"CompletionDateTime": "2019-08-24T14:15:22Z"
},
"SCASupportData": {"RequestedSCAExemptionType": "BillPayment",
"AppliedAuthenticationApproach": "CA",
"ReferencePaymentOrderId": "string"
},
"Debtor": {"SchemeName": "string",
"Identification": "string",
"Name": "string",
"SecondaryIdentification": "string"
}
},
"Risk": {"PaymentContextCode": "BillingGoodsAndServicesInAdvance",
"MerchantCategoryCode": "stri",
"MerchantCustomerIdentification": "string",
"ContractPresentInidicator": true,
"BeneficiaryPrepopulatedIndicator": true,
"PaymentPurposeCode": "stri",
"BeneficiaryAccountType": "Business",
"DeliveryAddress": {"AddressLine": ["string"
],
"StreetName": "string",
"BuildingNumber": "string",
"PostCode": "string",
"TownName": "string",
"CountrySubDivision": "string",
"Country": "string"
}
},
"Links": {"Self": "http://example.com",
"First": "http://example.com",
"Prev": "http://example.com",
"Next": "http://example.com",
"Last": "http://example.com"
},
"Meta": {"TotalPages": 0,
"FirstAvailableDateTime": "2019-08-24T14:15:22Z",
"LastAvailableDateTime": "2019-08-24T14:15:22Z"
}
}

Single Immediate Payment Initiation

Initiate Single Immediate Payment

Authorizations:

clientId

clientSecret

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Request Body schema: application/json

amount required	string [ 4 .. 10 ] characters ^\d+\.\d{0,2}$ A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
provider required	string (SingleImmediatePaymentProvider) Enum: "ob-sandbox-lloyds" "ob-sandbox-revolut" "ob-sandbox-rbs" "ob-sandbox-natwest" "ob-sandbox-tsb" "ob-lloyds-personal" "ob-barclays-personal" "ob-barclays-business" "ob-revolut" "ob-santander" "ob-halifax-personal" "ob-natwest" "ob-tsb" "ob-hsbc-personal" "ob-hsbc-business" "ob-bos-personal" "ob-lloyds-business" "ob-bos-business" "ob-monzo" "ob-virgin-money" "ob-first-direct" "ob-rbs" "ob-ulster" "ob-metro-personal" "ob-nationwide" "ob-sandbox-cbs" "ob-cbs" "ob-sandbox-ybs" "ob-ybs" "ob-sandbox-aibgb-retail" "ob-sandbox-aibgb-corporate" "ob-aibgb-retail" "ob-aibgb-corporate" "ob-sandbox-cumberland" "ob-cumberland" "ob-mettle" "ob-sandbox-danske-private" "ob-sandbox-danske-business" "ob-danske-private" "ob-danske-business" "starling" ID of given provider bank.
customerPaymentId required	string
reference	string [ 1 .. 18 ] characters Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction
required	object
	object
	object
	object
accountConsentId	string <uuid> Account consent ID of the bank account to which funds will be sent. Need for double-checking payment status.

Responses

Request samples

Payload

Content type

application/json

{"amount": "0.01",
"provider": "ob-sandbox-lloyds",
"customerPaymentId": "f929d718-1496-11eb-adc1-0242ac120002",
"reference": "Test Payment",
"beneficiary": {"sortCode": "123456",
"accountNumber": "12345678",
"name": "Vasya Gladush"
},
"remitter": {"sortCode": "123456",
"accountNumber": "12345678",
"name": "Vasya Gladush",
"psuIpAddress": "192.168.0.1"
},
"risk": {"customerId": "string",
"context": "BillPayment",
"merchantCategoryCode": 0,
"address": {"addressLine": ["string"
],
"streetName": "string",
"postCode": "string",
"townName": "string",
"country": "st"
}
},
"option": {"redirectUri": "string",
"webhookUri": "string"
},
"accountConsentId": "9cc65f3b-41dd-47e0-870a-254a66cb4e54"
}

Response samples

201
500

Content type

application/json; charset=utf-8

{"result": {"single_immediate_payment": {"id": "2e9b449f-4d9b-4e75-90f2-f983373c7ad8",
"provider": {"id": "ob-coutts",
"name": "Coutts & Company",
"sortCodeRange": null
},
"amount": "1.00",
"referenceNumber": "3321589-29927",
"customerPaymentId": "f929d718-1496-11eb-adc1-0242ac120002",
"beneficiaryAccountNumber": "123456",
"beneficiarySortCode": "12345678",
"beneficiaryName": "Vasya Gladush",
"risk": null,
"remitterAccountNumber": null,
"remitterSortCode": null,
"remitterName": null,
"psuIpAddress": "192.168.35.55",
"status": "initiated",
"providerReferenceNumber": "DomPayId:2260321099",
"providerAlternativeReferenceNumber": null,
"redirectUri": null,
"webhookUri": null,
"log": null,
"completedAt": null,
"refundAccountName": null,
"refundAccountNumber": null,
"refundAccountSortCode": null,
"createdAt": "2022-10-16T14:08:22.546Z",
"updatedAt": "2022-10-16T14:08:35.616Z"
},
"auth_flow": {"type": "redirect",
"uri": "https://secure1.coutts.com/as/authorization.oauth2?client_id=6-RYOBul9n8Qo2SPJpaUooWU&scope=openid%20payments&response_type=code%20id_token&redirect_uri=https%3A%2F%2Fprovider.api.staging.fena.co%2Fcompleted&state=2e9b449f-4d9b-4e75-90f2-f983373c7ad8&nonce=2e9b449f-4d9b-4e75-90f2-f983373c7ad8&request=eyJhbGciOiJQUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIteWM1VC1jeW1jNEZXVnN5U051V3ZpbHhZYyJ9.eyJzdWIiOiJodHRwczovL3NlY3VyZTEuY291dHRzLmNvbSIsImF1ZCI6Imh0dHBzOi8vc2VjdXJlMS5jb3V0dHMuY29tIiwiaXNzIjoiNi1SWU9CdWw5bjhRbzJTUEpwYVVvb1dVIiwicmVzcG9uc2VfdHlwZSI6ImNvZGUgaWRfdG9rZW4iLCJjbGllbnRfaWQiOiI2LVJZT0J1bDluOFFvMlNQSnBhVW9vV1UiLCJyZWRpcmVjdF91cmkiOiJodHRwczovL3Byb3ZpZGVyLmFwaS5zdGFnaW5nLmZlbmEuY28vY29tcGxldGVkIiwic2NvcGUiOiJvcGVuaWQgcGF5bWVudHMiLCJzdGF0ZSI6IjJlOWI0NDlmLTRkOWItNGU3NS05MGYyLWY5ODMzNzNjN2FkOCIsIm5vbmNlIjoiMmU5YjQ0OWYtNGQ5Yi00ZTc1LTkwZjItZjk4MzM3M2M3YWQ4IiwiZXhwIjoxNjY1OTMyOTE1LCJjbGFpbXMiOnsiaWRfdG9rZW4iOnsiYWNyIjp7InZhbHVlIjoidXJuOm9wZW5iYW5raW5nOnBzZDI6c2NhIiwiZXNzZW50aWFsIjp0cnVlfSwib3BlbmJhbmtpbmdfaW50ZW50X2lkIjp7InZhbHVlIjoiRG9tUGF5SWQ6MjI2MDMyMTA5OSIsImVzc2VudGlhbCI6dHJ1ZX19LCJ1c2VyaW5mbyI6eyJvcGVuYmFua2luZ19pbnRlbnRfaWQiOnsidmFsdWUiOiJEb21QYXlJZDoyMjYwMzIxMDk5IiwiZXNzZW50aWFsIjp0cnVlfX19LCJhY3JfdmFsdWVzIjoidXJuOm9wZW5iYW5raW5nOnBzZDI6c2NhIiwianRpIjoiZDE2NjU5MjkzMTUifQ.ejS51QU8ufiQGU5QjjnM5_9N3d7ON_8eUWnYzGFJuzuep13L5n6L3nZ6gwLT48gnQtuTqgo7ptzpeQx-J-Y6tX0tRVSQV3nVrXOreDKa0sGHI7FSSdgcAoKsgEbRtgSB_Go0AJX-lc2sbiWjrdHt0oVf4eYPgEY_8XOki5KxKXwN7dKESKYYFTM5Ehkp130oBofGIE_yNXbK4Oi2_5PrypPeuHJdPktro5pbnpoQLNfmpUbsbVvD4Qi_idROC5MbKnP--B5_0pshHH6qElyZRDV7-_GK8ZjGFYvh1MA28g",
"expiry": "2022-10-16T15:08:35.665Z"
}
}
}

Get Single Immediate Payment Information

Authorizations:

clientId

clientSecret

path Parameters

paymentId

required

string <uuid>

ID of the payment in Provider API database (it's not customerPaymentId)

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200
404
500

Content type

application/json; charset=utf-8

{"id": "75a9f30c-1b68-4aef-9dce-7c6ebd651111",
"customerPaymentId": "f929d718-1496-11eb-adc1-0242ac120002",
"providerReferenceNumber": "DomPayId:2258546601",
"providerAlternativeReferenceNumber": null,
"amount": "1.00",
"beneficiarySortCode": "123456",
"beneficiaryAccountNumber": "12345678",
"beneficiaryName": "Vasya Gladush",
"remitterSortCode": null,
"remitterAccountNumber": null,
"remitterName": null,
"redirectUri": null,
"status": "initiated",
"webhookUri": null,
"log": null,
"risk": null,
"completedAt": null,
"createdAt": "2022-10-12T20:24:12.253Z",
"updatedAt": "2022-10-12T20:24:15.923Z",
"referenceNumber": "3321589-bed9c",
"psuIpAddress": "192.168.35.55",
"refundAccountName": null,
"refundAccountNumber": null,
"refundAccountSortCode": null,
"provider": {"id": "ob-coutts",
"name": "Coutts & Company",
"sortCodeRange": null
}
}

Get Refund Account Details of a Single Immediate Payment

Authorizations:

clientId

clientSecret

path Parameters

paymentId

required

string <uuid>

ID of the payment in Provider API database (it's not customerPaymentId)

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200
404
500

Content type

application/json; charset=utf-8

{"name": "Vasya Gladush",
"accountNumber": "12345678",
"sortCode": "123456"
}

Single Immediate Payment Refund

Initiate Single Immediate Payment Refund

Authorizations:

clientId

clientSecret

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Request Body schema: application/json

originalPaymentId required	string^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]... The Provider's API ID of the original payment made via Provider API.
amount	string [ 4 .. 10 ] characters ^\d+\.\d{0,2}$ If 'amount' property is not provided, the amount of original payment will be used. A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
provider required	string (SingleImmediatePaymentProvider) Enum: "ob-sandbox-lloyds" "ob-sandbox-revolut" "ob-sandbox-rbs" "ob-sandbox-natwest" "ob-sandbox-tsb" "ob-lloyds-personal" "ob-barclays-personal" "ob-barclays-business" "ob-revolut" "ob-santander" "ob-halifax-personal" "ob-natwest" "ob-tsb" "ob-hsbc-personal" "ob-hsbc-business" "ob-bos-personal" "ob-lloyds-business" "ob-bos-business" "ob-monzo" "ob-virgin-money" "ob-first-direct" "ob-rbs" "ob-ulster" "ob-metro-personal" "ob-nationwide" "ob-sandbox-cbs" "ob-cbs" "ob-sandbox-ybs" "ob-ybs" "ob-sandbox-aibgb-retail" "ob-sandbox-aibgb-corporate" "ob-aibgb-retail" "ob-aibgb-corporate" "ob-sandbox-cumberland" "ob-cumberland" "ob-mettle" "ob-sandbox-danske-private" "ob-sandbox-danske-business" "ob-danske-private" "ob-danske-business" "starling" ID of given provider bank.
customerPaymentId required	string
	object If you specify beneficiary details we will use them in refund payment. Provide this if there is no refund account details stored on Provider API (you can check it by GET requests to /payment/single-immediate-payment-initiation-requests) or if you just want to provide other account details.
	object
	object
	object

Responses

Request samples

Payload

Content type

application/json

{"originalPaymentId": "string",
"amount": "0.01",
"provider": "ob-sandbox-lloyds",
"customerPaymentId": "f929d718-1496-11eb-adc1-0242ac120002",
"beneficiary": {"sortCode": "123456",
"accountNumber": "12345678",
"name": "Vasya Gladush"
},
"remitter": {"sortCode": "123456",
"accountNumber": "12345678",
"name": "Vasya Gladush",
"psuIpAddress": "192.168.0.1"
},
"risk": {"customerId": "string",
"context": "BillPayment",
"merchantCategoryCode": 0,
"address": {"addressLine": ["string"
],
"streetName": "string",
"postCode": "string",
"townName": "string",
"country": "st"
}
},
"option": {"redirectUri": "string",
"webhookUri": "string"
}
}

Response samples

201
500

Content type

application/json; charset=utf-8

{"result": {"single_immediate_payment": {"id": "51758330-52ee-4148-bc0d-f710a64db721",
"originalPayment": {"id": "11cc0d30-3a09-49bf-a47f-74ae4c233d3a",
"customerPaymentId": "f929d718-1496-11eb-adc1-0242ac120002",
"providerReferenceNumber": "urn:obp:pi:3.1.10:02e9bcaf-d538-44fd-badb-5243a962a80e",
"providerAlternativeReferenceNumber": "ce2c539b-0d1c-49f0-a062-07422d83edc2",
"amount": "0.01",
"beneficiarySortCode": "040075",
"beneficiaryAccountNumber": "28266757",
"beneficiaryName": "Fena Labs Ltd",
"remitterSortCode": null,
"remitterAccountNumber": null,
"remitterName": null,
"redirectUri": null,
"status": "executed",
"webhookUri": null,
"log": null,
"risk": null,
"completedAt": "2022-10-11T14:54:04.418Z",
"createdAt": "2022-10-11T14:53:25.762Z",
"updatedAt": "2022-10-11T14:54:04.440Z",
"referenceNumber": "3321589-b930c",
"psuIpAddress": "192.168.35.55",
"refundAccountName": null,
"refundAccountNumber": null,
"refundAccountSortCode": null
},
"provider": {"id": "ob-tsb",
"name": "TSB",
"sortCodeRange": "[774600,779900)"
},
"customerPaymentId": "f929d718-1496-11eb-adc1-0242ac120002",
"beneficiaryAccountNumber": "28266757",
"beneficiarySortCode": "040075",
"beneficiaryName": "Fena Labs Ltd",
"amount": "1.00",
"risk": null,
"remitterAccountNumber": null,
"remitterSortCode": null,
"remitterName": null,
"psuIpAddress": "192.168.35.55",
"status": "initiated",
"providerReferenceNumber": "3f25a20b-aff6-4c7c-be54-9b5da44c8d2c",
"providerAlternativeReferenceNumber": null,
"redirectUri": null,
"webhookUri": null,
"log": null,
"completedAt": null,
"createdAt": "2022-10-16T15:21:20.097Z",
"updatedAt": "2022-10-16T15:21:21.967Z"
},
"auth_flow": {"type": "redirect",
"uri": "https://apis.tsb.co.uk/apis/open-banking/v3.1/auth/oauth2/authorize?client_id=e326badc-5c9b-440d-8da1-0a5059fc74cb&scope=openid%20payments&response_type=code%20id_token&redirect_uri=https%3A%2F%2Fprovider.api.staging.fena.co%2Fcompleted&state=51758330-52ee-4148-bc0d-f710a64db721&nonce=51758330-52ee-4148-bc0d-f710a64db721&request=eyJhbGciOiJQUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIteWM1VC1jeW1jNEZXVnN5U051V3ZpbHhZYyJ9.eyJzdWIiOiJ0c2IiLCJhdWQiOiJodHRwczovL2FwaXMudHNiLmNvLnVrL2FwaXMvb3Blbi1iYW5raW5nL3YzLjEvIiwiaXNzIjoiZTMyNmJhZGMtNWM5Yi00NDBkLThkYTEtMGE1MDU5ZmM3NGNiIiwicmVzcG9uc2VfdHlwZSI6ImNvZGUgaWRfdG9rZW4iLCJjbGllbnRfaWQiOiJlMzI2YmFkYy01YzliLTQ0MGQtOGRhMS0wYTUwNTlmYzc0Y2IiLCJyZWRpcmVjdF91cmkiOiJodHRwczovL3Byb3ZpZGVyLmFwaS5zdGFnaW5nLmZlbmEuY28vY29tcGxldGVkIiwic2NvcGUiOiJvcGVuaWQgcGF5bWVudHMiLCJzdGF0ZSI6IjUxNzU4MzMwLTUyZWUtNDE0OC1iYzBkLWY3MTBhNjRkYjcyMSIsIm5vbmNlIjoiNTE3NTgzMzAtNTJlZS00MTQ4LWJjMGQtZjcxMGE2NGRiNzIxIiwiZXhwIjoxNjY1OTM3MjgxLCJjbGFpbXMiOnsiaWRfdG9rZW4iOnsiYWNyIjp7InZhbHVlIjoidXJuOm9wZW5iYW5raW5nOnBzZDI6c2NhIiwiZXNzZW50aWFsIjp0cnVlfSwib3BlbmJhbmtpbmdfaW50ZW50X2lkIjp7InZhbHVlIjoiM2YyNWEyMGItYWZmNi00YzdjLWJlNTQtOWI1ZGE0NGM4ZDJjIiwiZXNzZW50aWFsIjp0cnVlfX0sInVzZXJpbmZvIjp7Im9wZW5iYW5raW5nX2ludGVudF9pZCI6eyJ2YWx1ZSI6IjNmMjVhMjBiLWFmZjYtNGM3Yy1iZTU0LTliNWRhNDRjOGQyYyIsImVzc2VudGlhbCI6dHJ1ZX19fSwiYWNyX3ZhbHVlcyI6InVybjpvcGVuYmFua2luZzpwc2QyOnNjYSIsImp0aSI6ImQxNjY1OTMzNjgxIn0.Y-lTVGd2rLFH6oElpMw2bRgaKeYQHZl1Rb5LivSV3RI8qg2f3h9US5CjoOnwugN-7sg4JcDGB5GiwVweBrA-ZcjpSqiWNQHWQZ1pZkCv6mAXM4oKHxhoMYcfQfgIBiScKx2lLlB8HZSZ6ddC8_PMaRUN0MHCcNEv0GVDpbL7Q_qe67G4YKKk7ypt1OXMq0wnPKpdNMwfgR048yvD16VwbbMYB3XssopCOsNQ4xOaBx9qhRlv4pTtGA1Ak9npV2WUuzFOiEnhsjQTz3kxpZVCcNxJtwmSTvtSFcilxaf-_KdZR8Xf5Jg2VDZqdbpUC6gFaB81oitJZ0qruftYD43Grw",
"expiry": "2022-10-16T16:21:22.060Z"
}
}
}

Get Single Immediate Payment Refund Information

Authorizations:

clientId

clientSecret

path Parameters

refundId

required

string <uuid>

ID of the refund in Provider API database (it's not customerPaymentId)

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200
404
500

Content type

application/json; charset=utf-8

{"id": "51758330-52ee-4148-bc0d-f710a64db721",
"customerPaymentId": "f929d718-1496-11eb-adc1-0242ac120002",
"providerReferenceNumber": "3f25a20b-aff6-4c7c-be54-9b5da44c8d2c",
"providerAlternativeReferenceNumber": null,
"beneficiarySortCode": "040075",
"beneficiaryAccountNumber": "28266757",
"beneficiaryName": "Fena Labs Ltd",
"remitterSortCode": null,
"remitterAccountNumber": null,
"remitterName": null,
"redirectUri": null,
"status": "initiated",
"webhookUri": null,
"log": null,
"risk": null,
"completedAt": null,
"createdAt": "2022-10-16T15:21:20.097Z",
"updatedAt": "2022-10-16T15:21:21.967Z",
"psuIpAddress": "192.168.35.55",
"amount": "1.00",
"provider": {"id": "ob-tsb",
"name": "TSB",
"sortCodeRange": "[774600,779900)"
},
"originalPayment": {"id": "11cc0d30-3a09-49bf-a47f-74ae4c233d3a",
"customerPaymentId": "f929d718-1496-11eb-adc1-0242ac120002",
"providerReferenceNumber": "urn:obp:pi:3.1.10:02e9bcaf-d538-44fd-badb-5243a962a80e",
"providerAlternativeReferenceNumber": "ce2c539b-0d1c-49f0-a062-07422d83edc2",
"amount": "0.01",
"beneficiarySortCode": "040075",
"beneficiaryAccountNumber": "28266757",
"beneficiaryName": "Fena Labs Ltd",
"remitterSortCode": null,
"remitterAccountNumber": null,
"remitterName": null,
"redirectUri": null,
"status": "executed",
"webhookUri": null,
"log": null,
"risk": null,
"completedAt": "2022-10-11T14:54:04.418Z",
"createdAt": "2022-10-11T14:53:25.762Z",
"updatedAt": "2022-10-11T14:54:04.440Z",
"referenceNumber": "3321589-b930c",
"psuIpAddress": "192.168.35.55",
"refundAccountName": null,
"refundAccountNumber": null,
"refundAccountSortCode": null
}
}

Bulk Payment Consents

Create Bulk Payment Consents

Authorizations:

clientId

clientSecret

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Request Body schema: application/json

provider required	string Enum: "ob-barclays-business" "ob-revolut" "ob-natwest" "ob-hsbc-business" "ob-rbs" "ob-ulster" "ob-svb" "ob-clydesdale" "ob-yorkshire" "ob-lloyds-business" "ob-santander" "ob-sandbox-rbs" "ob-sandbox-natwest" Identifier of provider bank.
customerPaymentId required	string <uuid> Payment ID passed from client.
futurePaymentDate	string <date> The date on which the bulk payment will be made. All dates in the JSON payloads are represented in ISO 8601 date format. Time data should be excluded. All dates should be at least 2 days in the future from the current date.
required	object (FilePaymentData)
reference	string [ 1 .. 18 ] characters
	object

Responses

Request samples

Payload

Content type

application/json

{"provider": "ob-barclays-business",
"customerPaymentId": "0aa912e0-3dc8-4e2d-9af1-9d24c3eeb4fb",
"futurePaymentDate": "2022-10-05",
"paymentData": {"debtor": {"sortCode": "string",
"accountNumber": "stringst"
},
"transactions": [{"creditorName": "string",
"creditorSortCode": "string",
"creditorAccountNumber": "stringst",
"creditorType": "INDIVIDUAL",
"amount": "string",
"paymentReference": "string"
}
]
},
"reference": "string",
"option": {"redirectUri": "string",
"webhookUri": "string"
}
}

Response samples

201
500

Content type

application/json; charset=utf-8

{"result": {"file_payment": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"provider": {"id": "ob-barclays-business",
"name": "Barclays Business"
},
"amount": "string",
"referenceNumber": "string",
"customerPaymentId": "0aa912e0-3dc8-4e2d-9af1-9d24c3eeb4fb",
"futurePaymentDate": "2022-10-05",
"numberOfTransactions": "string",
"paymentFileUri": "http://example.com",
"risk": {"PaymentContextCode": "BillingGoodsAndServicesInAdvance",
"MerchantCategoryCode": "stri",
"MerchantCustomerIdentification": "string",
"ContractPresentInidicator": true,
"BeneficiaryPrepopulatedIndicator": true,
"PaymentPurposeCode": "stri",
"BeneficiaryAccountType": "Business",
"DeliveryAddress": {"AddressLine": ["string"
],
"StreetName": "string",
"BuildingNumber": "string",
"PostCode": "string",
"TownName": "string",
"CountrySubDivision": "string",
"Country": "string"
}
},
"status": "new_file_payment",
"providerReferenceNumber": "ad9a8dd8-4cbb-418f-a6b0-a87465d52aa6",
"providerAlternativeReferenceNumber": "50f4293e-78c3-4fc4-bcb9-68c3e02a9710",
"providerUserGrantToken": "string",
"redirectUri": "http://example.com",
"webhookUri": "http://example.com",
"log": "string",
"completedAt": "2019-08-24T14:15:22Z",
"remitterSortCode": "string",
"remitterAccountNumber": "string",
"remitterName": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"auth_flow": {"type": "redirect",
"uri": "http://example.com",
"expiry": "2019-08-24T14:15:22Z"
}
}
}

Bulk Payments

Create Bulk Payments

Responses

Response samples

200

Content type

application/json; charset=utf-8

{"type": "string",
"status": "new_file_payment",
"comment": "string",
"data": {"error": null
}
}

Get Bulk Payment

Authorizations:

clientId

clientSecret

path Parameters

id

required

string <uuid>

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200
404

Content type

application/json; charset=utf-8

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"provider": {"id": "ob-barclays-business",
"name": "string",
"sortCodeRange": "string"
},
"customerPaymentId": "0aa912e0-3dc8-4e2d-9af1-9d24c3eeb4fb",
"providerReferenceNumber": "ad9a8dd8-4cbb-418f-a6b0-a87465d52aa6",
"providerAlternativeReferenceNumber": "50f4293e-78c3-4fc4-bcb9-68c3e02a9710",
"providerUserGrantToken": "string",
"amount": "string",
"numberOfTransactions": "string",
"paymentFileUri": "http://example.com",
"redirectUri": "http://example.com",
"status": "new_file_payment",
"webhookUri": "http://example.com",
"log": "string",
"risk": {"PaymentContextCode": "BillingGoodsAndServicesInAdvance",
"MerchantCategoryCode": "stri",
"MerchantCustomerIdentification": "string",
"ContractPresentInidicator": true,
"BeneficiaryPrepopulatedIndicator": true,
"PaymentPurposeCode": "stri",
"BeneficiaryAccountType": "Business",
"DeliveryAddress": {"AddressLine": ["string"
],
"StreetName": "string",
"BuildingNumber": "string",
"PostCode": "string",
"TownName": "string",
"CountrySubDivision": "string",
"Country": "string"
}
},
"completedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"referenceNumber": "string",
"remitterSortCode": "string",
"remitterAccountNumber": "string",
"remitterName": "string"
}

Starling Transactions

Get Transactions

Authorizations:

clientId

clientSecret

path Parameters

consentId required	string ID of the consent created.
accountId required	string ID of the account.
categoryId required	string ID of the category.

query Parameters

transactionStartDate	string <date-time> ID of the account.
transactionEndDate	string <date-time> ID of the account.

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200
500

Content type

application/json; charset=utf-8

{"Data": [{"feedItemUid": "11221122-1122-1122-1122-112211221122",
"categoryUid": "ccddccdd-ccdd-ccdd-ccdd-ccddccddccdd",
"amount": {"currency": "GBP",
"minorUnits": 123456
},
"sourceAmount": {"currency": "GBP",
"minorUnits": 123456
},
"direction": "IN",
"updatedAt": "string",
"transactionTime": "string",
"settlementTime": "string",
"retryAllocationUntilTime": "string",
"source": "MASTER_CARD",
"sourceSubType": "CONTACTLESS",
"status": "PENDING",
"transactingApplicationUserUid": "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
"counterPartyType": "MERCHANT",
"counterPartyUid": "68e16af4-c2c3-413b-bf93-1056b90097fa",
"counterPartyName": "Tesco",
"counterPartySubEntityUid": "35d46207-d90e-483c-a40a-128cc4da4bee",
"counterPartySubEntityName": "Tesco Southampton",
"counterPartySubEntityIdentifier": 608371,
"counterPartySubEntitySubIdentifier": 342391,
"exchangeRate": 0,
"totalFees": 0,
"totalFeeAmount": {"currency": "GBP",
"minorUnits": 123456
},
"reference": "TESCO-STORES-6148 SOUTHAMPTON GBR",
"country": "GB",
"spendingCategory": "GROCERIES",
"userNote": "Tax deductable, submit me to payroll",
"roundUp": {"goalCategoryUid": "68e16af4-c2c3-413b-bf93-1056b90097fa",
"amount": {"currency": "GBP",
"minorUnits": 123456
}
},
"hasAttachment": true,
"hasReceipt": true
}
]
}

EU Single Payment Initiation

Create a Single Payment Initiation

Authorizations:

clientId

clientSecret

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Request Body schema: application/json

amount required	string [ 4 .. 10 ] characters ^\d+\.\d{0,2}$ A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
provider required	string Enum: "bg-ubb" "bg-raiffeisen" "bg-unicredit" "bg-postbank" "bg-dskbank"
paymentType required	string Enum: "domestic-credit-transfer" "sepa-credit-transfer" domestic-credit-transfer is available for: bg-ubb, bg-raiffeisen, bg-unicredit, bg-postbank, bg-dskbank sepa-credit-transfer is available for: none
customerPaymentId required	string
reference	string [ 1 .. 18 ] characters Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction
remittanceInformation	string [ 4 .. 140 ] characters
required	object
required	object
	object
	object
currency	string^[A-Z]{3,3}$ A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

Responses

Request samples

Payload

Content type

application/json

{"amount": "0.01",
"provider": "bg-postbank",
"paymentType": "domestic-credit-transfer",
"customerPaymentId": "f929d718-1496-11eb-adc1-0242ac120002",
"reference": "Test Payment",
"remittanceInformation": "Payment done via Provider API",
"beneficiary": {"iban": "BG009BPBI000003",
"name": "Vasya Gladush"
},
"remitter": {"iban": "BG009BPBI000001",
"psuId": "vasyagladush",
"psuIpAddress": "192.128.0.1"
},
"risk": {"customerId": "string",
"context": "BillPayment",
"merchantCategoryCode": 0,
"address": {"addressLine": ["string"
],
"streetName": "string",
"postCode": "string",
"townName": "string",
"country": "st"
}
},
"option": {"redirectUri": "string"
},
"currency": "BGN"
}

Response samples

201
500

Content type

application/json; charset=utf-8

{"result": {"single_payment": {"id": "ea8f1a34-a19a-467f-9ce7-88f290ac1740",
"psuIpAddress": "192.128.0.1",
"provider": {"id": "bg-postbank",
"name": "PostBank"
},
"type": "domestic-credit-transfer",
"amount": "0.01",
"referenceNumber": "Test Payment",
"customerPaymentId": "f929d718-1496-11eb-adc1-0242ac120002",
"beneficiaryIban": "BG009BPBI000003",
"beneficiaryName": "Vasya Gladush",
"remitterIban": "BG009BPBI000001",
"psuId": "vasyagladush",
"remittanceInformation": "Payment done via Provider API",
"currency": null,
"status": "initiated",
"completedAt": null,
"createdAt": "2022-07-18T21:40:26.158Z",
"updatedAt": "2022-07-18T21:40:26.158Z"
},
"auth_flow": {"type": "redirect",
"uri": "https://gate.postbank.bg:444/postbank/psd2/live/oauth2/authorize?response_type=code&client_id=75281b59-baa7-4670-b47b-177885348a37&redirect_uri=https://2f1a-193-164-255-15.ngrok.io/eu-authorization-code-callback&scope=pisp&state=ea8f1a34-a19a-467f-9ce7-88f290ac1740payments-api"
}
}
}

Get a Single Payment Information

Authorizations:

clientId

clientSecret

path Parameters

paymentId

required

string <uuid>

ID of the payment in Provider API database (it's not customerPaymentId)

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200
404
500

Content type

application/json; charset=utf-8

{"id": "e95fe48b-b811-4852-901e-34e858cf69db",
"customerPaymentId": "f929d718-1496-11eb-adc1-0242ac120002",
"type": "domestic-credit-transfer",
"amount": "0.01",
"beneficiaryIban": "BG009BPBI000003",
"beneficiaryName": "Vasya Gladush",
"remitterIban": "BG009BPBI000001",
"status": "pending",
"completedAt": null,
"createdAt": "2022-07-14T21:28:41.077Z",
"updatedAt": "2022-07-14T21:30:00.369Z",
"referenceNumber": "Test Payment",
"psuId": "vasyagladush",
"psuIpAddress": "192.128.0.1",
"remittanceInformation": "Payment done via Provider API",
"currency": null,
"provider": {"id": "bg-postbank",
"name": "PostBank"
}
}

Webhook

Create a Webhook

Authorizations:

clientId

clientSecret

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Request Body schema: application/json

consentId required	string Consent ID
url required	string Your webhook URL
event required	string Enum: "ACCOUNT_ACCESS_CONSENT" "ACCOUNT" "ACCOUNTS" "ACCOUNT_BALANCES" "ACCOUNT_TRANSACTION" "ACCOUNT_TRANSACTIONS" "DOMESTIC_STANDING_ACCESS_CONSENT" Event
product required	string Enum: "ACCOUNTS" "DOMESTIC_STANDING_PAYMENTS" Product. Note: you can use 'ACCOUNTS' product for UK providers and also EU providers

Responses

Request samples

Payload

Content type

application/json

{"consentId": "string",
"url": "string",
"event": "ACCOUNT_ACCESS_CONSENT",
"product": "ACCOUNTS"
}

Response samples

201
400
500

Content type

application/json; charset=utf-8

{"message": "Request is completed successfully."
}

Get Webhook

Authorizations:

clientId

clientSecret

path Parameters

consentId

required

string <uuid>

ID of the consent the webhook was registered with

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200
400
500

Content type

application/json; charset=utf-8

{"consentId": "string",
"url": "string",
"event": "ACCOUNT_ACCESS_CONSENT",
"product": "ACCOUNTS"
}

Delete a Webhook

Authorizations:

clientId

clientSecret

path Parameters

consentId

required

string <uuid>

ID of the consent the webhook was registered with

header Parameters

client_id required	string <uuid> Client clientId.
client_secret required	string <uuid> Client clientSecret.

Responses

Response samples

200
400
500

Content type

application/json; charset=utf-8

{"message": "Request is completed successfully."
}