Jump to Content
Platform Guides
Recipes
API Documentation
v1.0
v2.0
Log In
API Documentation
Log In
2.0
Platform Guides
Recipes
API Documentation
Get Event Types
Search
JUMP TO
Neo Platform
Introduction
Authentication
Long running operations
Get Operation by ID
get
Operation
Get Operation by ID
get
Event Subscription
Get Event Types
get
Get Event Subscription By ID
get
Delete Event Subscription
delete
Create Or Update Event Subscription
put
Get Event Subscriptions Of The Requester
get
Reference Data
Get ReferenceData Types
get
Get ReferenceData Values
get
Neo Generic
Task
Create task
post
Custom Field Structure
Get custom field structure
get
CustomField
Get custom field structure
get
Neo 360
ReferenceData
Get Loan Types
get
The available extra payment types
get
Get Company Status Transition List
get
Get Interest Calculation Method List
get
Get Company Product Roles List
get
Get Country List
get
Get Person Status Transition List
get
Get Block Reasons List
get
Get Status List
get
Get Person Status List
get
Get Person Product Roles List
get
Get Precomputed Holiday Type List
get
Get Company Status List
get
Get cost type List
get
Get Nationality List
get
Get Gender List
get
Get Identity Document Type List
get
Get External Payment State Type List
get
Get Company Details Setting List
get
Get Company Legal Form List
get
Get New Interest Spread Period Start Type List
get
Get Offboarding Reasons List
get
Get Risk Rating List
get
The available loan statusses
get
Get Company Industries List
get
Get Title List
get
Get Marital Status List
get
Get Period Type List
get
Get entity relation type extensions structure
get
Get Interest Type List
get
The available default types
get
Get Ownership Percentage List
get
Get Address Type List
get
Get Language List
get
Get Penalty Rate Type List
get
The available principal repayment methods
get
Get Precomputed Repayment Type List
get
Get Day Count Method List
get
Get Payment Holiday Type List
get
Get Entity Relations List
get
Get Product roles List
get
Get UsPerson List
get
Get Currency Code List
get
Get Rate Type List
get
Person
Delete person data
delete
Update person
patch
Get person by id
get
Create person
post
Upload a document to persons folder
post
Get an overview persons document(s)
get
Update person status
patch
Get document by id for specified person
get
Update person status
put
Company
Update UBO relation
patch
Get company entity relation(s)
get
Create company entity relation
post
Update company status
put
Create other entity relation
post
Update company
patch
Get company by Id
get
Update company entity relation
patch
Update other entity relation
patch
Create company
post
Create UBO relation
post
PersonV2
Create person
post
Get person by id
get
Update person
patch
Folder
Get folder structure
get
Product Relation
Update Product Relation
put
Delete Product Relation
delete
Get Product Relation
get
Create Products Relations
post
Neo Lending
Regular Loan
Cancel Payment
post
Add costs on a loan
post
Write off regular loan
post
Create loan prospect calculation
post
Change interest
post
Get cashflow cost details
get
Get loan details by ID
get
Get loan cashflows by loan ID
get
Get Payments for Specified Loan
get
Register a payment for a loan
post
Remove unpaid costs for a loan.
post
Get loans
get
Create regular loan
post
Refunds
post
Change regular loan
patch
Get List of Nominated Accounts for Provided Loan Identifier
get
Create Loan To Nominated Account Relation
post
Update Loan to Nominated Account Relation
patch
Get the loan balance
get
RevolvingCredit
Create revolving credit administration fee
post
Change Interest
post
Cancel Payment
post
Change revolving credit limit
put
Drawdown Revolving Credit
post
Change final date of the revolving credit
put
Create Revolving Credit
post
Change revolving credit final drawdown date
put
Get Revolving Credit
get
Write off revolving credit
post
Refunds
post
Change Repayment Amount
put
Change revolving credit loan
patch
PrecomputedLoan
Refunds
post
Register a payment holiday for a precomputed loan
post
Write off precomputed loan
post
Change precomputed loan
patch
Cancel Payment
post
Create precomputed loan
post
Get precomputed loan details
get
LoanPayments
Get batch payment details
get
Get batch payment status
get
Register batch payment
post
LoanConfiguration
Get rate lists
get
Get Costs
get
Create Interest Value
post
Get Interest Series
get
Get write-off types
get
Get active interest categories
get
RegularLoan
Get Payments for Specified Loan
get
Register a payment for a loan
post
Change interest
post
Refunds
post
Get the loan balance
get
Update Loan to Nominated Account Relation
patch
Get List of Nominated Accounts for Provided Loan Identifier
get
Create Loan To Nominated Account Relation
post
Write off regular loan
post
Get cashflow cost details
get
Change regular loan
patch
Add costs on a loan
post
Create loan prospect calculation
post
Get loan cashflows by loan ID
get
Cancel Payment
post
Get loans
get
Create regular loan
post
Get loan details by ID
get
Remove unpaid costs for a loan.
post
Precomputed Loan
Register a payment holiday for a precomputed loan
post
Refunds
post
Get precomputed loan details
get
Change precomputed loan
patch
Cancel Payment
post
Create precomputed loan
post
Write off precomputed loan
post
Revolving Credit
Cancel Payment
post
Change final date of the revolving credit
put
Write off revolving credit
post
Change Interest
post
Get Revolving Credit
get
Change revolving credit loan
patch
Refunds
post
Drawdown Revolving Credit
post
Create Revolving Credit
post
Change Repayment Amount
put
Change revolving credit limit
put
Change revolving credit final drawdown date
put
Create revolving credit administration fee
post
Loan Payments
Get batch payment status
get
Register batch payment
post
Get batch payment details
get
Configuration
Get write-off types
get
Get Costs
get
Get active interest categories
get
Get Interest Series
get
Create Interest Value
post
Neo Accounts
Cash Account
Create single sweep
post
Get cash accounts details by filter
post
Close cash account
post
Delete nominated account
delete
Get direct debits
get
Change product
post
Get cash account balance
get
Get cash account movements
get
Get client report
get
Create client report configuration
post
Update client report configuration
put
Delete client report configuration
delete
Create an incoming payment
post
Get interest rate overrides
get
Register new interest rate
post
Change status
post
Create cash account
post
Get accrued interest
get
Create outgoing payment
post
Request direct debits
post
Get cash account
get
Add nominated account
post
Delete interest rate override
delete
End interest rate override
post
Create sweeps
post
Term Deposits
End interest rate overrides
post
Replace linked account
post
Get term deposit
get
Deposit money
post
Close prematurely
post
Create new interest rate for a term deposit account
post
Get interest rate overrides
get
Create term deposit
post
Delete interest rate override
delete
Get movements
get
Payment Buckets
Get payment bucket items
get
Change outgoing payment bucket status
post
Get payment buckets
get
Create incoming return payment bucket
post
Update Payment Bucket Status to ReadyForExport
post
Get payment bucket items by filter
get
Create incoming payment bucket
post
Get payment buckets by filter
get
Change outgoing return payment bucket status
post
Get payment bucket by id
get
Fx Contract
Create incoming FxContract
post
Configuration
Get units
get
Get departments
get
Get products
get
Create interest rate
post
Get interest sources
get
Get payment subtypes
get
Reference Data
Get message types
get
Get sepa return codes
get
Get nominated account directions
get
Get charge handling methods
get
Get fee handlings
get
Get movement statuses
get
Get client reporting delivery types
get
Get account statuses
get
Get payment types
get
Get payment sources
get
Get interval time units
get
Get identification standards
get
Get tax exempt states
get
Get currencies
get
Get client reporting trigger types
get
Get country codes
get
Get payment bucket types
get
Get Operation Types
get
Get bank operation codes
get
Get transaction types
get
Get FX Contract Types
get
Get payment bucket statuses
get
Neo Direct Debits
Products
Deactivate the mandate on a product
post
Add a mandate to a product
post
Get products and their linked mandates
get
Create a product to be used for direct debits
post
Reactivate a suspended mandate on a product
post
Mandates
Create a mandate
post
Get mandates and their linked products
get
Neo Payment Gateway
Payment Messages
Get the message instructions by message ID
get
Post a message to be processed
post
Get incoming payment messages by filter
get
Set the messages as requested
post
Get outgoing payment messages by filter
get
Get the message content by message ID
get
Reference Data
Get the payment sources.
get
Get the message types.
get
Neo Connectors
PAC Connector
Get messageId and bucketId
get
Get Event Types
get
https://apim.demo01.my.fivedegrees.cloud/sbx/subscriptions/events
Get Event Types
Language
Shell
Node
Ruby
PHP
Python
Credentials
OAuth2
OAuth2
Bearer
RESPONSE
Click
Try It!
to start a request and see the response here!