Complete list of the ISO 20022 API's endpoints (methods)
An application programming interface is a way for two or more computer programs to communicate with each other. It is a type of software interface, offering a service to other pieces of software. A document or standard that describes how to build or use such a connection or interface is called an API specification. (as per Wikipedia)
The following API endpoints are located at this URL: https://api-sandbox.impel-lab577.co.uk/BBBBCAXXXXX/swagger-ui/index.html?configUrl=/BBBBCAXXXXX/v3/api-docs/swagger-config
Message id
Created
Ok
Ok
OK
The bank identification code (i.e. SWIFT/BIC)
Ok
Unique identifier for this party
Name of party
Swift BIC for this party
URL for this party's gateway
Base64 encoded certificate
Addresses for this party
XinFin address
The RSQL filter to apply as search criteria
The zero-indexed page number, optional
The page size, optional with default being 10
Ok
A filter to get events from given date
A filter to get events to given date
The zero-indexed page number
The page size
Ok
The RSQL filter to apply as search criteria
The zero-indexed page number, optional
The page size, optional with default being 10
Ok
Unique identifier for this party
Name of party
Swift BIC for this party
URL for this party's gateway
Base64 encoded certificate
Addresses for this party
XinFin address
Send message request
Message end to end id
Sender BIC
Recipient BIC
Message payload type
Message payload
Collateral
Collateral type, e.g. native XDC or ERC20 token
Collateral amount
Collateral exchange price
Collateral exchange currency
ERC20 token symbol, required when type is equal to ERC20
Flag which enables payload validation
Accepted
Message id
Message id
Ok
Proof status
Proof status change date time
Proof channel hash as hex
Sender BIC
Recipient BIC
Net settlement collaterals
Collateral type, e.g. native XDC or ERC20 token
Collateral net settlement amount
ERC20 token symbol
Flag which tells if all parties signed a proof
Initiator signature
Counterparty signature
Proof's messages identifiers
Proof's messages identifiers
Proof's messages end to end identifiers
Proof's messages end to end identifiers
Proof creation date time
Proof update date time
Message id
Flag if payload should be returned in a response
Ok
Message id
Message end to end id
Sender BIC
Recipient BIC
Message payload type
Message payload - returned only if requested
Collateral
Collateral type, e.g. native XDC or ERC20 token
Collateral amount
Collateral exchange price
Collateral exchange currency
ERC20 token symbol, required when type is equal to ERC20
Message status
Message direction (INBOX|OUTBOX) which tells if message was sent or received
Message hash
Previous message hash
Flag which tells if all parties signed a message
Initiator signature
Counterparty signature
Proof
Proof status
Proof status change date time
Proof channel hash as hex
Sender BIC
Recipient BIC
Net settlement collaterals
Collateral type, e.g. native XDC or ERC20 token
Collateral net settlement amount
ERC20 token symbol
Flag which tells if all parties signed a proof
Initiator signature
Counterparty signature
Proof's messages identifiers
Proof's messages identifiers
Proof's messages end to end identifiers
Proof's messages end to end identifiers
Proof creation date time
Proof update date time
Message creation date time
Message update date time
The RSQL filter to apply as search criteria
The zero-indexed page number, optional
The page size, optional with default being 10
The field to use for sorting
The sort direction, either ASC or DESC
Ok
Message id
Message end to end id
Sender BIC
Recipient BIC
Message payload type
Message payload - returned only if requested
Collateral
Collateral type, e.g. native XDC or ERC20 token
Collateral amount
Collateral exchange price
Collateral exchange currency
ERC20 token symbol, required when type is equal to ERC20
Message status
Message direction (INBOX|OUTBOX) which tells if message was sent or received
Message hash
Previous message hash
Flag which tells if all parties signed a message
Initiator signature
Counterparty signature
Proof
Proof status
Proof status change date time
Proof channel hash as hex
Sender BIC
Recipient BIC
Net settlement collaterals
Collateral type, e.g. native XDC or ERC20 token
Collateral net settlement amount
ERC20 token symbol
Flag which tells if all parties signed a proof
Initiator signature
Counterparty signature
Proof's messages identifiers
Proof's messages identifiers
Proof's messages end to end identifiers
Proof's messages end to end identifiers
Proof creation date time
Proof update date time
Message creation date time
Message update date time