description:Cancellation transaction identifier. Unique, as required in Chapter IX of the document SEPA-MMS User Detailed Functional Specifications for Credit Transfer Processing (SCT). Uniqueness is checked.
description:Return identification. Unique, as required in Chapter IX of the document SEPA-MMS User Detailed Functional Specifications for Credit Transfer Processing (SCT). Uniqueness is checked.
description:Request ID
example:D118100301086072
example:1
return_amount:
method:
type:number
type:string
format:double
enum:
description:Returned amount, calculated according to return reason
description:Cancellation transaction identifier from FFPCRQST, only filled if return_reason/iso_code is FOCR
payment_data:
example:D118100301085772
$ref:'#/components/schemas/PaymentData'
returning_party:
chrg_br:
$ref:'#/definitions/ReturningParty'
type:string
return_reason:
enum:
$ref:'#/definitions/ReturnReason'
-SLEV
payment_data:
description:Charge Bearer
$ref:'#/definitions/PaymentData'
example:SLEV
DocumentHeader:
PaymentReturnRequestParams:
type:object
type:object
description:Document header
description:Payment return request data
required:
required:
-doc_id
-header
-type
-assigner_bic
-date_time
-assignee_bic
-priority
-cancellation_id
-business_area
-cancelling_party
properties:
-cancellation_reason
doc_id:
-payment_data
type:string
properties:
description:Document ID - the structure is established in Section IX of the document LITAS-Pranesimu formatai.docx.
header:
example:D118091001045732
$ref:'#/components/schemas/DocumentHeader'
type:
assigner_bic:
type:string
type:string
enum:
description:Assigner BIC
-FFCCTRNS
example:PCTULT21XXX
-FFPCRQST
assignee_bic:
-PRTRN
type:string
-ROINVSTG
description:Assignee (BoL) BIC
description:Document type. Allowed values are FFCCTRNS/FFPCRQST/PRTRN/ROINVSTG
example:LIABLT2XMSD
example:FFCCTRNS
cancellation_id:
date_time:
type:string
type:string
description:>-
format:date-time
Cancellation transaction identifier. Unique, as required in Chapter
description:Document creation timestamp
IX of the document SEPA-MMS User Detailed Functional Specifications
example:2018-10-03T08:48:09
for Credit Transfer Processing (SCT). Uniqueness is checked.
priority:
example:D118100301085772
type:integer
cancelling_party:
description:Document priority
$ref:'#/components/schemas/CancellingParty'
example:51
cancellation_reason:
business_area:
$ref:'#/components/schemas/CancellationReason'
type:string
payment_data:
description:Document business area
$ref:'#/components/schemas/PaymentData'
example:SEPASCT
PaymentReturnParams:
PaymentData:
type:object
type:object
description:Payment return data
description:Payment data
required:
required:
-header
-instr_id
-return_id
-end_to_end_id
-return_reason
-tx_id
-returning_party
-amount
-return_amount
-currency
-return_currency
-date
-chrg_br
-mtd
-settlment_date
-prty
-payment_data
-cd
properties:
-debtor
header:
-creditor
$ref:'#/components/schemas/DocumentHeader'
properties:
return_id:
instr_id:
type:string
type:string
description:>-
description:Instruction identification
Return identification. Unique, as required in Chapter IX of the
example:D118091001048175
document SEPA-MMS User Detailed Functional Specifications for Credit
end_to_end_id:
Transfer Processing (SCT). Uniqueness is checked.
type:string
example:D118100301086072
description:A sending customer reference that must be passed to a receiveing customer. In the event that no reference was given, the value NOTPROVIDED must be used.
description:Unique Id of a transaction, as required in Chapter IX of the document SEPA-MMS User Detailed Functional Specifications for Credit Transfer Processing (SCT). Uniqueness is checked.
example:13.31
example:8e7070743da24402a7fc290bc62fbcd0
return_currency:
amount:
type:string
type:number
enum:
format:double
-EUR
description:Payment amount
description:Returned amount currency
example:13.31
example:EUR
currency:
chrg_br:
type:string
type:string
enum:
enum:
-EUR
-SLEV
description:Payment currency
description:Charge Bearer
example:EUR
example:SLEV
date:
settlment_date:
type:string
type:string
description:Payment date. In payment request must be current or next TARGET2 business day.
format:date
format:date
description:Current or next TARGET2 business day
mtd:
example:'2018-10-03T00:00:00.000Z'
type:string
additional_info:
enum:
type:string
-CLRG
description:>-
description:Settlment method
Cancellation transaction identifier from FFPCRQST, only filled if
example:CLRG
return_reason/iso_code is FOCR
prtry:
example:D118100301085772
type:string
returning_party:
description:Clearing system
$ref:'#/components/schemas/ReturningParty'
example:LITAS-MIG
return_reason:
cd:
$ref:'#/components/schemas/ReturnReason'
type:string
payment_data:
enum:
$ref:'#/components/schemas/PaymentData'
-SEPA
ResolutionOfInvestigationParams:
description:Service level code
type:object
example:SEPA
description:Resoultion of investigation data
debtor:
required:
$ref:'#/definitions/Participant'
-header
creditor:
-assigner_bic
$ref:'#/definitions/Participant'
-assignee_bic
CancellingParty:
-status
type:object
-resolution_id
description:Cancelling party data. Only one of available properties can be filled.
-rejecting_party
properties:
-rejection_reason
customer_name:
-payment_data
type:string
properties:
description:Customer name or BIC
header:
example:Dan Notestein or PCTULT21XXX
$ref:'#/components/schemas/DocumentHeader'
bank_bic:
assigner_bic:
type:string
type:string
description:Bank BIC
description:Assigner BIC
example:PCTULT21XXX
example:PCTULT21XXX
CancellationReason:
assignee_bic:
type:object
type:string
description:Cancellation reason. Only one of available properties can be filled
description:Assignee (BoL) BIC
properties:
example:LIABLT2XMSD
iso_code:
status:
type:string
type:string
enum:
enum:
-DUPL
-RJCR
description:ISO code of cancellation reason
description:Confirmation of resolution of investigation
example:DUPL
example:RJCR
code:
resolution_id:
type:string
type:string
enum:
description:>-
-FRAD
Identification of the cancellation request transaction status.
-TECH
Unique, as required in Chapter IX of the document SEPA-MMS User
description:Custom code of cancellation reason
Detailed Functional Specifications for Credit Transfer Processing
example:FRAD
(SCT). Uniqueness is checked.
ReturningParty:
example:D118100301086192
type:object
rejecting_party:
description:Data of party returning payment. Only one of available properties can be filled
$ref:'#/components/schemas/RejectingParty'
properties:
rejection_reason:
customer_name:
$ref:'#/components/schemas/RejectionReason'
type:string
additional_info:
description:Customer's name or BIC
type:array
example:Dan Notestein or PCTULT21XXX
items:
bank_bic:
type:string
type:string
minItems:1
description:Bank BIC
maxItems:2
example:PCTULT21XXX
description:To be used only when code is ‘LEGL’ in order to precise the reason.
ReturnReason:
example:
type:object
-AT51Description
description:Reason for payment return, Only one of available properties can be filled
-AT57Description
properties:
payment_data:
iso_code:
$ref:'#/components/schemas/PaymentData'
type:string
NextMessageRequestParams:
enum:
type:object
-AC01
description:Next message request parameters
-AC04
required:
-AC06
-tis_code
-AG01
properties:
-AG02
tis_code:
-AM05
type:string
-BE04
description:Two character TIS code - all generated IDs start with this
