loans--return-payments
Operations addressed under /loans — 79 operations.
Rendered section: This page contains the return-payments route group from loans. This is a presentation-only partition; it does not change the API contract or operation tags in the downloadable OpenAPI.
get-loan-return-payment-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<LoanReturnPaymentBaseDto>.
| Field | Declared type | Nullable |
|---|---|---|
Amount | decimal | no |
LoanId | Guid | no |
Status | int | no |
ReturnProcessingDate | DateTime? | yes |
ReturnDate | DateTime | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-loan-return-payment-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.
amountidloanIdreturnDatereturnProcessingDatestatusPermitted values — validated against the vendor_disbursement_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Pending Money Transfer | en: Pending Money Transfer · tr: Para Transferi Bekliyor · ar: التحويل المالي المعلق |
2 | Completed | en: Completed · tr: Ödeme Gerçekleşti · ar: تمّ. |
get-loan-return-payment-list-by-loan-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 IEnumerable<LoanReturnPaymentBaseDto>.
| Field | Declared type | Nullable |
|---|---|---|
Amount | decimal | no |
LoanId | Guid | no |
Status | int | no |
ReturnProcessingDate | DateTime? | yes |
ReturnDate | DateTime | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_LOAN_17 | 400 | LOAN_MUST_NOT_BE_NULL |
path Parameters
idget-loan-return-payment-list-by-loan-id › 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.
amountidloanIdreturnDatereturnProcessingDatestatusPermitted values — validated against the vendor_disbursement_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Pending Money Transfer | en: Pending Money Transfer · tr: Para Transferi Bekliyor · ar: التحويل المالي المعلق |
2 | Completed | en: Completed · tr: Ödeme Gerçekleşti · ar: تمّ. |
create-loan-return-payment
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_LOAN_17 | 400 | LOAN_MUST_NOT_BE_NULL |
path Parameters
idcreate-loan-return-payment › Request Body
amountreturnDatestatusPermitted values — validated against the return_payment_status parameter.
| Value | Meaning |
|---|---|
1 | pending |
2 | error |
3 | processed |
Permitted values — validated against the vendor_disbursement_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Pending Money Transfer | en: Pending Money Transfer · tr: Para Transferi Bekliyor · ar: التحويل المالي المعلق |
2 | Completed | en: Completed · tr: Ödeme Gerçekleşti · ar: تمّ. |
returnProcessingDatecreate-loan-return-payment › 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-loan-return-payment-detail-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 LoanReturnPaymentDto.
| Field | Declared type | Nullable |
|---|---|---|
LoanReturnPaymentDetail | List<LoanReturnPaymentDetailDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LOAN_17 | 400 | LOAN_MUST_NOT_BE_NULL | not published in this snapshot |
ERR_LOAN_92 | 400 | LOAN_RETURN_PAYMENT_NOT_FOUND | Return Payment is not found. Id:{0} |
path Parameters
idloanReturnPaymentIdget-loan-return-payment-detail-by-id › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
amountidloanIdreturnDatereturnProcessingDatestatusPermitted values — validated against the vendor_disbursement_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Pending Money Transfer | en: Pending Money Transfer · tr: Para Transferi Bekliyor · ar: التحويل المالي المعلق |
2 | Completed | en: Completed · tr: Ödeme Gerçekleşti · ar: تمّ. |
update-loan-return-payment
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_LOAN_17 | 400 | LOAN_MUST_NOT_BE_NULL | not published in this snapshot |
ERR_LOAN_92 | 400 | LOAN_RETURN_PAYMENT_NOT_FOUND | Return Payment is not found. Id:{0} |
path Parameters
idloanReturnPaymentIdupdate-loan-return-payment › Request Body
statusPermitted values — validated against the return_payment_status parameter.
| Value | Meaning |
|---|---|
1 | pending |
2 | error |
3 | processed |
Permitted values — validated against the vendor_disbursement_status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Pending Money Transfer | en: Pending Money Transfer · tr: Para Transferi Bekliyor · ar: التحويل المالي المعلق |
2 | Completed | en: Completed · tr: Ödeme Gerçekleşti · ar: تمّ. |
returnDatereturnProcessingDateupdate-loan-return-payment › 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-loan-return-payment
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_LOAN_17 | 400 | LOAN_MUST_NOT_BE_NULL | not published in this snapshot |
ERR_LOAN_92 | 400 | LOAN_RETURN_PAYMENT_NOT_FOUND | Return Payment is not found. Id:{0} |
path Parameters
idloanReturnPaymentIddelete-loan-return-payment › 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.
create-loan-return-payment-detail
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 | Message |
|---|---|---|---|
ERR_LOAN_17 | 400 | LOAN_MUST_NOT_BE_NULL | not published in this snapshot |
ERR_LOAN_92 | 400 | LOAN_RETURN_PAYMENT_NOT_FOUND | Return Payment is not found. Id:{0} |
path Parameters
idloanReturnPaymentIdcreate-loan-return-payment-detail › 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.