swift-transfers
Operations addressed under /swift-transfers — 36 operations.
get-swift-transfer-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<SwiftTransferDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Direction | string | no |
Status | string | no |
UETR | string | no |
Reference | string | no |
TransactionType | string | no |
TransactionDate | DateTime | no |
ValueDate | DateTime | no |
CustomerId | Guid | no |
FromAccountId | Guid | no |
AccountNumber | string | no |
IBAN | string | no |
BranchCode | string | no |
BranchName | string | no |
IsDomestic | bool | no |
TransactionAuthorizationType | string | no |
RemittanceInformation | string | no |
PaymentSource | string | no |
Amount | decimal | no |
NetAmount | decimal | no |
Currency | string | no |
SendersChargesAmount | decimal? | yes |
SendersChargesCurrency | string | no |
BankChargeAmount | decimal? | yes |
BankChargeCurrency | string | no |
TransactionReasonType | int | no |
TransferSubject | string | no |
PaymentPurposeCategory | int? | yes |
PaymentCategoryDetail | int? | yes |
PaymentDescription | string | no |
StatisticalCode | string | no |
InvoiceNumber | string | no |
InvoiceDate | DateTime? | yes |
BeneficiaryAccountNumber | string | no |
BeneficiaryName1 | string | no |
BeneficiaryAddress | string | no |
BeneficiaryNameCountryCode | string | no |
BeneficiaryAddressType | string | no |
BeneficiaryCareOf | string | no |
BeneficiaryDepartment | string | no |
BeneficiarySubDepartment | string | no |
BeneficiaryStreetName | string | no |
BeneficiaryBuildingNumber | string | no |
BeneficiaryBuildingName | string | no |
BeneficiaryFloor | string | no |
BeneficiaryUnitNumber | string | no |
BeneficiaryPostBox | string | no |
BeneficiaryRoom | string | no |
BeneficiaryPostCode | string | no |
BeneficiaryTownName | string | no |
BeneficiaryTownLocationName | string | no |
BeneficiaryDistrictName | string | no |
BeneficiaryCountrySubdivision | string | no |
BeneficiaryBankBICCode | string | no |
SendersCorrespondentBICCode | string | no |
ReceiversCorrespondentBICCode | string | no |
IntermediaryAgent1BICCode | string | no |
IntermediaryAgent2BICCode | string | no |
IntermediaryAgent3BICCode | string | no |
ThirdReimbursementAgentBICCode | string | no |
InstructionForNextAgent | string | no |
ChargeDetail | string | no |
MTMessagesToCreate | MTMessagesToCreateType | no |
MessageTypeScenario | int? | yes |
ProvisionNumber | int? | yes |
CorrespondentBankAccountId | int | no |
CorrespondentCustomerId | int | no |
ImportTransferAction | ImportTransferAction | no |
IsManuel | bool | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-swift-transfer-list › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
get-swift-transfer-list-by-filter
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<SwiftTransferDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Direction | string | no |
Status | string | no |
UETR | string | no |
Reference | string | no |
TransactionType | string | no |
TransactionDate | DateTime | no |
ValueDate | DateTime | no |
CustomerId | Guid | no |
FromAccountId | Guid | no |
AccountNumber | string | no |
IBAN | string | no |
BranchCode | string | no |
BranchName | string | no |
IsDomestic | bool | no |
TransactionAuthorizationType | string | no |
RemittanceInformation | string | no |
PaymentSource | string | no |
Amount | decimal | no |
NetAmount | decimal | no |
Currency | string | no |
SendersChargesAmount | decimal? | yes |
SendersChargesCurrency | string | no |
BankChargeAmount | decimal? | yes |
BankChargeCurrency | string | no |
TransactionReasonType | int | no |
TransferSubject | string | no |
PaymentPurposeCategory | int? | yes |
PaymentCategoryDetail | int? | yes |
PaymentDescription | string | no |
StatisticalCode | string | no |
InvoiceNumber | string | no |
InvoiceDate | DateTime? | yes |
BeneficiaryAccountNumber | string | no |
BeneficiaryName1 | string | no |
BeneficiaryAddress | string | no |
BeneficiaryNameCountryCode | string | no |
BeneficiaryAddressType | string | no |
BeneficiaryCareOf | string | no |
BeneficiaryDepartment | string | no |
BeneficiarySubDepartment | string | no |
BeneficiaryStreetName | string | no |
BeneficiaryBuildingNumber | string | no |
BeneficiaryBuildingName | string | no |
BeneficiaryFloor | string | no |
BeneficiaryUnitNumber | string | no |
BeneficiaryPostBox | string | no |
BeneficiaryRoom | string | no |
BeneficiaryPostCode | string | no |
BeneficiaryTownName | string | no |
BeneficiaryTownLocationName | string | no |
BeneficiaryDistrictName | string | no |
BeneficiaryCountrySubdivision | string | no |
BeneficiaryBankBICCode | string | no |
SendersCorrespondentBICCode | string | no |
ReceiversCorrespondentBICCode | string | no |
IntermediaryAgent1BICCode | string | no |
IntermediaryAgent2BICCode | string | no |
IntermediaryAgent3BICCode | string | no |
ThirdReimbursementAgentBICCode | string | no |
InstructionForNextAgent | string | no |
ChargeDetail | string | no |
MTMessagesToCreate | MTMessagesToCreateType | no |
MessageTypeScenario | int? | yes |
ProvisionNumber | int? | yes |
CorrespondentBankAccountId | int | no |
CorrespondentCustomerId | int | no |
ImportTransferAction | ImportTransferAction | no |
IsManuel | bool | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-swift-transfer-list-by-filter › Responses
Success. An exact, uniquely bound route registration classifies this response as a collection.
incoming-asking-branch-info-swift-transfer
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_FRGN_TRD_16 | 400 | SWIFT_TRANSFER_NOT_FOUND |
ERR_FRGN_TRD_17 | 400 | INVALID_SWIFT_TRANSFER_STATE |
incoming-asking-branch-info-swift-transfer › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
incoming-asking-receivable-swift-transfer
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_FRGN_TRD_16 | 400 | SWIFT_TRANSFER_NOT_FOUND |
ERR_FRGN_TRD_17 | 400 | INVALID_SWIFT_TRANSFER_STATE |
incoming-asking-receivable-swift-transfer › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
incoming-cancel-swift-transfer
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_FRGN_TRD_16 | 400 | SWIFT_TRANSFER_NOT_FOUND |
ERR_FRGN_TRD_17 | 400 | INVALID_SWIFT_TRANSFER_STATE |
incoming-cancel-swift-transfer › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
incoming-create-swift-transfer
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 SwiftTransferDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Direction | string | no |
Status | string | no |
UETR | string | no |
Reference | string | no |
TransactionType | string | no |
TransactionDate | DateTime | no |
ValueDate | DateTime | no |
CustomerId | Guid | no |
FromAccountId | Guid | no |
AccountNumber | string | no |
IBAN | string | no |
BranchCode | string | no |
BranchName | string | no |
IsDomestic | bool | no |
TransactionAuthorizationType | string | no |
RemittanceInformation | string | no |
PaymentSource | string | no |
Amount | decimal | no |
NetAmount | decimal | no |
Currency | string | no |
SendersChargesAmount | decimal? | yes |
SendersChargesCurrency | string | no |
BankChargeAmount | decimal? | yes |
BankChargeCurrency | string | no |
TransactionReasonType | int | no |
TransferSubject | string | no |
PaymentPurposeCategory | int? | yes |
PaymentCategoryDetail | int? | yes |
PaymentDescription | string | no |
StatisticalCode | string | no |
InvoiceNumber | string | no |
InvoiceDate | DateTime? | yes |
BeneficiaryAccountNumber | string | no |
BeneficiaryName1 | string | no |
BeneficiaryAddress | string | no |
BeneficiaryNameCountryCode | string | no |
BeneficiaryAddressType | string | no |
BeneficiaryCareOf | string | no |
BeneficiaryDepartment | string | no |
BeneficiarySubDepartment | string | no |
BeneficiaryStreetName | string | no |
BeneficiaryBuildingNumber | string | no |
BeneficiaryBuildingName | string | no |
BeneficiaryFloor | string | no |
BeneficiaryUnitNumber | string | no |
BeneficiaryPostBox | string | no |
BeneficiaryRoom | string | no |
BeneficiaryPostCode | string | no |
BeneficiaryTownName | string | no |
BeneficiaryTownLocationName | string | no |
BeneficiaryDistrictName | string | no |
BeneficiaryCountrySubdivision | string | no |
BeneficiaryBankBICCode | string | no |
SendersCorrespondentBICCode | string | no |
ReceiversCorrespondentBICCode | string | no |
IntermediaryAgent1BICCode | string | no |
IntermediaryAgent2BICCode | string | no |
IntermediaryAgent3BICCode | string | no |
ThirdReimbursementAgentBICCode | string | no |
InstructionForNextAgent | string | no |
ChargeDetail | string | no |
MTMessagesToCreate | MTMessagesToCreateType | no |
MessageTypeScenario | int? | yes |
ProvisionNumber | int? | yes |
CorrespondentBankAccountId | int | no |
CorrespondentCustomerId | int | no |
ImportTransferAction | ImportTransferAction | no |
IsManuel | bool | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_FRGN_TRD_16 | 400 | SWIFT_TRANSFER_NOT_FOUND |
incoming-create-swift-transfer › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
incoming-decline-swift-transfer
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_FRGN_TRD_16 | 400 | SWIFT_TRANSFER_NOT_FOUND |
ERR_FRGN_TRD_17 | 400 | INVALID_SWIFT_TRANSFER_STATE |
incoming-decline-swift-transfer › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
incoming-feedback-swift-transfer
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_FRGN_TRD_16 | 400 | SWIFT_TRANSFER_NOT_FOUND |
ERR_FRGN_TRD_17 | 400 | INVALID_SWIFT_TRANSFER_STATE |
incoming-feedback-swift-transfer › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
incoming-init-swift-transfer
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_FRGN_TRD_18 | 400 | NOT_CORRESPONDENT |
incoming-init-swift-transfer › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
incoming-received-create-swift-transfer
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.
incoming-received-create-swift-transfer › 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.
incoming-return-swift-transfer
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_FRGN_TRD_16 | 400 | SWIFT_TRANSFER_NOT_FOUND |
ERR_FRGN_TRD_17 | 400 | INVALID_SWIFT_TRANSFER_STATE |
incoming-return-swift-transfer › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
incoming-return-to-source-swift-transfer
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_FRGN_TRD_16 | 400 | SWIFT_TRANSFER_NOT_FOUND |
ERR_FRGN_TRD_17 | 400 | INVALID_SWIFT_TRANSFER_STATE |
incoming-return-to-source-swift-transfer › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
incoming-set-processing-swift-transfer
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_FRGN_TRD_16 | 400 | SWIFT_TRANSFER_NOT_FOUND |
ERR_FRGN_TRD_17 | 400 | INVALID_SWIFT_TRANSFER_STATE |
incoming-set-processing-swift-transfer › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
incoming-set-waiting-swift-transfer
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_FRGN_TRD_16 | 400 | SWIFT_TRANSFER_NOT_FOUND |
incoming-set-waiting-swift-transfer › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
swift-transfer-manuel
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_FRGN_TRD_10 | 400 | ALREADY_PROCESSED |
swift-transfer-manuel › Request Body optional
accountNumberaccountingBusinessKeyactiveWorkgroupIdaddToSwiftMessageamountbankChargeAmountbeneficiary59TagbeneficiaryAccountNumberbeneficiaryBankBICCodebeneficiaryBankBICNamebeneficiaryBankLocationbeneficiaryBankNameAndAddress1beneficiaryBankNameAndAddress2beneficiaryBankNameAndAddress3beneficiaryBankNameAndAddress4beneficiaryBankPartyIdentifierbeneficiaryBankTagTypebeneficiaryFullNamebeneficiaryIntermediaryBankBICCodebeneficiaryIntermediaryBankBICNamebeneficiaryIntermediaryBankNameAndAddress1beneficiaryIntermediaryBankNameAndAddress2beneficiaryIntermediaryBankNameAndAddress3beneficiaryIntermediaryBankNameAndAddress4beneficiaryIntermediaryBankPartyIdentifierbeneficiaryIntermediaryNameCountryCodebeneficiaryIntermediaryTagTypebeneficiaryName1beneficiaryName2beneficiaryName3beneficiaryName4beneficiaryNameBICbeneficiaryNameCountryCodebeneficiaryNameCountryNamebranchCommentTypebusinessKeycancellationNarrativechargeDetailconsensuscorrespondentBankAccountIdcorrespondentBankBICCodecorrespondentBankIBANcorrespondentCustomerIdcorrespondentExpenseReferencecreatedActiveWorkgroupIdcurrencycustomerIddetailsofAmountsAddeddetailsofChargesdirectionexpenseReferencefeedbackNotegroupGuididimportTransferActionincomingSwiftSourceinstructedAmountinstructedCurrencyinstructedValueDateintermediaryBankBICCodeintermediaryBankBICNameintermediaryBankNameAndAddress1intermediaryBankNameAndAddress2intermediaryBankNameAndAddress3intermediaryBankNameAndAddress4intermediaryBankPartyIdentifierintermediaryNameCountryCodeintermediaryTagTypeisCheckisDomesticisGLAccountingisImportDocumentmTMessagesToCreatemessageContentHtmlmessageContentPairHtmlmessageContentPairTxtmessageContentTxtmessageTypeScenariomtIdnarrativenarrativeForFEnetAmountoldStatusorderingBankBICCodeorderingBankBICNameorderingBankCountryCodepairReferencepaymentDescriptionplatformErrorMessageplatformReferenceplatformStatusplatformStatusDescriptionprovisionNumberqueriesreceiverBankBICCodereceiverBankBICNamereceiversCorrespondentBICCodereceiversCorrespondentBICNamereferencerelatedDocumentReferencerelatedDocumentTermIndexrelatedReferenceremittanceInformationreturnToSourceNotesenderAccountsenderAddresssenderBankBICCodesenderBankBICNamesenderCitysenderCountrysenderFullNameAndAddresssenderNamesenderPostCodesenderReferencesenderToReceiverInfoCodesenderToReceiverInformationsendersCharges71TagsendersChargesAmountsendersChargesCurrencysendersCorrespondentBICCodesendersCorrespondentBICNamestatisticalCodestatusswiftIncomingIdswiftMessageTypetransactionAuthorizationIdtransactionAuthorizationTypetransactionDatetransactionReasonTypetransactionTypetransferSubjectuETRusdAmountvalueDateswift-transfer-manuel › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
outgoing-cancel-swift-transfer
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_FRGN_TRD_16 | 400 | SWIFT_TRANSFER_NOT_FOUND |
ERR_FRGN_TRD_17 | 400 | INVALID_SWIFT_TRANSFER_STATE |
outgoing-cancel-swift-transfer › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
outgoing-create-swift-transfer
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_FRGN_TRD_16 | 400 | SWIFT_TRANSFER_NOT_FOUND |
ERR_FRGN_TRD_17 | 400 | INVALID_SWIFT_TRANSFER_STATE |
outgoing-create-swift-transfer › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
outgoing-create-swift-transfer-for-import-document
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.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_FRGN_TRD_16 | 400 | SWIFT_TRANSFER_NOT_FOUND |
outgoing-create-swift-transfer-for-import-document › 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.
outgoing-create-swift-transfer-for-import-letter-credit
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.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_FRGN_TRD_16 | 400 | SWIFT_TRANSFER_NOT_FOUND |
outgoing-create-swift-transfer-for-import-letter-credit › 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.
outgoing-decline-swift-transfer
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_FRGN_TRD_16 | 400 | SWIFT_TRANSFER_NOT_FOUND |
ERR_FRGN_TRD_17 | 400 | INVALID_SWIFT_TRANSFER_STATE |
outgoing-decline-swift-transfer › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
outgoing-edit-swift-transfer
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_FRGN_TRD_16 | 400 | SWIFT_TRANSFER_NOT_FOUND |
ERR_FRGN_TRD_17 | 400 | INVALID_SWIFT_TRANSFER_STATE |
outgoing-edit-swift-transfer › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
outgoing-feedback-swift-transfer
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_FRGN_TRD_16 | 400 | SWIFT_TRANSFER_NOT_FOUND |
ERR_FRGN_TRD_17 | 400 | INVALID_SWIFT_TRANSFER_STATE |
outgoing-feedback-swift-transfer › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
outgoing-init-swift-transfer
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 SwiftTransferDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Direction | string | no |
Status | string | no |
UETR | string | no |
Reference | string | no |
TransactionType | string | no |
TransactionDate | DateTime | no |
ValueDate | DateTime | no |
CustomerId | Guid | no |
FromAccountId | Guid | no |
AccountNumber | string | no |
IBAN | string | no |
BranchCode | string | no |
BranchName | string | no |
IsDomestic | bool | no |
TransactionAuthorizationType | string | no |
RemittanceInformation | string | no |
PaymentSource | string | no |
Amount | decimal | no |
NetAmount | decimal | no |
Currency | string | no |
SendersChargesAmount | decimal? | yes |
SendersChargesCurrency | string | no |
BankChargeAmount | decimal? | yes |
BankChargeCurrency | string | no |
TransactionReasonType | int | no |
TransferSubject | string | no |
PaymentPurposeCategory | int? | yes |
PaymentCategoryDetail | int? | yes |
PaymentDescription | string | no |
StatisticalCode | string | no |
InvoiceNumber | string | no |
InvoiceDate | DateTime? | yes |
BeneficiaryAccountNumber | string | no |
BeneficiaryName1 | string | no |
BeneficiaryAddress | string | no |
BeneficiaryNameCountryCode | string | no |
BeneficiaryAddressType | string | no |
BeneficiaryCareOf | string | no |
BeneficiaryDepartment | string | no |
BeneficiarySubDepartment | string | no |
BeneficiaryStreetName | string | no |
BeneficiaryBuildingNumber | string | no |
BeneficiaryBuildingName | string | no |
BeneficiaryFloor | string | no |
BeneficiaryUnitNumber | string | no |
BeneficiaryPostBox | string | no |
BeneficiaryRoom | string | no |
BeneficiaryPostCode | string | no |
BeneficiaryTownName | string | no |
BeneficiaryTownLocationName | string | no |
BeneficiaryDistrictName | string | no |
BeneficiaryCountrySubdivision | string | no |
BeneficiaryBankBICCode | string | no |
SendersCorrespondentBICCode | string | no |
ReceiversCorrespondentBICCode | string | no |
IntermediaryAgent1BICCode | string | no |
IntermediaryAgent2BICCode | string | no |
IntermediaryAgent3BICCode | string | no |
ThirdReimbursementAgentBICCode | string | no |
InstructionForNextAgent | string | no |
ChargeDetail | string | no |
MTMessagesToCreate | MTMessagesToCreateType | no |
MessageTypeScenario | int? | yes |
ProvisionNumber | int? | yes |
CorrespondentBankAccountId | int | no |
CorrespondentCustomerId | int | no |
ImportTransferAction | ImportTransferAction | no |
IsManuel | bool | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_FRGN_TRD_19 | 400 | INVALID_REFERENCE_NUMBER |
ERR_FRGN_TRD_24 | 400 | INSUFFICIENT_BALANCE |
outgoing-init-swift-transfer › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
outgoing-payback-swift-transfer
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_FRGN_TRD_16 | 400 | SWIFT_TRANSFER_NOT_FOUND |
ERR_FRGN_TRD_17 | 400 | INVALID_SWIFT_TRANSFER_STATE |
outgoing-payback-swift-transfer › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
outgoing-save-swift-transfer
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.
outgoing-save-swift-transfer › 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.
outgoing-send-swift-transfer
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_FRGN_TRD_16 | 400 | SWIFT_TRANSFER_NOT_FOUND |
ERR_FRGN_TRD_17 | 400 | INVALID_SWIFT_TRANSFER_STATE |
ERR_FRGN_TRD_35 | 400 | NO_MESSAGE_TO_SEND |
outgoing-send-swift-transfer › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
outgoing-set-completed-swift-transfer
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_FRGN_TRD_16 | 400 | SWIFT_TRANSFER_NOT_FOUND |
outgoing-set-completed-swift-transfer › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
outgoing-set-error-swift-transfer
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_FRGN_TRD_16 | 400 | SWIFT_TRANSFER_NOT_FOUND |
outgoing-set-error-swift-transfer › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
outgoing-set-swift-transfer-messages
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 ApiResponse<SwiftTransferDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Direction | string | no |
Status | string | no |
UETR | string | no |
Reference | string | no |
TransactionType | string | no |
TransactionDate | DateTime | no |
ValueDate | DateTime | no |
CustomerId | Guid | no |
FromAccountId | Guid | no |
AccountNumber | string | no |
IBAN | string | no |
BranchCode | string | no |
BranchName | string | no |
IsDomestic | bool | no |
TransactionAuthorizationType | string | no |
RemittanceInformation | string | no |
PaymentSource | string | no |
Amount | decimal | no |
NetAmount | decimal | no |
Currency | string | no |
SendersChargesAmount | decimal? | yes |
SendersChargesCurrency | string | no |
BankChargeAmount | decimal? | yes |
BankChargeCurrency | string | no |
TransactionReasonType | int | no |
TransferSubject | string | no |
PaymentPurposeCategory | int? | yes |
PaymentCategoryDetail | int? | yes |
PaymentDescription | string | no |
StatisticalCode | string | no |
InvoiceNumber | string | no |
InvoiceDate | DateTime? | yes |
BeneficiaryAccountNumber | string | no |
BeneficiaryName1 | string | no |
BeneficiaryAddress | string | no |
BeneficiaryNameCountryCode | string | no |
BeneficiaryAddressType | string | no |
BeneficiaryCareOf | string | no |
BeneficiaryDepartment | string | no |
BeneficiarySubDepartment | string | no |
BeneficiaryStreetName | string | no |
BeneficiaryBuildingNumber | string | no |
BeneficiaryBuildingName | string | no |
BeneficiaryFloor | string | no |
BeneficiaryUnitNumber | string | no |
BeneficiaryPostBox | string | no |
BeneficiaryRoom | string | no |
BeneficiaryPostCode | string | no |
BeneficiaryTownName | string | no |
BeneficiaryTownLocationName | string | no |
BeneficiaryDistrictName | string | no |
BeneficiaryCountrySubdivision | string | no |
BeneficiaryBankBICCode | string | no |
SendersCorrespondentBICCode | string | no |
ReceiversCorrespondentBICCode | string | no |
IntermediaryAgent1BICCode | string | no |
IntermediaryAgent2BICCode | string | no |
IntermediaryAgent3BICCode | string | no |
ThirdReimbursementAgentBICCode | string | no |
InstructionForNextAgent | string | no |
ChargeDetail | string | no |
MTMessagesToCreate | MTMessagesToCreateType | no |
MessageTypeScenario | int? | yes |
ProvisionNumber | int? | yes |
CorrespondentBankAccountId | int | no |
CorrespondentCustomerId | int | no |
ImportTransferAction | ImportTransferAction | no |
IsManuel | bool | no |
Member names are the service's declaration names.
outgoing-set-swift-transfer-messages › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
outgoing-set-processing-swift-transfer
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_FRGN_TRD_16 | 400 | SWIFT_TRANSFER_NOT_FOUND |
outgoing-set-processing-swift-transfer › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
outgoing-validate-swift-transfer
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 SwiftTransferDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Direction | string | no |
Status | string | no |
UETR | string | no |
Reference | string | no |
TransactionType | string | no |
TransactionDate | DateTime | no |
ValueDate | DateTime | no |
CustomerId | Guid | no |
FromAccountId | Guid | no |
AccountNumber | string | no |
IBAN | string | no |
BranchCode | string | no |
BranchName | string | no |
IsDomestic | bool | no |
TransactionAuthorizationType | string | no |
RemittanceInformation | string | no |
PaymentSource | string | no |
Amount | decimal | no |
NetAmount | decimal | no |
Currency | string | no |
SendersChargesAmount | decimal? | yes |
SendersChargesCurrency | string | no |
BankChargeAmount | decimal? | yes |
BankChargeCurrency | string | no |
TransactionReasonType | int | no |
TransferSubject | string | no |
PaymentPurposeCategory | int? | yes |
PaymentCategoryDetail | int? | yes |
PaymentDescription | string | no |
StatisticalCode | string | no |
InvoiceNumber | string | no |
InvoiceDate | DateTime? | yes |
BeneficiaryAccountNumber | string | no |
BeneficiaryName1 | string | no |
BeneficiaryAddress | string | no |
BeneficiaryNameCountryCode | string | no |
BeneficiaryAddressType | string | no |
BeneficiaryCareOf | string | no |
BeneficiaryDepartment | string | no |
BeneficiarySubDepartment | string | no |
BeneficiaryStreetName | string | no |
BeneficiaryBuildingNumber | string | no |
BeneficiaryBuildingName | string | no |
BeneficiaryFloor | string | no |
BeneficiaryUnitNumber | string | no |
BeneficiaryPostBox | string | no |
BeneficiaryRoom | string | no |
BeneficiaryPostCode | string | no |
BeneficiaryTownName | string | no |
BeneficiaryTownLocationName | string | no |
BeneficiaryDistrictName | string | no |
BeneficiaryCountrySubdivision | string | no |
BeneficiaryBankBICCode | string | no |
SendersCorrespondentBICCode | string | no |
ReceiversCorrespondentBICCode | string | no |
IntermediaryAgent1BICCode | string | no |
IntermediaryAgent2BICCode | string | no |
IntermediaryAgent3BICCode | string | no |
ThirdReimbursementAgentBICCode | string | no |
InstructionForNextAgent | string | no |
ChargeDetail | string | no |
MTMessagesToCreate | MTMessagesToCreateType | no |
MessageTypeScenario | int? | yes |
ProvisionNumber | int? | yes |
CorrespondentBankAccountId | int | no |
CorrespondentCustomerId | int | no |
ImportTransferAction | ImportTransferAction | no |
IsManuel | bool | no |
Member names are the service's declaration names.
outgoing-validate-swift-transfer › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
process-swift-transfer
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 SwiftTransferDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Direction | string | no |
Status | string | no |
UETR | string | no |
Reference | string | no |
TransactionType | string | no |
TransactionDate | DateTime | no |
ValueDate | DateTime | no |
CustomerId | Guid | no |
FromAccountId | Guid | no |
AccountNumber | string | no |
IBAN | string | no |
BranchCode | string | no |
BranchName | string | no |
IsDomestic | bool | no |
TransactionAuthorizationType | string | no |
RemittanceInformation | string | no |
PaymentSource | string | no |
Amount | decimal | no |
NetAmount | decimal | no |
Currency | string | no |
SendersChargesAmount | decimal? | yes |
SendersChargesCurrency | string | no |
BankChargeAmount | decimal? | yes |
BankChargeCurrency | string | no |
TransactionReasonType | int | no |
TransferSubject | string | no |
PaymentPurposeCategory | int? | yes |
PaymentCategoryDetail | int? | yes |
PaymentDescription | string | no |
StatisticalCode | string | no |
InvoiceNumber | string | no |
InvoiceDate | DateTime? | yes |
BeneficiaryAccountNumber | string | no |
BeneficiaryName1 | string | no |
BeneficiaryAddress | string | no |
BeneficiaryNameCountryCode | string | no |
BeneficiaryAddressType | string | no |
BeneficiaryCareOf | string | no |
BeneficiaryDepartment | string | no |
BeneficiarySubDepartment | string | no |
BeneficiaryStreetName | string | no |
BeneficiaryBuildingNumber | string | no |
BeneficiaryBuildingName | string | no |
BeneficiaryFloor | string | no |
BeneficiaryUnitNumber | string | no |
BeneficiaryPostBox | string | no |
BeneficiaryRoom | string | no |
BeneficiaryPostCode | string | no |
BeneficiaryTownName | string | no |
BeneficiaryTownLocationName | string | no |
BeneficiaryDistrictName | string | no |
BeneficiaryCountrySubdivision | string | no |
BeneficiaryBankBICCode | string | no |
SendersCorrespondentBICCode | string | no |
ReceiversCorrespondentBICCode | string | no |
IntermediaryAgent1BICCode | string | no |
IntermediaryAgent2BICCode | string | no |
IntermediaryAgent3BICCode | string | no |
ThirdReimbursementAgentBICCode | string | no |
InstructionForNextAgent | string | no |
ChargeDetail | string | no |
MTMessagesToCreate | MTMessagesToCreateType | no |
MessageTypeScenario | int? | yes |
ProvisionNumber | int? | yes |
CorrespondentBankAccountId | int | no |
CorrespondentCustomerId | int | no |
ImportTransferAction | ImportTransferAction | no |
IsManuel | bool | no |
Member names are the service's declaration names.
process-swift-transfer › Request Body
fiTransferIdidincomingDatemTIdmessageTextmessageTypereferencestatusprocess-swift-transfer › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
swift-transfer-set-header-bICCode
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 string, a scalar rather than an object. There is no field tree below because there are no fields: the body is a JSON string. This is a complete answer read from the declaration, not a gap.
swift-transfer-set-header-bICCode › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
get-swift-transfer-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 SwiftTransferDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Direction | string | no |
Status | string | no |
UETR | string | no |
Reference | string | no |
TransactionType | string | no |
TransactionDate | DateTime | no |
ValueDate | DateTime | no |
CustomerId | Guid | no |
FromAccountId | Guid | no |
AccountNumber | string | no |
IBAN | string | no |
BranchCode | string | no |
BranchName | string | no |
IsDomestic | bool | no |
TransactionAuthorizationType | string | no |
RemittanceInformation | string | no |
PaymentSource | string | no |
Amount | decimal | no |
NetAmount | decimal | no |
Currency | string | no |
SendersChargesAmount | decimal? | yes |
SendersChargesCurrency | string | no |
BankChargeAmount | decimal? | yes |
BankChargeCurrency | string | no |
TransactionReasonType | int | no |
TransferSubject | string | no |
PaymentPurposeCategory | int? | yes |
PaymentCategoryDetail | int? | yes |
PaymentDescription | string | no |
StatisticalCode | string | no |
InvoiceNumber | string | no |
InvoiceDate | DateTime? | yes |
BeneficiaryAccountNumber | string | no |
BeneficiaryName1 | string | no |
BeneficiaryAddress | string | no |
BeneficiaryNameCountryCode | string | no |
BeneficiaryAddressType | string | no |
BeneficiaryCareOf | string | no |
BeneficiaryDepartment | string | no |
BeneficiarySubDepartment | string | no |
BeneficiaryStreetName | string | no |
BeneficiaryBuildingNumber | string | no |
BeneficiaryBuildingName | string | no |
BeneficiaryFloor | string | no |
BeneficiaryUnitNumber | string | no |
BeneficiaryPostBox | string | no |
BeneficiaryRoom | string | no |
BeneficiaryPostCode | string | no |
BeneficiaryTownName | string | no |
BeneficiaryTownLocationName | string | no |
BeneficiaryDistrictName | string | no |
BeneficiaryCountrySubdivision | string | no |
BeneficiaryBankBICCode | string | no |
SendersCorrespondentBICCode | string | no |
ReceiversCorrespondentBICCode | string | no |
IntermediaryAgent1BICCode | string | no |
IntermediaryAgent2BICCode | string | no |
IntermediaryAgent3BICCode | string | no |
ThirdReimbursementAgentBICCode | string | no |
InstructionForNextAgent | string | no |
ChargeDetail | string | no |
MTMessagesToCreate | MTMessagesToCreateType | no |
MessageTypeScenario | int? | yes |
ProvisionNumber | int? | yes |
CorrespondentBankAccountId | int | no |
CorrespondentCustomerId | int | no |
ImportTransferAction | ImportTransferAction | no |
IsManuel | bool | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_FRGN_TRD_16 | 400 | SWIFT_TRANSFER_NOT_FOUND |
path Parameters
idget-swift-transfer-by-id › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
update-swift-transfer
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_FRGN_TRD_16 | 400 | SWIFT_TRANSFER_NOT_FOUND |
path Parameters
idupdate-swift-transfer › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
delete-swift-transfer
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_FRGN_TRD_16 | 400 | SWIFT_TRANSFER_NOT_FOUND |
path Parameters
iddelete-swift-transfer › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.