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.
example:D118100301085772
cancelling_party:
$ref:'#/definitions/CancellingParty'
cancellation_reason:
$ref:'#/definitions/CancellationReason'
payment_data:
$ref:'#/definitions/PaymentData'
PaymentReturnParams:
type:object
description:Payment return data
required:
-header
-return_id
-return_reason
-returning_party
-return_amount
-return_currency
-chrg_br
-settlment_date
-payment_data
properties:
header:
$ref:'#/definitions/DocumentHeader'
return_id:
type:string
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.
example:D118100301086072
return_amount:
type:number
format:double
description:Returned amount, calculated according to return reason
example:13.31
return_currency:
type:string
enum:
-EUR
description:Returned amount currency
example:EUR
chrg_br:
type:string
enum:
-SLEV
description:Charge Bearer
example:SLEV
settlment_date:
type:string
description:Current or next TARGET2 business day
format:date
additional_info:
type:string
description:Cancellation transaction identifier from FFPCRQST, only filled if return_reason/iso_code is FOCR
example:D118100301085772
returning_party:
$ref:'#/definitions/ReturningParty'
return_reason:
$ref:'#/definitions/ReturnReason'
payment_data:
$ref:'#/definitions/PaymentData'
DocumentHeader:
type:object
description:Document header
required:
-doc_id
-type
-date_time
-priority
-business_area
properties:
doc_id:
type:string
description:Document ID - the structure is established in Section IX of the document LITAS-Pranesimu formatai.docx.
example:D118091001045732
type:
type:string
enum:
-FFCCTRNS
-FFPCRQST
-PRTRN
-ROINVSTG
description:Document type. Allowed values are FFCCTRNS/FFPCRQST/PRTRN/ROINVSTG
example:FFCCTRNS
date_time:
type:string
format:date-time
description:Document creation timestamp
example:2018-10-03T08:48:09
priority:
type:integer
description:Document priority
example:51
business_area:
type:string
description:Document business area
example:SEPASCT
PaymentData:
type:object
description:Payment data
required:
-instr_id
-end_to_end_id
-tx_id
-amount
-currency
-date
-mtd
-prty
-cd
-debtor
-creditor
properties:
instr_id:
type:string
description:Instruction identification
example:D118091001048175
end_to_end_id:
type:string
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.
example:NOTPROVIDED
tx_id:
type:string
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:8e7070743da24402a7fc290bc62fbcd0
amount:
type:number
format:double
description:Payment amount
example:13.31
currency:
type:string
enum:
-EUR
description:Payment currency
example:EUR
date:
type:string
description:Payment date. In payment request must be current or next TARGET2 business day.
format:date
mtd:
type:string
enum:
-CLRG
description:Settlment method
example:CLRG
prtry:
type:string
description:Clearing system
example:LITAS-MIG
cd:
type:string
enum:
-SEPA
description:Service level code
example:SEPA
debtor:
$ref:'#/definitions/Participant'
creditor:
$ref:'#/definitions/Participant'
CancellingParty:
type:object
description:Cancelling party data. Only one of available properties can be filled.
properties:
customer_name:
type:string
description:Customer name or BIC
example:Dan Notestein or PCTULT21XXX
bank_bic:
type:string
description:Bank BIC
example:PCTULT21XXX
CancellationReason:
type:object
description:Cancellation reason. Only one of available properties can be filled
properties:
iso_code:
type:string
enum:
-DUPL
description:ISO code of cancellation reason
example:DUPL
code:
type:string
enum:
-FRAD
-TECH
description:Custom code of cancellation reason
example:FRAD
ReturningParty:
type:object
description:Data of party returning payment. Only one of available properties can be filled
properties:
customer_name:
type:string
description:Customer's name or BIC
example:Dan Notestein or PCTULT21XXX
bank_bic:
type:string
description:Bank BIC
example:PCTULT21XXX
ReturnReason:
type:object
description:Reason for payment return, Only one of available properties can be filled