Jump to Content
Guides
API reference
Release notes
API reference
Guides
API reference
Release notes
Credit arrangement object
All
Pages
Start typing to search…
JUMP TO
Getting started
Introduction
API basics
Main API resources
API docs
Environments
API authentication
Sign API requests
API versioning
Status codes
Rate limiting
Idempotency
Data types
Standard data types
Currency codes and decimals
Reason and purpose codes
SEPA reason codes
Bacs reason codes
FPS reason codes
Purpose codes
Pagination
Metadata
Events and webhooks
Events
Webhooks
Webhooks security
Payments
Payment orders
Payment order object
Payment order lifecycle
Create payment order
post
Approve payment order
post
Cancel payment order
post
Retry payment order
post
Update payment order
post
Update payment order validation
post
List payment orders
get
Retrieve payment order
get
Incoming payments
Incoming payment object
Incoming payment lifecycle
Confirm incoming payment
post
Reject incoming payment
post
Update incoming payment validation
post
Update incoming payment
post
Track incoming payment
post
List incoming payments
get
Retrieve incoming payment
get
Returns
Return object
Return lifecycle
Create return
post
Update return
post
Approve return
post
Cancel return
post
Update return validation
post
List returns
get
Retrieve return
get
Investigations
Return requests
Return request object
Return request lifecycle
Create return request
post
Accept return request
post
Deny return request
post
List return requests
get
Retrieve return request
get
Claims
Claim object
Claim lifecycle
Create claim
post
Accept claim
post
Reject claim
post
List claims
get
Retrieve claim
get
Inquiries
Inquiry object
Inquiry lifecycle
Deny inquiry
post
Create inquiry
post
List inquiries
get
Retrieve inquiry
get
Accounts
Connected accounts
Connected account object
List connected accounts
get
Retrieve connected account
get
Transactions
Transaction object
Transaction lifecycle
Update transaction
post
List transactions
get
Retrieve transaction
get
Balances
Balance object
Balance lifecycle
List balances
get
Retrieve balance
get
Counterparties
Account holders
Account holder object
Account holder lifecycle
Create account holder
post
Update account holder
post
Disable account holder
post
List account holders
get
Retrieve account holder
get
External accounts
External account object
External account lifecycle
Create external account
post
Approve external account
post
Deny external account
post
Disable external account
post
Verify external account
post
Update external account
post
List external accounts
get
Retrieve external account
get
Internal accounts
Internal account object
Internal account lifecycle
Create internal account
post
Block internal account
post
Unblock internal account
post
Update an internal account
post
Disable internal account
post
List internal accounts
get
Retrieve internal account
get
Direct debit mandates
Direct debit mandate object
Direct debit mandate lifecycle
Create direct debit mandate
post
Update direct debit mandate
post
Disable direct debit mandate
post
Block direct debit mandate
post
Authorize direct debit mandate
post
List direct debit mandates
get
Retrieve direct debit mandate
get
Reconciliations
Expected payments
Expected payment object
Expected payment lifecycle
Create expected payment
post
Cancel expected payment
post
Update expected payment
post
List expected payments
get
Retrieve expected payment
get
Payment captures
Payment capture object
Payment capture lifecycle
Create payment capture
post
Cancel payment capture
post
Update payment capture
post
List payment captures
get
Retrieve payment capture
get
Reconciliations
Reconciliation object
Reconciliation lifecycle
Create reconciliation
post
Cancel reconciliation
post
Update reconciliation
post
List reconciliations
get
Retrieve reconciliation
get
Files
Files
File object
File lifecycle
Approve file
post
Cancel file
post
List files
get
Retrieve file
get
Download file
get
Events
Events
Event object
Event lifecycle
Retry failed events
post
Resend event
post
List events
get
Retrieve event
get
Verification of Payee
Payee verification requests
Payee verification request object
Payee verification request lifecycle
Payee verification request bulk action lifecycle
Send verification payee request
post
Create bulk action for payee verification requests
post
Simulate incoming payee verification request
post
List payee verification requests
get
Retrieve payee verification request
get
Retrieve bulk action
get
Retrieve bulk action items
get
Verification scheme participants
Get supported identification types for a payee account
get
Retrieve verification scheme participant
get
Tools
Audit trails
Audit trail object
List audit trails
get
Retrieve audit trail
get
Process payments
Process payments
post
Bulk actions
Bulk action object
Bulk action lifecycle
Create bulk action
post
List bulk actions
get
Retrieve bulk action
get
Retrieve bulk action related items
get
Message forward
Forward message
post
Custom fields
Custom field object
Create custom field
post
Update custom field
post
List custom fields
get
Retrieve custom field
get
Payment retry rules
Payment retry rule object
List payment retry rules
get
Retrieve payment retry rule
get
Bank code lookup
Bank code lookup overview
Bank code lookup
post
Simulator
Simulate message received
post
Update payment status
post
Create balance
post
Create transaction
post
Create incoming payment
post
Connectivity syncs
Connectivity sync object
Connectivity sync lifecycle
List connectivity syncs
get
Retrieve connectivity sync
get
Platform health check
Check platform health
get
Developers
API keys
API key object
List API keys
get
Retrieve API key
get
Additional resources
Account details
Address
Organization identification
Private identification
External account verification
Credit arrangement object
Ask AI
