Open API for FSP Interoperability (FSPIOP) (Implementation Friendly Version)

Base URL: /fsp, Version: 1.0

Based on API Definition.docx updated on 2018-03-13 Version 1.0. Note - The API supports a maximum size of 65536 bytes (64 Kilobytes) in the HTTP header.

Schemes: http, https

Summary

Tag: participants

Operation Description
PUT /participants/{ID}/error

ParticipantsByIDAndError

PUT /participants/{ID}

ParticipantsByID

PUT /participants/{Type}/{ID}/error

ParticipantsErrorByTypeAndID

PUT /participants/{Type}/{ID}/{SubId}/error

ParticipantsSubIdErrorByTypeAndID

GET /participants/{Type}/{ID}/{SubId}

ParticipantsSubIdByTypeAndID

PUT /participants/{Type}/{ID}/{SubId}

ParticipantsSubIdByTypeAndID

POST /participants/{Type}/{ID}/{SubId}

ParticipantsSubIdByTypeAndID

DELETE /participants/{Type}/{ID}/{SubId}

ParticipantsSubIdByTypeAndID

GET /participants/{Type}/{ID}

ParticipantsByTypeAndID

PUT /participants/{Type}/{ID}

ParticipantsByTypeAndID

POST /participants/{Type}/{ID}

ParticipantsByIDAndType

DELETE /participants/{Type}/{ID}

ParticipantsByTypeAndID

POST /participants

Participants

Tag: parties

Operation Description
GET /parties/{Type}/{ID}

PartiesByTypeAndID

PUT /parties/{Type}/{ID}

PartiesByTypeAndID2

PUT /parties/{Type}/{ID}/error

PartiesErrorByTypeAndID

GET /parties/{Type}/{ID}/{SubId}

PartiesSubIdByTypeAndID

PUT /parties/{Type}/{ID}/{SubId}

PartiesSubIdByTypeAndID

PUT /parties/{Type}/{ID}/{SubId}/error

PartiesSubIdErrorByTypeAndID

Tag: transactionRequests

Operation Description
PUT /transactionRequests/{ID}/error

TransactionRequestsErrorByID

GET /transactionRequests/{ID}

TransactionRequestsByID

PUT /transactionRequests/{ID}

TransactionRequestsByID

POST /transactionRequests

TransactionRequests

Tag: quotes

Operation Description
PUT /quotes/{ID}/error

QuotesByIDAndError

GET /quotes/{ID}

QuotesByID

PUT /quotes/{ID}

QuotesByID

POST /quotes

Quotes

Tag: authorizations

Operation Description
GET /authorizations/{ID}

AuthorizationsByID

PUT /authorizations/{ID}

AuthorizationsByID

PUT /authorizations/{ID}/error

AuthorizationsByIDAndError

Tag: transfers

Operation Description
GET /transfers/{ID}

TransfersByIDGet

PUT /transfers/{ID}

TransfersByIDPut

PUT /transfers/{ID}/error

TransfersByIDAndError

POST /transfers

Transfers

Tag: transactions

Operation Description
GET /transactions/{ID}

TransactionsByID

PUT /transactions/{ID}

TransactionsByID

PUT /transactions/{ID}/error

TransactionsErrorByID

Tag: bulkQuotes

Operation Description
PUT /bulkQuotes/{ID}/error

BulkQuotesErrorByID

GET /bulkQuotes/{ID}

BulkQuotesByID

PUT /bulkQuotes/{ID}

BulkQuotesByID

POST /bulkQuotes

BulkQuotes

Tag: bulkTransfers

Operation Description
GET /bulkTransfers/{ID}

BulkTransferByID

PUT /bulkTransfers/{ID}

BulkTransfersByIDPut

POST /bulkTransfers

BulkTransfers

PUT /bulkTransfers/{ID}/error

BulkTransfersErrorByID

Paths

AuthorizationsByID

GET /authorizations/{ID}

Tags: authorizations

The HTTP request GET /authorizations/ is used to request the Payer to enter the applicable credentials in the Payee FSP system. The in the URI should contain the transactionRequestID, received from the POST /transactionRequests service earlier in the process. This request requires a query string to be included in the URI, with the following key-value pairs - authenticationType=, where value is a valid authentication type from the enumeration AuthenticationType. retriesLeft==, where is the number of retries left before the financial transaction is rejected. must be expressed in the form of the data type Integer. retriesLeft=1 means that this is the last retry before the financial transaction is rejected. amount=, where is the transaction amount that will be withdrawn from the Payer’s account. must be expressed in the form of the data type Amount. currency=, where is the transaction currency for the amount that will be withdrawn from the Payer’s account. The value must be expressed in the form of the enumeration CurrencyCode. An example URI containing all the required key-value pairs in the query string is the following - GET /authorization/3d492671-b7af-4f3f-88de-76169b1bdf88?authenticationType=OTP&retriesLeft=2&amount=102&currency=USD

Name Description Type Data Type Annotation
Accept

The Accept header field indicates the version of the API the client would like the server to use.

header string #/parameters/Accept
ID path string #/parameters/ID
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

header string #/parameters/Content-Type
Date

The Date header field indicates the date when the request was sent.

header string #/parameters/Date
X-Forwarded-For

The X-Forwarded-For header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple X-Forwarded-For values as in the example shown here should be expected and supported by implementers of the API. Note - An alternative to X-Forwarded-For is defined in RFC 7239. However, to this point RFC 7239 is less-used and supported than X-Forwarded-For.

header string #/parameters/X-Forwarded-For
FSPIOP-Source

The FSPIOP-Source header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field FSPIOP-Signature).

header string #/parameters/FSPIOP-Source
FSPIOP-Destination

The FSPIOP-Destination header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes.

header string #/parameters/FSPIOP-Destination
FSPIOP-Encryption

The FSPIOP-Encryption header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request.

header string #/parameters/FSPIOP-Encryption
FSPIOP-Signature

The FSPIOP-Signature header field is a non-HTTP standard field used by the API for applying an end-to-end request signature.

header string #/parameters/FSPIOP-Signature
FSPIOP-URI

The FSPIOP-URI header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information see API Signature document.

header string #/parameters/FSPIOP-URI
FSPIOP-HTTP-Method

The FSPIOP-HTTP-Method header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information see API Signature document.

header string #/parameters/FSPIOP-HTTP-Method

application/json

202 Accepted #/responses/Response202

Accepted

400 Bad Request #/responses/ErrorResponse400

Bad Request - The application cannot process the request; for example, due to malformed syntax or the payload exceeded size restrictions.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
401 Unauthorized #/responses/ErrorResponse401

Unauthorized - The request requires authentication in order to be processed.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
403 Forbidden #/responses/ErrorResponse403

Forbidden - The request was denied and will be denied in the future.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
404 Not Found #/responses/ErrorResponse404

Not Found - The resource specified in the URI was not found.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
405 Method Not Allowed #/responses/ErrorResponse405

Method Not Allowed - An unsupported HTTP method for the request was used.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
406 Not Acceptable #/responses/ErrorResponse406

Not acceptable - The server is not capable of generating content according to the Accept headers sent in the request. Used in the API to indicate that the server does not support the version that the client is requesting.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
501 Not Implemented #/responses/ErrorResponse501

Not Implemented - The server does not support the requested service. The client should not retry.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
503 Service Unavailable #/responses/ErrorResponse503

Service Unavailable - The server is currently unavailable to accept any new service requests. This should be a temporary state, and the client should retry within a reasonable time frame.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
AuthorizationsByID

PUT /authorizations/{ID}

Tags: authorizations

The callback PUT /authorizations/ is used to inform the client of the result of a previously-requested authorization. The in the URI should contain the that was used in the GET /authorizations/.

Name Description Type Data Type Annotation
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body. Note - The API supports a maximum size of 5242880 bytes (5 Megabytes)

header integer #/parameters/Content-Length
ID path string #/parameters/ID
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

header string #/parameters/Content-Type
Date

The Date header field indicates the date when the request was sent.

header string #/parameters/Date
X-Forwarded-For

The X-Forwarded-For header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple X-Forwarded-For values as in the example shown here should be expected and supported by implementers of the API. Note - An alternative to X-Forwarded-For is defined in RFC 7239. However, to this point RFC 7239 is less-used and supported than X-Forwarded-For.

header string #/parameters/X-Forwarded-For
FSPIOP-Source

The FSPIOP-Source header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field FSPIOP-Signature).

header string #/parameters/FSPIOP-Source
FSPIOP-Destination

The FSPIOP-Destination header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes.

header string #/parameters/FSPIOP-Destination
FSPIOP-Encryption

The FSPIOP-Encryption header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request.

header string #/parameters/FSPIOP-Encryption
FSPIOP-Signature

The FSPIOP-Signature header field is a non-HTTP standard field used by the API for applying an end-to-end request signature.

header string #/parameters/FSPIOP-Signature
FSPIOP-URI

The FSPIOP-URI header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information see API Signature document.

header string #/parameters/FSPIOP-URI
FSPIOP-HTTP-Method

The FSPIOP-HTTP-Method header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information see API Signature document.

header string #/parameters/FSPIOP-HTTP-Method

application/json

200 OK #/responses/Response200

OK

400 Bad Request #/responses/ErrorResponse400

Bad Request - The application cannot process the request; for example, due to malformed syntax or the payload exceeded size restrictions.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
401 Unauthorized #/responses/ErrorResponse401

Unauthorized - The request requires authentication in order to be processed.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
403 Forbidden #/responses/ErrorResponse403

Forbidden - The request was denied and will be denied in the future.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
404 Not Found #/responses/ErrorResponse404

Not Found - The resource specified in the URI was not found.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
405 Method Not Allowed #/responses/ErrorResponse405

Method Not Allowed - An unsupported HTTP method for the request was used.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
406 Not Acceptable #/responses/ErrorResponse406

Not acceptable - The server is not capable of generating content according to the Accept headers sent in the request. Used in the API to indicate that the server does not support the version that the client is requesting.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
501 Not Implemented #/responses/ErrorResponse501

Not Implemented - The server does not support the requested service. The client should not retry.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
503 Service Unavailable #/responses/ErrorResponse503

Service Unavailable - The server is currently unavailable to accept any new service requests. This should be a temporary state, and the client should retry within a reasonable time frame.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
AuthorizationsByIDAndError

PUT /authorizations/{ID}/error

Tags: authorizations

If the server is unable to find the transaction request, or another processing error occurs, the error callback PUT /authorizations//error is used. The in the URI should contain the that was used in the GET /authorizations/.

Name Description Type Data Type Annotation
ID path string #/parameters/ID
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body. Note - The API supports a maximum size of 5242880 bytes (5 Megabytes)

header integer #/parameters/Content-Length
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

header string #/parameters/Content-Type
Date

The Date header field indicates the date when the request was sent.

header string #/parameters/Date
X-Forwarded-For

The X-Forwarded-For header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple X-Forwarded-For values as in the example shown here should be expected and supported by implementers of the API. Note - An alternative to X-Forwarded-For is defined in RFC 7239. However, to this point RFC 7239 is less-used and supported than X-Forwarded-For.

header string #/parameters/X-Forwarded-For
FSPIOP-Source

The FSPIOP-Source header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field FSPIOP-Signature).

header string #/parameters/FSPIOP-Source
FSPIOP-Destination

The FSPIOP-Destination header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes.

header string #/parameters/FSPIOP-Destination
FSPIOP-Encryption

The FSPIOP-Encryption header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request.

header string #/parameters/FSPIOP-Encryption
FSPIOP-Signature

The FSPIOP-Signature header field is a non-HTTP standard field used by the API for applying an end-to-end request signature.

header string #/parameters/FSPIOP-Signature
FSPIOP-URI

The FSPIOP-URI header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information see API Signature document.

header string #/parameters/FSPIOP-URI
FSPIOP-HTTP-Method

The FSPIOP-HTTP-Method header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information see API Signature document.

header string #/parameters/FSPIOP-HTTP-Method

application/json

200 OK #/responses/Response200

OK

400 Bad Request #/responses/ErrorResponse400

Bad Request - The application cannot process the request; for example, due to malformed syntax or the payload exceeded size restrictions.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
401 Unauthorized #/responses/ErrorResponse401

Unauthorized - The request requires authentication in order to be processed.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
403 Forbidden #/responses/ErrorResponse403

Forbidden - The request was denied and will be denied in the future.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
404 Not Found #/responses/ErrorResponse404

Not Found - The resource specified in the URI was not found.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
405 Method Not Allowed #/responses/ErrorResponse405

Method Not Allowed - An unsupported HTTP method for the request was used.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
406 Not Acceptable #/responses/ErrorResponse406

Not acceptable - The server is not capable of generating content according to the Accept headers sent in the request. Used in the API to indicate that the server does not support the version that the client is requesting.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
501 Not Implemented #/responses/ErrorResponse501

Not Implemented - The server does not support the requested service. The client should not retry.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
503 Service Unavailable #/responses/ErrorResponse503

Service Unavailable - The server is currently unavailable to accept any new service requests. This should be a temporary state, and the client should retry within a reasonable time frame.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
BulkQuotes

POST /bulkQuotes

Tags: bulkQuotes

The HTTP request POST /bulkQuotes is used to request the creation of a bulk quote for the provided financial transactions in the server.

Name Description Type Data Type Annotation
Accept

The Accept header field indicates the version of the API the client would like the server to use.

header string #/parameters/Accept
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body. Note - The API supports a maximum size of 5242880 bytes (5 Megabytes)

header integer #/parameters/Content-Length
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

header string #/parameters/Content-Type
Date

The Date header field indicates the date when the request was sent.

header string #/parameters/Date
X-Forwarded-For

The X-Forwarded-For header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple X-Forwarded-For values as in the example shown here should be expected and supported by implementers of the API. Note - An alternative to X-Forwarded-For is defined in RFC 7239. However, to this point RFC 7239 is less-used and supported than X-Forwarded-For.

header string #/parameters/X-Forwarded-For
FSPIOP-Source

The FSPIOP-Source header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field FSPIOP-Signature).

header string #/parameters/FSPIOP-Source
FSPIOP-Destination

The FSPIOP-Destination header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes.

header string #/parameters/FSPIOP-Destination
FSPIOP-Encryption

The FSPIOP-Encryption header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request.

header string #/parameters/FSPIOP-Encryption
FSPIOP-Signature

The FSPIOP-Signature header field is a non-HTTP standard field used by the API for applying an end-to-end request signature.

header string #/parameters/FSPIOP-Signature
FSPIOP-URI

The FSPIOP-URI header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information see API Signature document.

header string #/parameters/FSPIOP-URI
FSPIOP-HTTP-Method

The FSPIOP-HTTP-Method header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information see API Signature document.

header string #/parameters/FSPIOP-HTTP-Method

application/json

202 Accepted #/responses/Response202

Accepted

400 Bad Request #/responses/ErrorResponse400

Bad Request - The application cannot process the request; for example, due to malformed syntax or the payload exceeded size restrictions.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
401 Unauthorized #/responses/ErrorResponse401

Unauthorized - The request requires authentication in order to be processed.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
403 Forbidden #/responses/ErrorResponse403

Forbidden - The request was denied and will be denied in the future.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
404 Not Found #/responses/ErrorResponse404

Not Found - The resource specified in the URI was not found.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
405 Method Not Allowed #/responses/ErrorResponse405

Method Not Allowed - An unsupported HTTP method for the request was used.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
406 Not Acceptable #/responses/ErrorResponse406

Not acceptable - The server is not capable of generating content according to the Accept headers sent in the request. Used in the API to indicate that the server does not support the version that the client is requesting.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
501 Not Implemented #/responses/ErrorResponse501

Not Implemented - The server does not support the requested service. The client should not retry.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
503 Service Unavailable #/responses/ErrorResponse503

Service Unavailable - The server is currently unavailable to accept any new service requests. This should be a temporary state, and the client should retry within a reasonable time frame.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
BulkQuotesByID

GET /bulkQuotes/{ID}

Tags: bulkQuotes

The HTTP request GET /bulkQuotes/ is used to get information regarding an earlier created or requested bulk quote. The in the URI should contain the bulkQuoteId that was used for the creation of the bulk quote.

Name Description Type Data Type Annotation
Accept

The Accept header field indicates the version of the API the client would like the server to use.

header string #/parameters/Accept
ID path string #/parameters/ID
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

header string #/parameters/Content-Type
Date

The Date header field indicates the date when the request was sent.

header string #/parameters/Date
X-Forwarded-For

The X-Forwarded-For header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple X-Forwarded-For values as in the example shown here should be expected and supported by implementers of the API. Note - An alternative to X-Forwarded-For is defined in RFC 7239. However, to this point RFC 7239 is less-used and supported than X-Forwarded-For.

header string #/parameters/X-Forwarded-For
FSPIOP-Source

The FSPIOP-Source header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field FSPIOP-Signature).

header string #/parameters/FSPIOP-Source
FSPIOP-Destination

The FSPIOP-Destination header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes.

header string #/parameters/FSPIOP-Destination
FSPIOP-Encryption

The FSPIOP-Encryption header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request.

header string #/parameters/FSPIOP-Encryption
FSPIOP-Signature

The FSPIOP-Signature header field is a non-HTTP standard field used by the API for applying an end-to-end request signature.

header string #/parameters/FSPIOP-Signature
FSPIOP-URI

The FSPIOP-URI header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information see API Signature document.

header string #/parameters/FSPIOP-URI
FSPIOP-HTTP-Method

The FSPIOP-HTTP-Method header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information see API Signature document.

header string #/parameters/FSPIOP-HTTP-Method

application/json

202 Accepted #/responses/Response202

Accepted

400 Bad Request #/responses/ErrorResponse400

Bad Request - The application cannot process the request; for example, due to malformed syntax or the payload exceeded size restrictions.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
401 Unauthorized #/responses/ErrorResponse401

Unauthorized - The request requires authentication in order to be processed.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
403 Forbidden #/responses/ErrorResponse403

Forbidden - The request was denied and will be denied in the future.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
404 Not Found #/responses/ErrorResponse404

Not Found - The resource specified in the URI was not found.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
405 Method Not Allowed #/responses/ErrorResponse405

Method Not Allowed - An unsupported HTTP method for the request was used.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
406 Not Acceptable #/responses/ErrorResponse406

Not acceptable - The server is not capable of generating content according to the Accept headers sent in the request. Used in the API to indicate that the server does not support the version that the client is requesting.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
501 Not Implemented #/responses/ErrorResponse501

Not Implemented - The server does not support the requested service. The client should not retry.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
503 Service Unavailable #/responses/ErrorResponse503

Service Unavailable - The server is currently unavailable to accept any new service requests. This should be a temporary state, and the client should retry within a reasonable time frame.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
BulkQuotesByID

PUT /bulkQuotes/{ID}

Tags: bulkQuotes

The callback PUT /bulkQuotes/ is used to inform the client of a requested or created bulk quote. The in the URI should contain the bulkQuoteId that was used for the creation of the bulk quote, or the that was used in the GET /bulkQuotes/.

Name Description Type Data Type Annotation
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body. Note - The API supports a maximum size of 5242880 bytes (5 Megabytes)

header integer #/parameters/Content-Length
ID path string #/parameters/ID
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

header string #/parameters/Content-Type
Date

The Date header field indicates the date when the request was sent.

header string #/parameters/Date
X-Forwarded-For

The X-Forwarded-For header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple X-Forwarded-For values as in the example shown here should be expected and supported by implementers of the API. Note - An alternative to X-Forwarded-For is defined in RFC 7239. However, to this point RFC 7239 is less-used and supported than X-Forwarded-For.

header string #/parameters/X-Forwarded-For
FSPIOP-Source

The FSPIOP-Source header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field FSPIOP-Signature).

header string #/parameters/FSPIOP-Source
FSPIOP-Destination

The FSPIOP-Destination header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes.

header string #/parameters/FSPIOP-Destination
FSPIOP-Encryption

The FSPIOP-Encryption header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request.

header string #/parameters/FSPIOP-Encryption
FSPIOP-Signature

The FSPIOP-Signature header field is a non-HTTP standard field used by the API for applying an end-to-end request signature.

header string #/parameters/FSPIOP-Signature
FSPIOP-URI

The FSPIOP-URI header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information see API Signature document.

header string #/parameters/FSPIOP-URI
FSPIOP-HTTP-Method

The FSPIOP-HTTP-Method header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information see API Signature document.

header string #/parameters/FSPIOP-HTTP-Method

application/json

200 OK #/responses/Response200

OK

400 Bad Request #/responses/ErrorResponse400

Bad Request - The application cannot process the request; for example, due to malformed syntax or the payload exceeded size restrictions.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
401 Unauthorized #/responses/ErrorResponse401

Unauthorized - The request requires authentication in order to be processed.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
403 Forbidden #/responses/ErrorResponse403

Forbidden - The request was denied and will be denied in the future.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
404 Not Found #/responses/ErrorResponse404

Not Found - The resource specified in the URI was not found.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
405 Method Not Allowed #/responses/ErrorResponse405

Method Not Allowed - An unsupported HTTP method for the request was used.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
406 Not Acceptable #/responses/ErrorResponse406

Not acceptable - The server is not capable of generating content according to the Accept headers sent in the request. Used in the API to indicate that the server does not support the version that the client is requesting.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
501 Not Implemented #/responses/ErrorResponse501

Not Implemented - The server does not support the requested service. The client should not retry.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
503 Service Unavailable #/responses/ErrorResponse503

Service Unavailable - The server is currently unavailable to accept any new service requests. This should be a temporary state, and the client should retry within a reasonable time frame.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
BulkQuotesErrorByID

PUT /bulkQuotes/{ID}/error

Tags: bulkQuotes

If the server is unable to find or create a bulk quote, or another processing error occurs, the error callback PUT /bulkQuotes//error is used. The in the URI should contain the bulkQuoteId that was used for the creation of the bulk quote, or the that was used in the GET /bulkQuotes/.

Name Description Type Data Type Annotation
ID path string #/parameters/ID
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body. Note - The API supports a maximum size of 5242880 bytes (5 Megabytes)

header integer #/parameters/Content-Length
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

header string #/parameters/Content-Type
Date

The Date header field indicates the date when the request was sent.

header string #/parameters/Date
X-Forwarded-For

The X-Forwarded-For header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple X-Forwarded-For values as in the example shown here should be expected and supported by implementers of the API. Note - An alternative to X-Forwarded-For is defined in RFC 7239. However, to this point RFC 7239 is less-used and supported than X-Forwarded-For.

header string #/parameters/X-Forwarded-For
FSPIOP-Source

The FSPIOP-Source header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field FSPIOP-Signature).

header string #/parameters/FSPIOP-Source
FSPIOP-Destination

The FSPIOP-Destination header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes.

header string #/parameters/FSPIOP-Destination
FSPIOP-Encryption

The FSPIOP-Encryption header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request.

header string #/parameters/FSPIOP-Encryption
FSPIOP-Signature

The FSPIOP-Signature header field is a non-HTTP standard field used by the API for applying an end-to-end request signature.

header string #/parameters/FSPIOP-Signature
FSPIOP-URI

The FSPIOP-URI header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information see API Signature document.

header string #/parameters/FSPIOP-URI
FSPIOP-HTTP-Method

The FSPIOP-HTTP-Method header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information see API Signature document.

header string #/parameters/FSPIOP-HTTP-Method

application/json

200 OK #/responses/Response200

OK

400 Bad Request #/responses/ErrorResponse400

Bad Request - The application cannot process the request; for example, due to malformed syntax or the payload exceeded size restrictions.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
401 Unauthorized #/responses/ErrorResponse401

Unauthorized - The request requires authentication in order to be processed.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
403 Forbidden #/responses/ErrorResponse403

Forbidden - The request was denied and will be denied in the future.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
404 Not Found #/responses/ErrorResponse404

Not Found - The resource specified in the URI was not found.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
405 Method Not Allowed #/responses/ErrorResponse405

Method Not Allowed - An unsupported HTTP method for the request was used.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
406 Not Acceptable #/responses/ErrorResponse406

Not acceptable - The server is not capable of generating content according to the Accept headers sent in the request. Used in the API to indicate that the server does not support the version that the client is requesting.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
501 Not Implemented #/responses/ErrorResponse501

Not Implemented - The server does not support the requested service. The client should not retry.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
503 Service Unavailable #/responses/ErrorResponse503

Service Unavailable - The server is currently unavailable to accept any new service requests. This should be a temporary state, and the client should retry within a reasonable time frame.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
BulkTransfers

POST /bulkTransfers

Tags: bulkTransfers

The HTTP request POST /bulkTransfers is used to request the creation of a bulk transfer in the server.

Name Description Type Data Type Annotation
Accept

The Accept header field indicates the version of the API the client would like the server to use.

header string #/parameters/Accept
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body. Note - The API supports a maximum size of 5242880 bytes (5 Megabytes)

header integer #/parameters/Content-Length
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

header string #/parameters/Content-Type
Date

The Date header field indicates the date when the request was sent.

header string #/parameters/Date
X-Forwarded-For

The X-Forwarded-For header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple X-Forwarded-For values as in the example shown here should be expected and supported by implementers of the API. Note - An alternative to X-Forwarded-For is defined in RFC 7239. However, to this point RFC 7239 is less-used and supported than X-Forwarded-For.

header string #/parameters/X-Forwarded-For
FSPIOP-Source

The FSPIOP-Source header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field FSPIOP-Signature).

header string #/parameters/FSPIOP-Source
FSPIOP-Destination

The FSPIOP-Destination header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes.

header string #/parameters/FSPIOP-Destination
FSPIOP-Encryption

The FSPIOP-Encryption header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request.

header string #/parameters/FSPIOP-Encryption
FSPIOP-Signature

The FSPIOP-Signature header field is a non-HTTP standard field used by the API for applying an end-to-end request signature.

header string #/parameters/FSPIOP-Signature
FSPIOP-URI

The FSPIOP-URI header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information see API Signature document.

header string #/parameters/FSPIOP-URI
FSPIOP-HTTP-Method

The FSPIOP-HTTP-Method header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information see API Signature document.

header string #/parameters/FSPIOP-HTTP-Method

application/json

202 Accepted #/responses/Response202

Accepted

400 Bad Request #/responses/ErrorResponse400

Bad Request - The application cannot process the request; for example, due to malformed syntax or the payload exceeded size restrictions.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
401 Unauthorized #/responses/ErrorResponse401

Unauthorized - The request requires authentication in order to be processed.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
403 Forbidden #/responses/ErrorResponse403

Forbidden - The request was denied and will be denied in the future.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
404 Not Found #/responses/ErrorResponse404

Not Found - The resource specified in the URI was not found.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
405 Method Not Allowed #/responses/ErrorResponse405

Method Not Allowed - An unsupported HTTP method for the request was used.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
406 Not Acceptable #/responses/ErrorResponse406

Not acceptable - The server is not capable of generating content according to the Accept headers sent in the request. Used in the API to indicate that the server does not support the version that the client is requesting.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
501 Not Implemented #/responses/ErrorResponse501

Not Implemented - The server does not support the requested service. The client should not retry.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
503 Service Unavailable #/responses/ErrorResponse503

Service Unavailable - The server is currently unavailable to accept any new service requests. This should be a temporary state, and the client should retry within a reasonable time frame.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
BulkTransferByID

GET /bulkTransfers/{ID}

Tags: bulkTransfers

The HTTP request GET /bulkTransfers/ is used to get information regarding an earlier created or requested bulk transfer. The in the URI should contain the bulkTransferId that was used for the creation of the bulk transfer.

Name Description Type Data Type Annotation
Accept

The Accept header field indicates the version of the API the client would like the server to use.

header string #/parameters/Accept
ID path string #/parameters/ID
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

header string #/parameters/Content-Type
Date

The Date header field indicates the date when the request was sent.

header string #/parameters/Date
X-Forwarded-For

The X-Forwarded-For header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple X-Forwarded-For values as in the example shown here should be expected and supported by implementers of the API. Note - An alternative to X-Forwarded-For is defined in RFC 7239. However, to this point RFC 7239 is less-used and supported than X-Forwarded-For.

header string #/parameters/X-Forwarded-For
FSPIOP-Source

The FSPIOP-Source header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field FSPIOP-Signature).

header string #/parameters/FSPIOP-Source
FSPIOP-Destination

The FSPIOP-Destination header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes.

header string #/parameters/FSPIOP-Destination
FSPIOP-Encryption

The FSPIOP-Encryption header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request.

header string #/parameters/FSPIOP-Encryption
FSPIOP-Signature

The FSPIOP-Signature header field is a non-HTTP standard field used by the API for applying an end-to-end request signature.

header string #/parameters/FSPIOP-Signature
FSPIOP-URI

The FSPIOP-URI header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information see API Signature document.

header string #/parameters/FSPIOP-URI
FSPIOP-HTTP-Method

The FSPIOP-HTTP-Method header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information see API Signature document.

header string #/parameters/FSPIOP-HTTP-Method

application/json

202 Accepted #/responses/Response202

Accepted

400 Bad Request #/responses/ErrorResponse400

Bad Request - The application cannot process the request; for example, due to malformed syntax or the payload exceeded size restrictions.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
401 Unauthorized #/responses/ErrorResponse401

Unauthorized - The request requires authentication in order to be processed.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
403 Forbidden #/responses/ErrorResponse403

Forbidden - The request was denied and will be denied in the future.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
404 Not Found #/responses/ErrorResponse404

Not Found - The resource specified in the URI was not found.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
405 Method Not Allowed #/responses/ErrorResponse405

Method Not Allowed - An unsupported HTTP method for the request was used.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
406 Not Acceptable #/responses/ErrorResponse406

Not acceptable - The server is not capable of generating content according to the Accept headers sent in the request. Used in the API to indicate that the server does not support the version that the client is requesting.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
501 Not Implemented #/responses/ErrorResponse501

Not Implemented - The server does not support the requested service. The client should not retry.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
503 Service Unavailable #/responses/ErrorResponse503

Service Unavailable - The server is currently unavailable to accept any new service requests. This should be a temporary state, and the client should retry within a reasonable time frame.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
BulkTransfersByIDPut

PUT /bulkTransfers/{ID}

Tags: bulkTransfers

The callback PUT /bulkTransfers/ is used to inform the client of a requested or created bulk transfer. The in the URI should contain the bulkTransferId that was used for the creation of the bulk transfer (POST /bulkTransfers), or the that was used in the GET /bulkTransfers/.

Name Description Type Data Type Annotation
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body. Note - The API supports a maximum size of 5242880 bytes (5 Megabytes)

header integer #/parameters/Content-Length
ID path string #/parameters/ID
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

header string #/parameters/Content-Type
Date

The Date header field indicates the date when the request was sent.

header string #/parameters/Date
X-Forwarded-For

The X-Forwarded-For header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple X-Forwarded-For values as in the example shown here should be expected and supported by implementers of the API. Note - An alternative to X-Forwarded-For is defined in RFC 7239. However, to this point RFC 7239 is less-used and supported than X-Forwarded-For.

header string #/parameters/X-Forwarded-For
FSPIOP-Source

The FSPIOP-Source header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field FSPIOP-Signature).

header string #/parameters/FSPIOP-Source
FSPIOP-Destination

The FSPIOP-Destination header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes.

header string #/parameters/FSPIOP-Destination
FSPIOP-Encryption

The FSPIOP-Encryption header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request.

header string #/parameters/FSPIOP-Encryption
FSPIOP-Signature

The FSPIOP-Signature header field is a non-HTTP standard field used by the API for applying an end-to-end request signature.

header string #/parameters/FSPIOP-Signature
FSPIOP-URI

The FSPIOP-URI header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information see API Signature document.

header string #/parameters/FSPIOP-URI
FSPIOP-HTTP-Method

The FSPIOP-HTTP-Method header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information see API Signature document.

header string #/parameters/FSPIOP-HTTP-Method

application/json

200 OK #/responses/Response200

OK

400 Bad Request #/responses/ErrorResponse400

Bad Request - The application cannot process the request; for example, due to malformed syntax or the payload exceeded size restrictions.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
401 Unauthorized #/responses/ErrorResponse401

Unauthorized - The request requires authentication in order to be processed.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
403 Forbidden #/responses/ErrorResponse403

Forbidden - The request was denied and will be denied in the future.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
404 Not Found #/responses/ErrorResponse404

Not Found - The resource specified in the URI was not found.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
405 Method Not Allowed #/responses/ErrorResponse405

Method Not Allowed - An unsupported HTTP method for the request was used.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
406 Not Acceptable #/responses/ErrorResponse406

Not acceptable - The server is not capable of generating content according to the Accept headers sent in the request. Used in the API to indicate that the server does not support the version that the client is requesting.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
501 Not Implemented #/responses/ErrorResponse501

Not Implemented - The server does not support the requested service. The client should not retry.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
503 Service Unavailable #/responses/ErrorResponse503

Service Unavailable - The server is currently unavailable to accept any new service requests. This should be a temporary state, and the client should retry within a reasonable time frame.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
BulkTransfersErrorByID

PUT /bulkTransfers/{ID}/error

Tags: bulkTransfers

If the server is unable to find or create a bulk transfer, or another processing error occurs, the error callback PUT /bulkTransfers//error is used. The in the URI should contain the bulkTransferId that was used for the creation of the bulk transfer (POST /bulkTransfers), or the that was used in the GET /bulkTransfers/.

Name Description Type Data Type Annotation
ID path string #/parameters/ID
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body. Note - The API supports a maximum size of 5242880 bytes (5 Megabytes)

header integer #/parameters/Content-Length
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

header string #/parameters/Content-Type
Date

The Date header field indicates the date when the request was sent.

header string #/parameters/Date
X-Forwarded-For

The X-Forwarded-For header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple X-Forwarded-For values as in the example shown here should be expected and supported by implementers of the API. Note - An alternative to X-Forwarded-For is defined in RFC 7239. However, to this point RFC 7239 is less-used and supported than X-Forwarded-For.

header string #/parameters/X-Forwarded-For
FSPIOP-Source

The FSPIOP-Source header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field FSPIOP-Signature).

header string #/parameters/FSPIOP-Source
FSPIOP-Destination

The FSPIOP-Destination header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes.

header string #/parameters/FSPIOP-Destination
FSPIOP-Encryption

The FSPIOP-Encryption header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request.

header string #/parameters/FSPIOP-Encryption
FSPIOP-Signature

The FSPIOP-Signature header field is a non-HTTP standard field used by the API for applying an end-to-end request signature.

header string #/parameters/FSPIOP-Signature
FSPIOP-URI

The FSPIOP-URI header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information see API Signature document.

header string #/parameters/FSPIOP-URI
FSPIOP-HTTP-Method

The FSPIOP-HTTP-Method header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information see API Signature document.

header string #/parameters/FSPIOP-HTTP-Method

application/json

200 OK #/responses/Response200

OK

400 Bad Request #/responses/ErrorResponse400

Bad Request - The application cannot process the request; for example, due to malformed syntax or the payload exceeded size restrictions.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
401 Unauthorized #/responses/ErrorResponse401

Unauthorized - The request requires authentication in order to be processed.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
403 Forbidden #/responses/ErrorResponse403

Forbidden - The request was denied and will be denied in the future.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
404 Not Found #/responses/ErrorResponse404

Not Found - The resource specified in the URI was not found.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
405 Method Not Allowed #/responses/ErrorResponse405

Method Not Allowed - An unsupported HTTP method for the request was used.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
406 Not Acceptable #/responses/ErrorResponse406

Not acceptable - The server is not capable of generating content according to the Accept headers sent in the request. Used in the API to indicate that the server does not support the version that the client is requesting.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
501 Not Implemented #/responses/ErrorResponse501

Not Implemented - The server does not support the requested service. The client should not retry.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
503 Service Unavailable #/responses/ErrorResponse503

Service Unavailable - The server is currently unavailable to accept any new service requests. This should be a temporary state, and the client should retry within a reasonable time frame.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
Participants

POST /participants

Tags: participants

The HTTP request POST /participants is used to create information in the server regarding the provided list of identities. This request should be used for bulk creation of FSP information for more than one Party. The optional currency parameter should indicate that each provided Party supports the currency

Name Description Type Data Type Annotation
Accept

The Accept header field indicates the version of the API the client would like the server to use.

header string #/parameters/Accept
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body. Note - The API supports a maximum size of 5242880 bytes (5 Megabytes)

header integer #/parameters/Content-Length
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

header string #/parameters/Content-Type
Date

The Date header field indicates the date when the request was sent.

header string #/parameters/Date
X-Forwarded-For

The X-Forwarded-For header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple X-Forwarded-For values as in the example shown here should be expected and supported by implementers of the API. Note - An alternative to X-Forwarded-For is defined in RFC 7239. However, to this point RFC 7239 is less-used and supported than X-Forwarded-For.

header string #/parameters/X-Forwarded-For
FSPIOP-Source

The FSPIOP-Source header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field FSPIOP-Signature).

header string #/parameters/FSPIOP-Source
FSPIOP-Destination

The FSPIOP-Destination header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes.

header string #/parameters/FSPIOP-Destination
FSPIOP-Encryption

The FSPIOP-Encryption header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request.

header string #/parameters/FSPIOP-Encryption
FSPIOP-Signature

The FSPIOP-Signature header field is a non-HTTP standard field used by the API for applying an end-to-end request signature.

header string #/parameters/FSPIOP-Signature
FSPIOP-URI

The FSPIOP-URI header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information see API Signature document.

header string #/parameters/FSPIOP-URI
FSPIOP-HTTP-Method

The FSPIOP-HTTP-Method header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information see API Signature document.

header string #/parameters/FSPIOP-HTTP-Method

application/json

202 Accepted #/responses/Response202

Accepted

400 Bad Request #/responses/ErrorResponse400

Bad Request - The application cannot process the request; for example, due to malformed syntax or the payload exceeded size restrictions.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
401 Unauthorized #/responses/ErrorResponse401

Unauthorized - The request requires authentication in order to be processed.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
403 Forbidden #/responses/ErrorResponse403

Forbidden - The request was denied and will be denied in the future.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
404 Not Found #/responses/ErrorResponse404

Not Found - The resource specified in the URI was not found.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
405 Method Not Allowed #/responses/ErrorResponse405

Method Not Allowed - An unsupported HTTP method for the request was used.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
406 Not Acceptable #/responses/ErrorResponse406

Not acceptable - The server is not capable of generating content according to the Accept headers sent in the request. Used in the API to indicate that the server does not support the version that the client is requesting.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
501 Not Implemented #/responses/ErrorResponse501

Not Implemented - The server does not support the requested service. The client should not retry.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
503 Service Unavailable #/responses/ErrorResponse503

Service Unavailable - The server is currently unavailable to accept any new service requests. This should be a temporary state, and the client should retry within a reasonable time frame.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
ParticipantsByID

PUT /participants/{ID}

Tags: participants

The callback PUT /participants/ is used to inform the client of the result of the creation of the provided list of identities.

Name Description Type Data Type Annotation
ID path string #/parameters/ID
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body. Note - The API supports a maximum size of 5242880 bytes (5 Megabytes)

header integer #/parameters/Content-Length
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

header string #/parameters/Content-Type
Date

The Date header field indicates the date when the request was sent.

header string #/parameters/Date
X-Forwarded-For

The X-Forwarded-For header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple X-Forwarded-For values as in the example shown here should be expected and supported by implementers of the API. Note - An alternative to X-Forwarded-For is defined in RFC 7239. However, to this point RFC 7239 is less-used and supported than X-Forwarded-For.

header string #/parameters/X-Forwarded-For
FSPIOP-Source

The FSPIOP-Source header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field FSPIOP-Signature).

header string #/parameters/FSPIOP-Source
FSPIOP-Destination

The FSPIOP-Destination header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes.

header string #/parameters/FSPIOP-Destination
FSPIOP-Encryption

The FSPIOP-Encryption header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request.

header string #/parameters/FSPIOP-Encryption
FSPIOP-Signature

The FSPIOP-Signature header field is a non-HTTP standard field used by the API for applying an end-to-end request signature.

header string #/parameters/FSPIOP-Signature
FSPIOP-URI

The FSPIOP-URI header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information see API Signature document.

header string #/parameters/FSPIOP-URI
FSPIOP-HTTP-Method

The FSPIOP-HTTP-Method header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information see API Signature document.

header string #/parameters/FSPIOP-HTTP-Method

application/json

200 OK #/responses/Response200

OK

400 Bad Request #/responses/ErrorResponse400

Bad Request - The application cannot process the request; for example, due to malformed syntax or the payload exceeded size restrictions.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
401 Unauthorized #/responses/ErrorResponse401

Unauthorized - The request requires authentication in order to be processed.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
403 Forbidden #/responses/ErrorResponse403

Forbidden - The request was denied and will be denied in the future.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
404 Not Found #/responses/ErrorResponse404

Not Found - The resource specified in the URI was not found.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
405 Method Not Allowed #/responses/ErrorResponse405

Method Not Allowed - An unsupported HTTP method for the request was used.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
406 Not Acceptable #/responses/ErrorResponse406

Not acceptable - The server is not capable of generating content according to the Accept headers sent in the request. Used in the API to indicate that the server does not support the version that the client is requesting.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
501 Not Implemented #/responses/ErrorResponse501

Not Implemented - The server does not support the requested service. The client should not retry.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
503 Service Unavailable #/responses/ErrorResponse503

Service Unavailable - The server is currently unavailable to accept any new service requests. This should be a temporary state, and the client should retry within a reasonable time frame.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
ParticipantsByIDAndError

PUT /participants/{ID}/error

Tags: participants

If there is an error during FSP information creation in the server, the error callback PUT /participants//error is used. The in the URI should contain the requestId that was used for the creation of the participant information.

Name Description Type Data Type Annotation
ID path string #/parameters/ID
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body. Note - The API supports a maximum size of 5242880 bytes (5 Megabytes)

header integer #/parameters/Content-Length
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

header string #/parameters/Content-Type
Date

The Date header field indicates the date when the request was sent.

header string #/parameters/Date
X-Forwarded-For

The X-Forwarded-For header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple X-Forwarded-For values as in the example shown here should be expected and supported by implementers of the API. Note - An alternative to X-Forwarded-For is defined in RFC 7239. However, to this point RFC 7239 is less-used and supported than X-Forwarded-For.

header string #/parameters/X-Forwarded-For
FSPIOP-Source

The FSPIOP-Source header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field FSPIOP-Signature).

header string #/parameters/FSPIOP-Source
FSPIOP-Destination

The FSPIOP-Destination header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes.

header string #/parameters/FSPIOP-Destination
FSPIOP-Encryption

The FSPIOP-Encryption header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request.

header string #/parameters/FSPIOP-Encryption
FSPIOP-Signature

The FSPIOP-Signature header field is a non-HTTP standard field used by the API for applying an end-to-end request signature.

header string #/parameters/FSPIOP-Signature
FSPIOP-URI

The FSPIOP-URI header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information see API Signature document.

header string #/parameters/FSPIOP-URI
FSPIOP-HTTP-Method

The FSPIOP-HTTP-Method header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information see API Signature document.

header string #/parameters/FSPIOP-HTTP-Method

application/json

200 OK #/responses/Response200

OK

400 Bad Request #/responses/ErrorResponse400

Bad Request - The application cannot process the request; for example, due to malformed syntax or the payload exceeded size restrictions.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
401 Unauthorized #/responses/ErrorResponse401

Unauthorized - The request requires authentication in order to be processed.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
403 Forbidden #/responses/ErrorResponse403

Forbidden - The request was denied and will be denied in the future.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
404 Not Found #/responses/ErrorResponse404

Not Found - The resource specified in the URI was not found.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
405 Method Not Allowed #/responses/ErrorResponse405

Method Not Allowed - An unsupported HTTP method for the request was used.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
406 Not Acceptable #/responses/ErrorResponse406

Not acceptable - The server is not capable of generating content according to the Accept headers sent in the request. Used in the API to indicate that the server does not support the version that the client is requesting.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
501 Not Implemented #/responses/ErrorResponse501

Not Implemented - The server does not support the requested service. The client should not retry.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
503 Service Unavailable #/responses/ErrorResponse503

Service Unavailable - The server is currently unavailable to accept any new service requests. This should be a temporary state, and the client should retry within a reasonable time frame.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
ParticipantsByTypeAndID

DELETE /participants/{Type}/{ID}

Tags: participants

The HTTP request DELETE /participants// (or DELETE /participants///) is used to delete information in the server regarding the provided identity, defined by and ) (for example, DELETE /participants/MSISDN/123456789), and optionally . This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request DELETE /participants//?currency=XYZ should be used, where XYZ is the requested currency. Note - The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.

Name Description Type Data Type Annotation
Accept

The Accept header field indicates the version of the API the client would like the server to use.

header string #/parameters/Accept
Type path string #/parameters/Type
ID path string #/parameters/ID
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

header string #/parameters/Content-Type
Date

The Date header field indicates the date when the request was sent.

header string #/parameters/Date
X-Forwarded-For

The X-Forwarded-For header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple X-Forwarded-For values as in the example shown here should be expected and supported by implementers of the API. Note - An alternative to X-Forwarded-For is defined in RFC 7239. However, to this point RFC 7239 is less-used and supported than X-Forwarded-For.

header string #/parameters/X-Forwarded-For
FSPIOP-Source

The FSPIOP-Source header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field FSPIOP-Signature).

header string #/parameters/FSPIOP-Source
FSPIOP-Destination

The FSPIOP-Destination header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes.

header string #/parameters/FSPIOP-Destination
FSPIOP-Encryption

The FSPIOP-Encryption header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request.

header string #/parameters/FSPIOP-Encryption
FSPIOP-Signature

The FSPIOP-Signature header field is a non-HTTP standard field used by the API for applying an end-to-end request signature.

header string #/parameters/FSPIOP-Signature
FSPIOP-URI

The FSPIOP-URI header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information see API Signature document.

header string #/parameters/FSPIOP-URI
FSPIOP-HTTP-Method

The FSPIOP-HTTP-Method header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information see API Signature document.

header string #/parameters/FSPIOP-HTTP-Method

application/json

202 Accepted #/responses/Response202

Accepted

400 Bad Request #/responses/ErrorResponse400

Bad Request - The application cannot process the request; for example, due to malformed syntax or the payload exceeded size restrictions.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
401 Unauthorized #/responses/ErrorResponse401

Unauthorized - The request requires authentication in order to be processed.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
403 Forbidden #/responses/ErrorResponse403

Forbidden - The request was denied and will be denied in the future.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
404 Not Found #/responses/ErrorResponse404

Not Found - The resource specified in the URI was not found.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
405 Method Not Allowed #/responses/ErrorResponse405

Method Not Allowed - An unsupported HTTP method for the request was used.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
406 Not Acceptable #/responses/ErrorResponse406

Not acceptable - The server is not capable of generating content according to the Accept headers sent in the request. Used in the API to indicate that the server does not support the version that the client is requesting.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
501 Not Implemented #/responses/ErrorResponse501

Not Implemented - The server does not support the requested service. The client should not retry.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
503 Service Unavailable #/responses/ErrorResponse503

Service Unavailable - The server is currently unavailable to accept any new service requests. This should be a temporary state, and the client should retry within a reasonable time frame.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
ParticipantsByTypeAndID

GET /participants/{Type}/{ID}

Tags: participants

The HTTP request GET /participants// (or GET /participants///) is used to find out in which FSP the requested Party, defined by , and optionally , is located (for example, GET /participants/MSISDN/123456789, or GET /participants/BUSINESS/shoecompany/employee1). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request GET /participants//?currency=XYZ should be used, where XYZ is the requested currency.

Name Description Type Data Type Annotation
Accept

The Accept header field indicates the version of the API the client would like the server to use.

header string #/parameters/Accept
Type path string #/parameters/Type
ID path string #/parameters/ID
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

header string #/parameters/Content-Type
Date

The Date header field indicates the date when the request was sent.

header string #/parameters/Date
X-Forwarded-For

The X-Forwarded-For header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple X-Forwarded-For values as in the example shown here should be expected and supported by implementers of the API. Note - An alternative to X-Forwarded-For is defined in RFC 7239. However, to this point RFC 7239 is less-used and supported than X-Forwarded-For.

header string #/parameters/X-Forwarded-For
FSPIOP-Source

The FSPIOP-Source header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field FSPIOP-Signature).

header string #/parameters/FSPIOP-Source
FSPIOP-Destination

The FSPIOP-Destination header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes.

header string #/parameters/FSPIOP-Destination
FSPIOP-Encryption

The FSPIOP-Encryption header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request.

header string #/parameters/FSPIOP-Encryption
FSPIOP-Signature

The FSPIOP-Signature header field is a non-HTTP standard field used by the API for applying an end-to-end request signature.

header string #/parameters/FSPIOP-Signature
FSPIOP-URI

The FSPIOP-URI header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information see API Signature document.

header string #/parameters/FSPIOP-URI
FSPIOP-HTTP-Method

The FSPIOP-HTTP-Method header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information see API Signature document.

header string #/parameters/FSPIOP-HTTP-Method

application/json

202 Accepted #/responses/Response202

Accepted

400 Bad Request #/responses/ErrorResponse400

Bad Request - The application cannot process the request; for example, due to malformed syntax or the payload exceeded size restrictions.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
401 Unauthorized #/responses/ErrorResponse401

Unauthorized - The request requires authentication in order to be processed.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
403 Forbidden #/responses/ErrorResponse403

Forbidden - The request was denied and will be denied in the future.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
404 Not Found #/responses/ErrorResponse404

Not Found - The resource specified in the URI was not found.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
405 Method Not Allowed #/responses/ErrorResponse405

Method Not Allowed - An unsupported HTTP method for the request was used.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
406 Not Acceptable #/responses/ErrorResponse406

Not acceptable - The server is not capable of generating content according to the Accept headers sent in the request. Used in the API to indicate that the server does not support the version that the client is requesting.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
501 Not Implemented #/responses/ErrorResponse501

Not Implemented - The server does not support the requested service. The client should not retry.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
503 Service Unavailable #/responses/ErrorResponse503

Service Unavailable - The server is currently unavailable to accept any new service requests. This should be a temporary state, and the client should retry within a reasonable time frame.

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

integer
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

string
ParticipantsByIDAndType

POST /participants/{Type}/{ID}

Tags: participants

The HTTP request POST /participants// (or POST /participants///) is used to create information in the server regarding the provided identity, defined by , , and optionally (for example, POST /participants/MSISDN/12345678