swift-outgoings
Operations addressed under /swift-outgoings — 3 operations.
get-swift-outgoing-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<SwiftOutgoingDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
MTId | Guid | no |
Reference | string | no |
MessageType | string | no |
MessageText | string | no |
Status | string | no |
TransactionDate | DateTime | no |
ValueDate | DateTime? | yes |
SendDate | DateTime? | yes |
Response | string | no |
UETR | string | no |
MessageContentHtml | string | no |
BusinessKey | string | no |
ParentReference | string | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-swift-outgoing-list › Responses
Success. An exact, uniquely bound route registration classifies this response as a collection.
create-swift-outgoing
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route returns AuraCommandDto<Guid>, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, Id, of type Guid. A caller gets a JSON OBJECT with one field, not a bare value. The field is id on the wire.
| Field | Name on the wire | Declared type | Nullable |
|---|---|---|---|
Id | id | Guid | no |
Member names are the service's declaration names.
create-swift-outgoing › Request Body
businessKeymTIdmessageContentHtmlmessageTextmessageTypeparentReferencereferenceresponsesendDatestatustransactionDateuETRvalueDatecreate-swift-outgoing › Responses
Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.
idIdentifier returned by the command.
get-swift-outgoing-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as SwiftOutgoingDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
MTId | Guid | no |
Reference | string | no |
MessageType | string | no |
MessageText | string | no |
Status | string | no |
TransactionDate | DateTime | no |
ValueDate | DateTime? | yes |
SendDate | DateTime? | yes |
Response | string | no |
UETR | string | no |
MessageContentHtml | string | no |
BusinessKey | string | no |
ParentReference | string | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_FRGN_TRD_11 | 400 | SWIFT_OUTGOING_NOT_FOUND |
path Parameters
idget-swift-outgoing-by-id › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.