interbank
Operations addressed under /interbank — 5 operations.
get-interbank-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<InterbankDto>.
| Field | Declared type | Nullable |
|---|---|---|
MessageDirection | int? | yes |
Transferid | string | no |
AccountingEntryId | Guid? | yes |
ErrorCode | string | no |
ErrorCodeDescription | string | no |
CancelAccountingEntryId | Guid? | yes |
ChannelId | Guid? | yes |
TargetIban | string | no |
TargetOwner | string | no |
Amount | decimal? | yes |
Description | string | no |
AccountId | Guid? | yes |
ProcessDate | DateOnly? | yes |
Status | int? | yes |
PaymentPurpose | int? | yes |
QueryNumber | string | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-interbank-list › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
accountIdaccountingEntryIdamountcancelAccountingEntryIdchannelIddescriptionerrorCodeerrorCodeDescriptionidmessageDirectionPermitted values — validated against the message_direction parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Incoming | en: Incoming · tr: Gelen · ar: القادم |
2 | Outgoing | en: Outgoing · tr: Giden · ar: مُغادر |
3 | Order | no label seeded |
paymentPurposePermitted values — validated against the payment_purpose parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Residential Rent Payment | en: Residential Rent Payment · tr: Konut Kirası Ödemesi · ar: دفع إيجار السكن |
2 | Workplace Rent Payment | en: Workplace Rent Payment · tr: İş Yeri Kirası Ödemesi · ar: دفع إيجار مكان العمل |
3 | Other Rent Payment | en: Other Rent Payment · tr: Diğer Kira Ödemesi · ar: دفعة إيجار أخرى |
4 | E-Commerce Payment | en: E-Commerce Payment · tr: E-Ticaret Ödemesi · ar: الدفع عبر التجارة الإلكترونية |
5 | Salary Payment | en: Salary Payment · tr: Maaş Ödemesi · ar: دفع الراتب |
6 | Corporate Payment | en: Individual Payment · tr: Bireysel Ödeme · ar: الدفع الفردي |
7 | Individual Payment | en: Investment · tr: Yatırım · ar: استثمار |
8 | Investment | en: Financial · tr: Finansal · ar: مالي |
9 | Financial | en: Education Payment · tr: Eğitim Ödemesi · ar: دفع التعليم |
10 | Education Payment | en: Membership Fee Payment · tr: Aidat Ödemesi · ar: دفع رسوم العضوية |
11 | Membership Fee Payment | en: Other · tr: Diğer · ar: آخر |
99 | Others | no label seeded |
processDatequeryNumberstatusPermitted values — validated against the status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
0 | Pending | no label seeded |
1 | Done | no label seeded |
2 | Cancel | no label seeded |
3 | Write | no label seeded |
targetIbantargetOwnertransferidcreate-interbank
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-interbank › Request Body
accountIdamountmessageDirectionPermitted values — validated against the message_direction parameter.
| Value | Meaning |
|---|---|
1 | Incoming |
2 | Outgoing |
3 | Order |
Permitted values — validated against the message_direction parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Incoming | en: Incoming · tr: Gelen · ar: القادم |
2 | Outgoing | en: Outgoing · tr: Giden · ar: مُغادر |
3 | Order | no label seeded |
paymentPurposePermitted values — validated against the payment_purpose parameter.
| Value | Meaning |
|---|---|
1 | Residential Rent Payment |
2 | Workplace Rent Payment |
3 | Other Rent Payment |
4 | E-Commerce Payment |
5 | Salary Payment |
6 | Individual Payment |
7 | Investment |
8 | Financial |
9 | Education Payment |
10 | Membership Fee Payment |
11 | Other |
99 | Others |
Permitted values — validated against the payment_purpose parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Residential Rent Payment | en: Residential Rent Payment · tr: Konut Kirası Ödemesi · ar: دفع إيجار السكن |
2 | Workplace Rent Payment | en: Workplace Rent Payment · tr: İş Yeri Kirası Ödemesi · ar: دفع إيجار مكان العمل |
3 | Other Rent Payment | en: Other Rent Payment · tr: Diğer Kira Ödemesi · ar: دفعة إيجار أخرى |
4 | E-Commerce Payment | en: E-Commerce Payment · tr: E-Ticaret Ödemesi · ar: الدفع عبر التجارة الإلكترونية |
5 | Salary Payment | en: Salary Payment · tr: Maaş Ödemesi · ar: دفع الراتب |
6 | Corporate Payment | en: Individual Payment · tr: Bireysel Ödeme · ar: الدفع الفردي |
7 | Individual Payment | en: Investment · tr: Yatırım · ar: استثمار |
8 | Investment | en: Financial · tr: Finansal · ar: مالي |
9 | Financial | en: Education Payment · tr: Eğitim Ödemesi · ar: دفع التعليم |
10 | Education Payment | en: Membership Fee Payment · tr: Aidat Ödemesi · ar: دفع رسوم العضوية |
11 | Membership Fee Payment | en: Other · tr: Diğer · ar: آخر |
99 | Others | no label seeded |
processDatequeryNumberstatusPermitted values — validated against the status parameter.
| Value | Meaning |
|---|---|
0 | Pending |
1 | Done |
2 | Cancel |
3 | Write |
Permitted values — validated against the status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
0 | Pending | no label seeded |
1 | Done | no label seeded |
2 | Cancel | no label seeded |
3 | Write | no label seeded |
targetIbantargetOwneraccountingEntryIdcancelAccountingEntryIdchannelIddescriptionerrorCodeerrorCodeDescriptiontransferidcreate-interbank › 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-interbank-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 InterbankDto.
| Field | Declared type | Nullable |
|---|---|---|
MessageDirection | int? | yes |
Transferid | string | no |
AccountingEntryId | Guid? | yes |
ErrorCode | string | no |
ErrorCodeDescription | string | no |
CancelAccountingEntryId | Guid? | yes |
ChannelId | Guid? | yes |
TargetIban | string | no |
TargetOwner | string | no |
Amount | decimal? | yes |
Description | string | no |
AccountId | Guid? | yes |
ProcessDate | DateOnly? | yes |
Status | int? | yes |
PaymentPurpose | int? | yes |
QueryNumber | string | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_MNYTRNS_22 | 400 | INTER_BANK_NOT_FOUND | Inter Bank Not Found |
path Parameters
idget-interbank-by-id › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
update-interbank
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 | Message |
|---|---|---|---|
ERR_MNYTRNS_22 | 400 | INTER_BANK_NOT_FOUND | Inter Bank Not Found |
path Parameters
idupdate-interbank › Request Body
accountIdamountmessageDirectionPermitted values — validated against the message_direction parameter.
| Value | Meaning |
|---|---|
1 | Incoming |
2 | Outgoing |
3 | Order |
Permitted values — validated against the message_direction parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Incoming | en: Incoming · tr: Gelen · ar: القادم |
2 | Outgoing | en: Outgoing · tr: Giden · ar: مُغادر |
3 | Order | no label seeded |
paymentPurposePermitted values — validated against the payment_purpose parameter.
| Value | Meaning |
|---|---|
1 | Residential Rent Payment |
2 | Workplace Rent Payment |
3 | Other Rent Payment |
4 | E-Commerce Payment |
5 | Salary Payment |
6 | Individual Payment |
7 | Investment |
8 | Financial |
9 | Education Payment |
10 | Membership Fee Payment |
11 | Other |
99 | Others |
Permitted values — validated against the payment_purpose parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Residential Rent Payment | en: Residential Rent Payment · tr: Konut Kirası Ödemesi · ar: دفع إيجار السكن |
2 | Workplace Rent Payment | en: Workplace Rent Payment · tr: İş Yeri Kirası Ödemesi · ar: دفع إيجار مكان العمل |
3 | Other Rent Payment | en: Other Rent Payment · tr: Diğer Kira Ödemesi · ar: دفعة إيجار أخرى |
4 | E-Commerce Payment | en: E-Commerce Payment · tr: E-Ticaret Ödemesi · ar: الدفع عبر التجارة الإلكترونية |
5 | Salary Payment | en: Salary Payment · tr: Maaş Ödemesi · ar: دفع الراتب |
6 | Corporate Payment | en: Individual Payment · tr: Bireysel Ödeme · ar: الدفع الفردي |
7 | Individual Payment | en: Investment · tr: Yatırım · ar: استثمار |
8 | Investment | en: Financial · tr: Finansal · ar: مالي |
9 | Financial | en: Education Payment · tr: Eğitim Ödemesi · ar: دفع التعليم |
10 | Education Payment | en: Membership Fee Payment · tr: Aidat Ödemesi · ar: دفع رسوم العضوية |
11 | Membership Fee Payment | en: Other · tr: Diğer · ar: آخر |
99 | Others | no label seeded |
processDatequeryNumberstatusPermitted values — validated against the status parameter.
| Value | Meaning |
|---|---|
0 | Pending |
1 | Done |
2 | Cancel |
3 | Write |
Permitted values — validated against the status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
0 | Pending | no label seeded |
1 | Done | no label seeded |
2 | Cancel | no label seeded |
3 | Write | no label seeded |
targetIbantargetOwneraccountingEntryIdcancelAccountingEntryIdchannelIddescriptionerrorCodeerrorCodeDescriptiontransferidupdate-interbank › 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-interbank
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 | Message |
|---|---|---|---|
ERR_MNYTRNS_22 | 400 | INTER_BANK_NOT_FOUND | Inter Bank Not Found |
path Parameters
iddelete-interbank › 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.