openapi: 3.0.1
info:
title: WorldLink
version: 3.0.0
description: >-
WorldLink is a complete cross-border payment and Foreign-Exchange (FX)
service that allows you to perform payments in 135 currencies without
having
the need to maintain local currency accounts for each of them.
The CitiConnect WorldLink API now offers FX rate inquiry, FX deal booking,
and
cross-border payment initiation with 24X7 availability.
**A note on 24X7 availability of the CitiConnect API Services**
Although Citi strives to make all APIs 24X7 available wherever possible,
there may still be downtimes albeit at a much reduced frequency and with
shortened windows.
Citi's Service representatives will send information about any near-term
planned downtimes 3-4 business days in advance valid email so that you can
plan your business activities related
to your API interface to minimize any possible impact to your business and
customers.
Download our SDKs:
* [Python
SDK](https://developer.citi.com/sandboxApi/admin/v1/downloadZipFile?language=python&apiTitle=all&isClientSecReq=true)
* [Java
SDK](https://developer.citi.com/sandboxApi/admin/v1/downloadZipFile?language=java&apiTitle=all&isClientSecReq=true)
* [.Net
SDK](https://developer.citi.com/sandboxApi/admin/v1/downloadZipFile?language=dotnet&apiTitle=all&isClientSecReq=true)
* [Ruby
SDK](https://developer.citi.com/sandboxApi/admin/v1/downloadZipFile?language=ruby&apiTitle=all&isClientSecReq=true)
* [NodeJS
SDK](https://developer.citi.com/sandboxApi/admin/v1/downloadZipFile?language=nodejs&apiTitle=all&isClientSecReq=true)
* [Go
SDK](https://developer.citi.com/sandboxApi/admin/v1/downloadZipFile?language=go&apiTitle=all&isClientSecReq=true)
* [CLI Tool
SDK](https://developer.citi.com/sandboxApi/admin/v1/downloadZipFile?language=ccapi-cli&apiTitle=all&isClientSecReq=true)
contact:
name: Standards & Developer Hub
url: https://tts.sandbox.developer.citi.com/citiconnect/
email: developer-support@citi.com
servers:
- url: https://tts.apib2b.citi.com/citiconnect/prod/worldlinkservices
description: production gateway url
- url: https://tts.sandbox.apib2b.citi.com/citiconnect/sb/worldlinkservices
description: sandbox url
security:
- clientCredentials: []
tags:
- name: WorldLink v3
paths:
/v3/payment/initiation:
post:
tags:
- WorldLink v3
summary: WorldLink Payment Initiation
description: >-
The CitiConnect WorldLink Payment Initiation endpoint allows users to
perform payment initiation through their ERP/partner systems of
choice.
Content-Type: Supports application/xml:
operationId: paymentInitiation
parameters:
- name: client_id
in: query
description: Unique identifier created during the onboarding process.
required: true
schema:
type: string
- name: Content-Type
in: header
description: Supports \"application/xml\" and \"application/json\".
required: true
schema:
type: string
- name: Authorization
in: header
description: The OAuth Token prefixed with "Bearer" and space in between.
required: true
schema:
type: string
- name: payloadType
in: header
description: >
ISO XML type of input request payload. Supports
"urn:iso:std:iso:20022:tech:xsd:pain.001.001.03"
schema:
type: string
enum:
- urn:iso:std:iso:20022:tech:xsd:pain.001.001.03
requestBody:
description: >-
Contains the required fields of the ISOXML request body. The request
body must be Base64 encoded and enclosed within the
\\ tags.
content:
application/xml:
schema:
$ref: '#/components/schemas/Request'
example: >-
Wire_SZD_API_14012020-02-20T09:30:471200MSA
ILE DE
FRANCEADDRDept001Subdept001street
name011132323701234567777777townname1townname1townnasubdivctry01GB248840001TRClient5Wire_SZD_FD_API_1401TRF2022-09-22MSA
ILE DE
FRANCEADDRDept001street
name011132323701234567777777townname1subdivctry01SZ789652CADCITICA5AXXX248840001JA2020072233SM22557799URGPOTHR200SHARSOGEADPPXXXBene
Bank NameWellsprings
RenaissancBuilding No
0271492NewtownshipsADRehanHOMEMumbai113232123456ADAD120001203020035910010012796190145799300
application/json:
schema:
$ref: '#/components/schemas/Request'
examples:
Payment-Initiation-Request-Json:
$ref: '#/components/examples/Payment-Initiation-Request-Json'
required: false
responses:
'200':
description: OK
content:
application/xml:
schema:
$ref: '#/components/schemas/Document'
examples:
Payment-Initiation-Response-Xml:
value: >-
Wire_SZD_API_14012020-02-20T09:30:47MSA
ILE DE
FRANCEADDRDept001Subdept001street
name011132323701234567777777townname1townname1townnasubdivctry01GB248840001TRClient5Wire_SZD_API_1401Pain.001.001.032020-02-20T09:30:471200Wire_SZD_FD_API_1401JA2020072233SM22667799ACCP2002022-09-30URGPOTHRTRF12796190145799300MSA
ILE DE
FRANCEADDRDept001street
name011132323701234567777777townname1subdivctry01SZ789652CADCITICA5AXXX248840001SOGEADPPXXXBene
Bank NameWellsprings
RenaissancBuilding No
0271492NewtownshipsADRehanHOMEMumbai113232123456ADAD1200012030200359100100
application/json:
schema:
$ref: '#/components/schemas/Document'
examples:
Payment-Initiation-Response-Json:
$ref: '#/components/examples/Payment-Initiation-Response-Json'
'400':
description: Bad Request
content:
application/xml:
schema:
$ref: '#/components/schemas/Response'
example: >-
400Mismatch of WorldLink
Client ID or Client ID not
maintainedq2te~8b8b4912-1b37-449a-9e1a-3401d7ab7d8312198
application/json:
schema:
$ref: '#/components/schemas/Response'
example:
correlationId: q2te~bd8e9b8f-d8e5-4a48-ad13-5d1ec8bb32e815587
message: >-
Mismatch of WorldLink client ID or client ID is not
maintained.
status: '400'
'401':
description: Unauthorized
content:
application/xml:
schema:
$ref: '#/components/schemas/Error-Response'
example: >-
401Invalid OAuth
TokenPlease use valid OAuth
Token
application/json:
schema:
$ref: '#/components/schemas/Error-Response'
example:
httpMessage: Unauthorized
httpCode: '401'
moreInformation: >-
This server could not verify that you are authorized to access
the URL
'404':
description: Not found
content:
application/xml:
schema:
$ref: '#/components/schemas/Error-Response'
example: >-
404Not
FoundNo resources match requested
URI
application/json:
schema:
$ref: '#/components/schemas/Error-Response'
example:
httpMessage: Not Found
httpCode: '404'
moreInformation: No resources match requested URI
'405':
description: Method Not Allowed
content:
application/xml:
schema:
$ref: '#/components/schemas/Error-Response'
example: >-
405Method Not
AllowedThe method is not allowed
for the requested URL
application/json:
schema:
$ref: '#/components/schemas/Error-Response'
example:
httpMessage: Method Not Allowed
httpCode: '405'
moreInformation: The method is not allowed for the requested URL
'415':
description: Unsupported Media Type
content:
application/xml:
schema:
$ref: '#/components/schemas/Error-Response'
example: >-
415Unsupported
Media TypeUnsupported
Content-Type
application/json:
schema:
$ref: '#/components/schemas/Error-Response'
example:
httpMessage: Unsupported Media Type
httpCode: '415'
moreInformation: Unsupported Content-Type
'500':
description: Internal Server Error
content:
application/xml:
schema:
$ref: '#/components/schemas/Response'
example: >-
500Unable to process your
requestq2te~8b8b4912-1b37-449a-9e1a-3401d7ab7d8312352
application/json:
schema:
$ref: '#/components/schemas/Response'
example:
message: Unable to process your request
status: '500'
correlationId: q2te~8b8b4912-1b37-449a-9e1a-3401d7ab7d8312352
x-codegen-request-body-name: body
/v3/fx/raterequest:
post:
tags:
- WorldLink v3
summary: WorldLink FX Rate Inquiry
description: >-
The CitiConnect WorldLink FX Rate Inquiry endpoint allows users to get
updates on the present FX Rate details along with the rate expiry date,
time, and Rate Quote ID, accelerating FX transactions.
operationId: processRateRequest
parameters:
- name: client_id
in: query
description: Unique identifier created during the onboarding process.
required: true
schema:
type: string
- name: Content-Type
in: header
description: Supports \"application/xml\" and \"application/json\".
required: true
schema:
type: string
- name: Authorization
in: header
description: The OAuth Token prefixed with "Bearer" and space in between.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/IFXRequest-FX-Rate'
examples:
Fx-Rate-Request-Json:
$ref: '#/components/examples/Fx-Rate-Request-Json'
application/xml:
schema:
$ref: '#/components/schemas/IFXRequest-FX-Rate'
example: >-
2025-12-17T05:21:02ENGLISHKIWIBANKCTSI
INTERFACE1.0696f88f1-71f1-4ba5-abe4-ff98166d7861ec1553fe-bca8-43f9-8da1-fa324b661c0cCTSI3913100019999999999KB200.00CADNOKIndicatedSELLSpotDEALID16
required: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/IFXResponse-FX-Rate'
examples:
Fx-Rate-Response-Json:
$ref: '#/components/examples/Fx-Rate-Response-Json'
application/xml:
schema:
$ref: '#/components/schemas/IFXResponse-FX-Rate'
example: >-
PROCESSEDNONE000
: Rate
returned696f88f1-71f1-4ba5-abe4-ff98166d7861PROCESSEDNONE000
: Rate
returnedec1553fe-bca8-43f9-8da1-fa324b661c0c200.00CADNOK9999999999KB200.0001473.140CADNOK7.36570000Direct2025-12-17T01:19:47XML56EPA2025-12-19
'400':
description: Bad Request
content:
application/xml:
schema:
$ref: '#/components/schemas/Response'
example: >-
400Mismatch of WorldLink
Client ID or Client ID not
maintainedq2te~8b8b4912-1b37-449a-9e1a-3401d7ab7d8312198
application/json:
schema:
$ref: '#/components/schemas/Response'
example:
correlationId: q2te~bd8e9b8f-d8e5-4a48-ad13-5d1ec8bb32e815587
message: >-
Mismatch of WorldLink client ID or client ID is not
maintained.
status: '400'
'401':
description: Unauthorized
content:
application/xml:
schema:
$ref: '#/components/schemas/Error-Response'
example: >-
401Invalid OAuth
TokenPlease use valid OAuth
Token
application/json:
schema:
$ref: '#/components/schemas/Error-Response'
example:
httpMessage: Unauthorized
httpCode: '401'
moreInformation: >-
This server could not verify that you are authorized to access
the URL
'404':
description: Not found
content:
application/xml:
schema:
$ref: '#/components/schemas/Error-Response'
example: >-
404Not
FoundNo resources match requested
URI
application/json:
schema:
$ref: '#/components/schemas/Error-Response'
example:
httpMessage: Not Found
httpCode: '404'
moreInformation: No resources match requested URI
'405':
description: Method Not Allowed
content:
application/xml:
schema:
$ref: '#/components/schemas/Error-Response'
example: >-
405Method Not
AllowedThe method is not allowed
for the requested URL
application/json:
schema:
$ref: '#/components/schemas/Error-Response'
example:
httpMessage: Method Not Allowed
httpCode: '405'
moreInformation: The method is not allowed for the requested URL
'415':
description: Unsupported Media Type
content:
application/xml:
schema:
$ref: '#/components/schemas/Error-Response'
example: >-
415Unsupported
Media TypeUnsupported
Content-Type
application/json:
schema:
$ref: '#/components/schemas/Error-Response'
example:
httpMessage: Unsupported Media Type
httpCode: '415'
moreInformation: Unsupported Content-Type
'500':
description: Internal Server Error
content:
application/xml:
schema:
$ref: '#/components/schemas/Response'
example: >-
500Unable to process your
requestq2te~8b8b4912-1b37-449a-9e1a-3401d7ab7d8312352
application/json:
schema:
$ref: '#/components/schemas/Response'
example:
message: Unable to process your request
status: '500'
correlationId: q2te~8b8b4912-1b37-449a-9e1a-3401d7ab7d8312352
x-codegen-request-body-name: body
/v3/fx/bookfx:
post:
tags:
- WorldLink v3
summary: WorldLink FX Booking
description: >-
The CitiConnect WorldLink FX Booking endpoint allows you to book FX
deals according to rate quotes received through CitiConnect FX Rate
Inquiry for available currency combinations.
**Content Type:** Supports application/xml or application/json.
**Authorization:** The OAuth Token prefixed with Bearer and space in
between.
**Request:** For more information on specific field mappings, please
refer to Customized IFX XML standards.
operationId: bookFx
parameters:
- name: client_id
in: query
description: Unique identifier created during the onboarding process.
required: true
schema:
type: string
- name: Content-Type
in: header
description: Supports \"application/xml\" and \"application/json\".
required: true
schema:
type: string
- name: Authorization
in: header
description: The OAuth Token prefixed with "Bearer" and space in between.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/IFXRequest-Book-FX'
examples:
Book-Fx-Request-Json:
$ref: '#/components/examples/Book-Fx-Request-Json'
application/xml:
schema:
$ref: '#/components/schemas/IFXRequest-Book-FX'
example: >-
2025-12-17T05:21:03ENGLISHKIWIBANKCTSI
INTERFACE1.0696f88f1-71f1-4ba5-abe4-ff98166d7861NWOec1553fe-bca8-43f9-8da1-fa324b661c0cCTSI391310001SELLDirectNOK200CADXML56EPA
required: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/IFXResponse-Book-FX'
examples:
Book-Fx-Response-Json:
$ref: '#/components/examples/Book-Fx-Response-Json'
application/xml:
schema:
$ref: '#/components/schemas/IFXResponse-Book-FX'
examples:
value: >-
PROCESSEDNONE000
: Rate
returned696f88f1-71f1-4ba5-abe4-ff98166d7861NWOPROCESSEDNONE000
: Rate
returnedec1553fe-bca8-43f9-8da1-fa324b661c0cSELLDirectNOK200CADXML56EPAAA23401012345157.36570000Direct1473.140NOK200.000CADXML56EPA
'400':
description: Bad Request
content:
application/xml:
schema:
$ref: '#/components/schemas/Response'
example: >-
400Mismatch of WorldLink
Client ID or Client ID not
maintainedq2te~8b8b4912-1b37-449a-9e1a-3401d7ab7d8312198
application/json:
schema:
$ref: '#/components/schemas/Response'
example:
correlationId: q2te~bd8e9b8f-d8e5-4a48-ad13-5d1ec8bb32e815587
message: >-
Mismatch of WorldLink client ID or client ID is not
maintained.
status: '400'
'401':
description: Unauthorized
content:
application/xml:
schema:
$ref: '#/components/schemas/Error-Response'
example: >-
401Invalid OAuth
TokenPlease use valid OAuth
Token
application/json:
schema:
$ref: '#/components/schemas/Error-Response'
example:
httpMessage: Unauthorized
httpCode: '401'
moreInformation: >-
This server could not verify that you are authorized to access
the URL
'404':
description: Not found
content:
application/xml:
schema:
$ref: '#/components/schemas/Error-Response'
example: >-
404Not
FoundNo resources match requested
URI
application/json:
schema:
$ref: '#/components/schemas/Error-Response'
example:
httpMessage: Not Found
httpCode: '404'
moreInformation: No resources match requested URI
'405':
description: Method Not Allowed
content:
application/xml:
schema:
$ref: '#/components/schemas/Error-Response'
example: >-
405Method Not
AllowedThe method is not allowed
for the requested URL
application/json:
schema:
$ref: '#/components/schemas/Error-Response'
example:
httpMessage: Method Not Allowed
httpCode: '405'
moreInformation: The method is not allowed for the requested URL
'415':
description: Unsupported Media Type
content:
application/xml:
schema:
$ref: '#/components/schemas/Error-Response'
example: >-
415Unsupported
Media TypeUnsupported
Content-Type
application/json:
schema:
$ref: '#/components/schemas/Error-Response'
example:
httpMessage: Unsupported Media Type
httpCode: '415'
moreInformation: Unsupported Content-Type
'500':
description: Internal Server Error
content:
application/xml:
schema:
$ref: '#/components/schemas/Response'
example: >-
500Unable to process your
requestq2te~8b8b4912-1b37-449a-9e1a-3401d7ab7d8312352
application/json:
schema:
$ref: '#/components/schemas/Response'
example:
message: Unable to process your request
status: '500'
correlationId: q2te~8b8b4912-1b37-449a-9e1a-3401d7ab7d8312352
x-codegen-request-body-name: body
components:
schemas:
ATMTrnInfo:
title: ATMTrnInfo
type: object
properties:
atmcityState:
maxLength: 15
minLength: 1
type: string
atmlocation:
maxLength: 18
minLength: 1
type: string
atmowner:
maxLength: 14
minLength: 1
type: string
AcctAssignRq:
title: AcctAssignRq
type: object
properties:
acctId:
maxLength: 255
minLength: 1
pattern: '[^"']*'
type: string
description: FROM account number
xml:
name: AcctId
attribute: false
wrapped: false
assignDeassign:
minLength: 1
type: string
xml:
name: AssignDeassign
attribute: false
wrapped: false
enum:
- A
- D
bankId:
maxLength: 34
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: BankId
attribute: false
wrapped: false
branchId:
maxLength: 22
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: BranchId
attribute: false
wrapped: false
checkerId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: CheckerId
attribute: false
wrapped: false
checkerTime:
minLength: 1
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: CheckerTime
attribute: false
wrapped: false
enterpriseId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: EnterpriseId
attribute: false
wrapped: false
entitlementId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: EntitlementId
attribute: false
wrapped: false
makerId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: MakerId
attribute: false
wrapped: false
makerTime:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: MakerTime
attribute: false
wrapped: false
requestID:
maxLength: 36
minLength: 1
type: string
xml:
name: RequestID
attribute: false
wrapped: false
AcctAssignRs:
title: AcctAssignRs
type: object
properties:
requestID:
maxLength: 36
minLength: 1
type: string
xml:
name: RequestID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
AcctBal:
title: AcctBal
type: object
properties:
balType:
minLength: 1
type: string
xml:
name: BalType
attribute: false
wrapped: false
curAmt:
$ref: '#/components/schemas/CurAmt'
desc:
maxLength: 80
minLength: 1
type: string
xml:
name: Desc
attribute: false
wrapped: false
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
expDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
description: Contract Expiry Datetime
xml:
name: ExpDt
attribute: false
wrapped: false
AcctInqRq:
title: AcctInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
depAcctId:
$ref: '#/components/schemas/DepAcctId'
incBal:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncBal
attribute: false
wrapped: false
enum:
- '0'
- '1'
incExtBal:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncExtBal
attribute: false
wrapped: false
enum:
- '0'
- '1'
loanAcctId:
$ref: '#/components/schemas/LoanAcctId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: AcctInqRq
attribute: false
wrapped: false
AcctInqRs:
title: AcctInqRs
type: object
properties:
acctBal:
type: array
xml:
name: AcctBal
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/AcctBal'
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
ccacctRec:
$ref: '#/components/schemas/CCAcctRec'
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
depAcctId:
$ref: '#/components/schemas/DepAcctId'
depAcctRec:
$ref: '#/components/schemas/DepAcctRec'
extAcctBal:
type: array
xml:
name: ExtAcctBal
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/ExtAcctBal'
incBal:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncBal
attribute: false
wrapped: false
enum:
- '0'
- '1'
incExtBal:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncExtBal
attribute: false
wrapped: false
enum:
- '0'
- '1'
lastStmtDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
lastTrnDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
loanAcctId:
$ref: '#/components/schemas/LoanAcctId'
loanAcctRec:
$ref: '#/components/schemas/LoanAcctRec'
locacctRec:
$ref: '#/components/schemas/LOCAcctRec'
mortAcctRec:
$ref: '#/components/schemas/MortAcctRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
upDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
xml:
name: AcctInqRs
attribute: false
wrapped: false
AcctTaxInfo:
title: AcctTaxInfo
type: object
properties:
curAmt:
$ref: '#/components/schemas/CurAmt'
org:
maxLength: 36
minLength: 1
type: string
description: Customer System application manufacturer
xml:
name: Org
attribute: false
wrapped: false
prevYrCurAmt:
$ref: '#/components/schemas/PrevYrCurAmt'
rate:
type: number
xml:
name: Rate
attribute: false
wrapped: false
taxType:
minLength: 1
type: string
xml:
name: TaxType
attribute: false
wrapped: false
AdditionalStatus:
title: AdditionalStatus
type: object
properties:
serverStatusCode:
minLength: 1
type: string
description: Backend Status Code
xml:
name: ServerStatusCode
attribute: false
wrapped: false
severity:
minLength: 1
type: string
description: Error,Warn,Info
xml:
name: Severity
attribute: false
wrapped: false
statusCode:
minLength: 1
type: string
description: StatusCode as Per IFX XML
xml:
name: StatusCode
attribute: false
wrapped: false
statusDesc:
maxLength: 255
minLength: 1
type: string
description: Text description for status code
xml:
name: StatusDesc
attribute: false
wrapped: false
AgtInterBuyCntrPrtyType:
title: AgtInterBuyCntrPrtyType
type: object
properties:
acctId:
maxLength: 255
minLength: 1
pattern: '[^"']*'
type: string
description: FROM account number
xml:
name: AcctId
attribute: false
wrapped: false
bankId:
maxLength: 34
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: BankId
attribute: false
wrapped: false
bankIdType:
minLength: 1
type: string
xml:
name: BankIdType
attribute: false
wrapped: false
cntrPrtyType:
minLength: 1
type: string
xml:
name: CntrPrtyType
attribute: false
wrapped: false
enum:
- PARTY_A
- PARTY_B
- FUND_BENE_CUST
- DELIVERY_AGENT
- INTERMEDIARY
- RECEIVING_AGENT
- BENEFICIARY_INSTITUTION
- DEALING_BRANCH_PARTY_A
- DEALING_BRANCH_PARTY_B
- BROKER_IDENTIFICATION
name:
maxLength: 40
minLength: 1
type: string
xml:
name: Name
attribute: false
wrapped: false
postAddr:
$ref: '#/components/schemas/PostAddr'
AgtInterSellCntrPrtyType:
title: AgtInterSellCntrPrtyType
type: object
properties:
acctId:
maxLength: 255
minLength: 1
pattern: '[^"']*'
type: string
description: FROM account number
xml:
name: AcctId
attribute: false
wrapped: false
bankId:
maxLength: 34
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: BankId
attribute: false
wrapped: false
bankIdType:
minLength: 1
type: string
xml:
name: BankIdType
attribute: false
wrapped: false
cntrPrtyType:
minLength: 1
type: string
xml:
name: CntrPrtyType
attribute: false
wrapped: false
enum:
- PARTY_A
- PARTY_B
- FUND_BENE_CUST
- DELIVERY_AGENT
- INTERMEDIARY
- RECEIVING_AGENT
- BENEFICIARY_INSTITUTION
- DEALING_BRANCH_PARTY_A
- DEALING_BRANCH_PARTY_B
- BROKER_IDENTIFICATION
name:
maxLength: 40
minLength: 1
type: string
xml:
name: Name
attribute: false
wrapped: false
postAddr:
$ref: '#/components/schemas/PostAddr'
AmtAdj:
title: AmtAdj
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
AmtAdjB:
title: AmtAdjB
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
AmtAdjType:
title: AmtAdjType
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
xml:
name: AmtAdj_Type
attribute: false
wrapped: false
AmtBt:
title: AmtBt
type: object
properties:
curAmt:
$ref: '#/components/schemas/CurAmt'
AmtBtType:
title: AmtBtType
type: object
properties:
curAmt:
$ref: '#/components/schemas/CurAmt'
xml:
name: AmtBt_Type
attribute: false
wrapped: false
AmtFnd:
title: AmtFnd
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
AmtFndType:
title: AmtFndType
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
xml:
name: AmtFnd_Type
attribute: false
wrapped: false
AmtSld:
title: AmtSld
type: object
properties:
curAmt:
$ref: '#/components/schemas/CurAmt'
AmtSldType:
title: AmtSldType
type: object
properties:
curAmt:
$ref: '#/components/schemas/CurAmt'
xml:
name: AmtSld_Type
attribute: false
wrapped: false
AsyncRsInfo:
title: AsyncRsInfo
type: object
properties:
availDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: AvailDt
attribute: false
wrapped: false
expDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
description: Contract Expiry Datetime
xml:
name: ExpDt
attribute: false
wrapped: false
AuthInfo:
title: AuthInfo
type: object
properties:
custPswd:
$ref: '#/components/schemas/CustPswd'
BESStatusType:
title: BESStatusType
type: object
properties:
besstatusCode:
maxLength: 20
minLength: 1
type: string
rejectReason:
maxLength: 255
minLength: 1
type: string
xml:
name: RejectReason
attribute: false
wrapped: false
severity:
minLength: 1
type: string
description: Error,Warn,Info
xml:
name: Severity
attribute: false
wrapped: false
statusDesc:
maxLength: 255
minLength: 1
type: string
description: Text description for status code
xml:
name: StatusDesc
attribute: false
wrapped: false
BSPReferTo:
title: BSPReferTo
type: object
properties:
orgContact:
$ref: '#/components/schemas/OrgContact'
spname:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Always set to CTSI
BalInqRq:
title: BalInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
depAcctId:
$ref: '#/components/schemas/DepAcctId'
incExtBal:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncExtBal
attribute: false
wrapped: false
enum:
- '0'
- '1'
loanAcctId:
$ref: '#/components/schemas/LoanAcctId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: BalInqRq
attribute: false
wrapped: false
BalInqRs:
title: BalInqRs
type: object
properties:
acctBal:
type: array
xml:
name: AcctBal
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/AcctBal'
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
depAcctId:
$ref: '#/components/schemas/DepAcctId'
extAcctBal:
type: array
xml:
name: ExtAcctBal
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/ExtAcctBal'
incExtBal:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncExtBal
attribute: false
wrapped: false
enum:
- '0'
- '1'
loanAcctId:
$ref: '#/components/schemas/LoanAcctId'
mktgInfo:
maxLength: 255
minLength: 1
type: string
xml:
name: MktgInfo
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
xml:
name: BalInqRs
attribute: false
wrapped: false
BankAcctFeatLimit:
title: BankAcctFeatLimit
type: object
properties:
bankAcctFeatLimitType:
minLength: 1
type: string
xml:
name: BankAcctFeatLimitType
attribute: false
wrapped: false
curAmt:
$ref: '#/components/schemas/CurAmt'
trnSrc:
minLength: 1
type: string
xml:
name: TrnSrc
attribute: false
wrapped: false
BankAcctFeatSupt:
title: BankAcctFeatSupt
type: object
properties:
bankAcctFeatLimit:
type: array
xml:
name: BankAcctFeatLimit
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/BankAcctFeatLimit'
bankAcctFeatType:
minLength: 1
type: string
xml:
name: BankAcctFeatType
attribute: false
wrapped: false
trnSrc:
type: array
xml:
name: TrnSrc
attribute: false
wrapped: false
items:
minLength: 1
type: string
BankAcctInfoType:
title: BankAcctInfoType
type: object
properties:
backupWithholding:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: BackupWithholding
attribute: false
wrapped: false
enum:
- '0'
- '1'
contactInfo:
$ref: '#/components/schemas/ContactInfo'
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
custAcctUse:
minLength: 1
type: string
xml:
name: CustAcctUse
attribute: false
wrapped: false
custName:
$ref: '#/components/schemas/CustName'
desc:
maxLength: 80
minLength: 1
type: string
xml:
name: Desc
attribute: false
wrapped: false
initialDeposit:
$ref: '#/components/schemas/InitialDepositType'
intRateInfo:
$ref: '#/components/schemas/IntRateInfoType'
orgContact:
$ref: '#/components/schemas/OrgContact'
ownership:
maxLength: 42
minLength: 1
type: string
xml:
name: Ownership
attribute: false
wrapped: false
personName:
$ref: '#/components/schemas/PersonName'
primaryAcct:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: PrimaryAcct
attribute: false
wrapped: false
enum:
- '0'
- '1'
productId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: ProductId
attribute: false
wrapped: false
taxCountry:
maxLength: 35
minLength: 1
type: string
xml:
name: TaxCountry
attribute: false
wrapped: false
taxProvince:
maxLength: 32
minLength: 1
type: string
xml:
name: TaxProvince
attribute: false
wrapped: false
term:
$ref: '#/components/schemas/Term'
BankAcctRec:
title: BankAcctRec
type: object
properties:
acctBal:
type: array
xml:
name: AcctBal
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/AcctBal'
acctTaxType:
minLength: 1
type: string
xml:
name: AcctTaxType
attribute: false
wrapped: false
bankAcctFeatSupt:
type: array
xml:
name: BankAcctFeatSupt
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/BankAcctFeatSupt'
bankAcctInfo:
$ref: '#/components/schemas/BankAcctInfoType'
bankAcctStatus:
$ref: '#/components/schemas/BankAcctStatus'
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
loanAcctId:
$ref: '#/components/schemas/LoanAcctId'
paySupt:
$ref: '#/components/schemas/PaySupt'
xferFromSupt:
$ref: '#/components/schemas/XferFromSupt'
xferToSupt:
$ref: '#/components/schemas/XferToSupt'
BankAcctStatus:
title: BankAcctStatus
type: object
properties:
bankAcctStatusCode:
minLength: 1
type: string
description: StatusCode as Per IFX XML
xml:
name: BankAcctStatusCode
attribute: false
wrapped: false
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
statusDesc:
maxLength: 255
minLength: 1
type: string
description: Text description for status code
xml:
name: StatusDesc
attribute: false
wrapped: false
statusModBy:
minLength: 1
type: string
xml:
name: StatusModBy
attribute: false
wrapped: false
BankAcctTaxInqRq:
title: BankAcctTaxInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
depAcctId:
$ref: '#/components/schemas/DepAcctId'
loanAcctId:
$ref: '#/components/schemas/LoanAcctId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
taxYear:
$ref: '#/components/schemas/XMLGregorianCalendar'
xml:
name: BankAcctTaxInqRq
attribute: false
wrapped: false
BankAcctTaxInqRs:
title: BankAcctTaxInqRs
type: object
properties:
acctTaxInfo:
type: array
xml:
name: AcctTaxInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/AcctTaxInfo'
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
depAcctId:
$ref: '#/components/schemas/DepAcctId'
loanAcctId:
$ref: '#/components/schemas/LoanAcctId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
taxId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: TaxId
attribute: false
wrapped: false
taxYear:
$ref: '#/components/schemas/XMLGregorianCalendar'
xml:
name: BankAcctTaxInqRs
attribute: false
wrapped: false
BankAcctTrnImgInqRq:
title: BankAcctTrnImgInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
contactInfo:
$ref: '#/components/schemas/ContactInfo'
custContact:
$ref: '#/components/schemas/CustContact'
custId:
$ref: '#/components/schemas/CustId'
deliveryMedia:
minLength: 1
type: string
xml:
name: DeliveryMedia
attribute: false
wrapped: false
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
depAcctId:
$ref: '#/components/schemas/DepAcctId'
incAllItems:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncAllItems
attribute: false
wrapped: false
enum:
- '0'
- '1'
loanAcctId:
$ref: '#/components/schemas/LoanAcctId'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeCurAmt:
$ref: '#/components/schemas/SelRangeCurAmt'
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
stopChkInfo:
$ref: '#/components/schemas/StopChkInfo'
chkNum:
maxLength: 12
minLength: 1
type: string
xml:
name: ChkNum
attribute: false
wrapped: false
trnType:
type: array
xml:
name: TrnType
attribute: false
wrapped: false
items:
minLength: 1
type: string
xml:
name: BankAcctTrnImgInqRq
attribute: false
wrapped: false
BankAcctTrnImgInqRs:
title: BankAcctTrnImgInqRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
bankAcctTrnImgRec:
type: array
xml:
name: BankAcctTrnImgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/BankAcctTrnImgRec'
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
chkNum:
maxLength: 12
minLength: 1
type: string
xml:
name: ChkNum
attribute: false
wrapped: false
contactInfo:
$ref: '#/components/schemas/ContactInfo'
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custContact:
$ref: '#/components/schemas/CustContact'
custId:
$ref: '#/components/schemas/CustId'
deliveryMedia:
minLength: 1
type: string
xml:
name: DeliveryMedia
attribute: false
wrapped: false
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
depAcctId:
$ref: '#/components/schemas/DepAcctId'
incAllItems:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncAllItems
attribute: false
wrapped: false
enum:
- '0'
- '1'
loanAcctId:
$ref: '#/components/schemas/LoanAcctId'
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeCurAmt:
$ref: '#/components/schemas/SelRangeCurAmt'
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
stopChkInfo:
type: array
xml:
name: StopChkInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/StopChkInfo'
trnType:
type: array
xml:
name: TrnType
attribute: false
wrapped: false
items:
minLength: 1
type: string
xml:
name: BankAcctTrnImgInqRs
attribute: false
wrapped: false
BankAcctTrnImgRec:
title: BankAcctTrnImgRec
type: object
properties:
curAmt:
$ref: '#/components/schemas/CurAmt'
imageURL:
maxLength: 1024
minLength: 1
type: string
xml:
name: ImageURL
attribute: false
wrapped: false
prcDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
trnImage:
$ref: '#/components/schemas/TrnImage'
trnType:
minLength: 1
type: string
xml:
name: TrnType
attribute: false
wrapped: false
BankAcctTrnRec:
title: BankAcctTrnRec
type: object
properties:
billRefInfo:
maxLength: 80
minLength: 1
type: string
xml:
name: BillRefInfo
attribute: false
wrapped: false
compositeCurAmt:
type: array
xml:
name: CompositeCurAmt
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CompositeCurAmt'
counterpartyInfo:
$ref: '#/components/schemas/CounterpartyInfoType'
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
curAmt:
$ref: '#/components/schemas/CurAmt'
custPayeeInfo:
$ref: '#/components/schemas/CustPayeeInfo'
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
entryMethodDetails:
$ref: '#/components/schemas/EntryMethodDetails'
industId:
$ref: '#/components/schemas/IndustId'
invoiceInfo:
$ref: '#/components/schemas/InvoiceInfo'
memo:
type: array
xml:
name: Memo
attribute: false
wrapped: false
items:
maxLength: 1024
minLength: 1
type: string
name:
maxLength: 40
minLength: 1
type: string
xml:
name: Name
attribute: false
wrapped: false
origCurAmt:
$ref: '#/components/schemas/OrigCurAmt'
origDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
postedDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
refInfo:
type: array
xml:
name: RefInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/RefInfo'
remitAdviceRefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RemitAdviceRefId
attribute: false
wrapped: false
sprefId:
type: string
sprefIdCorrect:
$ref: '#/components/schemas/SPRefIdCorrect'
trnSrc:
minLength: 1
type: string
xml:
name: TrnSrc
attribute: false
wrapped: false
trnType:
minLength: 1
type: string
xml:
name: TrnType
attribute: false
wrapped: false
BankDetails:
title: BankDetails
type: object
properties:
additionalInfo:
maxLength: 1024
minLength: 1
type: string
xml:
name: AdditionalInfo
attribute: false
wrapped: false
codeword:
maxLength: 8
minLength: 1
type: string
xml:
name: Codeword
attribute: false
wrapped: false
BankInfo:
title: BankInfo
type: object
properties:
bankId:
maxLength: 34
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: BankId
attribute: false
wrapped: false
bankIdType:
minLength: 1
type: string
xml:
name: BankIdType
attribute: false
wrapped: false
branchId:
maxLength: 22
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: BranchId
attribute: false
wrapped: false
branchName:
maxLength: 40
minLength: 1
type: string
xml:
name: BranchName
attribute: false
wrapped: false
city:
maxLength: 35
minLength: 1
type: string
xml:
name: City
attribute: false
wrapped: false
country:
maxLength: 35
minLength: 1
type: string
xml:
name: Country
attribute: false
wrapped: false
name:
maxLength: 40
minLength: 1
type: string
xml:
name: Name
attribute: false
wrapped: false
postAddr:
$ref: '#/components/schemas/PostAddr'
postalCode:
maxLength: 35
minLength: 1
type: string
xml:
name: PostalCode
attribute: false
wrapped: false
refInfo:
type: array
xml:
name: RefInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/RefInfo'
stateProv:
maxLength: 32
minLength: 1
type: string
xml:
name: StateProv
attribute: false
wrapped: false
description: >-
Only parameter need to be present in the message. Parameters under this
block will be ignored.
BankSvcProfInfo:
title: BankSvcProfInfo
type: object
properties:
custBankPrefSupt:
type: array
xml:
name: CustBankPrefSupt
attribute: false
wrapped: false
items:
minLength: 1
type: string
deliveryMethod:
type: array
xml:
name: DeliveryMethod
attribute: false
wrapped: false
items:
minLength: 1
type: string
interXferProf:
$ref: '#/components/schemas/InterXferProf'
msgSupt:
type: array
xml:
name: MsgSupt
attribute: false
wrapped: false
items:
minLength: 1
type: string
optSupt:
type: array
xml:
name: OptSupt
attribute: false
wrapped: false
items:
minLength: 1
type: string
stopChkProf:
$ref: '#/components/schemas/StopChkProf'
svcCore:
$ref: '#/components/schemas/SvcCoreType'
xferProf:
$ref: '#/components/schemas/XferProf'
BankSvcRqType:
title: BankSvcRqType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
balInqRqAndAcctInqRqAndDepAcctStmtInqRq:
type: array
description: >-
refer to #/definitions/BalInqRq, and #/definitions/AcctInqRq, and
#/definitions/DepAcctStmtInqRq, and #/definitions/DepAcctSummStmtRq,
and #/definitions/CCAcctStmtInqRq, and
#/definitions/DepAcctTrnInqRq, and #/definitions/CCAcctTrnInqRq, and
#/definitions/CntrlDisbTrnInqRq, and
#/definitions/BankAcctTrnImgInqRq, and #/definitions/IntRateInqRq,
and #/definitions/BankAcctTaxInqRq, and
#/definitions/ForExRateInqRq, and #/definitions/ForExRateDealAddRq,
and #/definitions/ForExConfSettlRqType, and
#/definitions/ForExConfSettlInqRqType, and
#/definitions/PmtSchTrnRqType, and #/definitions/PmtSchStmtRqType,
and #/definitions/ConfCreditInqRqType, and
#/definitions/ConfDebitInqRqType, and #/definitions/StopChkAddRq,
and #/definitions/StopChkCanRq, and #/definitions/StopChkInqRq, and
#/definitions/StopChkAudRq, and #/definitions/StopChkSyncRq, and
#/definitions/XferAddRq, and #/definitions/XferModRq, and
#/definitions/XferStatusModRq, and #/definitions/XferCanRq, and
#/definitions/XferInqRq, and #/definitions/XferAudRq, and
#/definitions/XferSyncRq, and #/definitions/RecXferAddRq, and
#/definitions/RecXferModRq, and #/definitions/RecXferCanRq, and
#/definitions/RecXferInqRq, and #/definitions/RecXferAudRq, and
#/definitions/RecXferSyncRq, and #/definitions/ChkOrdAddRq, and
#/definitions/ChkOrdModRqType, and #/definitions/ChkOrdCanRqType,
and #/definitions/ChkOrdInqRqType, and
#/definitions/ChkOrdSyncRqType, and
#/definitions/RecChkOrdAddRqType, and
#/definitions/RecChkOrdModRqType, and
#/definitions/RecChkOrdCanRqType, and
#/definitions/RecChkOrdInqRqType, and
#/definitions/RecChkOrdSyncRqType, and
#/definitions/RecChkOrdInstAddRqType, and
#/definitions/DepBkOrdAddRq, and #/definitions/DebitAuthAddRq, and
#/definitions/DebitAuthModRq, and #/definitions/DebitAuthCanRq, and
#/definitions/DebitAuthInqRq, and #/definitions/DebitAuthAudRq, and
#/definitions/DebitAuthSyncRq, and #/definitions/DebitAddRq, and
#/definitions/CreditAuthAddRq, and #/definitions/CreditAuthModRq,
and #/definitions/CreditAuthCanRq, and
#/definitions/CreditAuthInqRq, and #/definitions/CreditAuthAudRq,
and #/definitions/CreditAuthSyncRq, and #/definitions/CreditAddRq,
and #/definitions/DepAppAddRqType, and
#/definitions/DepAppModRqType, and #/definitions/DepAppCanRqType,
and #/definitions/DepAppInqRqType, and
#/definitions/DepAppAudRqType, and #/definitions/DepAppSyncRqType,
and #/definitions/WLInfoTlxRq, and #/definitions/WLInfoTlxInqRq, and
#/definitions/CustAcctRq
items:
type: object
properties: {}
baseNo:
maxLength: 10
minLength: 1
type: string
description: >-
FXLM Base Number. If provided this base number will be passed to
FXLM for pricing and settlement. Only one of or
may be provided. If neither is present the OLR to base
number configuration will be used. Echoed from customer request.
xml:
name: BaseNo
attribute: false
wrapped: false
DealType:
minLength: 1
type: string
description: >-
Deal type. Deal type- 'B' for all bench deals for bench fixing
rates
Deal type- `Q` for all real time quoted rate deals This
must be coordinated with QUOTED fixing type
Deal Type- 'O' book
per OLR parameters
Default value will be O, if not provided.
Echoed from customer request.
xml:
name: DealType
attribute: false
wrapped: false
FXLMEntity:
maxLength: 10
minLength: 1
type: string
description: >-
FXLM Entity. If provided this Entity will be passed to FXLM for
pricing and settlement. Only one of or may be
provided. If neither is present the OLR to base number configuration
will be used. Echoed from customer request.
prefPrice:
maxLength: 1
type: string
description: >-
Preferred pricing indicator.
N - Default value for standard
pricing.
Value must be 'W' for Alipay Wallet payments, 'E' for
UPI Cards payment and ‘Z’ for Dandelion Wallet payments.
xml:
name: PrefPrice
attribute: false
wrapped: false
rqUID:
maxLength: 35
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Customer Ref No for the request. Ref. No for this BankSvcRq message
block. Unique Reference.
xml:
name: RqUID
attribute: false
wrapped: false
spname:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Always set to CTSI
WLFlag:
maxLength: 1
type: string
description: >-
Account processing and settlement. W - Standard WorldLink account
processing and settlement
N- Bypass all WorldLink account
processing and settlement. Pass the numeric detail TRN to FXLM.
O
- Bypass all WorldLink account processing and settlement. Pass the
OLR numeric sequence number as the TRN to FXLM.
If not provided
default will be W.
xml:
name: BankSvcRq_Type
attribute: false
wrapped: false
BankSvcRsType:
title: BankSvcRsType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
balInqRsAndAcctInqRsAndDepAcctStmtInqRs:
type: array
description: >-
refer to #/definitions/BalInqRs, and #/definitions/AcctInqRs, and
#/definitions/DepAcctStmtInqRs, and #/definitions/DepAcctSummStmtRs,
and #/definitions/CCAcctStmtInqRs, and
#/definitions/DepAcctTrnInqRs, and #/definitions/CCAcctTrnInqRs, and
#/definitions/CntrlDisbTrnInqRs, and
#/definitions/BankAcctTrnImgInqRs, and #/definitions/IntRateInqRs,
and #/definitions/BankAcctTaxInqRs, and
#/definitions/ForExRateInqRs, and
#/definitions/ForExConfSettlRsType, and
#/definitions/ForExConfSettlInqRsType, and
#/definitions/ConfDebitInqRsType, and
#/definitions/ConfCreditInqRsType, and
#/definitions/ForExRateDealAddRs, and #/definitions/PmtSchTrnRsType,
and #/definitions/PmtSchStmtRsType, and #/definitions/StopChkAddRs,
and #/definitions/StopChkCanRs, and #/definitions/StopChkInqRs, and
#/definitions/StopChkAudRs, and #/definitions/StopChkSyncRs, and
#/definitions/XferAddRs, and #/definitions/XferModRs, and
#/definitions/XferStatusModRs, and #/definitions/XferCanRs, and
#/definitions/XferInqRs, and #/definitions/XferAudRs, and
#/definitions/XferSyncRs, and #/definitions/RecXferAddRs, and
#/definitions/RecXferModRs, and #/definitions/RecXferCanRs, and
#/definitions/RecXferInqRs, and #/definitions/RecXferAudRs, and
#/definitions/RecXferSyncRs, and #/definitions/ChkOrdAddRs, and
#/definitions/ChkOrdModRsType, and #/definitions/ChkOrdCanRsType,
and #/definitions/ChkOrdInqRsType, and
#/definitions/ChkOrdSyncRsType, and
#/definitions/RecChkOrdAddRsType, and
#/definitions/RecChkOrdModRsType, and
#/definitions/RecChkOrdCanRsType, and
#/definitions/RecChkOrdInqRsType, and
#/definitions/RecChkOrdSyncRsType, and
#/definitions/RecChkOrdInstAddRsType, and
#/definitions/DepBkOrdAddRs, and #/definitions/DebitAuthAddRs, and
#/definitions/DebitAuthModRs, and #/definitions/DebitAuthCanRs, and
#/definitions/DebitAuthInqRs, and #/definitions/DebitAuthAudRs, and
#/definitions/DebitAuthSyncRs, and #/definitions/DebitAddRs, and
#/definitions/CreditAuthAddRs, and #/definitions/CreditAuthModRs,
and #/definitions/CreditAuthCanRs, and
#/definitions/CreditAuthInqRs, and #/definitions/CreditAuthAudRs,
and #/definitions/CreditAuthSyncRs, and #/definitions/CreditAddRs,
and #/definitions/DepAppAddRsType, and
#/definitions/DepAppModRsType, and #/definitions/DepAppCanRsType,
and #/definitions/DepAppInqRsType, and
#/definitions/DepAppAudRsType, and #/definitions/DepAppSyncRsType,
and #/definitions/WLInfoTlxRs, and #/definitions/WLInfoTlxInqRs, and
#/definitions/CustAcctRs
items:
type: object
properties: {}
baseNo:
maxLength: 10
minLength: 1
type: string
description: >-
FXLM Base Number. If provided this base number will be passed to
FXLM for pricing and settlement. Only one of or
may be provided. If neither is present the OLR to base
number configuration will be used. Echoed from customer request.
xml:
name: BaseNo
attribute: false
wrapped: false
dealType:
minLength: 1
type: string
description: >-
Deal type. Deal type- 'B' for all bench deals for bench fixing
rates
Deal type- `Q` for all real time quoted rate deals This
must be coordinated with QUOTED fixing type
Deal Type- 'O' book
per OLR parameters
Default value will be O, if not provided.
Echoed from customer request.
xml:
name: DealType
attribute: false
wrapped: false
fxlmentity:
maxLength: 10
minLength: 1
type: string
description: >-
FXLM Entity. If provided this Entity will be passed to FXLM for
pricing and settlement. Only one of or may be
provided. If neither is present the OLR to base number configuration
will be used.
prefPrice:
maxLength: 1
type: string
description: >-
Preferred pricing indicator.
N - Default value for standard
pricing.
Value must be 'W' for Alipay Wallet payments, 'E' for
UPI Cards payment and ‘Z’ for Dandelion Wallet payments.
xml:
name: PrefPrice
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
spname:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Always set to CTSI
status:
$ref: '#/components/schemas/StatusType'
wlflag:
maxLength: 1
minLength: 1
type: string
description: Account processing and settlement
xml:
name: BankSvcRs_Type
attribute: false
wrapped: false
BaseSvcProfInfo:
title: BaseSvcProfInfo
type: object
properties:
enrollProf:
$ref: '#/components/schemas/EnrollProf'
msgSupt:
type: array
xml:
name: MsgSupt
attribute: false
wrapped: false
items:
minLength: 1
type: string
optSupt:
type: array
xml:
name: OptSupt
attribute: false
wrapped: false
items:
minLength: 1
type: string
signonInfo:
$ref: '#/components/schemas/SignonInfo'
svcCore:
$ref: '#/components/schemas/SvcCoreType'
BaseSvcRqType:
title: BaseSvcRqType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
spname:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Always set to CTSI
svcProfInqRqAndHolInqRqAndCustAddRq:
type: array
description: >-
refers to
#/definitions/SvcProfInqRq,#/definitions/HolInqRq,#/definitions/CustAddRq,#/definitions/CustModRq,#/definitions/CustPswdModRq,#/definitions/CustAuthModRq,#/definitions/CustStatusModRq,#/definitions/CustDelRq,#/definitions/CustInqRq,#/definitions/CustIdInqRqType,#/definitions/CustAudRqType,#/definitions/CustSyncRq,#/definitions/CustSvcAddRq,#/definitions/CustSvcModRq,#/definitions/CustSvcStatusModRq,#/definitions/CustSvcDelRq,#/definitions/CustSvcAudRq,#/definitions/CustSvcSyncRq,#/definitions/SvcAcctIdModRq,#/definitions/SvcAcctAddRqType,#/definitions/SvcAcctModRqType,#/definitions/SvcAcctStatusModRq,#/definitions/SvcAcctDelRq,#/definitions/SvcAcctInqRq,#/definitions/SvcAcctAudRq,#/definitions/SvcAcctSyncRq,#/definitions/DiscInqRq,#/definitions/CustDiscStatusModRq,#/definitions/CustDiscInqRq,
items:
type: object
properties: {}
xml:
name: BaseSvcRq_Type
attribute: false
wrapped: false
BaseSvcRsType:
title: BaseSvcRsType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
spname:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Always set to CTSI
status:
$ref: '#/components/schemas/StatusType'
svcProfInqRsAndHolInqRsAndCustAddRs:
type: array
description: >-
#/definitions/SvcProfInqRs, and #/definitions/HolInqRs, and
#/definitions/CustAddRs, and #/definitions/CustModRs, and
#/definitions/CustPswdModRs, and #/definitions/CustAuthModRs, and
#/definitions/CustStatusModRs, and #/definitions/CustDelRs, and
#/definitions/CustInqRs, and #/definitions/CustIdInqRsType, and
#/definitions/CustAudRsType, and #/definitions/CustSyncRs, and
#/definitions/CustSvcAddRs, and #/definitions/CustSvcModRs, and
#/definitions/CustSvcStatusModRs, and #/definitions/CustSvcDelRs,
and #/definitions/CustSvcAudRs, and #/definitions/CustSvcSyncRs, and
#/definitions/SvcAcctAddRsType, and #/definitions/SvcAcctModRs, and
#/definitions/SvcAcctStatusModRs, and #/definitions/SvcAcctIdModRs,
and #/definitions/SvcAcctDelRs, and #/definitions/SvcAcctInqRs, and
#/definitions/SvcAcctAudRs, and #/definitions/SvcAcctSyncRs, and
#/definitions/DiscInqRs, and #/definitions/CustDiscStatusModRs, and
#/definitions/CustDiscInqRs
items:
type: object
properties: {}
xml:
name: BaseSvcRs_Type
attribute: false
wrapped: false
BatchInfoType:
title: BatchInfoType
type: object
properties:
count:
type: integer
format: int64
xml:
name: Count
attribute: false
wrapped: false
curAmt:
$ref: '#/components/schemas/CurAmt'
refInfo:
$ref: '#/components/schemas/RefInfo'
remitInfo:
type: array
xml:
name: RemitInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/RemitInfoType'
BillCounts:
title: BillCounts
type: object
properties:
billPmtStatusCounts:
type: array
xml:
name: BillPmtStatusCounts
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/BillPmtStatusCounts'
billStatusCounts:
type: array
xml:
name: BillStatusCounts
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/BillStatusCounts'
BillInfo:
title: BillInfo
type: object
properties:
billDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
billRefInfo:
maxLength: 80
minLength: 1
type: string
xml:
name: BillRefInfo
attribute: false
wrapped: false
billSummAmt:
type: array
xml:
name: BillSummAmt
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/BillSummAmt'
billType:
minLength: 1
type: string
xml:
name: BillType
attribute: false
wrapped: false
closeDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
custId:
$ref: '#/components/schemas/CustId'
dueDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
memo:
maxLength: 1024
minLength: 1
type: string
xml:
name: Memo
attribute: false
wrapped: false
notifyReqd:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: NotifyReqd
attribute: false
wrapped: false
enum:
- '0'
- '1'
openDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
pmtInst:
type: array
xml:
name: PmtInst
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/PmtInst'
presAcctId:
$ref: '#/components/schemas/PresAcctId'
stmtImage:
$ref: '#/components/schemas/StmtImage'
viewDtlPref:
minLength: 1
type: string
xml:
name: ViewDtlPref
attribute: false
wrapped: false
BillInqRq:
title: BillInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
billId:
type: array
xml:
name: BillId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
billPmtStatusCode:
type: array
xml:
name: BillPmtStatusCode
attribute: false
wrapped: false
items:
minLength: 1
type: string
billStatusCode:
type: array
xml:
name: BillStatusCode
attribute: false
wrapped: false
items:
minLength: 1
type: string
billType:
type: array
xml:
name: BillType
attribute: false
wrapped: false
items:
minLength: 1
type: string
billerId:
type: array
xml:
name: BillerId
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/BillerId'
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
incCounts:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncCounts
attribute: false
wrapped: false
enum:
- '0'
- '1'
incSummary:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncSummary
attribute: false
wrapped: false
enum:
- '0'
- '1'
notifyWilling:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: NotifyWilling
attribute: false
wrapped: false
enum:
- '0'
- '1'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
spname:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Always set to CTSI
xml:
name: BillInqRq
attribute: false
wrapped: false
BillInqRs:
title: BillInqRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
billCounts:
type: array
xml:
name: BillCounts
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/BillCounts'
billId:
type: array
xml:
name: BillId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
billPmtStatusCode:
type: array
xml:
name: BillPmtStatusCode
attribute: false
wrapped: false
items:
minLength: 1
type: string
billRec:
type: array
xml:
name: BillRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/BillRec'
billStatusCode:
type: array
xml:
name: BillStatusCode
attribute: false
wrapped: false
items:
minLength: 1
type: string
billType:
type: array
xml:
name: BillType
attribute: false
wrapped: false
items:
minLength: 1
type: string
billerId:
type: array
xml:
name: BillerId
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/BillerId'
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
incCounts:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncCounts
attribute: false
wrapped: false
enum:
- '0'
- '1'
incSummary:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncSummary
attribute: false
wrapped: false
enum:
- '0'
- '1'
notifyWilling:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: NotifyWilling
attribute: false
wrapped: false
enum:
- '0'
- '1'
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
status:
$ref: '#/components/schemas/StatusType'
xml:
name: BillInqRs
attribute: false
wrapped: false
BillPmtStatus:
title: BillPmtStatus
type: object
properties:
billPmtStatusCode:
minLength: 1
type: string
description: StatusCode as Per IFX XML
xml:
name: BillPmtStatusCode
attribute: false
wrapped: false
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
memo:
maxLength: 1024
minLength: 1
type: string
xml:
name: Memo
attribute: false
wrapped: false
pmtId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: PmtId
attribute: false
wrapped: false
statusModBy:
minLength: 1
type: string
xml:
name: StatusModBy
attribute: false
wrapped: false
BillPmtStatusCounts:
title: BillPmtStatusCounts
type: object
properties:
billPmtStatusCode:
minLength: 1
type: string
description: StatusCode as Per IFX XML
xml:
name: BillPmtStatusCode
attribute: false
wrapped: false
count:
type: integer
format: int64
xml:
name: Count
attribute: false
wrapped: false
BillRec:
title: BillRec
type: object
properties:
billId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: BillId
attribute: false
wrapped: false
billInfo:
$ref: '#/components/schemas/BillInfo'
billPmtStatus:
$ref: '#/components/schemas/BillPmtStatus'
billStatus:
$ref: '#/components/schemas/BillStatus'
BillRetAddr:
title: BillRetAddr
type: object
properties:
addr1:
maxLength: 35
minLength: 1
type: string
xml:
name: Addr1
attribute: false
wrapped: false
addr2:
maxLength: 35
minLength: 1
type: string
xml:
name: Addr2
attribute: false
wrapped: false
addr3:
maxLength: 35
minLength: 1
type: string
xml:
name: Addr3
attribute: false
wrapped: false
addr4:
maxLength: 35
minLength: 1
type: string
xml:
name: Addr4
attribute: false
wrapped: false
addrType:
minLength: 1
type: string
xml:
name: AddrType
attribute: false
wrapped: false
city:
maxLength: 35
minLength: 1
type: string
xml:
name: City
attribute: false
wrapped: false
country:
maxLength: 35
minLength: 1
type: string
xml:
name: Country
attribute: false
wrapped: false
endDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: EndDt
attribute: false
wrapped: false
postalCode:
maxLength: 35
minLength: 1
type: string
xml:
name: PostalCode
attribute: false
wrapped: false
startDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: StartDt
attribute: false
wrapped: false
stateProv:
maxLength: 32
minLength: 1
type: string
xml:
name: StateProv
attribute: false
wrapped: false
BillStatus:
title: BillStatus
type: object
properties:
billStatusCode:
minLength: 1
type: string
description: StatusCode as Per IFX XML
xml:
name: BillStatusCode
attribute: false
wrapped: false
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
memo:
maxLength: 1024
minLength: 1
type: string
xml:
name: Memo
attribute: false
wrapped: false
statusDesc:
maxLength: 255
minLength: 1
type: string
description: Text description for status code
xml:
name: StatusDesc
attribute: false
wrapped: false
statusModBy:
minLength: 1
type: string
xml:
name: StatusModBy
attribute: false
wrapped: false
BillStatusCounts:
title: BillStatusCounts
type: object
properties:
billStatusCode:
minLength: 1
type: string
description: StatusCode as Per IFX XML
xml:
name: BillStatusCode
attribute: false
wrapped: false
count:
type: integer
format: int64
xml:
name: Count
attribute: false
wrapped: false
BillStatusModRq:
title: BillStatusModRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
billId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: BillId
attribute: false
wrapped: false
billPmtStatus:
$ref: '#/components/schemas/BillPmtStatus'
billStatus:
$ref: '#/components/schemas/BillStatus'
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: BillStatusModRq
attribute: false
wrapped: false
BillStatusModRs:
title: BillStatusModRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
billId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: BillId
attribute: false
wrapped: false
billPmtStatus:
$ref: '#/components/schemas/BillPmtStatus'
billStatus:
$ref: '#/components/schemas/BillStatus'
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
xml:
name: BillStatusModRs
attribute: false
wrapped: false
BillSummAmt:
title: BillSummAmt
type: object
properties:
billSummAmtCode:
minLength: 1
type: string
xml:
name: BillSummAmtCode
attribute: false
wrapped: false
billSummAmtId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: BillSummAmtId
attribute: false
wrapped: false
billSummAmtType:
minLength: 1
type: string
xml:
name: BillSummAmtType
attribute: false
wrapped: false
billSummSubAmt:
type: array
xml:
name: BillSummSubAmt
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/BillSummSubAmt'
curAmt:
$ref: '#/components/schemas/CurAmt'
desc:
maxLength: 80
minLength: 1
type: string
xml:
name: Desc
attribute: false
wrapped: false
memo:
maxLength: 1024
minLength: 1
type: string
xml:
name: Memo
attribute: false
wrapped: false
shortDesc:
maxLength: 15
minLength: 1
type: string
xml:
name: ShortDesc
attribute: false
wrapped: false
BillSummSubAmt:
title: BillSummSubAmt
type: object
properties:
allocateAllowed:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: AllocateAllowed
attribute: false
wrapped: false
enum:
- '0'
- '1'
billSummAmtId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: BillSummAmtId
attribute: false
wrapped: false
curAmt:
$ref: '#/components/schemas/CurAmt'
desc:
maxLength: 80
minLength: 1
type: string
xml:
name: Desc
attribute: false
wrapped: false
memo:
maxLength: 1024
minLength: 1
type: string
xml:
name: Memo
attribute: false
wrapped: false
shortDesc:
maxLength: 15
minLength: 1
type: string
xml:
name: ShortDesc
attribute: false
wrapped: false
BillerAcctIdInfo:
title: BillerAcctIdInfo
type: object
properties:
acctFormat:
maxLength: 1024
minLength: 1
type: string
xml:
name: AcctFormat
attribute: false
wrapped: false
acctHelpMsg:
minLength: 1
type: string
xml:
name: AcctHelpMsg
attribute: false
wrapped: false
acctMask:
type: array
xml:
name: AcctMask
attribute: false
wrapped: false
items:
maxLength: 32
minLength: 1
type: string
acctRestrictMsg:
maxLength: 1024
minLength: 1
type: string
xml:
name: AcctRestrictMsg
attribute: false
wrapped: false
acctValidateURL:
maxLength: 1024
minLength: 1
type: string
xml:
name: AcctValidateURL
attribute: false
wrapped: false
BillerContactType:
title: BillerContactType
type: object
properties:
billRetAddr:
$ref: '#/components/schemas/BillRetAddr'
contactInfo:
type: array
xml:
name: ContactInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/ContactInfo'
legalName:
maxLength: 35
minLength: 1
type: string
xml:
name: LegalName
attribute: false
wrapped: false
name:
maxLength: 40
minLength: 1
type: string
xml:
name: Name
attribute: false
wrapped: false
orgContact:
type: array
xml:
name: OrgContact
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/OrgContact'
postAddr:
$ref: '#/components/schemas/PostAddr'
remitAddr:
$ref: '#/components/schemas/RemitAddr'
remitName:
maxLength: 40
minLength: 1
type: string
xml:
name: RemitName
attribute: false
wrapped: false
BillerId:
title: BillerId
type: object
properties:
billerNum:
maxLength: 36
minLength: 1
type: string
xml:
name: BillerNum
attribute: false
wrapped: false
spname:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Always set to CTSI
BillerInfo:
title: BillerInfo
type: object
properties:
billerAcctIdInfo:
$ref: '#/components/schemas/BillerAcctIdInfo'
billerContact:
$ref: '#/components/schemas/BillerContactType'
billerEnrollURL:
maxLength: 1024
minLength: 1
type: string
xml:
name: BillerEnrollURL
attribute: false
wrapped: false
billerPayInfo:
$ref: '#/components/schemas/BillerPayInfo'
cspcustInfoReq:
type: string
enum:
- '0'
- '1'
discDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
discId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: DiscId
attribute: false
wrapped: false
discReqd:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: DiscReqd
attribute: false
wrapped: false
enum:
- '0'
- '1'
histRetentionDays:
type: integer
format: int64
xml:
name: HistRetentionDays
attribute: false
wrapped: false
industId:
$ref: '#/components/schemas/IndustId'
logo:
$ref: '#/components/schemas/Logo'
logoURL:
maxLength: 1024
minLength: 1
type: string
xml:
name: LogoURL
attribute: false
wrapped: false
name:
maxLength: 40
minLength: 1
type: string
xml:
name: Name
attribute: false
wrapped: false
secretPromptAndCryptType:
type: array
items:
type: object
properties: {}
BillerInqRq:
title: BillerInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
billerId:
type: array
xml:
name: BillerId
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/BillerId'
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
incBillerContact:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncBillerContact
attribute: false
wrapped: false
enum:
- '0'
- '1'
incImages:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncImages
attribute: false
wrapped: false
enum:
- '0'
- '1'
industId:
type: array
xml:
name: IndustId
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/IndustId'
name:
type: array
xml:
name: Name
attribute: false
wrapped: false
items:
maxLength: 40
minLength: 1
type: string
phone:
type: array
xml:
name: Phone
attribute: false
wrapped: false
items:
minLength: 1
type: string
postAddr:
type: array
xml:
name: PostAddr
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/PostAddr'
postalCode:
type: array
xml:
name: PostalCode
attribute: false
wrapped: false
items:
maxLength: 35
minLength: 1
type: string
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
upDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
xml:
name: BillerInqRq
attribute: false
wrapped: false
BillerInqRs:
title: BillerInqRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
billerId:
type: array
xml:
name: BillerId
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/BillerId'
billerRec:
type: array
xml:
name: BillerRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/BillerRec'
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
incBillerContact:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncBillerContact
attribute: false
wrapped: false
enum:
- '0'
- '1'
incImages:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncImages
attribute: false
wrapped: false
enum:
- '0'
- '1'
industId:
type: array
xml:
name: IndustId
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/IndustId'
name:
type: array
xml:
name: Name
attribute: false
wrapped: false
items:
maxLength: 40
minLength: 1
type: string
newUpDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
phone:
type: array
xml:
name: Phone
attribute: false
wrapped: false
items:
minLength: 1
type: string
postAddr:
type: array
xml:
name: PostAddr
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/PostAddr'
postalCode:
type: array
xml:
name: PostalCode
attribute: false
wrapped: false
items:
maxLength: 35
minLength: 1
type: string
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
upDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
xml:
name: BillerInqRs
attribute: false
wrapped: false
BillerPayInfo:
title: BillerPayInfo
type: object
properties:
daysToEPost:
type: integer
format: int64
xml:
name: DaysToEPost
attribute: false
wrapped: false
pmtInst:
type: array
xml:
name: PmtInst
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/PmtInst'
prenoteReqd:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: PrenoteReqd
attribute: false
wrapped: false
enum:
- '0'
- '1'
BillerPayee:
title: BillerPayee
type: object
properties:
billerContact:
$ref: '#/components/schemas/BillerContactType'
billerId:
$ref: '#/components/schemas/BillerId'
billerPayInfo:
$ref: '#/components/schemas/BillerPayInfo'
histRetentionDays:
type: integer
format: int64
xml:
name: HistRetentionDays
attribute: false
wrapped: false
BillerRec:
title: BillerRec
type: object
properties:
billerId:
type: array
xml:
name: BillerId
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/BillerId'
billerInfo:
$ref: '#/components/schemas/BillerInfo'
billerStatus:
$ref: '#/components/schemas/BillerStatus'
bspreferTo:
$ref: '#/components/schemas/BSPReferTo'
BillerStatus:
title: BillerStatus
type: object
properties:
billerStatusCode:
minLength: 1
type: string
description: StatusCode as Per IFX XML
xml:
name: BillerStatusCode
attribute: false
wrapped: false
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
memo:
maxLength: 1024
minLength: 1
type: string
xml:
name: Memo
attribute: false
wrapped: false
statusDesc:
maxLength: 255
minLength: 1
type: string
description: Text description for status code
xml:
name: StatusDesc
attribute: false
wrapped: false
statusModBy:
minLength: 1
type: string
xml:
name: StatusModBy
attribute: false
wrapped: false
BillingAddr:
title: BillingAddr
type: object
properties:
addr1:
maxLength: 35
minLength: 1
type: string
xml:
name: Addr1
attribute: false
wrapped: false
addr2:
maxLength: 35
minLength: 1
type: string
xml:
name: Addr2
attribute: false
wrapped: false
addr3:
maxLength: 35
minLength: 1
type: string
xml:
name: Addr3
attribute: false
wrapped: false
addr4:
maxLength: 35
minLength: 1
type: string
xml:
name: Addr4
attribute: false
wrapped: false
addrType:
minLength: 1
type: string
xml:
name: AddrType
attribute: false
wrapped: false
city:
maxLength: 35
minLength: 1
type: string
xml:
name: City
attribute: false
wrapped: false
country:
maxLength: 35
minLength: 1
type: string
xml:
name: Country
attribute: false
wrapped: false
endDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: EndDt
attribute: false
wrapped: false
postalCode:
maxLength: 35
minLength: 1
type: string
xml:
name: PostalCode
attribute: false
wrapped: false
startDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: StartDt
attribute: false
wrapped: false
stateProv:
maxLength: 32
minLength: 1
type: string
xml:
name: StateProv
attribute: false
wrapped: false
xml:
name: BillingAddr
attribute: false
wrapped: false
Binary:
title: Binary
type: object
properties:
binData:
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
type: string
format: byte
xml:
name: BinData
attribute: false
wrapped: false
binLength:
type: integer
format: int64
xml:
name: BinLength
attribute: false
wrapped: false
contentType:
minLength: 1
type: string
xml:
name: ContentType
attribute: false
wrapped: false
description: >-
The Binary data type is a compound type consisting of threee logical
elements.
xml:
name: Binary
attribute: false
wrapped: false
BrkrCommType:
title: BrkrCommType
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
BuyAmtType:
title: BuyAmtType
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
CBRInfoType:
title: CBRInfoType
type: object
properties:
cbrtagName:
maxLength: 8
minLength: 1
type: string
cbrtagValue:
maxLength: 8
minLength: 1
type: string
CBRType:
title: CBRType
type: object
properties:
cbrcountryCode:
maxLength: 8
minLength: 1
type: string
cbrcountryName:
maxLength: 8
minLength: 1
type: string
cbrinfo:
type: array
items:
$ref: '#/components/schemas/CBRInfoType'
CCAcctRec:
title: CCAcctRec
type: object
properties:
dueDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
expDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
description: Contract Expiry Datetime
xml:
name: ExpDt
attribute: false
wrapped: false
lastPmtCurAmt:
$ref: '#/components/schemas/LastPmtCurAmt'
lastPmtDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
CCAcctStmtInqRq:
title: CCAcctStmtInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
incDetail:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncDetail
attribute: false
wrapped: false
enum:
- '0'
- '1'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
xml:
name: CCAcctStmtInqRq
attribute: false
wrapped: false
CCAcctStmtInqRs:
title: CCAcctStmtInqRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
ccacctStmtRec:
type: array
items:
$ref: '#/components/schemas/CCAcctStmtRec'
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
incDetail:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncDetail
attribute: false
wrapped: false
enum:
- '0'
- '1'
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
status:
$ref: '#/components/schemas/StatusType'
xml:
name: CCAcctStmtInqRs
attribute: false
wrapped: false
CCAcctStmtRec:
title: CCAcctStmtRec
type: object
properties:
acctBal:
type: array
xml:
name: AcctBal
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/AcctBal'
ccacctTrnRec:
type: array
items:
$ref: '#/components/schemas/CCAcctTrnRec'
delinqAging:
type: array
xml:
name: DelinqAging
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/DelinqAging'
dueDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
endDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: EndDt
attribute: false
wrapped: false
extAcctBal:
type: array
xml:
name: ExtAcctBal
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/ExtAcctBal'
minAmtDue:
$ref: '#/components/schemas/MinAmtDue'
mktgInfo:
maxLength: 255
minLength: 1
type: string
xml:
name: MktgInfo
attribute: false
wrapped: false
nextDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: NextDt
attribute: false
wrapped: false
sprefId:
type: string
startDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: StartDt
attribute: false
wrapped: false
stmtSummAmt:
type: array
xml:
name: StmtSummAmt
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/StmtSummAmt'
url:
maxLength: 1024
minLength: 1
type: string
xml:
name: URL
attribute: false
wrapped: false
CCAcctTrnInqRq:
title: CCAcctTrnInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
csprefId:
type: array
items:
maxLength: 36
minLength: 1
type: string
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeCurAmt:
$ref: '#/components/schemas/SelRangeCurAmt'
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
sprefId:
type: array
items:
type: string
trnSrc:
type: array
xml:
name: TrnSrc
attribute: false
wrapped: false
items:
minLength: 1
type: string
trnType:
type: array
xml:
name: TrnType
attribute: false
wrapped: false
items:
minLength: 1
type: string
xml:
name: CCAcctTrnInqRq
attribute: false
wrapped: false
CCAcctTrnInqRs:
title: CCAcctTrnInqRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
ccacctTrnRec:
type: array
items:
$ref: '#/components/schemas/CCAcctTrnRec'
csprefId:
type: array
items:
maxLength: 36
minLength: 1
type: string
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
mktgInfo:
maxLength: 255
minLength: 1
type: string
xml:
name: MktgInfo
attribute: false
wrapped: false
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeCurAmt:
$ref: '#/components/schemas/SelRangeCurAmt'
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
sprefId:
type: array
items:
type: string
status:
$ref: '#/components/schemas/StatusType'
trnSrc:
type: array
xml:
name: TrnSrc
attribute: false
wrapped: false
items:
minLength: 1
type: string
trnType:
type: array
xml:
name: TrnType
attribute: false
wrapped: false
items:
minLength: 1
type: string
xml:
name: CCAcctTrnInqRs
attribute: false
wrapped: false
CCAcctTrnRec:
title: CCAcctTrnRec
type: object
properties:
bankAcctTrnRec:
$ref: '#/components/schemas/BankAcctTrnRec'
memo:
maxLength: 1024
minLength: 1
type: string
xml:
name: Memo
attribute: false
wrapped: false
salesSlipRefNum:
maxLength: 23
minLength: 1
type: string
xml:
name: SalesSlipRefNum
attribute: false
wrapped: false
CCMotoAcct:
title: CCMotoAcct
type: object
properties:
brand:
minLength: 1
type: string
xml:
name: Brand
attribute: false
wrapped: false
expDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
description: Contract Expiry Datetime
xml:
name: ExpDt
attribute: false
wrapped: false
name:
maxLength: 40
minLength: 1
type: string
xml:
name: Name
attribute: false
wrapped: false
phone:
minLength: 1
type: string
xml:
name: Phone
attribute: false
wrapped: false
postAddr:
$ref: '#/components/schemas/PostAddr'
postalCode:
maxLength: 35
minLength: 1
type: string
xml:
name: PostalCode
attribute: false
wrapped: false
CardAcctId:
title: CardAcctId
type: object
properties:
acctId:
maxLength: 255
minLength: 1
pattern: '[^"']*'
type: string
description: FROM account number
xml:
name: AcctId
attribute: false
wrapped: false
acctType:
minLength: 1
type: string
description: FROM account type
xml:
name: AcctType
attribute: false
wrapped: false
cardMagData:
$ref: '#/components/schemas/CardMagDataType'
ccmotoAcct:
$ref: '#/components/schemas/CCMotoAcct'
CardAcctIdFrom:
title: CardAcctIdFrom
type: object
properties:
acctId:
maxLength: 255
minLength: 1
pattern: '[^"']*'
type: string
description: FROM account number
xml:
name: AcctId
attribute: false
wrapped: false
acctType:
minLength: 1
type: string
xml:
name: AcctType
attribute: false
wrapped: false
cardMagData:
$ref: '#/components/schemas/CardMagDataType'
ccmotoAcct:
$ref: '#/components/schemas/CCMotoAcct'
CardAcctIdTo:
title: CardAcctIdTo
type: object
properties:
acctId:
maxLength: 255
minLength: 1
pattern: '[^"']*'
type: string
description: FROM account number
xml:
name: AcctId
attribute: false
wrapped: false
acctType:
minLength: 1
type: string
xml:
name: AcctType
attribute: false
wrapped: false
cardMagData:
$ref: '#/components/schemas/CardMagDataType'
ccmotoAcct:
$ref: '#/components/schemas/CCMotoAcct'
CardAcctIdType:
title: CardAcctIdType
type: object
properties:
acctId:
maxLength: 255
minLength: 1
pattern: '[^"']*'
type: string
description: FROM account number
xml:
name: AcctId
attribute: false
wrapped: false
acctType:
minLength: 1
type: string
xml:
name: AcctType
attribute: false
wrapped: false
cardMagData:
$ref: '#/components/schemas/CardMagDataType'
ccmotoAcct:
$ref: '#/components/schemas/CCMotoAcct'
xml:
name: CardAcctId_Type
attribute: false
wrapped: false
CardMagDataType:
title: CardMagDataType
type: object
properties:
magData1:
maxLength: 79
minLength: 1
type: string
xml:
name: MagData1
attribute: false
wrapped: false
magData2:
maxLength: 40
minLength: 1
type: string
xml:
name: MagData2
attribute: false
wrapped: false
magData3:
maxLength: 107
minLength: 1
type: string
xml:
name: MagData3
attribute: false
wrapped: false
Certificate:
title: Certificate
type: object
properties:
binData:
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
type: string
format: byte
xml:
name: BinData
attribute: false
wrapped: false
binLength:
type: integer
format: int64
xml:
name: BinLength
attribute: false
wrapped: false
contentType:
minLength: 1
type: string
xml:
name: ContentType
attribute: false
wrapped: false
ChkInfo:
title: ChkInfo
type: object
properties:
chkNum:
maxLength: 12
minLength: 1
type: string
xml:
name: ChkNum
attribute: false
wrapped: false
memo:
maxLength: 1024
minLength: 1
type: string
xml:
name: Memo
attribute: false
wrapped: false
name:
maxLength: 40
minLength: 1
type: string
xml:
name: Name
attribute: false
wrapped: false
orgPhone:
minLength: 1
type: string
xml:
name: OrgPhone
attribute: false
wrapped: false
origDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
postAddr:
$ref: '#/components/schemas/PostAddr'
ChkOrdAddRq:
title: ChkOrdAddRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
chkOrdInfo:
$ref: '#/components/schemas/ChkOrdInfoType'
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: ChkOrdAddRq
attribute: false
wrapped: false
ChkOrdAddRs:
title: ChkOrdAddRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
chkOrdInfo:
$ref: '#/components/schemas/ChkOrdInfoType'
chkOrdRec:
$ref: '#/components/schemas/ChkOrdRec'
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
ChkOrdAudRqType:
title: ChkOrdAudRqType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
chkOrdId:
type: array
xml:
name: ChkOrdId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
custId:
$ref: '#/components/schemas/CustId'
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
recChkOrdId:
type: array
xml:
name: RecChkOrdId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
xml:
name: ChkOrdAudRq_Type
attribute: false
wrapped: false
ChkOrdAudRsType:
title: ChkOrdAudRsType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
chkOrdId:
type: array
xml:
name: ChkOrdId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
chkOrdMsgRec:
type: array
xml:
name: ChkOrdMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/ChkOrdMsgRecType'
custId:
$ref: '#/components/schemas/CustId'
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
recChkOrdId:
type: array
xml:
name: RecChkOrdId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
status:
$ref: '#/components/schemas/StatusType'
xml:
name: ChkOrdAudRs_Type
attribute: false
wrapped: false
ChkOrdCanRqType:
title: ChkOrdCanRqType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
chkOrdId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: ChkOrdId
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: ChkOrdCanRq_Type
attribute: false
wrapped: false
ChkOrdCanRsType:
title: ChkOrdCanRsType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
chkOrdId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: ChkOrdId
attribute: false
wrapped: false
chkOrdRec:
$ref: '#/components/schemas/ChkOrdRec'
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
ChkOrdDetailType:
title: ChkOrdDetailType
type: object
properties:
artWorkId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: ArtWorkId
attribute: false
wrapped: false
billingMethod:
minLength: 1
type: string
xml:
name: BillingMethod
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
chkBkStyleId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: ChkBkStyleId
attribute: false
wrapped: false
chkNumPrefix:
maxLength: 2
minLength: 1
type: string
xml:
name: ChkNumPrefix
attribute: false
wrapped: false
chkNumStart:
maxLength: 12
minLength: 1
type: string
xml:
name: ChkNumStart
attribute: false
wrapped: false
chkNumSuffix:
maxLength: 2
minLength: 1
type: string
xml:
name: ChkNumSuffix
attribute: false
wrapped: false
chkPrint:
$ref: '#/components/schemas/ChkPrintType'
chkText:
type: array
xml:
name: ChkText
attribute: false
wrapped: false
items:
maxLength: 80
minLength: 1
type: string
clubAcctId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: ClubAcctId
attribute: false
wrapped: false
count:
type: integer
format: int64
xml:
name: Count
attribute: false
wrapped: false
coverMngrm:
maxLength: 3
minLength: 1
type: string
xml:
name: CoverMngrm
attribute: false
wrapped: false
coverStyleId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: CoverStyleId
attribute: false
wrapped: false
custNameAddr:
type: array
xml:
name: CustNameAddr
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CustNameAddr'
deliveryDestination:
minLength: 1
type: string
xml:
name: DeliveryDestination
attribute: false
wrapped: false
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
depAcctId:
$ref: '#/components/schemas/DepAcctId'
fontId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: FontId
attribute: false
wrapped: false
incEndrsmntStmp:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncEndrsmntStmp
attribute: false
wrapped: false
enum:
- '0'
- '1'
incSecSigLine:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncSecSigLine
attribute: false
wrapped: false
enum:
- '0'
- '1'
loanAcctId:
$ref: '#/components/schemas/LoanAcctId'
ovrSigText:
maxLength: 40
minLength: 1
type: string
xml:
name: OvrSigText
attribute: false
wrapped: false
personInfo:
type: array
xml:
name: PersonInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/PersonInfo'
voucherTypeId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: VoucherTypeId
attribute: false
wrapped: false
ChkOrdInfoType:
title: ChkOrdInfoType
type: object
properties:
artWorkId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: ArtWorkId
attribute: false
wrapped: false
billingMethod:
minLength: 1
type: string
xml:
name: BillingMethod
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
chkBkStyleId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: ChkBkStyleId
attribute: false
wrapped: false
chkNumPrefix:
maxLength: 2
minLength: 1
type: string
xml:
name: ChkNumPrefix
attribute: false
wrapped: false
chkNumStart:
maxLength: 12
minLength: 1
type: string
xml:
name: ChkNumStart
attribute: false
wrapped: false
chkNumSuffix:
maxLength: 2
minLength: 1
type: string
xml:
name: ChkNumSuffix
attribute: false
wrapped: false
chkPrint:
$ref: '#/components/schemas/ChkPrintType'
chkText:
type: array
xml:
name: ChkText
attribute: false
wrapped: false
items:
maxLength: 80
minLength: 1
type: string
clubAcctId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: ClubAcctId
attribute: false
wrapped: false
count:
type: integer
format: int64
xml:
name: Count
attribute: false
wrapped: false
coverMngrm:
maxLength: 3
minLength: 1
type: string
xml:
name: CoverMngrm
attribute: false
wrapped: false
coverStyleId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: CoverStyleId
attribute: false
wrapped: false
custNameAddr:
type: array
xml:
name: CustNameAddr
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CustNameAddr'
deliveryDestination:
minLength: 1
type: string
xml:
name: DeliveryDestination
attribute: false
wrapped: false
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
depAcctId:
$ref: '#/components/schemas/DepAcctId'
fontId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: FontId
attribute: false
wrapped: false
incEndrsmntStmp:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncEndrsmntStmp
attribute: false
wrapped: false
enum:
- '0'
- '1'
incSecSigLine:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncSecSigLine
attribute: false
wrapped: false
enum:
- '0'
- '1'
loanAcctId:
$ref: '#/components/schemas/LoanAcctId'
ovrSigText:
maxLength: 40
minLength: 1
type: string
xml:
name: OvrSigText
attribute: false
wrapped: false
personInfo:
type: array
xml:
name: PersonInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/PersonInfo'
voucherTypeId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: VoucherTypeId
attribute: false
wrapped: false
ChkOrdInqRqType:
title: ChkOrdInqRqType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
chkOrdId:
type: array
xml:
name: ChkOrdId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
custId:
$ref: '#/components/schemas/CustId'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
loanAcctId:
$ref: '#/components/schemas/LoanAcctId'
recChkOrdId:
type: array
xml:
name: RecChkOrdId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
xml:
name: ChkOrdInqRq_Type
attribute: false
wrapped: false
ChkOrdInqRsType:
title: ChkOrdInqRsType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
chkOrdId:
type: array
xml:
name: ChkOrdId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
chkOrdRec:
type: array
xml:
name: ChkOrdRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/ChkOrdRec'
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
loanAcctId:
$ref: '#/components/schemas/LoanAcctId'
recChkOrdId:
type: array
xml:
name: RecChkOrdId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
xml:
name: ChkOrdInqRs_Type
attribute: false
wrapped: false
ChkOrdModRqType:
title: ChkOrdModRqType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
chkOrdId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: ChkOrdId
attribute: false
wrapped: false
chkOrdInfo:
$ref: '#/components/schemas/ChkOrdInfoType'
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: ChkOrdModRq_Type
attribute: false
wrapped: false
ChkOrdModRsType:
title: ChkOrdModRsType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
chkOrdId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: ChkOrdId
attribute: false
wrapped: false
chkOrdInfo:
$ref: '#/components/schemas/ChkOrdInfoType'
chkOrdRec:
$ref: '#/components/schemas/ChkOrdRec'
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
ChkOrdMsgRecType:
title: ChkOrdMsgRecType
type: object
properties:
chkOrdAddRs:
$ref: '#/components/schemas/ChkOrdAddRs'
chkOrdCanRs:
$ref: '#/components/schemas/ChkOrdCanRsType'
chkOrdModRs:
$ref: '#/components/schemas/ChkOrdModRsType'
custId:
type: array
xml:
name: CustId
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CustId'
msgRecDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: MsgRecDt
attribute: false
wrapped: false
ChkOrdRec:
title: ChkOrdRec
type: object
properties:
chkOrdId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: ChkOrdId
attribute: false
wrapped: false
chkOrdInfo:
$ref: '#/components/schemas/ChkOrdInfoType'
chkOrdStatus:
$ref: '#/components/schemas/ChkOrdStatus'
ChkOrdStatus:
title: ChkOrdStatus
type: object
properties:
chkOrdStatusCode:
minLength: 1
type: string
description: StatusCode as Per IFX XML
xml:
name: ChkOrdStatusCode
attribute: false
wrapped: false
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
resolvePendingDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
statusDesc:
maxLength: 255
minLength: 1
type: string
description: Text description for status code
xml:
name: StatusDesc
attribute: false
wrapped: false
statusModBy:
minLength: 1
type: string
xml:
name: StatusModBy
attribute: false
wrapped: false
ChkOrdSyncRqType:
title: ChkOrdSyncRqType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
chkOrdId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: ChkOrdId
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: ChkOrdSyncRq_Type
attribute: false
wrapped: false
ChkOrdSyncRsType:
title: ChkOrdSyncRsType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
chkOrdId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: ChkOrdId
attribute: false
wrapped: false
chkOrdMsgRec:
type: array
xml:
name: ChkOrdMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/ChkOrdMsgRecType'
custId:
$ref: '#/components/schemas/CustId'
newToken:
maxLength: 36
minLength: 1
type: string
xml:
name: NewToken
attribute: false
wrapped: false
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: ChkOrdSyncRs_Type
attribute: false
wrapped: false
ChkPrintType:
title: ChkPrintType
type: object
properties:
custName:
type: array
xml:
name: CustName
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CustName'
desc:
maxLength: 80
minLength: 1
type: string
xml:
name: Desc
attribute: false
wrapped: false
personName:
type: array
xml:
name: PersonName
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/PersonName'
phone:
minLength: 1
type: string
xml:
name: Phone
attribute: false
wrapped: false
postAddr:
$ref: '#/components/schemas/PostAddr'
ChkRangeType:
title: ChkRangeType
type: object
properties:
chkNumEnd:
maxLength: 12
minLength: 1
type: string
xml:
name: ChkNumEnd
attribute: false
wrapped: false
chkNumStart:
maxLength: 12
minLength: 1
type: string
xml:
name: ChkNumStart
attribute: false
wrapped: false
Chksum:
title: Chksum
type: object
properties:
chksumType:
minLength: 1
type: string
xml:
name: ChksumType
attribute: false
wrapped: false
chksumValue:
type: number
xml:
name: ChksumValue
attribute: false
wrapped: false
ChksumAddRq:
title: ChksumAddRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
chksumInfo:
$ref: '#/components/schemas/ChksumInfo'
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
svcRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: SvcRqUID
attribute: false
wrapped: false
xml:
name: ChksumAddRq
attribute: false
wrapped: false
ChksumAddRs:
title: ChksumAddRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
chksumInfo:
$ref: '#/components/schemas/ChksumInfo'
chksumRec:
$ref: '#/components/schemas/ChksumRec'
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
svcRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: SvcRqUID
attribute: false
wrapped: false
ChksumAudRq:
title: ChksumAudRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
chksumId:
type: array
xml:
name: ChksumId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
custId:
$ref: '#/components/schemas/CustId'
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
xml:
name: ChksumAudRq
attribute: false
wrapped: false
ChksumAudRs:
title: ChksumAudRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
chksumId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: ChksumId
attribute: false
wrapped: false
chksumMsgRec:
type: array
xml:
name: ChksumMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/ChksumMsgRec'
custId:
$ref: '#/components/schemas/CustId'
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
status:
$ref: '#/components/schemas/StatusType'
xml:
name: ChksumAudRs
attribute: false
wrapped: false
ChksumDelRq:
title: ChksumDelRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
chksumId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: ChksumId
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
svcRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: SvcRqUID
attribute: false
wrapped: false
xml:
name: ChksumDelRq
attribute: false
wrapped: false
ChksumDelRs:
title: ChksumDelRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
chksumId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: ChksumId
attribute: false
wrapped: false
chksumRec:
$ref: '#/components/schemas/ChksumRec'
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
svcRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: SvcRqUID
attribute: false
wrapped: false
ChksumInfo:
title: ChksumInfo
type: object
properties:
chksum:
type: array
xml:
name: Chksum
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/Chksum'
count:
type: integer
format: int64
xml:
name: Count
attribute: false
wrapped: false
msgType:
minLength: 1
type: string
xml:
name: MsgType
attribute: false
wrapped: false
refInfo:
$ref: '#/components/schemas/RefInfo'
ChksumInqRq:
title: ChksumInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
chksumId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: ChksumId
attribute: false
wrapped: false
chksumStatusCode:
minLength: 1
type: string
description: StatusCode as Per IFX XML
xml:
name: ChksumStatusCode
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
svcRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: SvcRqUID
attribute: false
wrapped: false
xml:
name: ChksumInqRq
attribute: false
wrapped: false
ChksumInqRs:
title: ChksumInqRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
chksumId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: ChksumId
attribute: false
wrapped: false
chksumRec:
$ref: '#/components/schemas/ChksumRec'
chksumStatusCode:
minLength: 1
type: string
description: StatusCode as Per IFX XML
xml:
name: ChksumStatusCode
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
svcRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: SvcRqUID
attribute: false
wrapped: false
xml:
name: ChksumInqRs
attribute: false
wrapped: false
ChksumModRq:
title: ChksumModRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
chksumId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: ChksumId
attribute: false
wrapped: false
chksumInfo:
$ref: '#/components/schemas/ChksumInfo'
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
svcRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: SvcRqUID
attribute: false
wrapped: false
xml:
name: ChksumModRq
attribute: false
wrapped: false
ChksumModRs:
title: ChksumModRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
chksumId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: ChksumId
attribute: false
wrapped: false
chksumInfo:
$ref: '#/components/schemas/ChksumInfo'
chksumRec:
$ref: '#/components/schemas/ChksumRec'
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
svcRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: SvcRqUID
attribute: false
wrapped: false
ChksumMsgRec:
title: ChksumMsgRec
type: object
properties:
chksumAddRs:
$ref: '#/components/schemas/ChksumAddRs'
chksumDelRs:
$ref: '#/components/schemas/ChksumDelRs'
chksumModRs:
$ref: '#/components/schemas/ChksumModRs'
chksumStatusModRs:
$ref: '#/components/schemas/ChksumStatusModRs'
custId:
$ref: '#/components/schemas/CustId'
msgRecDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: MsgRecDt
attribute: false
wrapped: false
ChksumRec:
title: ChksumRec
type: object
properties:
chksumId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: ChksumId
attribute: false
wrapped: false
chksumInfo:
$ref: '#/components/schemas/ChksumInfo'
chksumStatus:
$ref: '#/components/schemas/ChksumStatusType'
ChksumStatusModRq:
title: ChksumStatusModRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
chksumId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: ChksumId
attribute: false
wrapped: false
chksumStatus:
$ref: '#/components/schemas/ChksumStatusType'
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
svcRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: SvcRqUID
attribute: false
wrapped: false
xml:
name: ChksumStatusModRq
attribute: false
wrapped: false
ChksumStatusModRs:
title: ChksumStatusModRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
chksumId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: ChksumId
attribute: false
wrapped: false
chksumStatus:
$ref: '#/components/schemas/ChksumStatusType'
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
svcRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: SvcRqUID
attribute: false
wrapped: false
ChksumStatusType:
title: ChksumStatusType
type: object
properties:
chksumStatusCode:
minLength: 1
type: string
description: StatusCode as Per IFX XML
xml:
name: ChksumStatusCode
attribute: false
wrapped: false
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
memo:
maxLength: 1024
minLength: 1
type: string
xml:
name: Memo
attribute: false
wrapped: false
statusDesc:
maxLength: 255
minLength: 1
type: string
description: Text description for status code
xml:
name: StatusDesc
attribute: false
wrapped: false
statusModBy:
minLength: 1
type: string
xml:
name: StatusModBy
attribute: false
wrapped: false
ChksumSyncRq:
title: ChksumSyncRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: ChksumSyncRq
attribute: false
wrapped: false
ChksumSyncRs:
title: ChksumSyncRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
chksumMsgRec:
type: array
xml:
name: ChksumMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/ChksumMsgRec'
custId:
$ref: '#/components/schemas/CustId'
newToken:
maxLength: 36
minLength: 1
type: string
xml:
name: NewToken
attribute: false
wrapped: false
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: ChksumSyncRs
attribute: false
wrapped: false
ClientApp:
title: ClientApp
type: object
properties:
Name:
maxLength: 140
minLength: 1
type: string
description: >-
Customer System application name. CTSI INTERFACE/ GPP would map this
as default - GPP
xml:
name: Name
attribute: false
wrapped: false
Org:
maxLength: 140
minLength: 1
type: string
description: >-
Customer System application manufacturer. CTSI INTERFACE/ GPP would
map this as default - GPP
xml:
name: Org
attribute: false
wrapped: false
Version:
maxLength: 3
minLength: 1
type: string
description: 'Customer system application version. '
xml:
name: Version
attribute: false
wrapped: false
ClientAppType:
title: ClientAppType
type: object
properties:
Name:
maxLength: 40
minLength: 1
type: string
xml:
name: Name
attribute: false
wrapped: false
Org:
maxLength: 36
minLength: 1
type: string
description: Customer System application manufacturer
xml:
name: Org
attribute: false
wrapped: false
Version:
maxLength: 12
minLength: 1
type: string
description: Customer system application version
xml:
name: Version
attribute: false
wrapped: false
xml:
name: ClientApp_Type
attribute: false
wrapped: false
CntrlDisbRec:
title: CntrlDisbRec
type: object
properties:
depAcctId:
$ref: '#/components/schemas/DepAcctId'
hopData:
$ref: '#/components/schemas/HopData'
presentment:
type: array
xml:
name: Presentment
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/Presentment'
presentmentAdjustment:
$ref: '#/components/schemas/PresentmentAdjustment'
CntrlDisbTrnInqRq:
title: CntrlDisbTrnInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
delUndel:
minLength: 1
type: string
xml:
name: DelUndel
attribute: false
wrapped: false
enum:
- DELIVERED
- UNDELIVERED
- BOTH
depAcctId:
$ref: '#/components/schemas/DepAcctId'
hopBrkNo:
maxLength: 15
minLength: 1
type: string
xml:
name: HopBrkNo
attribute: false
wrapped: false
presType:
maxLength: 3
minLength: 1
type: string
xml:
name: PresType
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
xml:
name: CntrlDisbTrnInqRq
attribute: false
wrapped: false
CntrlDisbTrnInqRs:
title: CntrlDisbTrnInqRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cntrlDisbRec:
$ref: '#/components/schemas/CntrlDisbRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
xml:
name: CntrlDisbTrnInqRs
attribute: false
wrapped: false
ComRefType:
title: ComRefType
type: object
properties:
bankCode1:
maxLength: 4
minLength: 4
type: string
xml:
name: BankCode1
attribute: false
wrapped: false
bankCode2:
maxLength: 4
minLength: 4
type: string
xml:
name: BankCode2
attribute: false
wrapped: false
locationCode1:
maxLength: 2
minLength: 2
type: string
xml:
name: LocationCode1
attribute: false
wrapped: false
locationCode2:
maxLength: 2
minLength: 2
type: string
xml:
name: LocationCode2
attribute: false
wrapped: false
refCode:
minLength: 1
type: string
xml:
name: RefCode
attribute: false
wrapped: false
CompRemitStmtAddRqType:
title: CompRemitStmtAddRqType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
compRemitStmtInfo:
$ref: '#/components/schemas/CompRemitStmtInfoType'
custId:
$ref: '#/components/schemas/CustId'
dupChkOverride:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: DupChkOverride
attribute: false
wrapped: false
enum:
- '0'
- '1'
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: CompRemitStmtAddRq_Type
attribute: false
wrapped: false
CompRemitStmtAddRsType:
title: CompRemitStmtAddRsType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
compRemitStmtInfo:
$ref: '#/components/schemas/CompRemitStmtInfoType'
compRemitStmtRec:
$ref: '#/components/schemas/CompRemitStmtRecType'
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
dupChkOverride:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: DupChkOverride
attribute: false
wrapped: false
enum:
- '0'
- '1'
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
CompRemitStmtAudRqType:
title: CompRemitStmtAudRqType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
depAcctId:
type: array
xml:
name: DepAcctId
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/DepAcctId'
lockboxDepId:
type: array
xml:
name: LockboxDepId
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/LockboxDepIdType'
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
xml:
name: CompRemitStmtAudRq_Type
attribute: false
wrapped: false
CompRemitStmtAudRsType:
title: CompRemitStmtAudRsType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
compRemitStmtMsgRec:
type: array
xml:
name: CompRemitStmtMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CompRemitStmtMsgRecType'
custId:
$ref: '#/components/schemas/CustId'
depAcctId:
type: array
xml:
name: DepAcctId
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/DepAcctId'
lockboxDepId:
type: array
xml:
name: LockboxDepId
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/LockboxDepIdType'
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
status:
$ref: '#/components/schemas/StatusType'
xml:
name: CompRemitStmtAudRs_Type
attribute: false
wrapped: false
CompRemitStmtInfoType:
title: CompRemitStmtInfoType
type: object
properties:
batchInfo:
type: array
xml:
name: BatchInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/BatchInfoType'
count:
type: integer
format: int64
xml:
name: Count
attribute: false
wrapped: false
curAmt:
$ref: '#/components/schemas/CurAmt'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
lockboxDepId:
$ref: '#/components/schemas/LockboxDepIdType'
lockboxURL:
maxLength: 1024
minLength: 1
type: string
xml:
name: LockboxURL
attribute: false
wrapped: false
prcDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
refInfo:
$ref: '#/components/schemas/RefInfo'
CompRemitStmtInqRqType:
title: CompRemitStmtInqRqType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
depAcctId:
type: array
xml:
name: DepAcctId
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/DepAcctId'
incToken:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncToken
attribute: false
wrapped: false
enum:
- '0'
- '1'
lockboxDepId:
type: array
xml:
name: LockboxDepId
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/LockboxDepIdType'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeCurAmt:
$ref: '#/components/schemas/SelRangeCurAmt'
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
xml:
name: CompRemitStmtInqRq_Type
attribute: false
wrapped: false
CompRemitStmtInqRsType:
title: CompRemitStmtInqRsType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
compRemitStmtRec:
$ref: '#/components/schemas/CompRemitStmtRecType'
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
depAcctId:
type: array
xml:
name: DepAcctId
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/DepAcctId'
lockboxDepId:
type: array
xml:
name: LockboxDepId
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/LockboxDepIdType'
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeCurAmt:
$ref: '#/components/schemas/SelRangeCurAmt'
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
status:
$ref: '#/components/schemas/StatusType'
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: CompRemitStmtInqRs_Type
attribute: false
wrapped: false
CompRemitStmtMsgRecType:
title: CompRemitStmtMsgRecType
type: object
properties:
compRemitStmtAddRs:
$ref: '#/components/schemas/CompRemitStmtAddRsType'
custId:
$ref: '#/components/schemas/CustId'
msgRecDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: MsgRecDt
attribute: false
wrapped: false
CompRemitStmtRecType:
title: CompRemitStmtRecType
type: object
properties:
compRemitStmtId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: CompRemitStmtId
attribute: false
wrapped: false
compRemitStmtInfo:
$ref: '#/components/schemas/CompRemitStmtInfoType'
compRemitStmtStatus:
$ref: '#/components/schemas/CompRemitStmtStatusType'
CompRemitStmtStatusType:
title: CompRemitStmtStatusType
type: object
properties:
compRemitStmtStatusCode:
minLength: 1
type: string
description: StatusCode as Per IFX XML
xml:
name: CompRemitStmtStatusCode
attribute: false
wrapped: false
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
statusDesc:
maxLength: 255
minLength: 1
type: string
description: Text description for status code
xml:
name: StatusDesc
attribute: false
wrapped: false
statusModBy:
minLength: 1
type: string
xml:
name: StatusModBy
attribute: false
wrapped: false
CompRemitStmtSyncRqType:
title: CompRemitStmtSyncRqType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
lockboxDepId:
$ref: '#/components/schemas/LockboxDepIdType'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: CompRemitStmtSyncRq_Type
attribute: false
wrapped: false
CompRemitStmtSyncRsType:
title: CompRemitStmtSyncRsType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
compRemitStmtMsgRec:
type: array
xml:
name: CompRemitStmtMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CompRemitStmtMsgRecType'
custId:
$ref: '#/components/schemas/CustId'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
lockboxDepId:
$ref: '#/components/schemas/LockboxDepIdType'
newToken:
maxLength: 36
minLength: 1
type: string
xml:
name: NewToken
attribute: false
wrapped: false
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: CompRemitStmtSyncRs_Type
attribute: false
wrapped: false
CompositeContactInfo:
title: CompositeContactInfo
type: object
properties:
contactInfo:
$ref: '#/components/schemas/ContactInfo'
contactInfoType:
minLength: 1
type: string
xml:
name: ContactInfoType
attribute: false
wrapped: false
CompositeCurAmt:
title: CompositeCurAmt
type: object
properties:
compositeCurAmtId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: CompositeCurAmtId
attribute: false
wrapped: false
compositeCurAmtType:
minLength: 1
type: string
xml:
name: CompositeCurAmtType
attribute: false
wrapped: false
curAmt:
$ref: '#/components/schemas/CurAmt'
maxCurAmt:
$ref: '#/components/schemas/MaxCurAmt'
memo:
maxLength: 1024
minLength: 1
type: string
xml:
name: Memo
attribute: false
wrapped: false
minCurAmt:
$ref: '#/components/schemas/MinCurAmt'
rate:
type: number
xml:
name: Rate
attribute: false
wrapped: false
specialHandling:
minLength: 1
type: string
xml:
name: SpecialHandling
attribute: false
wrapped: false
CompositePmtRemitInfoType:
title: CompositePmtRemitInfoType
type: object
properties:
pmtRemitChksum:
$ref: '#/components/schemas/PmtRemitChksumType'
pmtRemitDetail:
type: array
xml:
name: PmtRemitDetail
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/PmtRemitDetailType'
ConfCreditInqRqType:
title: ConfCreditInqRqType
type: object
properties:
delUndel:
minLength: 1
type: string
xml:
name: DelUndel
attribute: false
wrapped: false
enum:
- DELIVERED
- UNDELIVERED
- BOTH
depAcctId:
$ref: '#/components/schemas/DepAcctId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
sendRefNbr:
maxLength: 16
minLength: 1
type: string
xml:
name: SendRefNbr
attribute: false
wrapped: false
xml:
name: ConfCreditInqRq_Type
attribute: false
wrapped: false
ConfCreditInqRsType:
title: ConfCreditInqRsType
type: object
properties:
confCreditRec:
$ref: '#/components/schemas/ConfCreditRecType'
delUndel:
minLength: 1
type: string
xml:
name: DelUndel
attribute: false
wrapped: false
enum:
- DELIVERED
- UNDELIVERED
- BOTH
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
xml:
name: ConfCreditInqRs_Type
attribute: false
wrapped: false
ConfCreditRecType:
title: ConfCreditRecType
type: object
properties:
curAmt:
$ref: '#/components/schemas/CurAmt'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
intermediary:
$ref: '#/components/schemas/IntermediaryType'
orderInst:
$ref: '#/components/schemas/OrderInstType'
relRefNbr:
maxLength: 16
minLength: 1
type: string
xml:
name: RelRefNbr
attribute: false
wrapped: false
sendRecInfo:
maxLength: 512
minLength: 1
type: string
xml:
name: SendRecInfo
attribute: false
wrapped: false
txnRefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: TxnRefId
attribute: false
wrapped: false
valueDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: ValueDt
attribute: false
wrapped: false
ConfDebitInqRqType:
title: ConfDebitInqRqType
type: object
properties:
delUndel:
minLength: 1
type: string
xml:
name: DelUndel
attribute: false
wrapped: false
enum:
- DELIVERED
- UNDELIVERED
- BOTH
depAcctId:
$ref: '#/components/schemas/DepAcctId'
relRefNbr:
maxLength: 16
minLength: 1
type: string
xml:
name: RelRefNbr
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
sendRefNbr:
maxLength: 16
minLength: 1
type: string
xml:
name: SendRefNbr
attribute: false
wrapped: false
xml:
name: ConfDebitInqRq_Type
attribute: false
wrapped: false
ConfDebitInqRsType:
title: ConfDebitInqRsType
type: object
properties:
confDebitRec:
$ref: '#/components/schemas/ConfDebitRecType'
delUndel:
minLength: 1
type: string
xml:
name: DelUndel
attribute: false
wrapped: false
enum:
- DELIVERED
- UNDELIVERED
- BOTH
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
xml:
name: ConfDebitInqRs_Type
attribute: false
wrapped: false
ConfDebitRecType:
title: ConfDebitRecType
type: object
properties:
curAmt:
$ref: '#/components/schemas/CurAmt'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
orderInst:
$ref: '#/components/schemas/OrderInstType'
relRefNbr:
maxLength: 16
minLength: 1
type: string
xml:
name: RelRefNbr
attribute: false
wrapped: false
sendRecInfo:
maxLength: 512
minLength: 1
type: string
xml:
name: SendRecInfo
attribute: false
wrapped: false
txnRefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: TxnRefId
attribute: false
wrapped: false
valueDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: ValueDt
attribute: false
wrapped: false
ContInfoType:
title: ContInfoType
type: object
properties:
dept:
maxLength: 35
minLength: 1
type: string
xml:
name: Dept
attribute: false
wrapped: false
fax:
minLength: 1
type: string
xml:
name: Fax
attribute: false
wrapped: false
name:
maxLength: 40
minLength: 1
type: string
xml:
name: Name
attribute: false
wrapped: false
phone:
minLength: 1
type: string
xml:
name: Phone
attribute: false
wrapped: false
telex:
minLength: 1
type: string
xml:
name: Telex
attribute: false
wrapped: false
ContactData:
title: ContactData
type: object
properties:
contactName:
maxLength: 35
minLength: 1
type: string
xml:
name: ContactName
attribute: false
wrapped: false
contactSeqNum:
type: string
xml:
name: ContactSeqNum
attribute: false
wrapped: false
enum:
- '1'
- '2'
- '3'
phone:
minLength: 1
type: string
xml:
name: Phone
attribute: false
wrapped: false
ContactInfo:
title: ContactInfo
type: object
properties:
contactPref:
minLength: 1
type: string
xml:
name: ContactPref
attribute: false
wrapped: false
emailAddr:
maxLength: 128
minLength: 1
type: string
xml:
name: EmailAddr
attribute: false
wrapped: false
phoneNum:
type: array
xml:
name: PhoneNum
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/PhoneNum'
postAddr:
type: array
xml:
name: PostAddr
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/PostAddr'
prefTimeEnd:
$ref: '#/components/schemas/XMLGregorianCalendar'
prefTimeStart:
$ref: '#/components/schemas/XMLGregorianCalendar'
url:
maxLength: 1024
minLength: 1
type: string
xml:
name: URL
attribute: false
wrapped: false
CounterpartyInfoType:
title: CounterpartyInfoType
type: object
properties:
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
legalName:
maxLength: 35
minLength: 1
type: string
xml:
name: LegalName
attribute: false
wrapped: false
loanAcctId:
$ref: '#/components/schemas/LoanAcctId'
refInfo:
type: array
xml:
name: RefInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/RefInfo'
CreditAddRq:
title: CreditAddRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
creditInfo:
$ref: '#/components/schemas/CreditInfoType'
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: CreditAddRq
attribute: false
wrapped: false
CreditAddRs:
title: CreditAddRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
creditInfo:
$ref: '#/components/schemas/CreditInfoType'
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
xml:
name: CreditAddRs
attribute: false
wrapped: false
CreditAmt:
title: CreditAmt
type: object
properties:
curAmt:
$ref: '#/components/schemas/CurAmt'
CreditAuthAddRq:
title: CreditAuthAddRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
creditAuthInfo:
$ref: '#/components/schemas/CreditAuthInfo'
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: CreditAuthAddRq
attribute: false
wrapped: false
CreditAuthAddRs:
title: CreditAuthAddRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
creditAuthInfo:
$ref: '#/components/schemas/CreditAuthInfo'
creditAuthRec:
$ref: '#/components/schemas/CreditAuthRec'
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
CreditAuthAudRq:
title: CreditAuthAudRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
creditAuthId:
type: array
xml:
name: CreditAuthId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
custId:
$ref: '#/components/schemas/CustId'
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
xml:
name: CreditAuthAudRq
attribute: false
wrapped: false
CreditAuthAudRs:
title: CreditAuthAudRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
creditAuthId:
type: array
xml:
name: CreditAuthId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
creditAuthMsgRec:
type: array
xml:
name: CreditAuthMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CreditAuthMsgRec'
custId:
$ref: '#/components/schemas/CustId'
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
status:
$ref: '#/components/schemas/StatusType'
xml:
name: CreditAuthAudRs
attribute: false
wrapped: false
CreditAuthCanRq:
title: CreditAuthCanRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
clientChgCode:
minLength: 1
type: string
xml:
name: ClientChgCode
attribute: false
wrapped: false
creditAuthId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: CreditAuthId
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: CreditAuthCanRq
attribute: false
wrapped: false
CreditAuthCanRs:
title: CreditAuthCanRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
clientChgCode:
minLength: 1
type: string
xml:
name: ClientChgCode
attribute: false
wrapped: false
creditAuthId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: CreditAuthId
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
CreditAuthInfo:
title: CreditAuthInfo
type: object
properties:
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
compositeCurAmt:
type: array
xml:
name: CompositeCurAmt
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CompositeCurAmt'
creditAuthType:
minLength: 1
type: string
xml:
name: CreditAuthType
attribute: false
wrapped: false
depAcctId:
$ref: '#/components/schemas/DepAcctId'
CreditAuthInqRq:
title: CreditAuthInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
clientChgCode:
type: array
xml:
name: ClientChgCode
attribute: false
wrapped: false
items:
minLength: 1
type: string
creditAuthId:
type: array
xml:
name: CreditAuthId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
csprefId:
type: array
items:
maxLength: 36
minLength: 1
type: string
custId:
$ref: '#/components/schemas/CustId'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
incToken:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncToken
attribute: false
wrapped: false
enum:
- '0'
- '1'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeCurAmt:
$ref: '#/components/schemas/SelRangeCurAmt'
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
sprefId:
type: array
items:
type: string
xml:
name: CreditAuthInqRq
attribute: false
wrapped: false
CreditAuthInqRs:
title: CreditAuthInqRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
clientChgCode:
type: array
xml:
name: ClientChgCode
attribute: false
wrapped: false
items:
minLength: 1
type: string
creditAuthId:
type: array
xml:
name: CreditAuthId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
creditAuthRec:
type: array
xml:
name: CreditAuthRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CreditAuthRec'
csprefId:
type: array
items:
maxLength: 36
minLength: 1
type: string
custId:
$ref: '#/components/schemas/CustId'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeCurAmt:
$ref: '#/components/schemas/SelRangeCurAmt'
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
sprefId:
type: array
items:
type: string
status:
$ref: '#/components/schemas/StatusType'
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: CreditAuthInqRs
attribute: false
wrapped: false
CreditAuthModRq:
title: CreditAuthModRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
creditAuthId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: CreditAuthId
attribute: false
wrapped: false
creditAuthInfo:
$ref: '#/components/schemas/CreditAuthInfo'
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: CreditAuthModRq
attribute: false
wrapped: false
CreditAuthModRs:
title: CreditAuthModRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
creditAuthId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: CreditAuthId
attribute: false
wrapped: false
creditAuthInfo:
$ref: '#/components/schemas/CreditAuthInfo'
creditAuthRec:
$ref: '#/components/schemas/CreditAuthRec'
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
CreditAuthMsgRec:
title: CreditAuthMsgRec
type: object
properties:
creditAuthAddRs:
$ref: '#/components/schemas/CreditAuthAddRs'
creditAuthCanRs:
$ref: '#/components/schemas/CreditAuthCanRs'
creditAuthModRs:
$ref: '#/components/schemas/CreditAuthModRs'
custId:
$ref: '#/components/schemas/CustId'
msgRecDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: MsgRecDt
attribute: false
wrapped: false
CreditAuthRec:
title: CreditAuthRec
type: object
properties:
creditAuthId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: CreditAuthId
attribute: false
wrapped: false
creditAuthInfo:
$ref: '#/components/schemas/CreditAuthInfo'
creditAuthStatus:
$ref: '#/components/schemas/CreditAuthStatus'
CreditAuthStatus:
title: CreditAuthStatus
type: object
properties:
creditStatusCode:
minLength: 1
type: string
description: StatusCode as Per IFX XML
xml:
name: CreditStatusCode
attribute: false
wrapped: false
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
statusModBy:
minLength: 1
type: string
xml:
name: StatusModBy
attribute: false
wrapped: false
CreditAuthSyncRq:
title: CreditAuthSyncRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
custId:
$ref: '#/components/schemas/CustId'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: CreditAuthSyncRq
attribute: false
wrapped: false
CreditAuthSyncRs:
title: CreditAuthSyncRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
creditAuthMsgRec:
type: array
xml:
name: CreditAuthMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CreditAuthMsgRec'
custId:
$ref: '#/components/schemas/CustId'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
newToken:
maxLength: 36
minLength: 1
type: string
xml:
name: NewToken
attribute: false
wrapped: false
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
xml:
name: CreditAuthSyncRs
attribute: false
wrapped: false
CreditEntries:
title: CreditEntries
type: object
properties:
curAmt:
$ref: '#/components/schemas/CurAmt'
numEntries:
type: integer
format: int64
xml:
name: NumEntries
attribute: false
wrapped: false
CreditInfoType:
title: CreditInfoType
type: object
properties:
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
clientChgCode:
minLength: 1
type: string
xml:
name: ClientChgCode
attribute: false
wrapped: false
compositeCurAmt:
type: array
xml:
name: CompositeCurAmt
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CompositeCurAmt'
creditAuthId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: CreditAuthId
attribute: false
wrapped: false
creditAuthType:
minLength: 1
type: string
xml:
name: CreditAuthType
attribute: false
wrapped: false
depAcctId:
$ref: '#/components/schemas/DepAcctId'
networkTrnInfo:
$ref: '#/components/schemas/NetworkTrnInfoType'
CryptPswd:
title: CryptPswd
type: object
properties:
binData:
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
type: string
format: byte
xml:
name: BinData
attribute: false
wrapped: false
binLength:
type: integer
format: int64
xml:
name: BinLength
attribute: false
wrapped: false
contentType:
minLength: 1
type: string
xml:
name: ContentType
attribute: false
wrapped: false
CryptSecret:
title: CryptSecret
type: object
properties:
binData:
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
type: string
format: byte
xml:
name: BinData
attribute: false
wrapped: false
binLength:
type: integer
format: int64
xml:
name: BinLength
attribute: false
wrapped: false
contentType:
minLength: 1
type: string
xml:
name: ContentType
attribute: false
wrapped: false
CurAmt:
title: CurAmt
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
CurrencyAmount:
title: CurrencyAmount
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
xml:
name: CurrencyAmount
attribute: false
wrapped: false
Cursor:
title: Cursor
type: object
properties:
binData:
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
type: string
format: byte
xml:
name: BinData
attribute: false
wrapped: false
binLength:
type: integer
format: int64
xml:
name: BinLength
attribute: false
wrapped: false
contentType:
minLength: 1
type: string
xml:
name: ContentType
attribute: false
wrapped: false
CustAcctRq:
title: CustAcctRq
type: object
properties:
acctAssignRq:
$ref: '#/components/schemas/AcctAssignRq'
citidirectProfileId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: CitidirectProfileId
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: CustAcctRq
attribute: false
wrapped: false
CustAcctRs:
title: CustAcctRs
type: object
properties:
acctAssignRs:
$ref: '#/components/schemas/AcctAssignRs'
citidirectProfileId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: CitidirectProfileId
attribute: false
wrapped: false
xml:
name: CustAcctRs
attribute: false
wrapped: false
CustAddRq:
title: CustAddRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
authInfo:
$ref: '#/components/schemas/AuthInfo'
cryptType:
minLength: 1
type: string
xml:
name: CryptType
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
custInfo:
$ref: '#/components/schemas/CustInfoType'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
secretList:
type: array
xml:
name: SecretList
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/SecretList'
xml:
name: CustAddRq
attribute: false
wrapped: false
CustAddRs:
title: CustAddRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
custInfo:
$ref: '#/components/schemas/CustInfoType'
custRec:
$ref: '#/components/schemas/CustRec'
pswdDelivery:
$ref: '#/components/schemas/PswdDelivery'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
CustAudRqType:
title: CustAudRqType
type: object
properties:
content:
type: array
items:
type: object
properties: {}
xml:
name: CustAudRq_Type
attribute: false
wrapped: false
CustAudRsType:
title: CustAudRsType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
type: array
xml:
name: CustId
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CustId'
custMsgRec:
type: array
xml:
name: CustMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CustMsgRec'
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
spname:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Always set to CTSI
status:
$ref: '#/components/schemas/StatusType'
xml:
name: CustAudRs_Type
attribute: false
wrapped: false
CustAuthModRq:
title: CustAuthModRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
certificate:
$ref: '#/components/schemas/Certificate'
custId:
$ref: '#/components/schemas/CustId'
custPswd:
$ref: '#/components/schemas/CustPswd'
pinblock:
maxLength: 32
minLength: 1
type: string
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: CustAuthModRq
attribute: false
wrapped: false
CustAuthModRs:
title: CustAuthModRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
expDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
description: Contract Expiry Datetime
xml:
name: ExpDt
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
xml:
name: CustAuthModRs
attribute: false
wrapped: false
CustBankSvcPrefType:
title: CustBankSvcPrefType
type: object
properties:
custWithdrawalPref:
$ref: '#/components/schemas/CustWithdrawalPrefType'
CustContact:
title: CustContact
type: object
properties:
custContactPref:
minLength: 1
type: string
xml:
name: CustContactPref
attribute: false
wrapped: false
dayFax:
minLength: 1
type: string
xml:
name: DayFax
attribute: false
wrapped: false
dayPhone:
minLength: 1
type: string
xml:
name: DayPhone
attribute: false
wrapped: false
emailAddr:
maxLength: 128
minLength: 1
type: string
xml:
name: EmailAddr
attribute: false
wrapped: false
eveFax:
minLength: 1
type: string
xml:
name: EveFax
attribute: false
wrapped: false
evePhone:
minLength: 1
type: string
xml:
name: EvePhone
attribute: false
wrapped: false
prefTimeEnd:
$ref: '#/components/schemas/XMLGregorianCalendar'
prefTimeStart:
$ref: '#/components/schemas/XMLGregorianCalendar'
CustDelRq:
title: CustDelRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cascadeDel:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: CascadeDel
attribute: false
wrapped: false
enum:
- '0'
- '1'
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: CustDelRq
attribute: false
wrapped: false
CustDelRs:
title: CustDelRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cascadeDel:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: CascadeDel
attribute: false
wrapped: false
enum:
- '0'
- '1'
custId:
$ref: '#/components/schemas/CustId'
custRec:
$ref: '#/components/schemas/CustRec'
dependentType:
type: array
xml:
name: DependentType
attribute: false
wrapped: false
items:
minLength: 1
type: string
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
CustDiscInqRq:
title: CustDiscInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custDiscStatusCode:
minLength: 1
type: string
description: StatusCode as Per IFX XML
xml:
name: CustDiscStatusCode
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
discId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: DiscId
attribute: false
wrapped: false
incDisc:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncDisc
attribute: false
wrapped: false
enum:
- '0'
- '1'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
svcName:
minLength: 1
type: string
xml:
name: SvcName
attribute: false
wrapped: false
xml:
name: CustDiscInqRq
attribute: false
wrapped: false
CustDiscInqRs:
title: CustDiscInqRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custDiscRec:
type: array
xml:
name: CustDiscRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CustDiscRec'
custDiscStatusCode:
minLength: 1
type: string
description: StatusCode as Per IFX XML
xml:
name: CustDiscStatusCode
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
discId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: DiscId
attribute: false
wrapped: false
incDisc:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncDisc
attribute: false
wrapped: false
enum:
- '0'
- '1'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
svcName:
minLength: 1
type: string
xml:
name: SvcName
attribute: false
wrapped: false
xml:
name: CustDiscInqRs
attribute: false
wrapped: false
CustDiscRec:
title: CustDiscRec
type: object
properties:
custDiscStatus:
$ref: '#/components/schemas/CustDiscStatus'
custId:
$ref: '#/components/schemas/CustId'
discId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: DiscId
attribute: false
wrapped: false
discInfo:
$ref: '#/components/schemas/DiscInfo'
CustDiscStatus:
title: CustDiscStatus
type: object
properties:
custDiscStatusCode:
minLength: 1
type: string
description: StatusCode as Per IFX XML
xml:
name: CustDiscStatusCode
attribute: false
wrapped: false
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
statusDesc:
maxLength: 255
minLength: 1
type: string
description: Text description for status code
xml:
name: StatusDesc
attribute: false
wrapped: false
statusModBy:
minLength: 1
type: string
xml:
name: StatusModBy
attribute: false
wrapped: false
CustDiscStatusModRq:
title: CustDiscStatusModRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custDiscStatusCode:
minLength: 1
type: string
description: StatusCode as Per IFX XML
xml:
name: CustDiscStatusCode
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
discId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: DiscId
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: CustDiscStatusModRq
attribute: false
wrapped: false
CustDiscStatusModRs:
title: CustDiscStatusModRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custDiscStatusCode:
minLength: 1
type: string
description: StatusCode as Per IFX XML
xml:
name: CustDiscStatusCode
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
discId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: DiscId
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
xml:
name: CustDiscStatusModRs
attribute: false
wrapped: false
CustId:
title: CustId
required:
- custPermId
- spname
type: object
properties:
custLoginId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: CustLoginId
attribute: false
wrapped: false
custPermId:
maxLength: 9
minLength: 1
pattern: '[^"']*'
type: string
description: >-
WL Client Number + WorldLink Branch Number. Validate if Client Id is
valid. Please note this will be same for all requests in a single
message as per existing CMX flow.
xml:
name: CustPermId
attribute: false
wrapped: false
spname:
maxLength: 35
minLength: 1
pattern: '[^"']*'
type: string
description: Always set to CTSI
CustIdInqRqType:
title: CustIdInqRqType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custLoginId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: CustLoginId
attribute: false
wrapped: false
custPermId:
maxLength: 32
minLength: 1
pattern: '[^"']*'
type: string
description: WL Client Number + WorldLink Branch Number
xml:
name: CustPermId
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: CustIdInqRq_Type
attribute: false
wrapped: false
CustIdInqRsType:
title: CustIdInqRsType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
xml:
name: CustIdInqRs_Type
attribute: false
wrapped: false
CustInfoType:
title: CustInfoType
type: object
properties:
contactInfo:
$ref: '#/components/schemas/ContactInfo'
custContact:
$ref: '#/components/schemas/CustContact'
custName:
$ref: '#/components/schemas/CustName'
custPref:
$ref: '#/components/schemas/CustPref'
custType:
minLength: 1
type: string
xml:
name: CustType
attribute: false
wrapped: false
orgInfo:
$ref: '#/components/schemas/OrgInfoType'
personInfo:
$ref: '#/components/schemas/PersonInfo'
postAddr:
$ref: '#/components/schemas/PostAddr'
CustInqRq:
title: CustInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardMagData:
type: array
xml:
name: CardMagData
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CardMagDataType'
custId:
type: array
xml:
name: CustId
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
incToken:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncToken
attribute: false
wrapped: false
enum:
- '0'
- '1'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
upDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
xml:
name: CustInqRq
attribute: false
wrapped: false
CustInqRs:
title: CustInqRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardMagData:
type: array
xml:
name: CardMagData
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CardMagDataType'
custId:
type: array
xml:
name: CustId
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CustId'
custRec:
type: array
xml:
name: CustRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CustRec'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
incToken:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncToken
attribute: false
wrapped: false
enum:
- '0'
- '1'
newUpDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
upDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
xml:
name: CustInqRs
attribute: false
wrapped: false
CustModRq:
title: CustModRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
custInfo:
$ref: '#/components/schemas/CustInfoType'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: CustModRq
attribute: false
wrapped: false
CustModRs:
title: CustModRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
custInfo:
$ref: '#/components/schemas/CustInfoType'
custRec:
$ref: '#/components/schemas/CustRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
CustMsgRec:
title: CustMsgRec
type: object
properties:
custAddRs:
$ref: '#/components/schemas/CustAddRs'
custDelRs:
$ref: '#/components/schemas/CustDelRs'
custId:
$ref: '#/components/schemas/CustId'
custModRs:
$ref: '#/components/schemas/CustModRs'
custStatusModRs:
$ref: '#/components/schemas/CustStatusModRs'
msgRecDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: MsgRecDt
attribute: false
wrapped: false
CustName:
title: CustName
type: object
properties:
firstName:
type: array
xml:
name: FirstName
attribute: false
wrapped: false
items:
maxLength: 40
minLength: 1
type: string
lastName:
type: array
xml:
name: LastName
attribute: false
wrapped: false
items:
maxLength: 40
minLength: 1
type: string
legalName:
maxLength: 35
minLength: 1
type: string
xml:
name: LegalName
attribute: false
wrapped: false
middleName:
type: array
xml:
name: MiddleName
attribute: false
wrapped: false
items:
maxLength: 40
minLength: 1
type: string
nameSuffix:
maxLength: 40
minLength: 1
type: string
xml:
name: NameSuffix
attribute: false
wrapped: false
nickname:
maxLength: 40
minLength: 1
type: string
xml:
name: Nickname
attribute: false
wrapped: false
titlePrefix:
maxLength: 8
minLength: 1
type: string
xml:
name: TitlePrefix
attribute: false
wrapped: false
CustNameAddr:
title: CustNameAddr
type: object
properties:
contactInfo:
$ref: '#/components/schemas/ContactInfo'
custContact:
$ref: '#/components/schemas/CustContact'
custName:
$ref: '#/components/schemas/CustName'
fullName:
type: array
xml:
name: FullName
attribute: false
wrapped: false
items:
maxLength: 96
minLength: 1
type: string
nameAddrType:
minLength: 1
type: string
xml:
name: NameAddrType
attribute: false
wrapped: false
personName:
$ref: '#/components/schemas/PersonName'
postAddr:
$ref: '#/components/schemas/PostAddr'
CustPayeeAddRq:
title: CustPayeeAddRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
custPayeeInfo:
$ref: '#/components/schemas/CustPayeeInfo'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: CustPayeeAddRq
attribute: false
wrapped: false
CustPayeeAddRs:
title: CustPayeeAddRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
custPayeeInfo:
$ref: '#/components/schemas/CustPayeeInfo'
custPayeeRec:
$ref: '#/components/schemas/CustPayeeRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
CustPayeeAudRq:
title: CustPayeeAudRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
custPayeeId:
type: array
xml:
name: CustPayeeId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
xml:
name: CustPayeeAudRq
attribute: false
wrapped: false
CustPayeeAudRs:
title: CustPayeeAudRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
custPayeeId:
type: array
xml:
name: CustPayeeId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
custPayeeMsgRec:
type: array
xml:
name: CustPayeeMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CustPayeeMsgRec'
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
status:
$ref: '#/components/schemas/StatusType'
xml:
name: CustPayeeAudRs
attribute: false
wrapped: false
CustPayeeDelRq:
title: CustPayeeDelRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cascadeDel:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: CascadeDel
attribute: false
wrapped: false
enum:
- '0'
- '1'
custId:
$ref: '#/components/schemas/CustId'
custPayeeId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: CustPayeeId
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: CustPayeeDelRq
attribute: false
wrapped: false
CustPayeeDelRs:
title: CustPayeeDelRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cascadeDel:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: CascadeDel
attribute: false
wrapped: false
enum:
- '0'
- '1'
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
custPayeeId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: CustPayeeId
attribute: false
wrapped: false
custPayeeRec:
$ref: '#/components/schemas/CustPayeeRec'
dependentType:
type: array
xml:
name: DependentType
attribute: false
wrapped: false
items:
minLength: 1
type: string
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
CustPayeeInfo:
title: CustPayeeInfo
type: object
properties:
acctPayAcctId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: AcctPayAcctId
attribute: false
wrapped: false
billerPayee:
$ref: '#/components/schemas/BillerPayee'
billingAcct:
maxLength: 32
minLength: 1
type: string
xml:
name: BillingAcct
attribute: false
wrapped: false
dfltPmtInfo:
$ref: '#/components/schemas/DfltPmtInfo'
fspayee:
$ref: '#/components/schemas/FSPayeeType'
name:
maxLength: 40
minLength: 1
type: string
xml:
name: Name
attribute: false
wrapped: false
nickname:
maxLength: 40
minLength: 1
type: string
xml:
name: Nickname
attribute: false
wrapped: false
postAddr:
$ref: '#/components/schemas/PostAddr'
stdPayeeId:
$ref: '#/components/schemas/StdPayeeId'
taxIdentifier:
maxLength: 35
minLength: 1
type: string
xml:
name: TaxIdentifier
attribute: false
wrapped: false
xferPayee:
$ref: '#/components/schemas/XferPayee'
CustPayeeInqRq:
title: CustPayeeInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
custPayeeId:
type: array
xml:
name: CustPayeeId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
incToken:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncToken
attribute: false
wrapped: false
enum:
- '0'
- '1'
name:
type: array
xml:
name: Name
attribute: false
wrapped: false
items:
maxLength: 40
minLength: 1
type: string
nickname:
type: array
xml:
name: Nickname
attribute: false
wrapped: false
items:
maxLength: 40
minLength: 1
type: string
payeeType:
type: array
xml:
name: PayeeType
attribute: false
wrapped: false
items:
minLength: 1
type: string
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: CustPayeeInqRq
attribute: false
wrapped: false
CustPayeeInqRs:
title: CustPayeeInqRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
custPayeeId:
type: array
xml:
name: CustPayeeId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
custPayeeRec:
type: array
xml:
name: CustPayeeRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CustPayeeRec'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
incToken:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncToken
attribute: false
wrapped: false
enum:
- '0'
- '1'
name:
type: array
xml:
name: Name
attribute: false
wrapped: false
items:
maxLength: 40
minLength: 1
type: string
nickname:
type: array
xml:
name: Nickname
attribute: false
wrapped: false
items:
maxLength: 40
minLength: 1
type: string
payeeType:
type: array
xml:
name: PayeeType
attribute: false
wrapped: false
items:
minLength: 1
type: string
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: CustPayeeInqRs
attribute: false
wrapped: false
CustPayeeModRq:
title: CustPayeeModRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
custPayeeId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: CustPayeeId
attribute: false
wrapped: false
custPayeeInfo:
$ref: '#/components/schemas/CustPayeeInfo'
modPending:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: ModPending
attribute: false
wrapped: false
enum:
- '0'
- '1'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: CustPayeeModRq
attribute: false
wrapped: false
CustPayeeModRs:
title: CustPayeeModRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
custPayeeId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: CustPayeeId
attribute: false
wrapped: false
custPayeeInfo:
$ref: '#/components/schemas/CustPayeeInfo'
custPayeeRec:
$ref: '#/components/schemas/CustPayeeRec'
modPending:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: ModPending
attribute: false
wrapped: false
enum:
- '0'
- '1'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
CustPayeeMsgRec:
title: CustPayeeMsgRec
type: object
properties:
custId:
$ref: '#/components/schemas/CustId'
custPayeeAddRs:
$ref: '#/components/schemas/CustPayeeAddRs'
custPayeeDelRs:
$ref: '#/components/schemas/CustPayeeDelRs'
custPayeeModRs:
$ref: '#/components/schemas/CustPayeeModRs'
custPayeeTypeModRs:
$ref: '#/components/schemas/CustPayeeTypeModRs'
msgRecDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: MsgRecDt
attribute: false
wrapped: false
CustPayeeRec:
title: CustPayeeRec
type: object
properties:
billerContact:
$ref: '#/components/schemas/BillerContactType'
custPayeeId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: CustPayeeId
attribute: false
wrapped: false
custPayeeInfo:
$ref: '#/components/schemas/CustPayeeInfo'
daysToPay:
type: integer
format: int64
xml:
name: DaysToPay
attribute: false
wrapped: false
CustPayeeSyncRq:
title: CustPayeeSyncRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: CustPayeeSyncRq
attribute: false
wrapped: false
CustPayeeSyncRs:
title: CustPayeeSyncRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
custPayeeMsgRec:
type: array
xml:
name: CustPayeeMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CustPayeeMsgRec'
newToken:
maxLength: 36
minLength: 1
type: string
xml:
name: NewToken
attribute: false
wrapped: false
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: CustPayeeSyncRs
attribute: false
wrapped: false
CustPayeeTypeModRq:
title: CustPayeeTypeModRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
custPayeeId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: CustPayeeId
attribute: false
wrapped: false
payeeType:
minLength: 1
type: string
xml:
name: PayeeType
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: CustPayeeTypeModRq
attribute: false
wrapped: false
CustPayeeTypeModRs:
title: CustPayeeTypeModRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
custPayeeId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: CustPayeeId
attribute: false
wrapped: false
payeeType:
minLength: 1
type: string
xml:
name: PayeeType
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
CustPref:
title: CustPref
type: object
properties:
custBankSvcPref:
$ref: '#/components/schemas/CustBankSvcPrefType'
language:
maxLength: 17
minLength: 1
type: string
xml:
name: Language
attribute: false
wrapped: false
mktgInfo:
maxLength: 255
minLength: 1
type: string
xml:
name: MktgInfo
attribute: false
wrapped: false
CustPswd:
title: CustPswd
type: object
properties:
cryptPswd:
$ref: '#/components/schemas/CryptPswd'
cryptType:
minLength: 1
type: string
xml:
name: CryptType
attribute: false
wrapped: false
pswd:
maxLength: 32
minLength: 1
type: string
xml:
name: Pswd
attribute: false
wrapped: false
CustPswdModRq:
title: CustPswdModRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
custPswd:
$ref: '#/components/schemas/CustPswd'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: CustPswdModRq
attribute: false
wrapped: false
CustPswdModRs:
title: CustPswdModRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
expDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
description: Contract Expiry Datetime
xml:
name: ExpDt
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
xml:
name: CustPswdModRs
attribute: false
wrapped: false
CustRec:
title: CustRec
type: object
properties:
custId:
$ref: '#/components/schemas/CustId'
custInfo:
$ref: '#/components/schemas/CustInfoType'
custStatus:
$ref: '#/components/schemas/CustStatus'
upDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
CustStatus:
title: CustStatus
type: object
properties:
custStatusCode:
minLength: 1
type: string
description: StatusCode as Per IFX XML
xml:
name: CustStatusCode
attribute: false
wrapped: false
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
resolvePendingDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
statusDesc:
maxLength: 255
minLength: 1
type: string
description: Text description for status code
xml:
name: StatusDesc
attribute: false
wrapped: false
statusModBy:
minLength: 1
type: string
xml:
name: StatusModBy
attribute: false
wrapped: false
CustStatusModRq:
title: CustStatusModRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
custStatus:
$ref: '#/components/schemas/CustStatus'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: CustStatusModRq
attribute: false
wrapped: false
CustStatusModRs:
title: CustStatusModRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
custRec:
$ref: '#/components/schemas/CustRec'
custStatus:
$ref: '#/components/schemas/CustStatus'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
CustSvcAddRq:
title: CustSvcAddRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
custSvcId:
$ref: '#/components/schemas/CustSvcId'
custSvcInfo:
$ref: '#/components/schemas/CustSvcInfo'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: CustSvcAddRq
attribute: false
wrapped: false
CustSvcAddRs:
title: CustSvcAddRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
custSvcId:
$ref: '#/components/schemas/CustSvcId'
custSvcInfo:
$ref: '#/components/schemas/CustSvcInfo'
custSvcRec:
$ref: '#/components/schemas/CustSvcRec'
discRec:
type: array
xml:
name: DiscRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/DiscRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
CustSvcAudRq:
title: CustSvcAudRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
type: array
xml:
name: CustId
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CustId'
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
spname:
type: array
items:
maxLength: 36
minLength: 1
type: string
svcName:
type: array
xml:
name: SvcName
attribute: false
wrapped: false
items:
minLength: 1
type: string
xml:
name: CustSvcAudRq
attribute: false
wrapped: false
CustSvcAudRs:
title: CustSvcAudRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
type: array
xml:
name: CustId
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CustId'
custSvcMsgRec:
type: array
xml:
name: CustSvcMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CustSvcMsgRec'
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
spname:
type: array
items:
maxLength: 36
minLength: 1
type: string
status:
$ref: '#/components/schemas/StatusType'
svcName:
type: array
xml:
name: SvcName
attribute: false
wrapped: false
items:
minLength: 1
type: string
xml:
name: CustSvcAudRs
attribute: false
wrapped: false
CustSvcDelRq:
title: CustSvcDelRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cascadeDel:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: CascadeDel
attribute: false
wrapped: false
enum:
- '0'
- '1'
custId:
$ref: '#/components/schemas/CustId'
custSvcId:
$ref: '#/components/schemas/CustSvcId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: CustSvcDelRq
attribute: false
wrapped: false
CustSvcDelRs:
title: CustSvcDelRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cascadeDel:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: CascadeDel
attribute: false
wrapped: false
enum:
- '0'
- '1'
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
custSvcId:
$ref: '#/components/schemas/CustSvcId'
custSvcRec:
$ref: '#/components/schemas/CustSvcRec'
dependentType:
type: array
xml:
name: DependentType
attribute: false
wrapped: false
items:
minLength: 1
type: string
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
CustSvcId:
title: CustSvcId
type: object
properties:
spname:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Always set to CTSI
svcName:
minLength: 1
type: string
xml:
name: SvcName
attribute: false
wrapped: false
CustSvcInfo:
title: CustSvcInfo
type: object
properties:
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
CustSvcModRq:
title: CustSvcModRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
custSvcId:
$ref: '#/components/schemas/CustSvcId'
custSvcInfo:
$ref: '#/components/schemas/CustSvcInfo'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: CustSvcModRq
attribute: false
wrapped: false
CustSvcModRs:
title: CustSvcModRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
custSvcId:
$ref: '#/components/schemas/CustSvcId'
custSvcInfo:
$ref: '#/components/schemas/CustSvcInfo'
custSvcRec:
$ref: '#/components/schemas/CustSvcRec'
discRec:
type: array
xml:
name: DiscRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/DiscRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
CustSvcMsgRec:
title: CustSvcMsgRec
type: object
properties:
custId:
$ref: '#/components/schemas/CustId'
custSvcAddRs:
$ref: '#/components/schemas/CustSvcAddRs'
custSvcDelRs:
$ref: '#/components/schemas/CustSvcDelRs'
custSvcModRs:
$ref: '#/components/schemas/CustSvcModRs'
custSvcStatusModRs:
$ref: '#/components/schemas/CustSvcStatusModRs'
msgRecDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: MsgRecDt
attribute: false
wrapped: false
CustSvcRec:
title: CustSvcRec
type: object
properties:
custSvcId:
$ref: '#/components/schemas/CustSvcId'
custSvcInfo:
$ref: '#/components/schemas/CustSvcInfo'
custSvcStatus:
$ref: '#/components/schemas/CustSvcStatus'
CustSvcStatus:
title: CustSvcStatus
type: object
properties:
custSvcStatusCode:
minLength: 1
type: string
description: StatusCode as Per IFX XML
xml:
name: CustSvcStatusCode
attribute: false
wrapped: false
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
resolvePendingDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
statusDesc:
maxLength: 255
minLength: 1
type: string
description: Text description for status code
xml:
name: StatusDesc
attribute: false
wrapped: false
statusModBy:
minLength: 1
type: string
xml:
name: StatusModBy
attribute: false
wrapped: false
CustSvcStatusModRq:
title: CustSvcStatusModRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
custSvcId:
$ref: '#/components/schemas/CustSvcId'
custSvcStatus:
$ref: '#/components/schemas/CustSvcStatus'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: CustSvcStatusModRq
attribute: false
wrapped: false
CustSvcStatusModRs:
title: CustSvcStatusModRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
custSvcId:
$ref: '#/components/schemas/CustSvcId'
custSvcRec:
$ref: '#/components/schemas/CustSvcRec'
custSvcStatus:
$ref: '#/components/schemas/CustSvcStatus'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
CustSvcSyncRq:
title: CustSvcSyncRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: CustSvcSyncRq
attribute: false
wrapped: false
CustSvcSyncRs:
title: CustSvcSyncRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
custSvcMsgRec:
type: array
xml:
name: CustSvcMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CustSvcMsgRec'
newToken:
maxLength: 36
minLength: 1
type: string
xml:
name: NewToken
attribute: false
wrapped: false
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: CustSvcSyncRs
attribute: false
wrapped: false
CustSyncRq:
title: CustSyncRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: CustSyncRq
attribute: false
wrapped: false
CustSyncRs:
title: CustSyncRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
custMsgRec:
type: array
xml:
name: CustMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CustMsgRec'
newToken:
maxLength: 36
minLength: 1
type: string
xml:
name: NewToken
attribute: false
wrapped: false
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: CustSyncRs
attribute: false
wrapped: false
CustWithdrawalPrefType:
title: CustWithdrawalPrefType
type: object
properties:
curAmt:
$ref: '#/components/schemas/CurAmt'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
DealMethType:
title: DealMethType
type: object
properties:
dealMethodCode:
minLength: 1
type: string
xml:
name: DealMethodCode
attribute: false
wrapped: false
enum:
- BROK
- ELEC
- FAXT
- PHON
- TELX
dealMethodDetails:
maxLength: 35
minLength: 1
type: string
xml:
name: DealMethodDetails
attribute: false
wrapped: false
DealingBranchCntrPrtyType:
title: DealingBranchCntrPrtyType
type: object
properties:
acctId:
maxLength: 255
minLength: 1
pattern: '[^"']*'
type: string
description: FROM account number
xml:
name: AcctId
attribute: false
wrapped: false
bankId:
maxLength: 34
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: BankId
attribute: false
wrapped: false
bankIdType:
minLength: 1
type: string
xml:
name: BankIdType
attribute: false
wrapped: false
cntrPrtyType:
minLength: 1
type: string
xml:
name: CntrPrtyType
attribute: false
wrapped: false
enum:
- PARTY_A
- PARTY_B
- FUND_BENE_CUST
- DELIVERY_AGENT
- INTERMEDIARY
- RECEIVING_AGENT
- BENEFICIARY_INSTITUTION
- DEALING_BRANCH_PARTY_A
- DEALING_BRANCH_PARTY_B
- BROKER_IDENTIFICATION
name:
maxLength: 40
minLength: 1
type: string
xml:
name: Name
attribute: false
wrapped: false
postAddr:
$ref: '#/components/schemas/PostAddr'
DebitAddRq:
title: DebitAddRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
debitInfo:
$ref: '#/components/schemas/DebitInfo'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: DebitAddRq
attribute: false
wrapped: false
DebitAddRs:
title: DebitAddRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
debitInfo:
$ref: '#/components/schemas/DebitInfo'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
xml:
name: DebitAddRs
attribute: false
wrapped: false
DebitAmt:
title: DebitAmt
type: object
properties:
curAmt:
$ref: '#/components/schemas/CurAmt'
DebitAuthAddRq:
title: DebitAuthAddRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
debitAuthInfo:
$ref: '#/components/schemas/DebitAuthInfo'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: DebitAuthAddRq
attribute: false
wrapped: false
DebitAuthAddRs:
title: DebitAuthAddRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
debitAuthInfo:
$ref: '#/components/schemas/DebitAuthInfo'
debitAuthRec:
$ref: '#/components/schemas/DebitAuthRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
DebitAuthAudRq:
title: DebitAuthAudRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
debitAuthId:
type: array
xml:
name: DebitAuthId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
xml:
name: DebitAuthAudRq
attribute: false
wrapped: false
DebitAuthAudRs:
title: DebitAuthAudRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
debitAuthId:
type: array
xml:
name: DebitAuthId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
debitAuthMsgRec:
type: array
xml:
name: DebitAuthMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/DebitAuthMsgRec'
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
status:
$ref: '#/components/schemas/StatusType'
xml:
name: DebitAuthAudRs
attribute: false
wrapped: false
DebitAuthCanRq:
title: DebitAuthCanRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
clientChgCode:
minLength: 1
type: string
xml:
name: ClientChgCode
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
debitAuthId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: DebitAuthId
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: DebitAuthCanRq
attribute: false
wrapped: false
DebitAuthCanRs:
title: DebitAuthCanRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
clientChgCode:
minLength: 1
type: string
xml:
name: ClientChgCode
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
debitAuthId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: DebitAuthId
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
DebitAuthInfo:
title: DebitAuthInfo
type: object
properties:
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
compositeCurAmt:
type: array
xml:
name: CompositeCurAmt
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CompositeCurAmt'
debitAuthType:
minLength: 1
type: string
xml:
name: DebitAuthType
attribute: false
wrapped: false
depAcctId:
$ref: '#/components/schemas/DepAcctId'
DebitAuthInqRq:
title: DebitAuthInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
clientChgCode:
type: array
xml:
name: ClientChgCode
attribute: false
wrapped: false
items:
minLength: 1
type: string
csprefId:
type: array
items:
maxLength: 36
minLength: 1
type: string
custId:
$ref: '#/components/schemas/CustId'
debitAuthId:
type: array
xml:
name: DebitAuthId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
depAcctId:
$ref: '#/components/schemas/DepAcctId'
incToken:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncToken
attribute: false
wrapped: false
enum:
- '0'
- '1'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeCurAmt:
$ref: '#/components/schemas/SelRangeCurAmt'
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
sprefId:
type: array
items:
type: string
xml:
name: DebitAuthInqRq
attribute: false
wrapped: false
DebitAuthInqRs:
title: DebitAuthInqRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
clientChgCode:
type: array
xml:
name: ClientChgCode
attribute: false
wrapped: false
items:
minLength: 1
type: string
csprefId:
type: array
items:
maxLength: 36
minLength: 1
type: string
custId:
$ref: '#/components/schemas/CustId'
debitAuthId:
type: array
xml:
name: DebitAuthId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
debitAuthRec:
type: array
xml:
name: DebitAuthRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/DebitAuthRec'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeCurAmt:
$ref: '#/components/schemas/SelRangeCurAmt'
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
sprefId:
type: array
items:
type: string
status:
$ref: '#/components/schemas/StatusType'
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: DebitAuthInqRs
attribute: false
wrapped: false
DebitAuthModRq:
title: DebitAuthModRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
debitAuthId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: DebitAuthId
attribute: false
wrapped: false
debitAuthInfo:
$ref: '#/components/schemas/DebitAuthInfo'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: DebitAuthModRq
attribute: false
wrapped: false
DebitAuthModRs:
title: DebitAuthModRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
debitAuthId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: DebitAuthId
attribute: false
wrapped: false
debitAuthInfo:
$ref: '#/components/schemas/DebitAuthInfo'
debitAuthRec:
$ref: '#/components/schemas/DebitAuthRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
DebitAuthMsgRec:
title: DebitAuthMsgRec
type: object
properties:
custId:
$ref: '#/components/schemas/CustId'
debitAuthAddRs:
$ref: '#/components/schemas/DebitAuthAddRs'
debitAuthCanRs:
$ref: '#/components/schemas/DebitAuthCanRs'
debitAuthModRs:
$ref: '#/components/schemas/DebitAuthModRs'
msgRecDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: MsgRecDt
attribute: false
wrapped: false
DebitAuthRec:
title: DebitAuthRec
type: object
properties:
debitAuthId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: DebitAuthId
attribute: false
wrapped: false
debitAuthInfo:
$ref: '#/components/schemas/DebitAuthInfo'
debitAuthStatus:
$ref: '#/components/schemas/DebitAuthStatus'
DebitAuthStatus:
title: DebitAuthStatus
type: object
properties:
debitStatusCode:
minLength: 1
type: string
description: StatusCode as Per IFX XML
xml:
name: DebitStatusCode
attribute: false
wrapped: false
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
statusModBy:
minLength: 1
type: string
xml:
name: StatusModBy
attribute: false
wrapped: false
DebitAuthSyncRq:
title: DebitAuthSyncRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
custId:
$ref: '#/components/schemas/CustId'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: DebitAuthSyncRq
attribute: false
wrapped: false
DebitAuthSyncRs:
title: DebitAuthSyncRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
custId:
$ref: '#/components/schemas/CustId'
debitAuthMsgRec:
type: array
xml:
name: DebitAuthMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/DebitAuthMsgRec'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
newToken:
maxLength: 36
minLength: 1
type: string
xml:
name: NewToken
attribute: false
wrapped: false
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
xml:
name: DebitAuthSyncRs
attribute: false
wrapped: false
DebitEntries:
title: DebitEntries
type: object
properties:
curAmt:
$ref: '#/components/schemas/CurAmt'
numEntries:
type: integer
format: int64
xml:
name: NumEntries
attribute: false
wrapped: false
DebitInfo:
title: DebitInfo
type: object
properties:
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
clientChgCode:
minLength: 1
type: string
xml:
name: ClientChgCode
attribute: false
wrapped: false
compositeCurAmt:
type: array
xml:
name: CompositeCurAmt
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CompositeCurAmt'
debitAuthId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: DebitAuthId
attribute: false
wrapped: false
debitAuthType:
minLength: 1
type: string
xml:
name: DebitAuthType
attribute: false
wrapped: false
depAcctId:
$ref: '#/components/schemas/DepAcctId'
networkTrnInfo:
$ref: '#/components/schemas/NetworkTrnInfoType'
DelinqAging:
title: DelinqAging
type: object
properties:
aging:
minLength: 1
type: string
xml:
name: Aging
attribute: false
wrapped: false
curAmt:
$ref: '#/components/schemas/CurAmt'
DepAcctId:
title: DepAcctId
type: object
properties:
acctCur:
maxLength: 22
minLength: 1
type: string
xml:
name: AcctCur
attribute: false
wrapped: false
acctId:
maxLength: 35
minLength: 1
pattern: '[^"']*'
type: string
description: >-
FROM account number. Not used. Echoed from Customer Request
ForExRateInqRq
xml:
name: AcctId
attribute: false
wrapped: false
acctKey:
maxLength: 22
minLength: 1
type: string
xml:
name: AcctKey
attribute: false
wrapped: false
acctName:
minLength: 1
type: string
xml:
name: AcctName
attribute: false
wrapped: false
acctType:
maxLength: 4
minLength: 1
type: string
description: >-
FROM account type. Not used. Echoed from Customer Request
ForExRateInqRq
xml:
name: AcctType
attribute: false
wrapped: false
bankInfo:
$ref: '#/components/schemas/BankInfo'
floorLmt:
$ref: '#/components/schemas/FloorLmt'
DepAcctIdFrom:
title: DepAcctIdFrom
type: object
properties:
acctCur:
maxLength: 22
minLength: 1
type: string
xml:
name: AcctCur
attribute: false
wrapped: false
acctId:
maxLength: 255
minLength: 1
pattern: '[^"']*'
type: string
description: FROM account number
xml:
name: AcctId
attribute: false
wrapped: false
acctKey:
maxLength: 22
minLength: 1
type: string
xml:
name: AcctKey
attribute: false
wrapped: false
acctName:
minLength: 1
type: string
xml:
name: AcctName
attribute: false
wrapped: false
acctType:
minLength: 1
type: string
xml:
name: AcctType
attribute: false
wrapped: false
bankInfo:
$ref: '#/components/schemas/BankInfo'
floorLmt:
$ref: '#/components/schemas/FloorLmt'
DepAcctIdTo:
title: DepAcctIdTo
type: object
properties:
acctCur:
maxLength: 22
minLength: 1
type: string
xml:
name: AcctCur
attribute: false
wrapped: false
acctId:
maxLength: 255
minLength: 1
pattern: '[^"']*'
type: string
description: FROM account number
xml:
name: AcctId
attribute: false
wrapped: false
acctKey:
maxLength: 22
minLength: 1
type: string
xml:
name: AcctKey
attribute: false
wrapped: false
acctName:
minLength: 1
type: string
xml:
name: AcctName
attribute: false
wrapped: false
acctType:
minLength: 1
type: string
xml:
name: AcctType
attribute: false
wrapped: false
bankInfo:
$ref: '#/components/schemas/BankInfo'
floorLmt:
$ref: '#/components/schemas/FloorLmt'
DepAcctIdType:
title: DepAcctIdType
type: object
properties:
acctCur:
maxLength: 22
minLength: 1
type: string
xml:
name: AcctCur
attribute: false
wrapped: false
acctId:
maxLength: 255
minLength: 1
pattern: '[^"']*'
type: string
description: FROM account number
xml:
name: AcctId
attribute: false
wrapped: false
acctKey:
maxLength: 22
minLength: 1
type: string
xml:
name: AcctKey
attribute: false
wrapped: false
acctName:
minLength: 1
type: string
xml:
name: AcctName
attribute: false
wrapped: false
acctType:
minLength: 1
type: string
xml:
name: AcctType
attribute: false
wrapped: false
bankInfo:
$ref: '#/components/schemas/BankInfo'
floorLmt:
$ref: '#/components/schemas/FloorLmt'
xml:
name: DepAcctId_Type
attribute: false
wrapped: false
DepAcctRec:
title: DepAcctRec
type: object
properties:
depMatureDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
holdCount:
type: integer
format: int64
xml:
name: HoldCount
attribute: false
wrapped: false
lastDepCurAmt:
$ref: '#/components/schemas/LastDepCurAmt'
lastDepDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
stopCount:
type: integer
format: int64
xml:
name: StopCount
attribute: false
wrapped: false
DepAcctStmtInqRq:
title: DepAcctStmtInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
custId:
$ref: '#/components/schemas/CustId'
delUndel:
minLength: 1
type: string
xml:
name: DelUndel
attribute: false
wrapped: false
enum:
- DELIVERED
- UNDELIVERED
- BOTH
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
depAcctId:
$ref: '#/components/schemas/DepAcctId'
incDetail:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncDetail
attribute: false
wrapped: false
enum:
- '0'
- '1'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
xml:
name: DepAcctStmtInqRq
attribute: false
wrapped: false
DepAcctStmtInqRs:
title: DepAcctStmtInqRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
custId:
$ref: '#/components/schemas/CustId'
delUndel:
minLength: 1
type: string
xml:
name: DelUndel
attribute: false
wrapped: false
enum:
- DELIVERED
- UNDELIVERED
- BOTH
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
depAcctId:
$ref: '#/components/schemas/DepAcctId'
depAcctStmtRec:
type: array
xml:
name: DepAcctStmtRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/DepAcctStmtRec'
fee:
type: array
xml:
name: Fee
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/FeeType'
incDetail:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncDetail
attribute: false
wrapped: false
enum:
- '0'
- '1'
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
status:
$ref: '#/components/schemas/StatusType'
stmtMemo:
minLength: 1
type: string
xml:
name: StmtMemo
attribute: false
wrapped: false
txnRefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: TxnRefId
attribute: false
wrapped: false
xml:
name: DepAcctStmtInqRs
attribute: false
wrapped: false
DepAcctStmtRec:
title: DepAcctStmtRec
type: object
properties:
acctBal:
type: array
xml:
name: AcctBal
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/AcctBal'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
depAcctStmtId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: DepAcctStmtId
attribute: false
wrapped: false
depAcctTrnRec:
type: array
xml:
name: DepAcctTrnRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/DepAcctTrnRec'
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
endDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: EndDt
attribute: false
wrapped: false
mktgInfo:
maxLength: 255
minLength: 1
type: string
xml:
name: MktgInfo
attribute: false
wrapped: false
nextDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: NextDt
attribute: false
wrapped: false
sprefId:
type: string
startDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: StartDt
attribute: false
wrapped: false
stmtSummAmt:
type: array
xml:
name: StmtSummAmt
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/StmtSummAmt'
url:
maxLength: 1024
minLength: 1
type: string
xml:
name: URL
attribute: false
wrapped: false
DepAcctSummStmtRq:
title: DepAcctSummStmtRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
custId:
$ref: '#/components/schemas/CustId'
delUndel:
minLength: 1
type: string
xml:
name: DelUndel
attribute: false
wrapped: false
enum:
- DELIVERED
- UNDELIVERED
- BOTH
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
depAcctId:
$ref: '#/components/schemas/DepAcctId'
incDetail:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncDetail
attribute: false
wrapped: false
enum:
- '0'
- '1'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
xml:
name: DepAcctSummStmtRq
attribute: false
wrapped: false
DepAcctSummStmtRs:
title: DepAcctSummStmtRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
custId:
$ref: '#/components/schemas/CustId'
delUndel:
minLength: 1
type: string
xml:
name: DelUndel
attribute: false
wrapped: false
enum:
- DELIVERED
- UNDELIVERED
- BOTH
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
depAcctId:
$ref: '#/components/schemas/DepAcctId'
depAcctStmtRec:
type: array
xml:
name: DepAcctStmtRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/DepAcctStmtRec'
fee:
type: array
xml:
name: Fee
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/FeeType'
incDetail:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncDetail
attribute: false
wrapped: false
enum:
- '0'
- '1'
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
status:
$ref: '#/components/schemas/StatusType'
stmtMemo:
minLength: 1
type: string
xml:
name: StmtMemo
attribute: false
wrapped: false
txnRefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: TxnRefId
attribute: false
wrapped: false
xml:
name: DepAcctSummStmtRs
attribute: false
wrapped: false
DepAcctTrnInqRq:
title: DepAcctTrnInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
chkRange:
$ref: '#/components/schemas/ChkRangeType'
csprefId:
type: array
items:
maxLength: 36
minLength: 1
type: string
custId:
$ref: '#/components/schemas/CustId'
delUndel:
minLength: 1
type: string
xml:
name: DelUndel
attribute: false
wrapped: false
enum:
- DELIVERED
- UNDELIVERED
- BOTH
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
depAcctId:
$ref: '#/components/schemas/DepAcctId'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeCurAmt:
$ref: '#/components/schemas/SelRangeCurAmt'
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
sprefId:
type: array
items:
type: string
trnSrc:
type: array
xml:
name: TrnSrc
attribute: false
wrapped: false
items:
minLength: 1
type: string
trnType:
type: array
xml:
name: TrnType
attribute: false
wrapped: false
items:
minLength: 1
type: string
xml:
name: DepAcctTrnInqRq
attribute: false
wrapped: false
DepAcctTrnInqRs:
title: DepAcctTrnInqRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
chkRange:
$ref: '#/components/schemas/ChkRangeType'
csprefId:
type: array
items:
maxLength: 36
minLength: 1
type: string
custId:
$ref: '#/components/schemas/CustId'
delUndel:
minLength: 1
type: string
xml:
name: DelUndel
attribute: false
wrapped: false
enum:
- DELIVERED
- UNDELIVERED
- BOTH
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
depAcctId:
$ref: '#/components/schemas/DepAcctId'
depAcctTrnRec:
type: array
xml:
name: DepAcctTrnRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/DepAcctTrnRec'
fee:
type: array
xml:
name: Fee
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/FeeType'
mktgInfo:
maxLength: 255
minLength: 1
type: string
xml:
name: MktgInfo
attribute: false
wrapped: false
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
relRefId:
maxLength: 16
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RelRefId
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeCurAmt:
$ref: '#/components/schemas/SelRangeCurAmt'
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
sprefId:
type: array
items:
type: string
status:
$ref: '#/components/schemas/StatusType'
stmtDateTime:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: StmtDateTime
attribute: false
wrapped: false
stmtMemo:
minLength: 1
type: string
xml:
name: StmtMemo
attribute: false
wrapped: false
sumEntries:
$ref: '#/components/schemas/SumEntries'
trnSrc:
type: array
xml:
name: TrnSrc
attribute: false
wrapped: false
items:
minLength: 1
type: string
trnType:
type: array
xml:
name: TrnType
attribute: false
wrapped: false
items:
minLength: 1
type: string
txnRefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: TxnRefId
attribute: false
wrapped: false
xml:
name: DepAcctTrnInqRs
attribute: false
wrapped: false
DepAcctTrnRec:
title: DepAcctTrnRec
type: object
properties:
atmtrnInfo:
$ref: '#/components/schemas/ATMTrnInfo'
availDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: AvailDt
attribute: false
wrapped: false
bankAcctTrnRec:
$ref: '#/components/schemas/BankAcctTrnRec'
cardAcctIdTo:
$ref: '#/components/schemas/CardAcctIdTo'
chkNum:
maxLength: 12
minLength: 1
type: string
xml:
name: ChkNum
attribute: false
wrapped: false
compositeCurAmt:
type: array
xml:
name: CompositeCurAmt
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CompositeCurAmt'
depAcctIdTo:
$ref: '#/components/schemas/DepAcctIdTo'
loanAcctIdTo:
$ref: '#/components/schemas/LoanAcctIdTo'
networkTrnInfo:
$ref: '#/components/schemas/NetworkTrnInfoType'
pmtId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: PmtId
attribute: false
wrapped: false
usaachtrnInfo:
$ref: '#/components/schemas/USAACHTrnInfo'
xferId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: XferId
attribute: false
wrapped: false
DepAppAcctIdType:
title: DepAppAcctIdType
type: object
properties:
acctCur:
maxLength: 22
minLength: 1
type: string
xml:
name: AcctCur
attribute: false
wrapped: false
acctId:
maxLength: 255
minLength: 1
pattern: '[^"']*'
type: string
description: FROM account number
xml:
name: AcctId
attribute: false
wrapped: false
acctKey:
maxLength: 22
minLength: 1
type: string
xml:
name: AcctKey
attribute: false
wrapped: false
acctType:
minLength: 1
type: string
xml:
name: AcctType
attribute: false
wrapped: false
bankInfo:
$ref: '#/components/schemas/BankInfo'
DepAppAddRqType:
title: DepAppAddRqType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
depAppInfo:
$ref: '#/components/schemas/DepAppInfoType'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: DepAppAddRq_Type
attribute: false
wrapped: false
DepAppAddRsType:
title: DepAppAddRsType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
depAppInfo:
$ref: '#/components/schemas/DepAppInfoType'
depAppRec:
$ref: '#/components/schemas/DepAppRecType'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
DepAppAudRqType:
title: DepAppAudRqType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
depAppId:
type: array
xml:
name: DepAppId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
xml:
name: DepAppAudRq_Type
attribute: false
wrapped: false
DepAppAudRsType:
title: DepAppAudRsType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
depAppId:
type: array
xml:
name: DepAppId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
depAppMsgRec:
type: array
xml:
name: DepAppMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/DepAppMsgRecType'
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
status:
$ref: '#/components/schemas/StatusType'
xml:
name: DepAppAudRs_Type
attribute: false
wrapped: false
DepAppCanRqType:
title: DepAppCanRqType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
depAppId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: DepAppId
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: DepAppCanRq_Type
attribute: false
wrapped: false
DepAppCanRsType:
title: DepAppCanRsType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
depAppId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: DepAppId
attribute: false
wrapped: false
depAppRec:
$ref: '#/components/schemas/DepAppRecType'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
DepAppInfoType:
title: DepAppInfoType
type: object
properties:
bankAcctInfo:
$ref: '#/components/schemas/BankAcctInfoType'
cardType:
minLength: 1
type: string
xml:
name: CardType
attribute: false
wrapped: false
createdDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
depAppAcctId:
$ref: '#/components/schemas/DepAppAcctIdType'
depApplicant:
type: array
xml:
name: DepApplicant
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/DepApplicantType'
overdraftFunding:
type: array
xml:
name: OverdraftFunding
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/OverdraftFundingType'
DepAppInqRqType:
title: DepAppInqRqType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
depAppId:
type: array
xml:
name: DepAppId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
incToken:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncToken
attribute: false
wrapped: false
enum:
- '0'
- '1'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: DepAppInqRq_Type
attribute: false
wrapped: false
DepAppInqRsType:
title: DepAppInqRsType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
depAppId:
type: array
xml:
name: DepAppId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
depAppRec:
type: array
xml:
name: DepAppRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/DepAppRecType'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: DepAppInqRs_Type
attribute: false
wrapped: false
DepAppModRqType:
title: DepAppModRqType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
depAppId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: DepAppId
attribute: false
wrapped: false
depAppInfo:
$ref: '#/components/schemas/DepAppInfoType'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: DepAppModRq_Type
attribute: false
wrapped: false
DepAppModRsType:
title: DepAppModRsType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
depAppId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: DepAppId
attribute: false
wrapped: false
depAppInfo:
$ref: '#/components/schemas/DepAppInfoType'
depAppRec:
$ref: '#/components/schemas/DepAppRecType'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
DepAppMsgRecType:
title: DepAppMsgRecType
type: object
properties:
custId:
$ref: '#/components/schemas/CustId'
depAppAddRs:
$ref: '#/components/schemas/DepAppAddRsType'
depAppCanRs:
$ref: '#/components/schemas/DepAppCanRsType'
depAppModRs:
$ref: '#/components/schemas/DepAppModRsType'
msgRecDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: MsgRecDt
attribute: false
wrapped: false
DepAppRecType:
title: DepAppRecType
type: object
properties:
depAppId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: DepAppId
attribute: false
wrapped: false
depAppInfo:
$ref: '#/components/schemas/DepAppInfoType'
depAppStatus:
$ref: '#/components/schemas/DepAppStatusType'
DepAppStatusType:
title: DepAppStatusType
type: object
properties:
depAppStatusCode:
minLength: 1
type: string
description: StatusCode as Per IFX XML
xml:
name: DepAppStatusCode
attribute: false
wrapped: false
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
statusDesc:
maxLength: 255
minLength: 1
type: string
description: Text description for status code
xml:
name: StatusDesc
attribute: false
wrapped: false
statusModBy:
minLength: 1
type: string
xml:
name: StatusModBy
attribute: false
wrapped: false
DepAppSyncRqType:
title: DepAppSyncRqType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: DepAppSyncRq_Type
attribute: false
wrapped: false
DepAppSyncRsType:
title: DepAppSyncRsType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
depAppMsgRec:
type: array
xml:
name: DepAppMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/DepAppMsgRecType'
newToken:
maxLength: 36
minLength: 1
type: string
xml:
name: NewToken
attribute: false
wrapped: false
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
xml:
name: DepAppSyncRs_Type
attribute: false
wrapped: false
DepApplicantType:
title: DepApplicantType
type: object
properties:
custId:
$ref: '#/components/schemas/CustId'
custInfo:
$ref: '#/components/schemas/CustInfoType'
depApplicantAcctRel:
type: array
xml:
name: DepApplicantAcctRel
attribute: false
wrapped: false
items:
minLength: 1
type: string
DepBkOrdAddRq:
title: DepBkOrdAddRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
depBkOrdInfo:
$ref: '#/components/schemas/DepBkOrdInfo'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: DepBkOrdAddRq
attribute: false
wrapped: false
DepBkOrdAddRs:
title: DepBkOrdAddRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
depBkOrdInfo:
$ref: '#/components/schemas/DepBkOrdInfo'
depBkOrdRec:
$ref: '#/components/schemas/DepBkOrdRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
xml:
name: DepBkOrdAddRs
attribute: false
wrapped: false
DepBkOrdInfo:
title: DepBkOrdInfo
type: object
properties:
count:
type: integer
format: int64
xml:
name: Count
attribute: false
wrapped: false
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
depAcctId:
$ref: '#/components/schemas/DepAcctId'
depBkStyleId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: DepBkStyleId
attribute: false
wrapped: false
DepBkOrdRec:
title: DepBkOrdRec
type: object
properties:
depBkOrdId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: DepBkOrdId
attribute: false
wrapped: false
depBkOrdInfo:
$ref: '#/components/schemas/DepBkOrdInfo'
depBkOrdStatus:
$ref: '#/components/schemas/DepBkOrdStatus'
DepBkOrdStatus:
title: DepBkOrdStatus
type: object
properties:
depBkOrdStatusCode:
minLength: 1
type: string
description: StatusCode as Per IFX XML
xml:
name: DepBkOrdStatusCode
attribute: false
wrapped: false
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
statusDesc:
maxLength: 255
minLength: 1
type: string
description: Text description for status code
xml:
name: StatusDesc
attribute: false
wrapped: false
statusModBy:
minLength: 1
type: string
xml:
name: StatusModBy
attribute: false
wrapped: false
DetSeqTag50:
title: DetSeqTag50
type: object
properties:
detTagSeq50X:
$ref: '#/components/schemas/DetTagSeq50X'
seqNbr:
type: integer
format: int64
xml:
name: SeqNbr
attribute: false
wrapped: false
DetSeqTag50Type:
title: DetSeqTag50Type
type: object
properties:
detTagSeq50X:
$ref: '#/components/schemas/DetTagSeq50X'
seqNbr:
type: integer
format: int64
xml:
name: SeqNbr
attribute: false
wrapped: false
xml:
name: DetSeqTag50_Type
attribute: false
wrapped: false
DetSeqTag51:
title: DetSeqTag51
type: object
properties:
detTagSeq51A:
$ref: '#/components/schemas/DetTagSeq51A'
detTagSeq51B:
$ref: '#/components/schemas/DetTagSeq51B'
DetSeqTag51Type:
title: DetSeqTag51Type
type: object
properties:
detTagSeq51A:
$ref: '#/components/schemas/DetTagSeq51A'
detTagSeq51B:
$ref: '#/components/schemas/DetTagSeq51B'
xml:
name: DetSeqTag51_Type
attribute: false
wrapped: false
DetSeqTag93:
title: DetSeqTag93
type: object
properties:
detTagSeq93A:
$ref: '#/components/schemas/DetTagSeq93A'
seqNbr:
type: integer
format: int64
xml:
name: SeqNbr
attribute: false
wrapped: false
DetSeqTag93Type:
title: DetSeqTag93Type
type: object
properties:
detTagSeq93A:
$ref: '#/components/schemas/DetTagSeq93A'
seqNbr:
type: integer
format: int64
xml:
name: SeqNbr
attribute: false
wrapped: false
xml:
name: DetSeqTag93_Type
attribute: false
wrapped: false
DetSeqTag99:
title: DetSeqTag99
type: object
properties:
detTag99SeqA:
$ref: '#/components/schemas/DetTag99SeqA'
DetSeqTag99Type:
title: DetSeqTag99Type
type: object
properties:
detTag99SeqA:
$ref: '#/components/schemas/DetTag99SeqA'
xml:
name: DetSeqTag99_Type
attribute: false
wrapped: false
DetSeqTag9X:
title: DetSeqTag9X
type: object
properties:
adjustInd:
type: string
xml:
name: AdjustInd
attribute: false
wrapped: false
enum:
- '91'
- '92'
detSeqTag93:
$ref: '#/components/schemas/DetSeqTag93'
detSeqTag99:
$ref: '#/components/schemas/DetSeqTag99'
detTagSeq9XA:
$ref: '#/components/schemas/DetTagSeq9XA'
detTagSeq9XB:
$ref: '#/components/schemas/DetTagSeq9XB'
seqNbr:
type: integer
format: int64
xml:
name: SeqNbr
attribute: false
wrapped: false
DetSeqTag9XType:
title: DetSeqTag9XType
type: object
properties:
adjustInd:
type: string
xml:
name: AdjustInd
attribute: false
wrapped: false
enum:
- '91'
- '92'
detSeqTag93:
$ref: '#/components/schemas/DetSeqTag93'
detSeqTag99:
$ref: '#/components/schemas/DetSeqTag99'
detTagSeq9XA:
$ref: '#/components/schemas/DetTagSeq9XA'
detTagSeq9XB:
$ref: '#/components/schemas/DetTagSeq9XB'
seqNbr:
type: integer
format: int64
xml:
name: SeqNbr
attribute: false
wrapped: false
xml:
name: DetSeqTag9x_Type
attribute: false
wrapped: false
DetTag99SeqA:
title: DetTag99SeqA
type: object
properties:
fin:
maxLength: 5
minLength: 1
type: string
xml:
name: Fin
attribute: false
wrapped: false
mesDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
mesTm:
$ref: '#/components/schemas/XMLGregorianCalendar'
pageNbr:
type: integer
format: int64
xml:
name: PageNbr
attribute: false
wrapped: false
DetTag99SeqAType:
title: DetTag99SeqAType
type: object
properties:
fin:
maxLength: 5
minLength: 1
type: string
xml:
name: Fin
attribute: false
wrapped: false
mesDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
mesTm:
$ref: '#/components/schemas/XMLGregorianCalendar'
pageNbr:
type: integer
format: int64
xml:
name: PageNbr
attribute: false
wrapped: false
xml:
name: DetTag99SeqA_Type
attribute: false
wrapped: false
DetTagSeq50X:
title: DetTagSeq50X
type: object
properties:
acctId:
maxLength: 255
minLength: 1
pattern: '[^"']*'
type: string
description: FROM account number
xml:
name: AcctId
attribute: false
wrapped: false
amtBt:
$ref: '#/components/schemas/AmtBt'
amtSld:
$ref: '#/components/schemas/AmtSld'
autoFndInd:
minLength: 1
type: string
xml:
name: AutoFndInd
attribute: false
wrapped: false
enum:
- 'Y'
- 'N'
fxcontNbr:
maxLength: 6
minLength: 1
type: string
valDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: ValDt
attribute: false
wrapped: false
DetTagSeq50XType:
title: DetTagSeq50XType
type: object
properties:
acctId:
maxLength: 255
minLength: 1
pattern: '[^"']*'
type: string
description: FROM account number
xml:
name: AcctId
attribute: false
wrapped: false
amtBt:
$ref: '#/components/schemas/AmtBt'
amtSld:
$ref: '#/components/schemas/AmtSld'
autoFndInd:
minLength: 1
type: string
xml:
name: AutoFndInd
attribute: false
wrapped: false
enum:
- 'Y'
- 'N'
fxcontNbr:
maxLength: 6
minLength: 1
type: string
valDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: ValDt
attribute: false
wrapped: false
xml:
name: DetTagSeq50X_Type
attribute: false
wrapped: false
DetTagSeq51A:
title: DetTagSeq51A
type: object
properties:
acctId:
maxLength: 255
minLength: 1
pattern: '[^"']*'
type: string
description: FROM account number
xml:
name: AcctId
attribute: false
wrapped: false
actValDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
amtFnd:
$ref: '#/components/schemas/AmtFnd'
origValDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
DetTagSeq51AType:
title: DetTagSeq51AType
type: object
properties:
acctId:
maxLength: 255
minLength: 1
pattern: '[^"']*'
type: string
description: FROM account number
xml:
name: AcctId
attribute: false
wrapped: false
actValDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
amtFnd:
$ref: '#/components/schemas/AmtFnd'
origValDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
xml:
name: DetTagSeq51A_Type
attribute: false
wrapped: false
DetTagSeq51B:
title: DetTagSeq51B
type: object
properties:
tranRefNbr:
maxLength: 16
minLength: 1
type: string
xml:
name: TranRefNbr
attribute: false
wrapped: false
wlAcctId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: WlAcctId
attribute: false
wrapped: false
DetTagSeq51BType:
title: DetTagSeq51BType
type: object
properties:
tranRefNbr:
maxLength: 16
minLength: 1
type: string
xml:
name: TranRefNbr
attribute: false
wrapped: false
wlAcctId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: WlAcctId
attribute: false
wrapped: false
xml:
name: DetTagSeq51B_Type
attribute: false
wrapped: false
DetTagSeq93A:
title: DetTagSeq93A
type: object
properties:
chSerNbr:
type: integer
format: int64
xml:
name: ChSerNbr
attribute: false
wrapped: false
voidDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
DetTagSeq93AType:
title: DetTagSeq93AType
type: object
properties:
chSerNbr:
type: integer
format: int64
xml:
name: ChSerNbr
attribute: false
wrapped: false
voidDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
xml:
name: DetTagSeq93A_Type
attribute: false
wrapped: false
DetTagSeq9XA:
title: DetTagSeq9XA
type: object
properties:
adjustDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
amtAdj:
$ref: '#/components/schemas/AmtAdj'
fxContNbr:
maxLength: 6
minLength: 1
type: string
xml:
name: FxContNbr
attribute: false
wrapped: false
fxRate:
type: number
xml:
name: FxRate
attribute: false
wrapped: false
txnRefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: TxnRefId
attribute: false
wrapped: false
DetTagSeq9XAType:
title: DetTagSeq9XAType
type: object
properties:
adjustDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
amtAdj:
$ref: '#/components/schemas/AmtAdj'
fxContNbr:
maxLength: 6
minLength: 1
type: string
xml:
name: FxContNbr
attribute: false
wrapped: false
fxRate:
type: number
xml:
name: FxRate
attribute: false
wrapped: false
txnRefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: TxnRefId
attribute: false
wrapped: false
xml:
name: DetTagSeq9xA_Type
attribute: false
wrapped: false
DetTagSeq9XB:
title: DetTagSeq9XB
type: object
properties:
acctId:
maxLength: 255
minLength: 1
pattern: '[^"']*'
type: string
description: FROM account number
xml:
name: AcctId
attribute: false
wrapped: false
amtAdjB:
$ref: '#/components/schemas/AmtAdjB'
DetTagSeq9XBType:
title: DetTagSeq9XBType
type: object
properties:
acctId:
maxLength: 255
minLength: 1
pattern: '[^"']*'
type: string
description: FROM account number
xml:
name: AcctId
attribute: false
wrapped: false
amtAdjB:
$ref: '#/components/schemas/AmtAdjB'
xml:
name: DetTagSeq9xB_Type
attribute: false
wrapped: false
DfltPmtInfo:
title: DfltPmtInfo
type: object
properties:
cardAcctIdFrom:
$ref: '#/components/schemas/CardAcctIdFrom'
category:
maxLength: 40
minLength: 1
type: string
xml:
name: Category
attribute: false
wrapped: false
depAcctIdFrom:
$ref: '#/components/schemas/DepAcctIdFrom'
memo:
maxLength: 1024
minLength: 1
type: string
xml:
name: Memo
attribute: false
wrapped: false
DiscInfo:
title: DiscInfo
type: object
properties:
acceptReqd:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: AcceptReqd
attribute: false
wrapped: false
enum:
- '0'
- '1'
discURL:
maxLength: 1024
minLength: 1
type: string
xml:
name: DiscURL
attribute: false
wrapped: false
longText:
minLength: 1
type: string
xml:
name: LongText
attribute: false
wrapped: false
DiscInqRq:
title: DiscInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
discId:
type: array
xml:
name: DiscId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
svcName:
type: array
xml:
name: SvcName
attribute: false
wrapped: false
items:
minLength: 1
type: string
upDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
xml:
name: DiscInqRq
attribute: false
wrapped: false
DiscInqRs:
title: DiscInqRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
discId:
type: array
xml:
name: DiscId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
discRec:
type: array
xml:
name: DiscRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/DiscRec'
newUpDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
svcName:
type: array
xml:
name: SvcName
attribute: false
wrapped: false
items:
minLength: 1
type: string
upDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
xml:
name: DiscInqRs
attribute: false
wrapped: false
DiscRec:
title: DiscRec
type: object
properties:
discId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: DiscId
attribute: false
wrapped: false
discInfo:
$ref: '#/components/schemas/DiscInfo'
Discount:
title: Discount
type: object
properties:
curAmt:
$ref: '#/components/schemas/CurAmt'
desc:
maxLength: 80
minLength: 1
type: string
xml:
name: Desc
attribute: false
wrapped: false
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
rate:
type: number
xml:
name: Rate
attribute: false
wrapped: false
DomXferFeeCurAmt:
title: DomXferFeeCurAmt
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
DriversLicenseType:
title: DriversLicenseType
type: object
properties:
country:
maxLength: 35
minLength: 1
type: string
xml:
name: Country
attribute: false
wrapped: false
licenseNum:
maxLength: 32
minLength: 1
type: string
xml:
name: LicenseNum
attribute: false
wrapped: false
stateProv:
maxLength: 32
minLength: 1
type: string
xml:
name: StateProv
attribute: false
wrapped: false
EmploymentHistoryType:
title: EmploymentHistoryType
type: object
properties:
employmentStatus:
minLength: 1
type: string
xml:
name: EmploymentStatus
attribute: false
wrapped: false
endDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: EndDt
attribute: false
wrapped: false
income:
$ref: '#/components/schemas/IncomeType'
jobTitle:
maxLength: 32
minLength: 1
type: string
xml:
name: JobTitle
attribute: false
wrapped: false
occupation:
maxLength: 50
minLength: 1
type: string
xml:
name: Occupation
attribute: false
wrapped: false
orgInfo:
$ref: '#/components/schemas/OrgInfoType'
startDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: StartDt
attribute: false
wrapped: false
EnrollProf:
title: EnrollProf
type: object
properties:
cryptType:
minLength: 1
type: string
xml:
name: CryptType
attribute: false
wrapped: false
custNameReqd:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: CustNameReqd
attribute: false
wrapped: false
enum:
- '0'
- '1'
enrollDesc:
maxLength: 255
minLength: 1
type: string
xml:
name: EnrollDesc
attribute: false
wrapped: false
postAddrReqd:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: PostAddrReqd
attribute: false
wrapped: false
enum:
- '0'
- '1'
secretPrompt:
type: array
xml:
name: SecretPrompt
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/SecretPrompt'
webEnrollURL:
maxLength: 1024
minLength: 1
type: string
xml:
name: WebEnrollURL
attribute: false
wrapped: false
EntryMethodDetails:
title: EntryMethodDetails
type: object
properties:
entryMethod:
minLength: 1
type: string
xml:
name: EntryMethod
attribute: false
wrapped: false
entryReason:
minLength: 1
type: string
xml:
name: EntryReason
attribute: false
wrapped: false
ExtAcctBal:
title: ExtAcctBal
type: object
properties:
curAmt:
$ref: '#/components/schemas/CurAmt'
desc:
maxLength: 80
minLength: 1
type: string
xml:
name: Desc
attribute: false
wrapped: false
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
expDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
description: Contract Expiry Datetime
xml:
name: ExpDt
attribute: false
wrapped: false
extBalType:
minLength: 1
type: string
xml:
name: ExtBalType
attribute: false
wrapped: false
FSPayeeType:
title: FSPayeeType
type: object
properties:
contactInfo:
$ref: '#/components/schemas/ContactInfo'
eurClearingCountryCode:
minLength: 1
type: string
xml:
name: EurClearingCountryCode
attribute: false
wrapped: false
legalName:
maxLength: 35
minLength: 1
type: string
xml:
name: LegalName
attribute: false
wrapped: false
orgContact:
$ref: '#/components/schemas/OrgContact'
orgId:
type: array
xml:
name: OrgId
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/OrgId'
postAddr:
$ref: '#/components/schemas/PostAddr'
FXConfSettlStatusType:
title: FXConfSettlStatusType
type: object
properties:
fxconfSettlStatusCode:
maxLength: 10
minLength: 1
type: string
fxconfSettlStatusDesc:
maxLength: 255
minLength: 1
type: string
FXDealCntrPrtyType:
title: FXDealCntrPrtyType
type: object
properties:
acctId:
maxLength: 255
minLength: 1
pattern: '[^"']*'
type: string
description: FROM account number
xml:
name: AcctId
attribute: false
wrapped: false
bankId:
maxLength: 34
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: BankId
attribute: false
wrapped: false
bankIdType:
minLength: 1
type: string
xml:
name: BankIdType
attribute: false
wrapped: false
cntrPrtyType:
minLength: 1
type: string
xml:
name: CntrPrtyType
attribute: false
wrapped: false
enum:
- PARTY_A
- PARTY_B
- FUND_BENE_CUST
- DELIVERY_AGENT
- INTERMEDIARY
- RECEIVING_AGENT
- BENEFICIARY_INSTITUTION
- DEALING_BRANCH_PARTY_A
- DEALING_BRANCH_PARTY_B
- BROKER_IDENTIFICATION
name:
maxLength: 40
minLength: 1
type: string
xml:
name: Name
attribute: false
wrapped: false
postAddr:
$ref: '#/components/schemas/PostAddr'
FeeChargeAlloc:
title: FeeChargeAlloc
type: object
properties:
chargeRegulation:
minLength: 1
type: string
xml:
name: ChargeRegulation
attribute: false
wrapped: false
enum:
- OUR
- BEN
- SHA
depAcctId:
$ref: '#/components/schemas/DepAcctId'
fee:
$ref: '#/components/schemas/FeeType'
FeeType:
title: FeeType
type: object
properties:
curAmt:
$ref: '#/components/schemas/CurAmt'
feeType:
minLength: 1
type: string
xml:
name: FeeType
attribute: false
wrapped: false
maxCurAmt:
$ref: '#/components/schemas/MaxCurAmt'
minCurAmt:
$ref: '#/components/schemas/MinCurAmt'
rate:
type: number
xml:
name: Rate
attribute: false
wrapped: false
FinalCurAmt:
title: FinalCurAmt
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
FloorLmt:
title: FloorLmt
type: object
properties:
creditAmt:
$ref: '#/components/schemas/CreditAmt'
debitAmt:
$ref: '#/components/schemas/DebitAmt'
ForExConfSettlInqRqType:
title: ForExConfSettlInqRqType
type: object
properties:
buyCurCode:
maxLength: 3
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: BuyCurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
delUndel:
minLength: 1
type: string
xml:
name: DelUndel
attribute: false
wrapped: false
enum:
- DELIVERED
- UNDELIVERED
- BOTH
opType:
minLength: 1
type: string
xml:
name: OpType
attribute: false
wrapped: false
enum:
- NEWT
- AMND
- CANC
- EXOP
- DUPL
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
sellCurCode:
maxLength: 4
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: SellCurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
sendRefNbr:
maxLength: 16
minLength: 1
type: string
xml:
name: SendRefNbr
attribute: false
wrapped: false
xml:
name: ForExConfSettlInqRq_Type
attribute: false
wrapped: false
ForExConfSettlInqRsType:
title: ForExConfSettlInqRsType
type: object
properties:
buyAmt:
$ref: '#/components/schemas/BuyAmtType'
cbclsrefNbr:
minLength: 1
type: string
clsrefNbr:
minLength: 1
type: string
delUndel:
minLength: 1
type: string
xml:
name: DelUndel
attribute: false
wrapped: false
enum:
- DELIVERED
- UNDELIVERED
- BOTH
fxconfSettlStatus:
$ref: '#/components/schemas/FXConfSettlStatusType'
opType:
minLength: 1
type: string
xml:
name: OpType
attribute: false
wrapped: false
enum:
- NEWT
- AMND
- CANC
- EXOP
- DUPL
relRefNbr:
maxLength: 16
minLength: 1
type: string
xml:
name: RelRefNbr
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sellAmt:
$ref: '#/components/schemas/SellAmtType'
sendRefNbr:
maxLength: 16
minLength: 1
type: string
xml:
name: SendRefNbr
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
xml:
name: ForExConfSettlInqRs_Type
attribute: false
wrapped: false
ForExConfSettlRqType:
title: ForExConfSettlRqType
type: object
properties:
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
seqNbr15A:
$ref: '#/components/schemas/SeqNbr15AType'
seqNbr15B:
$ref: '#/components/schemas/SeqNbr15BType'
seqNbr15C:
$ref: '#/components/schemas/SeqNbr15CType'
seqNbr15D:
$ref: '#/components/schemas/SeqNbr15DType'
xml:
name: ForExConfSettlRq_Type
attribute: false
wrapped: false
ForExConfSettlRsType:
title: ForExConfSettlRsType
type: object
properties:
opType:
minLength: 1
type: string
xml:
name: OpType
attribute: false
wrapped: false
enum:
- NEWT
- AMND
- CANC
- EXOP
- DUPL
relRefNbr:
maxLength: 16
minLength: 1
type: string
xml:
name: RelRefNbr
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sendRefNbr:
maxLength: 16
minLength: 1
type: string
xml:
name: SendRefNbr
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
xml:
name: ForExConfSettlRs_Type
attribute: false
wrapped: false
ForExDealInfo:
type: object
properties:
content:
type: array
items:
type: object
properties:
forExRateDealType:
maxLength: 4
minLength: 1
type: string
description: Echoed from Customer Request.
xml:
name: ForExRateDealType
attribute: false
wrapped: false
deliveryMethod:
minLength: 1
type: string
xml:
name: DeliveryMethod
benchFixing:
maxLength: 20
minLength: 1
type: string
xml:
name: BenchFixing
curAmt:
$ref: '#/components/schemas/CurAmt'
curCode:
minLength: 1
type: string
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
type: string
xml:
name: CurConvertRule
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
expDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: ExpDt
issueAmt:
type: number
xml:
name: IssueAmt
issueCurCode:
minLength: 1
type: string
description: issue currency
xml:
name: IssueCurCode
remitAmt:
type: number
xml:
name: RemitAmt
sprefId:
type: string
ForExDealRec:
title: ForExDealRec
type: object
properties:
forExDealId:
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: ForExDealId
attribute: false
wrapped: false
forExDealInfo:
$ref: '#/components/schemas/ForExDealInfo'
forExDealStatus:
minLength: 1
type: string
xml:
name: ForExDealStatus
attribute: false
wrapped: false
ForExRateDealAddRq:
title: ForExRateDealAddRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
forExDealInfo:
$ref: '#/components/schemas/ForExDealInfo'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
SignonRq:
$ref: '#/components/schemas/SignonRqType'
BankSvcRq:
type: object
description: |
$ref: '#/definitions/BankSvcRqType'
xml:
name: ForExRateDealAddRq
attribute: false
wrapped: false
ForExRateDealAddRs:
title: ForExRateDealAddRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
forExDealInfo:
$ref: '#/components/schemas/ForExDealInfo'
forExDealRec:
$ref: '#/components/schemas/ForExDealRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request. Echoed from customer request.
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
PrefPrice:
maxLength: 1
type: string
description: >-
Preferred pricing indicator.
N - Default value for standard
pricing.
Value must be 'W' for Alipay Wallet payments, 'E' for
UPI Cards payment and ‘Z’ for Dandelion Wallet payments.
BaseNo:
maxLength: 10
type: string
description: >-
FXLM Base Number. If provided this base number will be passed to
FXLM for pricing and settlement. Only one of or
may be provided. If neither is present the OLR to base
number configuration will be used. Echoed from customer request.
FXLMEntity:
maxLength: 10
type: string
description: >-
If provided this Entity will be passed to FXLM for pricing and
settlement. Only one of or may be provided. If
neither is present the OLR to base number configuration will be
used. Echoed from customer request.
WLFlag:
maxLength: 1
type: string
description: >-
Account processing and settlement. W – Standard WorldLink account
processing and settlement
N- Bypass all WorldLink account
processing and settlement. Pass the numeric detail TRN to
FXLM.
O- Bypass all WorldLink account processing and settlement.
Pass the OLR numeric sequence number as the TRN to FXLM.
If not
provided default will be W
Echoed from customer request.
DealType:
maxLength: 1
type: string
description: >-
Deal type. Deal type- ‘B’ for all bench deals for bench fixing
rates
Deal type- ‘Q’ for all real time quoted rate deals This
must be coordinated with QUOTED fixing type
Deal Type- 'O' book
per OLR parameters
Default value will be O, if not
provided
xml:
name: ForExRateDealAddRs
attribute: false
wrapped: false
ForExRateInfo:
title: ForExRateInfo
type: object
properties:
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
curAmt:
$ref: '#/components/schemas/CurAmt'
curConvertRule:
maxLength: 35
minLength: 1
type: string
description: >-
Currency conversion method Direct/Indirect. Direct maps to multiply
and Indirect maps to Divide. This is how the rate is expressed or
interpreted.
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
description: FX Rate
xml:
name: CurRate
attribute: false
wrapped: false
ForExTnr:
maxLength: 2
type: string
description: >-
Tenor value from frontend. Two Alphanumeric code for tenor.0 SP, TN,
SD & BA. Conditional when FX request has Tenor listed as SD or TN or
SP, OLR will book the FX and respond with the same requested tenor
value. If the request is having BA as tenor value, OLR will
determine tenor value either as SD or TN or SP based on FX
availablity.
ForExValDt:
maxLength: 10
type: string
description: >-
Value date required only if ForExValDtType is Future. Data type is
"Date" as defined in IFX XML. FX contract Value Date mapped as
yyyy-mm-dd. Value date is required if ForExValDtType is Future
GPP to map the value date if Client profile is set up for FX
Request type as Value date
FxRateWithoutMarkup:
maxLength: 8
type: string
description: >-
Base FX rate. FX rate without spread. Base market rate available
during deal booking. Cross FX rate calculated without spread. Sample
value - 1.21340000
PartnerSpreadPercentage:
maxLength: 3
type: string
description: >-
Citi’s spread for Amazon. Spread applied on the FX deal as per
Client FX profile OLR will return the SPREAD value in BPS format.
Sample value - 50/100/250.
TargetSpreadAmount:
maxLength: 15
type: string
description: >-
Citi's P&L in funding currency. OLR actual P&L will be realized post
cover booking. During Client deal booking OLR can only share the
SPREAD difference from Client rate and Market rate. This expected
P&L can be different from the actual realized P&L after cover
booking. Calculate expected P&L from the difference of Client rate
and Market rate. Convert expected USD P&L in funding currency using
Market rate. Sample value - +12.23 or - 12.23.
PartnerSpreadCurrency:
maxLength: 3
type: string
description: Citi's profit currency. Funding currency from the request.
expDt:
maxLength: 19
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
description: >-
Contract Expiry Datetime. Not mapped to backend format. Format:
yyyy-mm-ddThh:mm:ss. This is the expiry datetime for this contract.
This may be a few minutes for a rate offer and may be few days for a
committed rate. This will be the Rate expiry time.
xml:
name: ExpDt
attribute: false
wrapped: false
fee:
type: array
xml:
name: Fee
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/FeeType'
issueAmt:
type: number
description: Issue Amount
xml:
name: IssueAmt
attribute: false
wrapped: false
issueCurCode:
maxLength: 3
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Currency Code for Issue Amount. Echoed from Customer Request
ForExRateInqRq.
xml:
name: IssueCurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
remitAmt:
type: number
description: Remit Amount.
xml:
name: RemitAmt
attribute: false
wrapped: false
remitCurCode:
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Currency Code for Remit Amount. Echoed from Customer Request
ForExRateInqRq.
xml:
name: RemitCurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
sprefId:
maxLength: 35
type: string
description: >-
Userid/transactionID In Control Record. If the ForExRateRq had
ForExRateType=Indicated then this field provides the Deal Offer ID
to be used in the ForExDealAddRq for approving/rejecting the Deal.
To be used for Rate Quote for new clients.
ForExRateInqRq:
title: ForExRateInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
benchFixing:
maxLength: 20
minLength: 1
type: string
description: >-
Fixing on which it is booked on Bench. Required only for Bench
Deals. Sample Fixings:
Sydney 09:00 SYD0900CITI
Sydney
09:45 SYD0945CITI
Tokyo 09:55 TOK0955CITI
Tokyo 11:00
TOK1100CITI
Tokyo 13:00 TOK1300CITI
Tokyo 14:00
TOK1400CITI
Tokyo 15:00 TOK1500CITI
Tokyo 16:00
TOK1600CITI
Tokyo 17:00 TOK1700CITI
London 09:00
LDN0900CITI
London 10:00 LDN1000CITI
London 11:00
LDN1100CITI
London 12:00 LDN1200CITI
London 13:15
LDN1315CITI
London 15:00 LDN1500CITI
London 16:00
LDN1600CITI
New York 12:00 NYK1200CITI
New York 15:00
NYK1500CITI
Request next available permissioned
fixing.
NEXTFIXING
For real time quoted
rate use:
QUOTED
This is used when deal type is ‘Q’ for quoted
xml:
name: BenchFixing
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
curAmt:
$ref: '#/components/schemas/CurAmt'
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: >-
Currency conversion method Direct/Indirect. Direct maps to multiply
and Indirect maps to Divide. This is how the rate is expressed or
interpreted.
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
custId:
$ref: '#/components/schemas/CustId'
DeliveryMethod:
maxLength: 35
minLength: 1
type: string
description: >-
DEALID6 or DEALID16. DeliveryMethod is required if the Transaction
Type is RREQXPCT(F/X RateRequest is with OLR Sequence Number). If
absent the default is RREQ (F/X RateRequest with Control
Record)
DEALID16 corresponds to RREQXPCT and DEALID6 or by
default corresponds to RREQ. This is the value currently populated
by CMX clients. This will no longer be used and new API clients need
not provide the same.
ClntSprd:
maxLength: 5
type: string
description: Client given Spread value as received in payment instruction.
xml:
name: DeliveryMethod
attribute: false
wrapped: false
depAcctId:
$ref: '#/components/schemas/DepAcctId'
forExRateDealType:
minLength: 1
type: string
description: Deal type
xml:
name: ForExRateDealType
attribute: false
wrapped: false
forExRateType:
minLength: 1
type: string
description: Values Indicated or Committed
xml:
name: ForExRateType
attribute: false
wrapped: false
enum:
- INDICATED
- COMMITTED
forExValDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
forExValDtType:
minLength: 1
type: string
description: Daily, Spot or Future
xml:
name: ForExValDtType
attribute: false
wrapped: false
issueAmt:
type: number
description: >-
Amount to buy or sell. If the element is remit amount it will be
associated with RemitCurCode and if the element is IssueAmt it will
be associated with IssueCurCode. If RemitAmt is provided it means
you are selling the currency and if IssueAmt is provided it means
you are buying a currency.
xml:
name: IssueAmt
attribute: false
wrapped: false
issueCurCode:
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Currency Code for Issue Amount. ISO currency code. Mandatory field
for rate request. Will be validated for a valid currency code.
xml:
name: IssueCurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
payAcct:
maxLength: 35
minLength: 1
type: string
description: >-
Citi Account held at Citi Branch routing id (valid Citi acct). This
is only passed if requesting OLR to credit a source requested Citi
account. Previous tag must also be sent in conjunction with this
tag.
xml:
name: PayAcct
attribute: false
wrapped: false
payBrnch:
maxLength: 3
minLength: 1
type: string
description: >-
Citi Branch routing id (valid Citi Branch). This is only passed if
requesting OLR to credit a source requested Citi account. Next tag
must also be sent in conjunction with this tag.
xml:
name: PayBrnch
attribute: false
wrapped: false
remitAcct:
maxLength: 35
minLength: 1
type: string
description: >-
Citi Account held at Citi Branch routing id (valid Citi acct). This
is only passed if requesting OLR to debit a source requested Citi
account. remitBrnch must also be sent.
xml:
name: RemitAcct
attribute: false
wrapped: false
remitAmt:
type: number
description: >-
Amount to buy or sell. If the element is remit amount it will be
associated with RemitCurCode and if the element is IssueAmt it will
be associated with IssueCurCode. If RemitAmt is provided it means
you are selling the currency and if IssueAmt is provided it means
you are buying a currency.
xml:
name: RemitAmt
attribute: false
wrapped: false
remitBrnch:
maxLength: 3
minLength: 1
type: string
description: >-
Citi Branch routing ID (valid Citi Branch). This is only passed if
the requesting OLR to debit a source requested Citi account.
RemitAcct must also be sent.
xml:
name: RemitBrnch
attribute: false
wrapped: false
remitCurCode:
maxLength: 3
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Currency Code for Remit Amount. Remit Currency. ISO currency code.
Mandatory field for rate request. Will be validated for a valid
currency code.
xml:
name: RemitCurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
rqUID:
maxLength: 35
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: ForExRateInqRq
attribute: false
wrapped: false
ForExRateInqRs:
title: ForExRateInqRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
curAmt:
$ref: '#/components/schemas/CurAmt'
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
maxLength: 35
minLength: 1
type: string
description: >-
Currency conversion method Direct/Indirect. Direct maps to multiply
and Indirect maps to Divide. The default is Direct (i.e. multiply in
backend).
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
depAcctId:
$ref: '#/components/schemas/DepAcctId'
forExRateDealType:
minLength: 1
type: string
description: Deal type
xml:
name: ForExRateDealType
attribute: false
wrapped: false
forExRateRec:
$ref: '#/components/schemas/ForExRateRec'
forExRateType:
maxLength: 35
minLength: 1
type: string
description: Values Indicated or Committed.
xml:
name: ForExRateType
attribute: false
wrapped: false
enum:
- INDICATED
- COMMITTED
forExValDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
forExValDtType:
minLength: 1
type: string
description: Daily, Spot or Future
xml:
name: ForExValDtType
attribute: false
wrapped: false
issueAmt:
type: number
xml:
name: IssueAmt
attribute: false
wrapped: false
issueCurCode:
maxLength: 3
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Currency Code for Issue Amount. Echoed from Customer Request
ForExRateInqRq.
xml:
name: IssueCurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
remitAmt:
type: number
description: >-
Remit Amount or Issue Amount. Echoed from Customer Request
ForExRateInqRq.
xml:
name: RemitAmt
attribute: false
wrapped: false
remitCurCode:
maxLength: 3
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Currency Code for Remit Amount. Echoed from Customer Request
ForExRateInqRq.
xml:
name: RemitCurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request. Echoed from customer request.
xml:
name: RqUID
attribute: false
wrapped: false
PrefPrice:
maxLength: 1
type: string
description: >-
Preferred pricing indicator. N - Default value for standard pricing.
Value must be ‘W’ for Alipay Wallet payments and ‘E’ for UPI Cards
payment. Echoed from customer request.
BaseNo:
maxLength: 10
type: string
description: >-
FXLM Base Number. If provided this base number will be passed to
FXLM for pricing and settlement. Only one of or
may be provided. If neither is present the OLR to base
number configuration will be used. Echoed from customer request.
FXLMEntity:
maxLength: 10
type: string
description: >-
If provided this Entity will be passed to FXLM for pricing and
settlement. Only one of or may be provided. If
neither is present the OLR to base number configuration will be
used. Echoed from customer request.
WLFlag:
maxLength: 1
type: string
description: >-
Account processing and settlement. W – Standard WorldLink account
processing and settlement
N- Bypass all WorldLink account
processing and settlement. Pass the numeric detail TRN to
FXLM.
O- Bypass all WorldLink account processing and settlement.
Pass the OLR numeric sequence number as the TRN to FXLM.
If not
provided default will be W
Echoed from customer request.
DealType:
$ref: '#/components/schemas/StatusType'
xml:
name: ForExRateInqRs
attribute: false
wrapped: false
ForExRateRec:
title: ForExRateRec
type: object
properties:
benchFixing:
maxLength: 20
minLength: 1
type: string
description: Fixing on which it is booked on Bench.
xml:
name: BenchFixing
attribute: false
wrapped: false
forExRateId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
The commited FX contract ID. This parameter is present if the
ForExRateRq had ForExRateType=Committed and the deal was
successfully booked.
xml:
name: ForExRateId
attribute: false
wrapped: false
forExRateInfo:
$ref: '#/components/schemas/ForExRateInfo'
forExValDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
forExValDtType:
minLength: 1
type: string
description: Daily, Spot or Future
xml:
name: ForExValDtType
attribute: false
wrapped: false
GermanyCBR:
title: GermanyCBR
type: object
properties:
buyingCountryCode:
maxLength: 2
minLength: 1
type: string
xml:
name: BuyingCountryCode
attribute: false
wrapped: false
countryOfPurchaseName:
maxLength: 37
minLength: 1
type: string
xml:
name: CountryOfPurchaseName
attribute: false
wrapped: false
payorCountryCode:
maxLength: 2
minLength: 1
type: string
xml:
name: PayorCountryCode
attribute: false
wrapped: false
payorCountryName:
maxLength: 35
minLength: 1
type: string
xml:
name: PayorCountryName
attribute: false
wrapped: false
typeOfGoodsBought:
maxLength: 27
minLength: 1
type: string
xml:
name: TypeOfGoodsBought
attribute: false
wrapped: false
typeOfGoodsSold:
maxLength: 1
minLength: 1
type: string
xml:
name: TypeOfGoodsSold
attribute: false
wrapped: false
HighCurAmt:
title: HighCurAmt
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
HolInfo:
title: HolInfo
type: object
properties:
holDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
name:
maxLength: 40
minLength: 1
type: string
xml:
name: Name
attribute: false
wrapped: false
HolInqRq:
title: HolInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
spname:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Always set to CTSI
svcName:
minLength: 1
type: string
xml:
name: SvcName
attribute: false
wrapped: false
xml:
name: HolInqRq
attribute: false
wrapped: false
HolInqRs:
title: HolInqRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
holInfo:
type: array
xml:
name: HolInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/HolInfo'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
spname:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Always set to CTSI
status:
$ref: '#/components/schemas/StatusType'
svcName:
minLength: 1
type: string
xml:
name: SvcName
attribute: false
wrapped: false
xml:
name: HolInqRs
attribute: false
wrapped: false
HopData:
title: HopData
type: object
properties:
hopBrkNo:
maxLength: 15
minLength: 1
type: string
xml:
name: HopBrkNo
attribute: false
wrapped: false
hopDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
hopRecordNo:
type: integer
format: int64
xml:
name: HopRecordNo
attribute: false
wrapped: false
totHopAmt:
type: number
xml:
name: TotHopAmt
attribute: false
wrapped: false
totHopCnt:
type: integer
format: int64
xml:
name: TotHopCnt
attribute: false
wrapped: false
HopDataType:
title: HopDataType
type: object
properties:
hopBrkNo:
maxLength: 15
minLength: 1
type: string
xml:
name: HopBrkNo
attribute: false
wrapped: false
hopDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
hopRecordNo:
type: integer
format: int64
xml:
name: HopRecordNo
attribute: false
wrapped: false
totHopAmt:
type: number
xml:
name: TotHopAmt
attribute: false
wrapped: false
totHopCnt:
type: integer
format: int64
xml:
name: TotHopCnt
attribute: false
wrapped: false
xml:
name: HopData_Type
attribute: false
wrapped: false
IFXType:
title: IFXType
type: object
properties:
baseSvcRqOrBankSvcRqOrPaySvcRqOrPresSvcRqOrPresSvcRqTypeOrMediaSvcRq:
type: array
description: >-
refer to [BankSvcRqType](#BankSvcRqType) or
#/definitions/BaseSvcRqType or #/definitions/PaySvcRqType or
#/definitions/PresSvcRqType Or #/definitions/MediaSvcRqType
items:
type: object
properties: {}
baseSvcRsOrBankSvcRsOrPaySvcRsOrPresSvcRsOrMediaSvcRs:
type: array
description: >-
refer to #/definitions/BankSvcRsType and #/definitions/BaseSvcRsType
and #/definitions/PaySvcRsType or #/definitions/PresSvcRsType or
#/definitions/MediaSvcRsType
items:
type: object
properties: {}
signoffRq:
$ref: '#/components/schemas/SignoffRqType'
signoffRs:
$ref: '#/components/schemas/SignoffRsType'
signonRq:
$ref: '#/components/schemas/SignonRqType'
signonRs:
$ref: '#/components/schemas/SignonRs'
status:
type: array
xml:
name: Status
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/StatusType'
xml:
name: IFX_Type
attribute: false
wrapped: false
IncomeType:
title: IncomeType
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
IndustId:
title: IndustId
type: object
properties:
industNum:
minLength: 1
type: string
xml:
name: IndustNum
attribute: false
wrapped: false
org:
maxLength: 36
minLength: 1
type: string
description: Customer System application manufacturer
xml:
name: Org
attribute: false
wrapped: false
InitialCurAmt:
title: InitialCurAmt
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
InitialDepositType:
title: InitialDepositType
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
InsPaidCurAmt:
title: InsPaidCurAmt
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
IntRateInfoType:
title: IntRateInfoType
type: object
properties:
desc:
maxLength: 80
minLength: 1
type: string
xml:
name: Desc
attribute: false
wrapped: false
highCurAmt:
$ref: '#/components/schemas/HighCurAmt'
intAPY:
type: number
xml:
name: IntAPY
attribute: false
wrapped: false
lowCurAmt:
$ref: '#/components/schemas/LowCurAmt'
rate:
type: number
xml:
name: Rate
attribute: false
wrapped: false
term:
$ref: '#/components/schemas/Term'
IntRateInqRq:
title: IntRateInqRq
type: object
properties:
acctTaxStatus:
minLength: 1
type: string
xml:
name: AcctTaxStatus
attribute: false
wrapped: false
acctType:
minLength: 1
type: string
xml:
name: AcctType
attribute: false
wrapped: false
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
curAmt:
$ref: '#/components/schemas/CurAmt'
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
term:
$ref: '#/components/schemas/Term'
xml:
name: IntRateInqRq
attribute: false
wrapped: false
IntRateInqRs:
title: IntRateInqRs
type: object
properties:
acctTaxStatus:
minLength: 1
type: string
xml:
name: AcctTaxStatus
attribute: false
wrapped: false
acctType:
minLength: 1
type: string
xml:
name: AcctType
attribute: false
wrapped: false
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
curAmt:
$ref: '#/components/schemas/CurAmt'
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
intRateInfo:
type: array
xml:
name: IntRateInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/IntRateInfoType'
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
term:
$ref: '#/components/schemas/Term'
xml:
name: IntRateInqRs
attribute: false
wrapped: false
InterXferProf:
title: InterXferProf
type: object
properties:
domXferFeeCurAmt:
$ref: '#/components/schemas/DomXferFeeCurAmt'
intlXferFeeCurAmt:
$ref: '#/components/schemas/IntlXferFeeCurAmt'
usaachprof:
$ref: '#/components/schemas/USAACHProf'
xferProf:
$ref: '#/components/schemas/XferProf'
IntermediaryDepAcct:
title: IntermediaryDepAcct
type: object
properties:
depAcctId:
$ref: '#/components/schemas/DepAcctId'
seqNum:
type: integer
format: int64
xml:
name: SeqNum
attribute: false
wrapped: false
IntermediaryType:
title: IntermediaryType
type: object
properties:
bankId:
maxLength: 34
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: BankId
attribute: false
wrapped: false
bankIdType:
minLength: 1
type: string
xml:
name: BankIdType
attribute: false
wrapped: false
branchId:
maxLength: 22
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: BranchId
attribute: false
wrapped: false
branchName:
maxLength: 40
minLength: 1
type: string
xml:
name: BranchName
attribute: false
wrapped: false
city:
maxLength: 35
minLength: 1
type: string
xml:
name: City
attribute: false
wrapped: false
country:
maxLength: 35
minLength: 1
type: string
xml:
name: Country
attribute: false
wrapped: false
name:
maxLength: 40
minLength: 1
type: string
xml:
name: Name
attribute: false
wrapped: false
postAddr:
$ref: '#/components/schemas/PostAddr'
postalCode:
maxLength: 35
minLength: 1
type: string
xml:
name: PostalCode
attribute: false
wrapped: false
refInfo:
type: array
xml:
name: RefInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/RefInfo'
stateProv:
maxLength: 32
minLength: 1
type: string
xml:
name: StateProv
attribute: false
wrapped: false
IntlXferFeeCurAmt:
title: IntlXferFeeCurAmt
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
InvoiceAdj:
title: InvoiceAdj
type: object
properties:
adjType:
minLength: 1
type: string
xml:
name: AdjType
attribute: false
wrapped: false
curAmt:
$ref: '#/components/schemas/CurAmt'
desc:
maxLength: 80
minLength: 1
type: string
xml:
name: Desc
attribute: false
wrapped: false
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
invoiceAdjNum:
maxLength: 32
minLength: 1
type: string
xml:
name: InvoiceAdjNum
attribute: false
wrapped: false
InvoiceInfo:
title: InvoiceInfo
type: object
properties:
desc:
maxLength: 80
minLength: 1
type: string
xml:
name: Desc
attribute: false
wrapped: false
discount:
$ref: '#/components/schemas/Discount'
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
fee:
type: array
xml:
name: Fee
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/FeeType'
invoiceAdj:
$ref: '#/components/schemas/InvoiceAdj'
invoiceLineItem:
type: array
xml:
name: InvoiceLineItem
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/InvoiceLineItem'
invoiceNum:
maxLength: 32
minLength: 1
type: string
xml:
name: InvoiceNum
attribute: false
wrapped: false
invoicePremium:
$ref: '#/components/schemas/InvoicePremium'
invoiceType:
minLength: 1
type: string
xml:
name: InvoiceType
attribute: false
wrapped: false
invoiceVouchNum:
maxLength: 80
minLength: 1
type: string
xml:
name: InvoiceVouchNum
attribute: false
wrapped: false
paidCurAmt:
$ref: '#/components/schemas/PaidCurAmt'
refInfo:
type: array
xml:
name: RefInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/RefInfo'
taxInfo:
$ref: '#/components/schemas/TaxInfoType'
totalCurAmt:
$ref: '#/components/schemas/TotalCurAmt'
InvoiceLineItem:
title: InvoiceLineItem
type: object
properties:
adjType:
minLength: 1
type: string
xml:
name: AdjType
attribute: false
wrapped: false
curAmt:
$ref: '#/components/schemas/CurAmt'
desc:
maxLength: 80
minLength: 1
type: string
xml:
name: Desc
attribute: false
wrapped: false
invoiceLineItemNum:
maxLength: 12
minLength: 1
type: string
xml:
name: InvoiceLineItemNum
attribute: false
wrapped: false
InvoicePremium:
title: InvoicePremium
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
InvoiceReceiver:
title: InvoiceReceiver
type: object
properties:
orgId:
$ref: '#/components/schemas/OrgId'
orgInfo:
$ref: '#/components/schemas/OrgInfoType'
postAddr:
$ref: '#/components/schemas/PostAddr'
InvoiceSender:
title: InvoiceSender
type: object
properties:
acctPayAcct:
maxLength: 35
minLength: 1
type: string
xml:
name: AcctPayAcct
attribute: false
wrapped: false
orgId:
$ref: '#/components/schemas/OrgId'
orgInfo:
$ref: '#/components/schemas/OrgInfoType'
postAddr:
$ref: '#/components/schemas/PostAddr'
IssueCurAmt:
title: IssueCurAmt
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
LOCAcctRec:
title: LOCAcctRec
type: object
properties:
expDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
description: >-
Contract Expiry Datetime. Not mapped to backend format. Format
yyyy-mm-ddThh:mm:ss. This is the expiry datetime for this contract.
This may be a few minutes for a rate offer and may be few days for a
committed rate.
xml:
name: ExpDt
attribute: false
wrapped: false
loanInfoCommon:
$ref: '#/components/schemas/LoanInfoCommon'
loclimit:
$ref: '#/components/schemas/LOCLimit'
minPmtCurAmt:
$ref: '#/components/schemas/MinPmtCurAmt'
LOCLimit:
title: LOCLimit
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
LastDepCurAmt:
title: LastDepCurAmt
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
LastPmtCurAmt:
title: LastPmtCurAmt
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
LastYrInsPaidCurAmt:
title: LastYrInsPaidCurAmt
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
LastYrTaxPaidCurAmt:
title: LastYrTaxPaidCurAmt
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
LoanAcctId:
title: LoanAcctId
type: object
properties:
acctId:
maxLength: 255
minLength: 1
pattern: '[^"']*'
type: string
description: FROM account number
xml:
name: AcctId
attribute: false
wrapped: false
acctType:
minLength: 1
type: string
xml:
name: AcctType
attribute: false
wrapped: false
bankInfo:
$ref: '#/components/schemas/BankInfo'
LoanAcctIdFrom:
title: LoanAcctIdFrom
type: object
properties:
acctId:
maxLength: 255
minLength: 1
pattern: '[^"']*'
type: string
description: FROM account number
xml:
name: AcctId
attribute: false
wrapped: false
acctType:
minLength: 1
type: string
xml:
name: AcctType
attribute: false
wrapped: false
bankInfo:
$ref: '#/components/schemas/BankInfo'
LoanAcctIdTo:
title: LoanAcctIdTo
type: object
properties:
acctId:
maxLength: 255
minLength: 1
pattern: '[^"']*'
type: string
description: FROM account number
xml:
name: AcctId
attribute: false
wrapped: false
acctType:
minLength: 1
type: string
xml:
name: AcctType
attribute: false
wrapped: false
bankInfo:
$ref: '#/components/schemas/BankInfo'
LoanAcctIdType:
title: LoanAcctIdType
type: object
properties:
acctId:
maxLength: 255
minLength: 1
pattern: '[^"']*'
type: string
description: FROM account number
xml:
name: AcctId
attribute: false
wrapped: false
acctType:
minLength: 1
type: string
xml:
name: AcctType
attribute: false
wrapped: false
bankInfo:
$ref: '#/components/schemas/BankInfo'
xml:
name: LoanAcctId_Type
attribute: false
wrapped: false
LoanAcctRec:
title: LoanAcctRec
type: object
properties:
loanInfoCommon:
$ref: '#/components/schemas/LoanInfoCommon'
matDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
term:
$ref: '#/components/schemas/Term'
LoanInfoCommon:
title: LoanInfoCommon
type: object
properties:
collateralDesc:
maxLength: 80
minLength: 1
type: string
xml:
name: CollateralDesc
attribute: false
wrapped: false
completedPmtCount:
type: integer
format: int64
xml:
name: CompletedPmtCount
attribute: false
wrapped: false
dueDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
freq:
minLength: 1
type: string
xml:
name: Freq
attribute: false
wrapped: false
lastPmtCurAmt:
$ref: '#/components/schemas/LastPmtCurAmt'
lastPmtDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
nextPmtCurAmt:
$ref: '#/components/schemas/NextPmtCurAmt'
origDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
pastDuePmtCount:
type: integer
format: int64
xml:
name: PastDuePmtCount
attribute: false
wrapped: false
prepayPenalty:
$ref: '#/components/schemas/PrepayPenalty'
purposeDesc:
maxLength: 80
minLength: 1
type: string
xml:
name: PurposeDesc
attribute: false
wrapped: false
regPmtCurAmt:
$ref: '#/components/schemas/RegPmtCurAmt'
remainingPmtCount:
type: integer
format: int64
xml:
name: RemainingPmtCount
attribute: false
wrapped: false
LockboxDepIdType:
title: LockboxDepIdType
type: object
properties:
depAcctId:
$ref: '#/components/schemas/DepAcctId'
lockboxAcctId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: LockboxAcctId
attribute: false
wrapped: false
Logo:
title: Logo
type: object
properties:
binData:
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
type: string
format: byte
xml:
name: BinData
attribute: false
wrapped: false
binLength:
type: integer
format: int64
xml:
name: BinLength
attribute: false
wrapped: false
contentType:
minLength: 1
type: string
xml:
name: ContentType
attribute: false
wrapped: false
LowCurAmt:
title: LowCurAmt
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
MaxCurAmt:
title: MaxCurAmt
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
MediaAcctAdjAddRq:
title: MediaAcctAdjAddRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
mediaAcctAdjInfo:
$ref: '#/components/schemas/MediaAcctAdjInfo'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: MediaAcctAdjAddRq
attribute: false
wrapped: false
MediaAcctAdjAddRs:
title: MediaAcctAdjAddRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
mediaAcctAdjInfo:
$ref: '#/components/schemas/MediaAcctAdjInfo'
mediaAcctAdjRec:
$ref: '#/components/schemas/MediaAcctAdjRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
MediaAcctAdjAudRq:
title: MediaAcctAdjAudRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
mediaAcctAdjId:
type: array
xml:
name: MediaAcctAdjId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
xml:
name: MediaAcctAdjAudRq
attribute: false
wrapped: false
MediaAcctAdjAudRs:
title: MediaAcctAdjAudRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
mediaAcctAdjId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: MediaAcctAdjId
attribute: false
wrapped: false
mediaAcctAdjMsgRec:
type: array
xml:
name: MediaAcctAdjMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/MediaAcctAdjMsgRec'
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
status:
$ref: '#/components/schemas/StatusType'
xml:
name: MediaAcctAdjAudRs
attribute: false
wrapped: false
MediaAcctAdjInfo:
title: MediaAcctAdjInfo
type: object
properties:
curAmt:
$ref: '#/components/schemas/CurAmt'
mediaAcctId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: MediaAcctId
attribute: false
wrapped: false
mediaItem:
type: array
xml:
name: MediaItem
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/MediaItemType'
mediaTrnType:
minLength: 1
type: string
xml:
name: MediaTrnType
attribute: false
wrapped: false
trnAuthId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: TrnAuthId
attribute: false
wrapped: false
MediaAcctAdjInqRq:
title: MediaAcctAdjInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
type: array
items:
maxLength: 36
minLength: 1
type: string
custId:
$ref: '#/components/schemas/CustId'
mediaAcctAdjId:
type: array
xml:
name: MediaAcctAdjId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
mediaAcctId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: MediaAcctId
attribute: false
wrapped: false
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeCurAmt:
$ref: '#/components/schemas/SelRangeCurAmt'
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
sprefId:
type: array
items:
type: string
xml:
name: MediaAcctAdjInqRq
attribute: false
wrapped: false
MediaAcctAdjInqRs:
title: MediaAcctAdjInqRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
type: array
items:
maxLength: 36
minLength: 1
type: string
custId:
$ref: '#/components/schemas/CustId'
mediaAcctAdjId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: MediaAcctAdjId
attribute: false
wrapped: false
mediaAcctAdjRec:
type: array
xml:
name: MediaAcctAdjRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/MediaAcctAdjRec'
mediaAcctId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: MediaAcctId
attribute: false
wrapped: false
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeCurAmt:
$ref: '#/components/schemas/SelRangeCurAmt'
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
sprefId:
type: array
items:
type: string
status:
$ref: '#/components/schemas/StatusType'
xml:
name: MediaAcctAdjInqRs
attribute: false
wrapped: false
MediaAcctAdjMsgRec:
title: MediaAcctAdjMsgRec
type: object
properties:
custId:
$ref: '#/components/schemas/CustId'
mediaAcctAdjAddRs:
$ref: '#/components/schemas/MediaAcctAdjAddRs'
msgRecDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: MsgRecDt
attribute: false
wrapped: false
MediaAcctAdjRec:
title: MediaAcctAdjRec
type: object
properties:
mediaAcctAdjId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: MediaAcctAdjId
attribute: false
wrapped: false
mediaAcctAdjInfo:
$ref: '#/components/schemas/MediaAcctAdjInfo'
MediaAcctAdjSyncRq:
title: MediaAcctAdjSyncRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
mediaAcctId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: MediaAcctId
attribute: false
wrapped: false
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: MediaAcctAdjSyncRq
attribute: false
wrapped: false
MediaAcctAdjSyncRs:
title: MediaAcctAdjSyncRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
mediaAcctAdjMsgRec:
type: array
xml:
name: MediaAcctAdjMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/MediaAcctAdjMsgRec'
mediaAcctId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: MediaAcctId
attribute: false
wrapped: false
newToken:
maxLength: 36
minLength: 1
type: string
xml:
name: NewToken
attribute: false
wrapped: false
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: MediaAcctAdjSyncRs
attribute: false
wrapped: false
MediaAcctInventoryInqRq:
title: MediaAcctInventoryInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
mediaAcctId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: MediaAcctId
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: MediaAcctInventoryInqRq
attribute: false
wrapped: false
MediaAcctInventoryInqRs:
title: MediaAcctInventoryInqRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
curAmt:
$ref: '#/components/schemas/CurAmt'
custId:
$ref: '#/components/schemas/CustId'
mediaAcctId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: MediaAcctId
attribute: false
wrapped: false
mediaItem:
type: array
xml:
name: MediaItem
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/MediaItemType'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
xml:
name: MediaAcctInventoryInqRs
attribute: false
wrapped: false
MediaItemType:
title: MediaItemType
type: object
properties:
count:
type: integer
format: int64
xml:
name: Count
attribute: false
wrapped: false
curAmt:
$ref: '#/components/schemas/CurAmt'
mediaContainerId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: MediaContainerId
attribute: false
wrapped: false
mediaSubType:
minLength: 1
type: string
xml:
name: MediaSubType
attribute: false
wrapped: false
mediaType:
minLength: 1
type: string
xml:
name: MediaType
attribute: false
wrapped: false
totalCurAmt:
$ref: '#/components/schemas/TotalCurAmt'
MediaSvcProfInfo:
title: MediaSvcProfInfo
type: object
properties:
msgSupt:
type: array
xml:
name: MsgSupt
attribute: false
wrapped: false
items:
minLength: 1
type: string
optSupt:
type: array
xml:
name: OptSupt
attribute: false
wrapped: false
items:
minLength: 1
type: string
svcCore:
$ref: '#/components/schemas/SvcCoreType'
MediaSvcRqType:
title: MediaSvcRqType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
mediaAcctAdjAddRqAndMediaAcctAdjInqRqAndMediaAcctAdjAudRq:
type: array
description: >-
refer to MediaAcctAdjAddRq, and #/definitions/MediaAcctAdjInqRq, and
#/definitions/MediaAcctAdjAudRq, and
#/definitions/MediaAcctAdjSyncRq, and
#/definitions/MediaAcctInventoryInqRq, and #/definitions/IncToken
items:
type: object
properties: {}
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
spname:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Always set to CTSI
xml:
name: MediaSvcRq_Type
attribute: false
wrapped: false
MediaSvcRsType:
title: MediaSvcRsType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
mediaAcctAdjAddRsAndMediaAcctAdjInqRsAndMediaAcctAdjAudRs:
type: array
description: >-
refer to MediaAcctAdjAddRs, and #/definitions/MediaAcctAdjInqRs, and
#/definitions/MediaAcctAdjAudRs, and
#/definitions/MediaAcctAdjSyncRs, and
#/definitions/MediaAcctInventoryInqRs
items:
type: object
properties: {}
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
spname:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Always set to CTSI
status:
$ref: '#/components/schemas/StatusType'
xml:
name: MediaSvcRs_Type
attribute: false
wrapped: false
MinAmtDue:
title: MinAmtDue
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
MinCurAmt:
title: MinCurAmt
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
MinPmtCurAmt:
title: MinPmtCurAmt
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
ModelAndView:
title: ModelAndView
type: object
properties:
empty:
type: boolean
model:
type: object
properties: {}
modelMap:
type: object
additionalProperties:
type: object
properties: {}
reference:
type: boolean
status:
type: string
enum:
- 100 CONTINUE
- 101 SWITCHING_PROTOCOLS
- 102 PROCESSING
- 103 CHECKPOINT
- 200 OK
- 201 CREATED
- 202 ACCEPTED
- 203 NON_AUTHORITATIVE_INFORMATION
- 204 NO_CONTENT
- 205 RESET_CONTENT
- 206 PARTIAL_CONTENT
- 207 MULTI_STATUS
- 208 ALREADY_REPORTED
- 226 IM_USED
- 300 MULTIPLE_CHOICES
- 301 MOVED_PERMANENTLY
- 302 FOUND
- 302 MOVED_TEMPORARILY
- 303 SEE_OTHER
- 304 NOT_MODIFIED
- 305 USE_PROXY
- 307 TEMPORARY_REDIRECT
- 308 PERMANENT_REDIRECT
- 400 BAD_REQUEST
- 401 UNAUTHORIZED
- 402 PAYMENT_REQUIRED
- 403 FORBIDDEN
- 404 NOT_FOUND
- 405 METHOD_NOT_ALLOWED
- 406 NOT_ACCEPTABLE
- 407 PROXY_AUTHENTICATION_REQUIRED
- 408 REQUEST_TIMEOUT
- 409 CONFLICT
- 410 GONE
- 411 LENGTH_REQUIRED
- 412 PRECONDITION_FAILED
- 413 PAYLOAD_TOO_LARGE
- 413 REQUEST_ENTITY_TOO_LARGE
- 414 URI_TOO_LONG
- 414 REQUEST_URI_TOO_LONG
- 415 UNSUPPORTED_MEDIA_TYPE
- 416 REQUESTED_RANGE_NOT_SATISFIABLE
- 417 EXPECTATION_FAILED
- 418 I_AM_A_TEAPOT
- 419 INSUFFICIENT_SPACE_ON_RESOURCE
- 420 METHOD_FAILURE
- 421 DESTINATION_LOCKED
- 422 UNPROCESSABLE_ENTITY
- 423 LOCKED
- 424 FAILED_DEPENDENCY
- 425 TOO_EARLY
- 426 UPGRADE_REQUIRED
- 428 PRECONDITION_REQUIRED
- 429 TOO_MANY_REQUESTS
- 431 REQUEST_HEADER_FIELDS_TOO_LARGE
- 451 UNAVAILABLE_FOR_LEGAL_REASONS
- 500 INTERNAL_SERVER_ERROR
- 501 NOT_IMPLEMENTED
- 502 BAD_GATEWAY
- 503 SERVICE_UNAVAILABLE
- 504 GATEWAY_TIMEOUT
- 505 HTTP_VERSION_NOT_SUPPORTED
- 506 VARIANT_ALSO_NEGOTIATES
- 507 INSUFFICIENT_STORAGE
- 508 LOOP_DETECTED
- 509 BANDWIDTH_LIMIT_EXCEEDED
- 510 NOT_EXTENDED
- 511 NETWORK_AUTHENTICATION_REQUIRED
view:
$ref: '#/components/schemas/View'
viewName:
type: string
MortAcctRec:
title: MortAcctRec
type: object
properties:
insPaidCurAmt:
$ref: '#/components/schemas/InsPaidCurAmt'
insPaidDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
lastPmtDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
lastYrInsPaidCurAmt:
$ref: '#/components/schemas/LastYrInsPaidCurAmt'
lastYrInsPaidDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
lastYrTaxPaidCurAmt:
$ref: '#/components/schemas/LastYrTaxPaidCurAmt'
lastYrTaxPaidDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
loanInfoCommon:
$ref: '#/components/schemas/LoanInfoCommon'
origDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
taxPaidCurAmt:
$ref: '#/components/schemas/TaxPaidCurAmt'
taxPaidDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
NACHAPmtAttr:
title: NACHAPmtAttr
type: object
properties:
nachapmtDesc:
minLength: 1
type: string
nachapmtMethod:
minLength: 1
type: string
NetworkTrnInfoType:
title: NetworkTrnInfoType
type: object
properties:
bankId:
maxLength: 34
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: BankId
attribute: false
wrapped: false
bankIdType:
minLength: 1
type: string
xml:
name: BankIdType
attribute: false
wrapped: false
desc:
maxLength: 80
minLength: 1
type: string
xml:
name: Desc
attribute: false
wrapped: false
name:
maxLength: 40
minLength: 1
type: string
xml:
name: Name
attribute: false
wrapped: false
networkOwner:
minLength: 1
type: string
xml:
name: NetworkOwner
attribute: false
wrapped: false
networkRefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: NetworkRefId
attribute: false
wrapped: false
originatorName:
maxLength: 40
minLength: 1
type: string
xml:
name: OriginatorName
attribute: false
wrapped: false
postAddr:
$ref: '#/components/schemas/PostAddr'
terminalId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: TerminalId
attribute: false
wrapped: false
NextPmtCurAmt:
title: NextPmtCurAmt
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
ObjectFactory:
title: ObjectFactory
type: object
OrderInstType:
title: OrderInstType
type: object
properties:
bankId:
maxLength: 34
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: BankId
attribute: false
wrapped: false
bankIdType:
minLength: 1
type: string
xml:
name: BankIdType
attribute: false
wrapped: false
branchId:
maxLength: 22
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: BranchId
attribute: false
wrapped: false
branchName:
maxLength: 40
minLength: 1
type: string
xml:
name: BranchName
attribute: false
wrapped: false
city:
maxLength: 35
minLength: 1
type: string
xml:
name: City
attribute: false
wrapped: false
country:
maxLength: 35
minLength: 1
type: string
xml:
name: Country
attribute: false
wrapped: false
name:
maxLength: 40
minLength: 1
type: string
xml:
name: Name
attribute: false
wrapped: false
postAddr:
$ref: '#/components/schemas/PostAddr'
postalCode:
maxLength: 35
minLength: 1
type: string
xml:
name: PostalCode
attribute: false
wrapped: false
refInfo:
type: array
xml:
name: RefInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/RefInfo'
stateProv:
maxLength: 32
minLength: 1
type: string
xml:
name: StateProv
attribute: false
wrapped: false
OrderingCustAddr:
title: OrderingCustAddr
type: object
properties:
postAddr:
$ref: '#/components/schemas/PostAddr'
OrderingCustIdType:
title: OrderingCustIdType
type: object
properties:
orderingCustIdType:
minLength: 1
type: string
xml:
name: OrderingCustIdType
attribute: false
wrapped: false
orderingCustRefId:
maxLength: 35
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: OrderingCustRefId
attribute: false
wrapped: false
OrderingPartyInfoType:
title: OrderingPartyInfoType
type: object
properties:
acctId:
maxLength: 255
minLength: 1
pattern: '[^"']*'
type: string
description: FROM account number
xml:
name: AcctId
attribute: false
wrapped: false
name:
maxLength: 40
minLength: 1
type: string
xml:
name: Name
attribute: false
wrapped: false
postAddr:
$ref: '#/components/schemas/PostAddr'
OrgContact:
title: OrgContact
type: object
properties:
contactType:
minLength: 1
type: string
xml:
name: ContactType
attribute: false
wrapped: false
desc:
maxLength: 80
minLength: 1
type: string
xml:
name: Desc
attribute: false
wrapped: false
emailAddr:
maxLength: 128
minLength: 1
type: string
xml:
name: EmailAddr
attribute: false
wrapped: false
fax:
minLength: 1
type: string
xml:
name: Fax
attribute: false
wrapped: false
phone:
minLength: 1
type: string
xml:
name: Phone
attribute: false
wrapped: false
url:
maxLength: 1024
minLength: 1
type: string
xml:
name: URL
attribute: false
wrapped: false
OrgId:
title: OrgId
type: object
properties:
orgIdNum:
maxLength: 36
minLength: 1
type: string
xml:
name: OrgIdNum
attribute: false
wrapped: false
orgIdType:
minLength: 1
type: string
xml:
name: OrgIdType
attribute: false
wrapped: false
OrgInfoType:
title: OrgInfoType
type: object
properties:
compositeContactInfo:
type: array
xml:
name: CompositeContactInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CompositeContactInfo'
establishDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
industId:
$ref: '#/components/schemas/IndustId'
legalName:
maxLength: 35
minLength: 1
type: string
xml:
name: LegalName
attribute: false
wrapped: false
name:
maxLength: 40
minLength: 1
type: string
xml:
name: Name
attribute: false
wrapped: false
numEmployees:
type: integer
format: int64
xml:
name: NumEmployees
attribute: false
wrapped: false
tininfo:
$ref: '#/components/schemas/TINInfoType'
OrgRec:
title: OrgRec
type: object
properties:
orgId:
type: array
xml:
name: OrgId
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/OrgId'
orgInfo:
$ref: '#/components/schemas/OrgInfoType'
xml:
name: OrgRec
attribute: false
wrapped: false
OrigCurAmt:
title: OrigCurAmt
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
OverdraftFundingType:
title: OverdraftFundingType
type: object
properties:
depAcctId:
$ref: '#/components/schemas/DepAcctId'
fundingPriority:
maxLength: 3
minLength: 1
type: string
xml:
name: FundingPriority
attribute: false
wrapped: false
loanAcctId:
$ref: '#/components/schemas/LoanAcctId'
PaidCurAmt:
title: PaidCurAmt
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
PartyContactInfoType:
title: PartyContactInfoType
type: object
properties:
dept:
maxLength: 35
minLength: 1
type: string
xml:
name: Dept
attribute: false
wrapped: false
fax:
minLength: 1
type: string
xml:
name: Fax
attribute: false
wrapped: false
name:
maxLength: 40
minLength: 1
type: string
xml:
name: Name
attribute: false
wrapped: false
phone:
minLength: 1
type: string
xml:
name: Phone
attribute: false
wrapped: false
telex:
minLength: 1
type: string
xml:
name: Telex
attribute: false
wrapped: false
PaySupt:
title: PaySupt
type: object
properties:
maxCurAmt:
$ref: '#/components/schemas/MaxCurAmt'
minCurAmt:
$ref: '#/components/schemas/MinCurAmt'
PaySvcProfInfo:
title: PaySvcProfInfo
type: object
properties:
daysWith:
type: integer
format: int64
xml:
name: DaysWith
attribute: false
wrapped: false
deliveryMethod:
type: array
xml:
name: DeliveryMethod
attribute: false
wrapped: false
items:
minLength: 1
type: string
dfltDaysToPay:
type: integer
format: int64
xml:
name: DfltDaysToPay
attribute: false
wrapped: false
dfltXferDaysToPay:
type: integer
format: int64
xml:
name: DfltXferDaysToPay
attribute: false
wrapped: false
histRetentionDays:
type: integer
format: int64
xml:
name: HistRetentionDays
attribute: false
wrapped: false
modPendingType:
minLength: 1
type: string
xml:
name: ModPendingType
attribute: false
wrapped: false
msgSupt:
type: array
xml:
name: MsgSupt
attribute: false
wrapped: false
items:
minLength: 1
type: string
optSupt:
type: array
xml:
name: OptSupt
attribute: false
wrapped: false
items:
minLength: 1
type: string
pmtModel:
minLength: 1
type: string
xml:
name: PmtModel
attribute: false
wrapped: false
prcSched:
$ref: '#/components/schemas/PrcSched'
recPmtProf:
$ref: '#/components/schemas/RecPmtProf'
svcCore:
$ref: '#/components/schemas/SvcCoreType'
PaySvcRqType:
title: PaySvcRqType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
pmtBatchId:
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: PmtBatchId
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
spname:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Always set to CTSI
stdPayeeInqRqAndCustPayeeAddRqAndCustPayeeModRq:
type: array
description: >-
refer to #/definitions/StdPayeeInqRqType, and
#/definitions/CustPayeeAddRq, and #/definitions/CustPayeeModRq, and
#/definitions/CustPayeeTypeModRq, and #/definitions/CustPayeeDelRq,
and #/definitions/CustPayeeInqRq, and #/definitions/CustPayeeAudRq,
and #/definitions/CustPayeeSyncRq, and #/definitions/PmtAddRq, and
#/definitions/PmtModRq, and #/definitions/PmtStatusModRq, and
#/definitions/PmtCanRq, and #/definitions/PmtInqRq, and
#/definitions/PmtAudRq, and #/definitions/PmtSyncRq, and
#/definitions/PmtAuthAddRq, and #/definitions/PmtAuthModRq, and
#/definitions/PmtAuthCanRq, and #/definitions/PmtAuthInqRq, and
#/definitions/PmtAuthAudRq, and #/definitions/PmtAuthSyncRq, and
#/definitions/RemitAddRq, and #/definitions/RemitModRq, and
#/definitions/RemitStatusModRq, and #/definitions/RemitDelRq, and
#/definitions/RemitInqRq, and #/definitions/RemitAudRq, and
#/definitions/RemitSyncRq, and #/definitions/RecFndAdviseRq, and
#/definitions/RecPmtAddRq, and #/definitions/RecPmtModRq, and
#/definitions/RecPmtCanRq, and #/definitions/RecPmtInqRq, and
#/definitions/RecPmtAudRq, and #/definitions/RecPmtSyncRq, and
#/definitions/PmtAckInqRq, and #/definitions/ChksumAddRq, and
#/definitions/ChksumModRq, and #/definitions/ChksumStatusModRq, and
#/definitions/ChksumDelRq, and #/definitions/ChksumInqRq, and
#/definitions/ChksumAudRq, and #/definitions/ChksumSyncRq, and
#/definitions/CompRemitStmtAddRqType, and
#/definitions/CompRemitStmtInqRqType, and
#/definitions/CompRemitStmtAudRqType, and
#/definitions/CompRemitStmtSyncRqType
items:
type: object
properties: {}
xml:
name: PaySvcRq_Type
attribute: false
wrapped: false
PaySvcRsType:
title: PaySvcRsType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
spname:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Always set to CTSI
status:
$ref: '#/components/schemas/StatusType'
stdPayeeInqRsAndCustPayeeAddRsAndCustPayeeModRs:
type: array
description: refer to "#/definitions/StdPayeeInqRs and
items:
type: object
properties: {}
xml:
name: PaySvcRs_Type
attribute: false
wrapped: false
PayerInfoType:
title: PayerInfoType
type: object
properties:
orgId:
$ref: '#/components/schemas/OrgId'
orgInfo:
$ref: '#/components/schemas/OrgInfoType'
personInfo:
$ref: '#/components/schemas/PersonInfo'
PersonInfo:
title: PersonInfo
type: object
properties:
birthDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
contactInfo:
$ref: '#/components/schemas/ContactInfo'
dependents:
type: integer
format: int64
xml:
name: Dependents
attribute: false
wrapped: false
driversLicense:
$ref: '#/components/schemas/DriversLicenseType'
employmentHistory:
type: array
xml:
name: EmploymentHistory
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/EmploymentHistoryType'
fullName:
maxLength: 96
minLength: 1
type: string
xml:
name: FullName
attribute: false
wrapped: false
gender:
minLength: 1
type: string
xml:
name: Gender
attribute: false
wrapped: false
maritalStatus:
minLength: 1
type: string
xml:
name: MaritalStatus
attribute: false
wrapped: false
motherMaidenName:
maxLength: 40
minLength: 1
type: string
xml:
name: MotherMaidenName
attribute: false
wrapped: false
nameAddrType:
minLength: 1
type: string
xml:
name: NameAddrType
attribute: false
wrapped: false
oedcode:
minLength: 1
type: string
oedinstitution:
minLength: 1
type: string
passportCountry:
maxLength: 3
minLength: 1
type: string
xml:
name: PassportCountry
attribute: false
wrapped: false
passportNumber:
maxLength: 32
minLength: 1
type: string
xml:
name: PassportNumber
attribute: false
wrapped: false
personName:
$ref: '#/components/schemas/PersonName'
spouseName:
maxLength: 40
minLength: 1
type: string
xml:
name: SpouseName
attribute: false
wrapped: false
tininfo:
$ref: '#/components/schemas/TINInfoType'
usamilitaryRank:
maxLength: 32
minLength: 1
type: string
PersonName:
title: PersonName
type: object
properties:
firstName:
maxLength: 40
minLength: 1
type: string
xml:
name: FirstName
attribute: false
wrapped: false
lastName:
type: array
xml:
name: LastName
attribute: false
wrapped: false
items:
maxLength: 40
minLength: 1
type: string
legalName:
maxLength: 35
minLength: 1
type: string
xml:
name: LegalName
attribute: false
wrapped: false
middleName:
type: array
xml:
name: MiddleName
attribute: false
wrapped: false
items:
maxLength: 40
minLength: 1
type: string
nameSuffix:
maxLength: 40
minLength: 1
type: string
xml:
name: NameSuffix
attribute: false
wrapped: false
nickname:
maxLength: 40
minLength: 1
type: string
xml:
name: Nickname
attribute: false
wrapped: false
titlePrefix:
maxLength: 8
minLength: 1
type: string
xml:
name: TitlePrefix
attribute: false
wrapped: false
PhoneNum:
title: PhoneNum
type: object
properties:
phone:
minLength: 1
type: string
xml:
name: Phone
attribute: false
wrapped: false
phoneType:
minLength: 1
type: string
xml:
name: PhoneType
attribute: false
wrapped: false
PmtAckInfo:
title: PmtAckInfo
type: object
properties:
compositeContactInfo:
$ref: '#/components/schemas/CompositeContactInfo'
curAmt:
$ref: '#/components/schemas/CurAmt'
memo:
maxLength: 1024
minLength: 1
type: string
xml:
name: Memo
attribute: false
wrapped: false
pmtId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: PmtId
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
PmtAckInqRq:
title: PmtAckInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDueDt:
$ref: '#/components/schemas/SelRangeDueDt'
svcRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: SvcRqUID
attribute: false
wrapped: false
xml:
name: PmtAckInqRq
attribute: false
wrapped: false
PmtAckInqRs:
title: PmtAckInqRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
count:
type: integer
format: int64
xml:
name: Count
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
pmtAckRec:
type: array
xml:
name: PmtAckRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/PmtAckRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDueDt:
$ref: '#/components/schemas/SelRangeDueDt'
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
svcRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: SvcRqUID
attribute: false
wrapped: false
xml:
name: PmtAckInqRs
attribute: false
wrapped: false
PmtAckRec:
title: PmtAckRec
type: object
properties:
pmtAckInfo:
type: array
xml:
name: PmtAckInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/PmtAckInfo'
svcRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: SvcRqUID
attribute: false
wrapped: false
PmtAddRq:
title: PmtAddRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
dupChkOverride:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: DupChkOverride
attribute: false
wrapped: false
enum:
- '0'
- '1'
pmtInfo:
$ref: '#/components/schemas/PmtInfoType'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
validationString:
$ref: '#/components/schemas/ValidationString'
xml:
name: PmtAddRq
attribute: false
wrapped: false
PmtAddRsType:
title: PmtAddRsType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
dupChkOverride:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: DupChkOverride
attribute: false
wrapped: false
enum:
- '0'
- '1'
pmtInfo:
$ref: '#/components/schemas/PmtInfoType'
pmtRec:
$ref: '#/components/schemas/PmtRecType'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
PmtAudRq:
title: PmtAudRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
pmtId:
type: array
xml:
name: PmtId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
xml:
name: PmtAudRq
attribute: false
wrapped: false
PmtAudRs:
title: PmtAudRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
pmtId:
type: array
xml:
name: PmtId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
pmtMsgRec:
type: array
xml:
name: PmtMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/PmtMsgRec'
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
status:
$ref: '#/components/schemas/StatusType'
xml:
name: PmtAudRs
attribute: false
wrapped: false
PmtAuthAddRq:
title: PmtAuthAddRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
pmtAuthInfo:
$ref: '#/components/schemas/PmtAuthInfo'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: PmtAuthAddRq
attribute: false
wrapped: false
PmtAuthAddRs:
title: PmtAuthAddRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
pmtAuthInfo:
$ref: '#/components/schemas/PmtAuthInfo'
pmtAuthRec:
$ref: '#/components/schemas/PmtAuthRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
PmtAuthAudRq:
title: PmtAuthAudRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
pmtAuthId:
type: array
xml:
name: PmtAuthId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
xml:
name: PmtAuthAudRq
attribute: false
wrapped: false
PmtAuthAudRs:
title: PmtAuthAudRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
pmtAuthId:
type: array
xml:
name: PmtAuthId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
pmtAuthMsgRec:
type: array
xml:
name: PmtAuthMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/PmtAuthMsgRec'
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
status:
$ref: '#/components/schemas/StatusType'
xml:
name: PmtAuthAudRs
attribute: false
wrapped: false
PmtAuthCanRq:
title: PmtAuthCanRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
pmtAuthId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: PmtAuthId
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: PmtAuthCanRq
attribute: false
wrapped: false
PmtAuthCanRs:
title: PmtAuthCanRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
pmtAuthId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: PmtAuthId
attribute: false
wrapped: false
pmtAuthRec:
$ref: '#/components/schemas/PmtAuthRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
PmtAuthInfo:
title: PmtAuthInfo
type: object
properties:
cardAcctIdFrom:
$ref: '#/components/schemas/CardAcctIdFrom'
curAmt:
$ref: '#/components/schemas/CurAmt'
depAcctIdFrom:
$ref: '#/components/schemas/DepAcctIdFrom'
name:
maxLength: 40
minLength: 1
type: string
xml:
name: Name
attribute: false
wrapped: false
PmtAuthInqRq:
title: PmtAuthInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
pmtAuthId:
type: array
xml:
name: PmtAuthId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeCurAmt:
$ref: '#/components/schemas/SelRangeCurAmt'
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
xml:
name: PmtAuthInqRq
attribute: false
wrapped: false
PmtAuthInqRs:
title: PmtAuthInqRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
pmtAuthId:
type: array
xml:
name: PmtAuthId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
pmtAuthRec:
type: array
xml:
name: PmtAuthRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/PmtAuthRec'
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeCurAmt:
$ref: '#/components/schemas/SelRangeCurAmt'
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
status:
$ref: '#/components/schemas/StatusType'
xml:
name: PmtAuthInqRs
attribute: false
wrapped: false
PmtAuthModRq:
title: PmtAuthModRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
pmtAuthId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: PmtAuthId
attribute: false
wrapped: false
pmtAuthInfo:
$ref: '#/components/schemas/PmtAuthInfo'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: PmtAuthModRq
attribute: false
wrapped: false
PmtAuthModRs:
title: PmtAuthModRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
pmtAuthId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: PmtAuthId
attribute: false
wrapped: false
pmtAuthInfo:
$ref: '#/components/schemas/PmtAuthInfo'
pmtAuthRec:
$ref: '#/components/schemas/PmtAuthRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
PmtAuthMsgRec:
title: PmtAuthMsgRec
type: object
properties:
custId:
$ref: '#/components/schemas/CustId'
msgRecDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: MsgRecDt
attribute: false
wrapped: false
pmtAuthAddRs:
$ref: '#/components/schemas/PmtAuthAddRs'
pmtAuthCanRs:
$ref: '#/components/schemas/PmtAuthCanRs'
pmtAuthModRs:
$ref: '#/components/schemas/PmtAuthModRs'
PmtAuthRec:
title: PmtAuthRec
type: object
properties:
pmtAuthId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: PmtAuthId
attribute: false
wrapped: false
pmtAuthInfo:
$ref: '#/components/schemas/PmtAuthInfo'
pmtAuthStatus:
$ref: '#/components/schemas/PmtAuthStatus'
PmtAuthStatus:
title: PmtAuthStatus
type: object
properties:
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
expDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
description: Contract Expiry Datetime
xml:
name: ExpDt
attribute: false
wrapped: false
pmtAuthStatusCode:
minLength: 1
type: string
description: StatusCode as Per IFX XML
xml:
name: PmtAuthStatusCode
attribute: false
wrapped: false
statusDesc:
maxLength: 255
minLength: 1
type: string
description: Text description for status code
xml:
name: StatusDesc
attribute: false
wrapped: false
statusModBy:
minLength: 1
type: string
xml:
name: StatusModBy
attribute: false
wrapped: false
PmtAuthSyncRq:
title: PmtAuthSyncRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: PmtAuthSyncRq
attribute: false
wrapped: false
PmtAuthSyncRs:
title: PmtAuthSyncRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
newToken:
maxLength: 36
minLength: 1
type: string
xml:
name: NewToken
attribute: false
wrapped: false
pmtAuthMsgRec:
type: array
xml:
name: PmtAuthMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/PmtAuthMsgRec'
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: PmtAuthSyncRs
attribute: false
wrapped: false
PmtCanRq:
title: PmtCanRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
pmtId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: PmtId
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: PmtCanRq
attribute: false
wrapped: false
PmtCanRs:
title: PmtCanRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
pmtId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: PmtId
attribute: false
wrapped: false
pmtRec:
$ref: '#/components/schemas/PmtRecType'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
PmtFieldTypeADetail:
title: PmtFieldTypeADetail
type: object
properties:
issueCurAmt:
$ref: '#/components/schemas/IssueCurAmt'
remitCurAmt:
$ref: '#/components/schemas/RemitCurAmt'
txnRefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: TxnRefId
attribute: false
wrapped: false
wlclientNbr:
maxLength: 5
minLength: 1
type: string
PmtFieldTypeADetailType:
title: PmtFieldTypeADetailType
type: object
properties:
issueCurAmt:
$ref: '#/components/schemas/IssueCurAmt'
remitCurAmt:
$ref: '#/components/schemas/RemitCurAmt'
txnRefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: TxnRefId
attribute: false
wrapped: false
wlclientNbr:
maxLength: 5
minLength: 1
type: string
xml:
name: PmtFieldTypeADetail_Type
attribute: false
wrapped: false
PmtFieldTypeBDetail:
title: PmtFieldTypeBDetail
type: object
properties:
contractAmt:
type: number
xml:
name: ContractAmt
attribute: false
wrapped: false
fxContractNo:
maxLength: 6
minLength: 1
type: string
xml:
name: FxContractNo
attribute: false
wrapped: false
fxRate:
type: number
xml:
name: FxRate
attribute: false
wrapped: false
valueDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: ValueDt
attribute: false
wrapped: false
PmtFieldTypeBDetailType:
title: PmtFieldTypeBDetailType
type: object
properties:
contractAmt:
type: number
xml:
name: ContractAmt
attribute: false
wrapped: false
fxContractNo:
maxLength: 6
minLength: 1
type: string
xml:
name: FxContractNo
attribute: false
wrapped: false
fxRate:
type: number
xml:
name: FxRate
attribute: false
wrapped: false
valueDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: ValueDt
attribute: false
wrapped: false
xml:
name: PmtFieldTypeBDetail_Type
attribute: false
wrapped: false
PmtFieldTypeInfo:
title: PmtFieldTypeInfo
type: object
properties:
pmtFieldTypeADetail:
$ref: '#/components/schemas/PmtFieldTypeADetail'
pmtFieldTypeBDetail:
$ref: '#/components/schemas/PmtFieldTypeBDetail'
pmtFieldTypeCode:
maxLength: 35
minLength: 1
type: string
xml:
name: PmtFieldTypeCode
attribute: false
wrapped: false
seqNbr:
type: integer
format: int64
xml:
name: SeqNbr
attribute: false
wrapped: false
PmtFieldTypeInfoType:
title: PmtFieldTypeInfoType
type: object
properties:
pmtFieldTypeADetail:
$ref: '#/components/schemas/PmtFieldTypeADetail'
pmtFieldTypeBDetail:
$ref: '#/components/schemas/PmtFieldTypeBDetail'
pmtFieldTypeCode:
maxLength: 35
minLength: 1
type: string
xml:
name: PmtFieldTypeCode
attribute: false
wrapped: false
seqNbr:
type: integer
format: int64
xml:
name: SeqNbr
attribute: false
wrapped: false
xml:
name: PmtFieldTypeInfo_Type
attribute: false
wrapped: false
PmtInfoType:
title: PmtInfoType
type: object
properties:
adviseBeneficiary:
maxLength: 1
minLength: 1
type: string
xml:
name: AdviseBeneficiary
attribute: false
wrapped: false
bankDetails:
type: array
xml:
name: BankDetails
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/BankDetails'
cardAcctIdFrom:
$ref: '#/components/schemas/CardAcctIdFrom'
category:
maxLength: 40
minLength: 1
type: string
xml:
name: Category
attribute: false
wrapped: false
cbr:
type: array
xml:
name: CBR
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CBRType'
curAmt:
$ref: '#/components/schemas/CurAmt'
depAcctIdFrom:
$ref: '#/components/schemas/DepAcctIdFrom'
documentTypeCode:
maxLength: 6
minLength: 1
type: string
xml:
name: DocumentTypeCode
attribute: false
wrapped: false
dueDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
fxcontractNumber:
maxLength: 35
minLength: 1
type: string
germanyCBR:
$ref: '#/components/schemas/GermanyCBR'
immediatePmt:
minLength: 1
type: string
xml:
name: ImmediatePmt
attribute: false
wrapped: false
enum:
- 'Y'
- 'N'
legalName:
maxLength: 35
minLength: 1
type: string
xml:
name: LegalName
attribute: false
wrapped: false
nachapmtAttr:
$ref: '#/components/schemas/NACHAPmtAttr'
orderingCustAddr:
$ref: '#/components/schemas/OrderingCustAddr'
orderingCustId:
$ref: '#/components/schemas/OrderingCustIdType'
payerInfo:
$ref: '#/components/schemas/PayerInfoType'
pmtRefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: PmtRefId
attribute: false
wrapped: false
prcDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
relRefId:
maxLength: 16
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RelRefId
attribute: false
wrapped: false
remitInfo:
type: array
xml:
name: RemitInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/RemitInfoType'
PmtInqRq:
title: PmtInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
billingAcct:
type: array
xml:
name: BillingAcct
attribute: false
wrapped: false
items:
maxLength: 32
minLength: 1
type: string
cardAcctIdFrom:
$ref: '#/components/schemas/CardAcctIdFrom'
category:
type: array
xml:
name: Category
attribute: false
wrapped: false
items:
maxLength: 40
minLength: 1
type: string
chkClrDt:
type: array
xml:
name: ChkClrDt
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/XMLGregorianCalendar'
chkNum:
type: array
xml:
name: ChkNum
attribute: false
wrapped: false
items:
maxLength: 12
minLength: 1
type: string
csprefId:
type: array
items:
maxLength: 36
minLength: 1
type: string
custId:
$ref: '#/components/schemas/CustId'
custPayeeId:
type: array
xml:
name: CustPayeeId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
delUndel:
minLength: 1
type: string
xml:
name: DelUndel
attribute: false
wrapped: false
enum:
- DELIVERED
- UNDELIVERED
- BOTH
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
depAcctIdFrom:
$ref: '#/components/schemas/DepAcctIdFrom'
ficreditTrcNum:
type: array
items:
maxLength: 7
minLength: 1
type: string
fidebitTrcNum:
type: array
items:
maxLength: 7
minLength: 1
type: string
incHistory:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncHistory
attribute: false
wrapped: false
enum:
- '0'
- '1'
incToken:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncToken
attribute: false
wrapped: false
enum:
- '0'
- '1'
memo:
type: array
xml:
name: Memo
attribute: false
wrapped: false
items:
maxLength: 1024
minLength: 1
type: string
name:
type: array
xml:
name: Name
attribute: false
wrapped: false
items:
maxLength: 40
minLength: 1
type: string
nickname:
type: array
xml:
name: Nickname
attribute: false
wrapped: false
items:
maxLength: 40
minLength: 1
type: string
pmtId:
type: array
xml:
name: PmtId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
pmtMethod:
type: array
xml:
name: PmtMethod
attribute: false
wrapped: false
items:
minLength: 1
type: string
pmtStatusCode:
type: array
xml:
name: PmtStatusCode
attribute: false
wrapped: false
items:
minLength: 1
type: string
pmtType:
type: array
xml:
name: PmtType
attribute: false
wrapped: false
items:
minLength: 1
type: string
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
recPmtId:
type: array
xml:
name: RecPmtId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeCurAmt:
$ref: '#/components/schemas/SelRangeCurAmt'
selRangeDueDt:
$ref: '#/components/schemas/SelRangeDueDt'
selRangePrcDt:
$ref: '#/components/schemas/SelRangePrcDt'
sprefId:
type: array
items:
type: string
stdPayeeId:
type: array
xml:
name: StdPayeeId
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/StdPayeeId'
xml:
name: PmtInqRq
attribute: false
wrapped: false
PmtInqRs:
title: PmtInqRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
besstatus:
$ref: '#/components/schemas/BESStatusType'
billingAcct:
type: array
xml:
name: BillingAcct
attribute: false
wrapped: false
items:
maxLength: 32
minLength: 1
type: string
cardAcctIdFrom:
$ref: '#/components/schemas/CardAcctIdFrom'
category:
type: array
xml:
name: Category
attribute: false
wrapped: false
items:
maxLength: 40
minLength: 1
type: string
chkClrDt:
type: array
xml:
name: ChkClrDt
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/XMLGregorianCalendar'
chkNum:
type: array
xml:
name: ChkNum
attribute: false
wrapped: false
items:
maxLength: 12
minLength: 1
type: string
csprefId:
type: array
items:
maxLength: 36
minLength: 1
type: string
custId:
$ref: '#/components/schemas/CustId'
custPayeeId:
type: array
xml:
name: CustPayeeId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
delUndel:
minLength: 1
type: string
xml:
name: DelUndel
attribute: false
wrapped: false
enum:
- DELIVERED
- UNDELIVERED
- BOTH
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
depAcctIdFrom:
$ref: '#/components/schemas/DepAcctIdFrom'
ficreditTrcNum:
type: array
items:
maxLength: 7
minLength: 1
type: string
fidebitTrcNum:
type: array
items:
maxLength: 7
minLength: 1
type: string
incHistory:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncHistory
attribute: false
wrapped: false
enum:
- '0'
- '1'
incToken:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncToken
attribute: false
wrapped: false
enum:
- '0'
- '1'
memo:
type: array
xml:
name: Memo
attribute: false
wrapped: false
items:
maxLength: 1024
minLength: 1
type: string
name:
type: array
xml:
name: Name
attribute: false
wrapped: false
items:
maxLength: 40
minLength: 1
type: string
nickname:
type: array
xml:
name: Nickname
attribute: false
wrapped: false
items:
maxLength: 40
minLength: 1
type: string
pmtId:
type: array
xml:
name: PmtId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
pmtMethod:
type: array
xml:
name: PmtMethod
attribute: false
wrapped: false
items:
minLength: 1
type: string
pmtRec:
type: array
xml:
name: PmtRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/PmtRecType'
pmtStatusCode:
type: array
xml:
name: PmtStatusCode
attribute: false
wrapped: false
items:
minLength: 1
type: string
pmtType:
type: array
xml:
name: PmtType
attribute: false
wrapped: false
items:
minLength: 1
type: string
processingSystemRef:
$ref: '#/components/schemas/ProcessingSystemRef'
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
recPmtId:
type: array
xml:
name: RecPmtId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeCurAmt:
$ref: '#/components/schemas/SelRangeCurAmt'
selRangeDueDt:
$ref: '#/components/schemas/SelRangeDueDt'
selRangePrcDt:
$ref: '#/components/schemas/SelRangePrcDt'
sprefId:
type: array
description: >-
Dealoffer ID if this is not a commited Deal. Userid/transactionID In
Control Record. If the ForExRateRq had ForExRateType=Indicated then
this field provides the Deal Offer ID to be used in the
ForExDealAddRq for approving/rejecting the Deal.
items:
type: string
status:
$ref: '#/components/schemas/StatusType'
stdPayeeId:
type: array
xml:
name: StdPayeeId
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/StdPayeeId'
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: PmtInqRs
attribute: false
wrapped: false
PmtInst:
title: PmtInst
type: object
properties:
brand:
minLength: 1
type: string
xml:
name: Brand
attribute: false
wrapped: false
pmtInstType:
minLength: 1
type: string
xml:
name: PmtInstType
attribute: false
wrapped: false
settlementInfo:
type: array
xml:
name: SettlementInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/SettlementInfoType'
PmtInstruction:
title: PmtInstruction
type: object
properties:
country:
maxLength: 35
minLength: 1
type: string
xml:
name: Country
attribute: false
wrapped: false
feeChargeAlloc:
$ref: '#/components/schemas/FeeChargeAlloc'
intermediaryDepAcct:
type: array
xml:
name: IntermediaryDepAcct
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/IntermediaryDepAcct'
pmtFormat:
minLength: 1
type: string
xml:
name: PmtFormat
attribute: false
wrapped: false
refInfo:
$ref: '#/components/schemas/RefInfo'
PmtLegalRpt:
title: PmtLegalRpt
type: object
properties:
curAmt:
$ref: '#/components/schemas/CurAmt'
orgId:
$ref: '#/components/schemas/OrgId'
orgInfo:
$ref: '#/components/schemas/OrgInfoType'
payeeCountry:
maxLength: 3
minLength: 1
type: string
xml:
name: PayeeCountry
attribute: false
wrapped: false
pmtLegalRptData:
type: array
xml:
name: PmtLegalRptData
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/PmtLegalRptData'
prcDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
PmtLegalRptData:
title: PmtLegalRptData
type: object
properties:
curAmt:
$ref: '#/components/schemas/CurAmt'
desc:
maxLength: 80
minLength: 1
type: string
xml:
name: Desc
attribute: false
wrapped: false
importDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
legalRptCode:
maxLength: 36
minLength: 1
type: string
xml:
name: LegalRptCode
attribute: false
wrapped: false
memo:
maxLength: 1024
minLength: 1
type: string
xml:
name: Memo
attribute: false
wrapped: false
supplRptCode:
maxLength: 36
minLength: 1
type: string
xml:
name: SupplRptCode
attribute: false
wrapped: false
supplyingCountry:
maxLength: 3
minLength: 1
type: string
xml:
name: SupplyingCountry
attribute: false
wrapped: false
PmtModRq:
title: PmtModRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
dupChkOverride:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: DupChkOverride
attribute: false
wrapped: false
enum:
- '0'
- '1'
pmtId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: PmtId
attribute: false
wrapped: false
pmtInfo:
$ref: '#/components/schemas/PmtInfoType'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
upPayee:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: UpPayee
attribute: false
wrapped: false
enum:
- '0'
- '1'
xml:
name: PmtModRq
attribute: false
wrapped: false
PmtModRs:
title: PmtModRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
dupChkOverride:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: DupChkOverride
attribute: false
wrapped: false
enum:
- '0'
- '1'
pmtId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: PmtId
attribute: false
wrapped: false
pmtInfo:
$ref: '#/components/schemas/PmtInfoType'
pmtRec:
$ref: '#/components/schemas/PmtRecType'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
upPayee:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: UpPayee
attribute: false
wrapped: false
enum:
- '0'
- '1'
PmtMsgRec:
title: PmtMsgRec
type: object
properties:
custId:
$ref: '#/components/schemas/CustId'
msgRecDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: MsgRecDt
attribute: false
wrapped: false
pmtAddRs:
$ref: '#/components/schemas/PmtAddRsType'
pmtCanRs:
$ref: '#/components/schemas/PmtCanRs'
pmtModRs:
$ref: '#/components/schemas/PmtModRs'
pmtStatusModRs:
$ref: '#/components/schemas/PmtStatusModRs'
PmtRecType:
title: PmtRecType
type: object
properties:
createdDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
ficreditTrcNum:
maxLength: 7
minLength: 1
type: string
fidebitTrcNum:
maxLength: 7
minLength: 1
type: string
origPmtDueDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
origPmtPrcDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
pmtId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: PmtId
attribute: false
wrapped: false
pmtInfo:
$ref: '#/components/schemas/PmtInfoType'
pmtRemitAck:
$ref: '#/components/schemas/PmtRemitAckType'
pmtRemitInfo:
$ref: '#/components/schemas/PmtRemitInfo'
pmtStatus:
$ref: '#/components/schemas/PmtStatusType'
recPmtId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RecPmtId
attribute: false
wrapped: false
sprefId:
type: string
svcRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: SvcRqUID
attribute: false
wrapped: false
PmtRemitAckType:
title: PmtRemitAckType
type: object
properties:
compositePmtRemitInfo:
type: array
xml:
name: CompositePmtRemitInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CompositePmtRemitInfoType'
totalFeeCharge:
$ref: '#/components/schemas/TotalFeeChargeType'
PmtRemitChksumType:
title: PmtRemitChksumType
type: object
properties:
ackType:
minLength: 1
type: string
xml:
name: AckType
attribute: false
wrapped: false
compositeContactInfo:
$ref: '#/components/schemas/CompositeContactInfo'
count:
type: integer
format: int64
xml:
name: Count
attribute: false
wrapped: false
memo:
maxLength: 1024
minLength: 1
type: string
xml:
name: Memo
attribute: false
wrapped: false
totalCurAmt:
$ref: '#/components/schemas/TotalCurAmt'
PmtRemitDetailType:
title: PmtRemitDetailType
type: object
properties:
curAmt:
$ref: '#/components/schemas/CurAmt'
pmtRemitRefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: PmtRemitRefId
attribute: false
wrapped: false
pmtRemitStatus:
$ref: '#/components/schemas/PmtRemitStatusType'
PmtRemitInfo:
title: PmtRemitInfo
type: object
properties:
name:
maxLength: 40
minLength: 1
type: string
xml:
name: Name
attribute: false
wrapped: false
postAddr:
$ref: '#/components/schemas/PostAddr'
PmtRemitStatusType:
title: PmtRemitStatusType
type: object
properties:
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
memo:
maxLength: 1024
minLength: 1
type: string
xml:
name: Memo
attribute: false
wrapped: false
pmtRemitStatusCode:
minLength: 1
type: string
description: StatusCode as Per IFX XML
xml:
name: PmtRemitStatusCode
attribute: false
wrapped: false
statusDesc:
maxLength: 255
minLength: 1
type: string
description: Text description for status code
xml:
name: StatusDesc
attribute: false
wrapped: false
statusModBy:
minLength: 1
type: string
xml:
name: StatusModBy
attribute: false
wrapped: false
PmtSchStmtRqType:
title: PmtSchStmtRqType
type: object
properties:
delUndel:
minLength: 1
type: string
xml:
name: DelUndel
attribute: false
wrapped: false
enum:
- DELIVERED
- UNDELIVERED
- BOTH
depAcctId:
$ref: '#/components/schemas/DepAcctId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
xml:
name: PmtSchStmtRq_Type
attribute: false
wrapped: false
PmtSchStmtRsType:
title: PmtSchStmtRsType
type: object
properties:
delUndel:
minLength: 1
type: string
xml:
name: DelUndel
attribute: false
wrapped: false
enum:
- DELIVERED
- UNDELIVERED
- BOTH
depAcctId:
$ref: '#/components/schemas/DepAcctId'
depAcctStmtRec:
$ref: '#/components/schemas/DepAcctStmtRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
txnRefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: TxnRefId
attribute: false
wrapped: false
xml:
name: PmtSchStmtRs_Type
attribute: false
wrapped: false
PmtSchTrnRqType:
title: PmtSchTrnRqType
type: object
properties:
delUndel:
minLength: 1
type: string
xml:
name: DelUndel
attribute: false
wrapped: false
enum:
- DELIVERED
- UNDELIVERED
- BOTH
depAcctId:
$ref: '#/components/schemas/DepAcctId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
xml:
name: PmtSchTrnRq_Type
attribute: false
wrapped: false
PmtSchTrnRsType:
title: PmtSchTrnRsType
type: object
properties:
delUndel:
minLength: 1
type: string
xml:
name: DelUndel
attribute: false
wrapped: false
enum:
- DELIVERED
- UNDELIVERED
- BOTH
depAcctId:
$ref: '#/components/schemas/DepAcctId'
depAcctStmtRec:
$ref: '#/components/schemas/DepAcctStmtRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
txnRefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: TxnRefId
attribute: false
wrapped: false
xml:
name: PmtSchTrnRs_Type
attribute: false
wrapped: false
PmtStatusInqRqType:
title: PmtStatusInqRqType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctIdFrom:
$ref: '#/components/schemas/CardAcctIdFrom'
category:
maxLength: 40
minLength: 1
type: string
xml:
name: Category
attribute: false
wrapped: false
chkNum:
maxLength: 12
minLength: 1
type: string
xml:
name: ChkNum
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
custPayeeId:
type: array
xml:
name: CustPayeeId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
depAcctIdFrom:
$ref: '#/components/schemas/DepAcctIdFrom'
fspayee:
type: array
items:
$ref: '#/components/schemas/FSPayeeType'
name:
type: array
xml:
name: Name
attribute: false
wrapped: false
items:
maxLength: 40
minLength: 1
type: string
payerInfo:
type: array
xml:
name: PayerInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/PayerInfoType'
pmtId:
type: array
xml:
name: PmtId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
pmtRefId:
type: array
xml:
name: PmtRefId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
pmtRemitRefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: PmtRemitRefId
attribute: false
wrapped: false
pmtStatusCode:
type: array
xml:
name: PmtStatusCode
attribute: false
wrapped: false
items:
minLength: 1
type: string
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDueDt:
$ref: '#/components/schemas/SelRangeDueDt'
settlementMethod:
type: array
xml:
name: SettlementMethod
attribute: false
wrapped: false
items:
minLength: 1
pattern: '[^"']*'
type: string
svcRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: SvcRqUID
attribute: false
wrapped: false
xml:
name: PmtStatusInqRq_Type
attribute: false
wrapped: false
PmtStatusInqRsType:
title: PmtStatusInqRsType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctIdFrom:
$ref: '#/components/schemas/CardAcctIdFrom'
category:
maxLength: 40
minLength: 1
type: string
xml:
name: Category
attribute: false
wrapped: false
chkNum:
maxLength: 12
minLength: 1
type: string
xml:
name: ChkNum
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
custPayeeId:
type: array
xml:
name: CustPayeeId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
depAcctIdFrom:
$ref: '#/components/schemas/DepAcctIdFrom'
fspayee:
type: array
items:
$ref: '#/components/schemas/FSPayeeType'
name:
type: array
xml:
name: Name
attribute: false
wrapped: false
items:
maxLength: 40
minLength: 1
type: string
payerInfo:
type: array
xml:
name: PayerInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/PayerInfoType'
pmtId:
type: array
xml:
name: PmtId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
pmtRefId:
type: array
xml:
name: PmtRefId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
pmtRemitRefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: PmtRemitRefId
attribute: false
wrapped: false
pmtStatusCode:
type: array
xml:
name: PmtStatusCode
attribute: false
wrapped: false
items:
minLength: 1
type: string
pmtStatusRec:
type: array
xml:
name: PmtStatusRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/PmtStatusRecType'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDueDt:
$ref: '#/components/schemas/SelRangeDueDt'
settlementMethod:
type: array
xml:
name: SettlementMethod
attribute: false
wrapped: false
items:
minLength: 1
pattern: '[^"']*'
type: string
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
svcRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: SvcRqUID
attribute: false
wrapped: false
xml:
name: PmtStatusInqRs_Type
attribute: false
wrapped: false
PmtStatusModRq:
title: PmtStatusModRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
pmtId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: PmtId
attribute: false
wrapped: false
pmtRefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: PmtRefId
attribute: false
wrapped: false
pmtStatus:
$ref: '#/components/schemas/PmtStatusType'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
svcRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: SvcRqUID
attribute: false
wrapped: false
xml:
name: PmtStatusModRq
attribute: false
wrapped: false
PmtStatusModRs:
title: PmtStatusModRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
compositeContactInfo:
$ref: '#/components/schemas/CompositeContactInfo'
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
networkTrnInfo:
$ref: '#/components/schemas/NetworkTrnInfoType'
pmtId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: PmtId
attribute: false
wrapped: false
pmtRefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: PmtRefId
attribute: false
wrapped: false
pmtStatus:
$ref: '#/components/schemas/PmtStatusType'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
svcRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: SvcRqUID
attribute: false
wrapped: false
PmtStatusRecType:
title: PmtStatusRecType
type: object
properties:
compositeContactInfo:
$ref: '#/components/schemas/CompositeContactInfo'
networkTrnInfo:
$ref: '#/components/schemas/NetworkTrnInfoType'
pmtId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: PmtId
attribute: false
wrapped: false
pmtRefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: PmtRefId
attribute: false
wrapped: false
pmtRemitAck:
type: array
xml:
name: PmtRemitAck
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/PmtRemitAckType'
pmtStatus:
$ref: '#/components/schemas/PmtStatusType'
svcRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: SvcRqUID
attribute: false
wrapped: false
PmtStatusType:
title: PmtStatusType
type: object
properties:
chkNum:
maxLength: 12
minLength: 1
type: string
xml:
name: ChkNum
attribute: false
wrapped: false
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
memo:
maxLength: 1024
minLength: 1
type: string
xml:
name: Memo
attribute: false
wrapped: false
pmtAuthCount:
type: integer
format: int64
xml:
name: PmtAuthCount
attribute: false
wrapped: false
pmtAuthId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: PmtAuthId
attribute: false
wrapped: false
pmtMethod:
minLength: 1
type: string
xml:
name: PmtMethod
attribute: false
wrapped: false
pmtStatusCode:
minLength: 1
type: string
description: StatusCode as Per IFX XML
xml:
name: PmtStatusCode
attribute: false
wrapped: false
recPmtMod:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: RecPmtMod
attribute: false
wrapped: false
enum:
- '0'
- '1'
remitId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RemitId
attribute: false
wrapped: false
statusDesc:
maxLength: 255
minLength: 1
type: string
description: Text description for status code
xml:
name: StatusDesc
attribute: false
wrapped: false
statusModBy:
minLength: 1
type: string
xml:
name: StatusModBy
attribute: false
wrapped: false
PmtSummAmt:
title: PmtSummAmt
type: object
properties:
billSummAmtId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: BillSummAmtId
attribute: false
wrapped: false
curAmt:
$ref: '#/components/schemas/CurAmt'
PmtSyncRq:
title: PmtSyncRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: PmtSyncRq
attribute: false
wrapped: false
PmtSyncRs:
title: PmtSyncRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
newToken:
maxLength: 36
minLength: 1
type: string
xml:
name: NewToken
attribute: false
wrapped: false
pmtMsgRec:
type: array
xml:
name: PmtMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/PmtMsgRec'
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: PmtSyncRs
attribute: false
wrapped: false
PostAddr:
title: PostAddr
type: object
properties:
addr1:
maxLength: 35
minLength: 1
type: string
xml:
name: Addr1
attribute: false
wrapped: false
addr2:
maxLength: 35
minLength: 1
type: string
xml:
name: Addr2
attribute: false
wrapped: false
addr3:
maxLength: 35
minLength: 1
type: string
xml:
name: Addr3
attribute: false
wrapped: false
addr4:
maxLength: 35
minLength: 1
type: string
xml:
name: Addr4
attribute: false
wrapped: false
addrType:
minLength: 1
type: string
xml:
name: AddrType
attribute: false
wrapped: false
city:
maxLength: 35
minLength: 1
type: string
xml:
name: City
attribute: false
wrapped: false
country:
maxLength: 35
minLength: 1
type: string
xml:
name: Country
attribute: false
wrapped: false
endDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: EndDt
attribute: false
wrapped: false
postalCode:
maxLength: 35
minLength: 1
type: string
xml:
name: PostalCode
attribute: false
wrapped: false
startDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: StartDt
attribute: false
wrapped: false
stateProv:
maxLength: 32
minLength: 1
type: string
xml:
name: StateProv
attribute: false
wrapped: false
PostAddrType:
title: PostAddrType
type: object
properties:
addr1:
maxLength: 35
minLength: 1
type: string
xml:
name: Addr1
attribute: false
wrapped: false
addr2:
maxLength: 35
minLength: 1
type: string
xml:
name: Addr2
attribute: false
wrapped: false
addr3:
maxLength: 35
minLength: 1
type: string
xml:
name: Addr3
attribute: false
wrapped: false
addr4:
maxLength: 35
minLength: 1
type: string
xml:
name: Addr4
attribute: false
wrapped: false
addrType:
minLength: 1
type: string
xml:
name: AddrType
attribute: false
wrapped: false
city:
maxLength: 35
minLength: 1
type: string
xml:
name: City
attribute: false
wrapped: false
country:
maxLength: 35
minLength: 1
type: string
xml:
name: Country
attribute: false
wrapped: false
endDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: EndDt
attribute: false
wrapped: false
postalCode:
maxLength: 35
minLength: 1
type: string
xml:
name: PostalCode
attribute: false
wrapped: false
startDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: StartDt
attribute: false
wrapped: false
stateProv:
maxLength: 32
minLength: 1
type: string
xml:
name: StateProv
attribute: false
wrapped: false
xml:
name: PostAddr_Type
attribute: false
wrapped: false
PrcSched:
title: PrcSched
type: object
properties:
cutoffTm:
$ref: '#/components/schemas/XMLGregorianCalendar'
prcDaysOff:
type: array
xml:
name: PrcDaysOff
attribute: false
wrapped: false
items:
minLength: 1
type: string
prcDtAdj:
minLength: 1
type: string
xml:
name: PrcDtAdj
attribute: false
wrapped: false
PrepayPenalty:
title: PrepayPenalty
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
PresAcctId:
title: PresAcctId
type: object
properties:
billerId:
$ref: '#/components/schemas/BillerId'
billingAcct:
maxLength: 32
minLength: 1
type: string
xml:
name: BillingAcct
attribute: false
wrapped: false
PresAcctInfo:
title: PresAcctInfo
type: object
properties:
custPayeeId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: CustPayeeId
attribute: false
wrapped: false
spname:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Always set to CTSI
stdPayeeId:
$ref: '#/components/schemas/StdPayeeId'
PresAcctRec:
title: PresAcctRec
type: object
properties:
presAcctId:
$ref: '#/components/schemas/PresAcctId'
presAcctInfo:
$ref: '#/components/schemas/PresAcctInfo'
presAcctStatus:
$ref: '#/components/schemas/PresAcctStatus'
PresAcctStatus:
title: PresAcctStatus
type: object
properties:
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
presAcctStatusCode:
minLength: 1
type: string
description: StatusCode as Per IFX XML
xml:
name: PresAcctStatusCode
attribute: false
wrapped: false
statusDesc:
maxLength: 255
minLength: 1
type: string
description: Text description for status code
xml:
name: StatusDesc
attribute: false
wrapped: false
statusModBy:
minLength: 1
type: string
xml:
name: StatusModBy
attribute: false
wrapped: false
PresAmt:
title: PresAmt
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
PresSvcProfInfo:
title: PresSvcProfInfo
type: object
properties:
msgSupt:
type: array
xml:
name: MsgSupt
attribute: false
wrapped: false
items:
minLength: 1
type: string
optSupt:
type: array
xml:
name: OptSupt
attribute: false
wrapped: false
items:
minLength: 1
type: string
prcSched:
$ref: '#/components/schemas/PrcSched'
svcCore:
$ref: '#/components/schemas/SvcCoreType'
PresSvcRqType:
title: PresSvcRqType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
billerInqRqAndBillInqRqAndBillStatusModRq:
type: array
description: >-
#/definitions/BillerInqRq and #/definitions/BillInqRq and
#/definitions/BillStatusModRq
items:
type: object
properties: {}
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
spname:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Always set to CTSI
xml:
name: PresSvcRq_Type
attribute: false
wrapped: false
PresSvcRsType:
title: PresSvcRsType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
billerInqRsAndBillInqRsAndBillStatusModRs:
type: array
description: >-
refer to BillerInqRs, and #/definitions/BillInqRs, and
#/definitions/BillStatusModRs
items:
type: object
properties: {}
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
spname:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Always set to CTSI
status:
$ref: '#/components/schemas/StatusType'
xml:
name: PresSvcRs_Type
attribute: false
wrapped: false
Presentment:
title: Presentment
type: object
properties:
contactData:
type: array
xml:
name: ContactData
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/ContactData'
presAdjustmentAmt:
type: number
xml:
name: PresAdjustmentAmt
attribute: false
wrapped: false
presAmt:
$ref: '#/components/schemas/PresAmt'
presDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: PresDt
attribute: false
wrapped: false
presItemCnt:
minLength: 1
type: string
xml:
name: PresItemCnt
attribute: false
wrapped: false
presSeqNo:
minLength: 1
type: string
xml:
name: PresSeqNo
attribute: false
wrapped: false
presTime:
minLength: 1
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: PresTime
attribute: false
wrapped: false
PresentmentAdjustment:
title: PresentmentAdjustment
type: object
properties:
contactData:
type: array
xml:
name: ContactData
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/ContactData'
presDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: PresDt
attribute: false
wrapped: false
totalAdjustmentAmt:
type: number
xml:
name: TotalAdjustmentAmt
attribute: false
wrapped: false
totalAdjustmentItemCnt:
type: integer
format: int64
xml:
name: TotalAdjustmentItemCnt
attribute: false
wrapped: false
yestFundDueAmt:
type: number
xml:
name: YestFundDueAmt
attribute: false
wrapped: false
PresentmentAdjustmentType:
title: PresentmentAdjustmentType
type: object
properties:
contactData:
type: array
xml:
name: ContactData
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/ContactData'
presDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: PresDt
attribute: false
wrapped: false
totalAdjustmentAmt:
type: number
xml:
name: TotalAdjustmentAmt
attribute: false
wrapped: false
totalAdjustmentItemCnt:
type: integer
format: int64
xml:
name: TotalAdjustmentItemCnt
attribute: false
wrapped: false
yestFundDueAmt:
type: number
xml:
name: YestFundDueAmt
attribute: false
wrapped: false
xml:
name: PresentmentAdjustment_Type
attribute: false
wrapped: false
PresentmentType:
title: PresentmentType
type: object
properties:
contactData:
type: array
xml:
name: ContactData
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/ContactData'
presAdjustmentAmt:
type: number
xml:
name: PresAdjustmentAmt
attribute: false
wrapped: false
presAmt:
$ref: '#/components/schemas/PresAmt'
presDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: PresDt
attribute: false
wrapped: false
presItemCnt:
minLength: 1
type: string
xml:
name: PresItemCnt
attribute: false
wrapped: false
presSeqNo:
minLength: 1
type: string
xml:
name: PresSeqNo
attribute: false
wrapped: false
presTime:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: PresTime
attribute: false
wrapped: false
xml:
name: Presentment_Type
attribute: false
wrapped: false
PrevYrCurAmt:
title: PrevYrCurAmt
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
ProcessingSystemRef:
title: ProcessingSystemRef
type: object
properties:
refId:
maxLength: 64
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RefId
attribute: false
wrapped: false
refType:
minLength: 1
type: string
xml:
name: RefType
attribute: false
wrapped: false
ProxyClient:
title: ProxyClient
type: object
properties:
name:
maxLength: 40
minLength: 1
type: string
xml:
name: Name
attribute: false
wrapped: false
org:
maxLength: 36
minLength: 1
type: string
description: Customer System application manufacturer
xml:
name: Org
attribute: false
wrapped: false
version:
maxLength: 12
minLength: 1
type: string
description: Customer system application version
xml:
name: Version
attribute: false
wrapped: false
PswdDelivery:
title: PswdDelivery
type: object
properties:
custPswd:
$ref: '#/components/schemas/CustPswd'
expDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
description: Contract Expiry Datetime
xml:
name: ExpDt
attribute: false
wrapped: false
QName:
title: QName
type: object
properties:
localPart:
type: string
namespaceURI:
type: string
prefix:
type: string
RecChkOrdAddRqType:
title: RecChkOrdAddRqType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
chkOrdInfo:
$ref: '#/components/schemas/ChkOrdInfoType'
custId:
$ref: '#/components/schemas/CustId'
dupChkOverride:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: DupChkOverride
attribute: false
wrapped: false
enum:
- '0'
- '1'
recModelInfo:
$ref: '#/components/schemas/RecModelInfo'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: RecChkOrdAddRq_Type
attribute: false
wrapped: false
RecChkOrdAddRsType:
title: RecChkOrdAddRsType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
chkOrdInfo:
$ref: '#/components/schemas/ChkOrdInfoType'
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
dupChkOverride:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: DupChkOverride
attribute: false
wrapped: false
enum:
- '0'
- '1'
recChkOrdRec:
$ref: '#/components/schemas/RecChkOrdRecType'
recModelInfo:
$ref: '#/components/schemas/RecModelInfo'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
RecChkOrdAudRqType:
title: RecChkOrdAudRqType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
recChkOrdId:
type: array
xml:
name: RecChkOrdId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
xml:
name: RecChkOrdAudRq_Type
attribute: false
wrapped: false
RecChkOrdAudRsType:
title: RecChkOrdAudRsType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
recChkOrdId:
type: array
xml:
name: RecChkOrdId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
recChkOrdMsgRec:
type: array
xml:
name: RecChkOrdMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/RecChkOrdMsgRecType'
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
status:
$ref: '#/components/schemas/StatusType'
xml:
name: RecChkOrdAudRs_Type
attribute: false
wrapped: false
RecChkOrdCanRqType:
title: RecChkOrdCanRqType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cascadeDel:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: CascadeDel
attribute: false
wrapped: false
enum:
- '0'
- '1'
custId:
$ref: '#/components/schemas/CustId'
recChkOrdId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RecChkOrdId
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: RecChkOrdCanRq_Type
attribute: false
wrapped: false
RecChkOrdCanRsType:
title: RecChkOrdCanRsType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cascadeDel:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: CascadeDel
attribute: false
wrapped: false
enum:
- '0'
- '1'
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
dependentType:
type: array
xml:
name: DependentType
attribute: false
wrapped: false
items:
minLength: 1
type: string
recChkOrdId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RecChkOrdId
attribute: false
wrapped: false
recChkOrdRec:
$ref: '#/components/schemas/RecChkOrdRecType'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
RecChkOrdInqRqType:
title: RecChkOrdInqRqType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
csprefId:
type: array
items:
maxLength: 36
minLength: 1
type: string
custId:
$ref: '#/components/schemas/CustId'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
incToken:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncToken
attribute: false
wrapped: false
enum:
- '0'
- '1'
loanAcctId:
$ref: '#/components/schemas/LoanAcctId'
recChkOrdId:
type: array
xml:
name: RecChkOrdId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
sprefId:
type: array
items:
type: string
xml:
name: RecChkOrdInqRq_Type
attribute: false
wrapped: false
RecChkOrdInqRsType:
title: RecChkOrdInqRsType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
csprefId:
type: array
items:
maxLength: 36
minLength: 1
type: string
custId:
$ref: '#/components/schemas/CustId'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
loanAcctId:
$ref: '#/components/schemas/LoanAcctId'
recChkOrdId:
type: array
xml:
name: RecChkOrdId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
recChkOrdRec:
type: array
xml:
name: RecChkOrdRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/RecChkOrdRecType'
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
sprefId:
type: array
items:
type: string
status:
$ref: '#/components/schemas/StatusType'
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: RecChkOrdInqRs_Type
attribute: false
wrapped: false
RecChkOrdInstAddRqType:
title: RecChkOrdInstAddRqType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
chkOrdDetail:
$ref: '#/components/schemas/ChkOrdDetailType'
custId:
$ref: '#/components/schemas/CustId'
recChkOrdId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RecChkOrdId
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: RecChkOrdInstAddRq_Type
attribute: false
wrapped: false
RecChkOrdInstAddRsType:
title: RecChkOrdInstAddRsType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
chkOrdDetail:
$ref: '#/components/schemas/ChkOrdDetailType'
custId:
$ref: '#/components/schemas/CustId'
recChkOrdId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RecChkOrdId
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
xml:
name: RecChkOrdInstAddRs_Type
attribute: false
wrapped: false
RecChkOrdModRqType:
title: RecChkOrdModRqType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
chkOrdInfo:
$ref: '#/components/schemas/ChkOrdInfoType'
custId:
$ref: '#/components/schemas/CustId'
modPending:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: ModPending
attribute: false
wrapped: false
enum:
- '0'
- '1'
recChkOrdId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RecChkOrdId
attribute: false
wrapped: false
recModelInfo:
$ref: '#/components/schemas/RecModelInfo'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: RecChkOrdModRq_Type
attribute: false
wrapped: false
RecChkOrdModRsType:
title: RecChkOrdModRsType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
chkOrdInfo:
$ref: '#/components/schemas/ChkOrdInfoType'
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
modPending:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: ModPending
attribute: false
wrapped: false
enum:
- '0'
- '1'
recChkOrdId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RecChkOrdId
attribute: false
wrapped: false
recChkOrdRec:
$ref: '#/components/schemas/RecChkOrdRecType'
recModelInfo:
$ref: '#/components/schemas/RecModelInfo'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
RecChkOrdMsgRecType:
title: RecChkOrdMsgRecType
type: object
properties:
custId:
type: array
xml:
name: CustId
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CustId'
msgRecDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: MsgRecDt
attribute: false
wrapped: false
recChkOrdAddRs:
$ref: '#/components/schemas/RecChkOrdAddRsType'
recChkOrdCanRs:
$ref: '#/components/schemas/RecChkOrdCanRsType'
recChkOrdModRs:
$ref: '#/components/schemas/RecChkOrdModRsType'
RecChkOrdRecType:
title: RecChkOrdRecType
type: object
properties:
chkOrdInfo:
$ref: '#/components/schemas/ChkOrdInfoType'
recChkOrdId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RecChkOrdId
attribute: false
wrapped: false
recModelInfo:
$ref: '#/components/schemas/RecModelInfo'
remainingInsts:
type: integer
format: int64
xml:
name: RemainingInsts
attribute: false
wrapped: false
RecChkOrdSyncRqType:
title: RecChkOrdSyncRqType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
custId:
$ref: '#/components/schemas/CustId'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
loanAcctId:
$ref: '#/components/schemas/LoanAcctId'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: RecChkOrdSyncRq_Type
attribute: false
wrapped: false
RecChkOrdSyncRsType:
title: RecChkOrdSyncRsType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
custId:
$ref: '#/components/schemas/CustId'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
loanAcctId:
$ref: '#/components/schemas/LoanAcctId'
newToken:
maxLength: 36
minLength: 1
type: string
xml:
name: NewToken
attribute: false
wrapped: false
recChkOrdMsgRec:
type: array
xml:
name: RecChkOrdMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/RecChkOrdMsgRecType'
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
xml:
name: RecChkOrdSyncRs_Type
attribute: false
wrapped: false
RecCtrlIn:
title: RecCtrlIn
type: object
properties:
cursor:
$ref: '#/components/schemas/Cursor'
maxRec:
type: integer
format: int64
xml:
name: MaxRec
attribute: false
wrapped: false
RecCtrlOut:
title: RecCtrlOut
type: object
properties:
cursor:
$ref: '#/components/schemas/Cursor'
matchedRec:
type: integer
format: int64
xml:
name: MatchedRec
attribute: false
wrapped: false
sentRec:
type: integer
format: int64
xml:
name: SentRec
attribute: false
wrapped: false
RecFndAdvisePartyDetails:
title: RecFndAdvisePartyDetails
type: object
properties:
postAddr:
$ref: '#/components/schemas/PostAddr'
recFndAdviseAcctId:
maxLength: 35
minLength: 1
type: string
xml:
name: RecFndAdviseAcctId
attribute: false
wrapped: false
recFndAdviseBankId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RecFndAdviseBankId
attribute: false
wrapped: false
recFndAdviseBankIdType:
minLength: 1
type: string
xml:
name: RecFndAdviseBankIdType
attribute: false
wrapped: false
recFndAdvisePartyName:
maxLength: 35
minLength: 1
type: string
xml:
name: RecFndAdvisePartyName
attribute: false
wrapped: false
recFndAdvisePartySeqNum:
type: string
xml:
name: RecFndAdvisePartySeqNum
attribute: false
wrapped: false
enum:
- '1'
- '2'
- '3'
RecFndAdviseRec:
title: RecFndAdviseRec
type: object
properties:
acctId:
maxLength: 255
minLength: 1
pattern: '[^"']*'
type: string
description: FROM account number
xml:
name: AcctId
attribute: false
wrapped: false
branchId:
maxLength: 22
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: BranchId
attribute: false
wrapped: false
recFndAdviseTxnRefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RecFndAdviseTxnRefId
attribute: false
wrapped: false
recFndPmtDetails:
type: array
xml:
name: RecFndPmtDetails
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/RecFndPmtDetailsType'
valDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: ValDt
attribute: false
wrapped: false
RecFndAdviseRq:
title: RecFndAdviseRq
type: object
properties:
acctId:
maxLength: 255
minLength: 1
pattern: '[^"']*'
type: string
description: FROM account number
xml:
name: AcctId
attribute: false
wrapped: false
branchId:
maxLength: 22
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: BranchId
attribute: false
wrapped: false
recFndAdviseTxnRefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RecFndAdviseTxnRefId
attribute: false
wrapped: false
recFndPmtDetails:
type: array
xml:
name: RecFndPmtDetails
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/RecFndPmtDetailsType'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
valDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: ValDt
attribute: false
wrapped: false
xml:
name: RecFndAdviseRq
attribute: false
wrapped: false
RecFndAdviseRs:
title: RecFndAdviseRs
type: object
properties:
recFndAdviseRec:
$ref: '#/components/schemas/RecFndAdviseRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
xml:
name: RecFndAdviseRs
attribute: false
wrapped: false
RecFndPmtDetailsType:
title: RecFndPmtDetailsType
type: object
properties:
curAmt:
$ref: '#/components/schemas/CurAmt'
recFndAdvisePartyDetails:
type: array
xml:
name: RecFndAdvisePartyDetails
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/RecFndAdvisePartyDetails'
relRefId:
maxLength: 16
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RelRefId
attribute: false
wrapped: false
RecModelInfo:
title: RecModelInfo
type: object
properties:
finalCurAmt:
$ref: '#/components/schemas/FinalCurAmt'
finalDueDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
finalPrcDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
freq:
minLength: 1
type: string
xml:
name: Freq
attribute: false
wrapped: false
initialCurAmt:
$ref: '#/components/schemas/InitialCurAmt'
nickname:
maxLength: 40
minLength: 1
type: string
xml:
name: Nickname
attribute: false
wrapped: false
numInsts:
type: integer
format: int64
xml:
name: NumInsts
attribute: false
wrapped: false
skipNextN:
type: integer
format: int64
xml:
name: SkipNextN
attribute: false
wrapped: false
RecPmtAddRq:
title: RecPmtAddRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
dupChkOverride:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: DupChkOverride
attribute: false
wrapped: false
enum:
- '0'
- '1'
pmtInfo:
$ref: '#/components/schemas/PmtInfoType'
recModelInfo:
$ref: '#/components/schemas/RecModelInfo'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: RecPmtAddRq
attribute: false
wrapped: false
RecPmtAddRs:
title: RecPmtAddRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
dupChkOverride:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: DupChkOverride
attribute: false
wrapped: false
enum:
- '0'
- '1'
pmtInfo:
$ref: '#/components/schemas/PmtInfoType'
recModelInfo:
$ref: '#/components/schemas/RecModelInfo'
recPmtRec:
$ref: '#/components/schemas/RecPmtRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
RecPmtAudRq:
title: RecPmtAudRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
recPmtId:
type: array
xml:
name: RecPmtId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
xml:
name: RecPmtAudRq
attribute: false
wrapped: false
RecPmtAudRs:
title: RecPmtAudRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
recPmtId:
type: array
xml:
name: RecPmtId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
recPmtMsgRec:
type: array
xml:
name: RecPmtMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/RecPmtMsgRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
status:
$ref: '#/components/schemas/StatusType'
xml:
name: RecPmtAudRs
attribute: false
wrapped: false
RecPmtCanRq:
title: RecPmtCanRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cascadeDel:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: CascadeDel
attribute: false
wrapped: false
enum:
- '0'
- '1'
custId:
$ref: '#/components/schemas/CustId'
recPmtId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RecPmtId
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: RecPmtCanRq
attribute: false
wrapped: false
RecPmtCanRs:
title: RecPmtCanRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cascadeDel:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: CascadeDel
attribute: false
wrapped: false
enum:
- '0'
- '1'
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
dependentType:
type: array
xml:
name: DependentType
attribute: false
wrapped: false
items:
minLength: 1
type: string
recPmtId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RecPmtId
attribute: false
wrapped: false
recPmtRec:
$ref: '#/components/schemas/RecPmtRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
RecPmtInqRq:
title: RecPmtInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
billingAcct:
type: array
xml:
name: BillingAcct
attribute: false
wrapped: false
items:
maxLength: 32
minLength: 1
type: string
cardAcctIdFrom:
$ref: '#/components/schemas/CardAcctIdFrom'
category:
type: array
xml:
name: Category
attribute: false
wrapped: false
items:
maxLength: 40
minLength: 1
type: string
csprefId:
type: array
items:
maxLength: 36
minLength: 1
type: string
custId:
$ref: '#/components/schemas/CustId'
custPayeeId:
type: array
xml:
name: CustPayeeId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
depAcctIdFrom:
$ref: '#/components/schemas/DepAcctIdFrom'
incToken:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncToken
attribute: false
wrapped: false
enum:
- '0'
- '1'
memo:
type: array
xml:
name: Memo
attribute: false
wrapped: false
items:
maxLength: 1024
minLength: 1
type: string
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
recPmtId:
type: array
xml:
name: RecPmtId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeCurAmt:
$ref: '#/components/schemas/SelRangeCurAmt'
sprefId:
type: array
items:
type: string
xml:
name: RecPmtInqRq
attribute: false
wrapped: false
RecPmtInqRs:
title: RecPmtInqRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
billingAcct:
type: array
xml:
name: BillingAcct
attribute: false
wrapped: false
items:
maxLength: 32
minLength: 1
type: string
cardAcctIdFrom:
$ref: '#/components/schemas/CardAcctIdFrom'
category:
type: array
xml:
name: Category
attribute: false
wrapped: false
items:
maxLength: 40
minLength: 1
type: string
csprefId:
type: array
items:
maxLength: 36
minLength: 1
type: string
custId:
$ref: '#/components/schemas/CustId'
custPayeeId:
type: array
xml:
name: CustPayeeId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
depAcctIdFrom:
$ref: '#/components/schemas/DepAcctIdFrom'
incToken:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncToken
attribute: false
wrapped: false
enum:
- '0'
- '1'
memo:
type: array
xml:
name: Memo
attribute: false
wrapped: false
items:
maxLength: 1024
minLength: 1
type: string
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
recPmtId:
type: array
xml:
name: RecPmtId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
recPmtRec:
type: array
xml:
name: RecPmtRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/RecPmtRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeCurAmt:
$ref: '#/components/schemas/SelRangeCurAmt'
sprefId:
type: array
items:
type: string
status:
$ref: '#/components/schemas/StatusType'
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: RecPmtInqRs
attribute: false
wrapped: false
RecPmtInstAddRq:
title: RecPmtInstAddRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
curAmt:
$ref: '#/components/schemas/CurAmt'
custId:
$ref: '#/components/schemas/CustId'
dueDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
pmtLegalRpt:
$ref: '#/components/schemas/PmtLegalRpt'
recPmtId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RecPmtId
attribute: false
wrapped: false
remitDetail:
type: array
xml:
name: RemitDetail
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/RemitDetail'
remitInstruction:
$ref: '#/components/schemas/RemitInstruction'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: RecPmtInstAddRq
attribute: false
wrapped: false
RecPmtInstAddRs:
title: RecPmtInstAddRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
curAmt:
$ref: '#/components/schemas/CurAmt'
custId:
$ref: '#/components/schemas/CustId'
dueDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
pmtLegalRpt:
$ref: '#/components/schemas/PmtLegalRpt'
pmtRec:
$ref: '#/components/schemas/PmtRecType'
recPmtId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RecPmtId
attribute: false
wrapped: false
remitDetail:
type: array
xml:
name: RemitDetail
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/RemitDetail'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
xml:
name: RecPmtInstAddRs
attribute: false
wrapped: false
RecPmtModRq:
title: RecPmtModRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
modPending:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: ModPending
attribute: false
wrapped: false
enum:
- '0'
- '1'
pmtInfo:
$ref: '#/components/schemas/PmtInfoType'
recModelInfo:
$ref: '#/components/schemas/RecModelInfo'
recPmtId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RecPmtId
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: RecPmtModRq
attribute: false
wrapped: false
RecPmtModRs:
title: RecPmtModRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
modPending:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: ModPending
attribute: false
wrapped: false
enum:
- '0'
- '1'
pmtInfo:
$ref: '#/components/schemas/PmtInfoType'
recModelInfo:
$ref: '#/components/schemas/RecModelInfo'
recPmtRec:
$ref: '#/components/schemas/RecPmtRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
RecPmtMsgRec:
title: RecPmtMsgRec
type: object
properties:
custId:
$ref: '#/components/schemas/CustId'
msgRecDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: MsgRecDt
attribute: false
wrapped: false
recPmtAddRs:
$ref: '#/components/schemas/RecPmtAddRs'
recPmtCanRs:
$ref: '#/components/schemas/RecPmtCanRs'
recPmtModRs:
$ref: '#/components/schemas/RecPmtModRs'
RecPmtProf:
title: RecPmtProf
type: object
properties:
freq:
type: array
xml:
name: Freq
attribute: false
wrapped: false
items:
minLength: 1
type: string
modPendingType:
minLength: 1
type: string
xml:
name: ModPendingType
attribute: false
wrapped: false
RecPmtRec:
title: RecPmtRec
type: object
properties:
pmtInfo:
$ref: '#/components/schemas/PmtInfoType'
recModelInfo:
$ref: '#/components/schemas/RecModelInfo'
recPmtId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RecPmtId
attribute: false
wrapped: false
remainingInsts:
type: integer
format: int64
xml:
name: RemainingInsts
attribute: false
wrapped: false
RecPmtSyncRq:
title: RecPmtSyncRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: RecPmtSyncRq
attribute: false
wrapped: false
RecPmtSyncRs:
title: RecPmtSyncRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
newToken:
maxLength: 36
minLength: 1
type: string
xml:
name: NewToken
attribute: false
wrapped: false
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
recPmtMsgRec:
type: array
xml:
name: RecPmtMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/RecPmtMsgRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: RecPmtSyncRs
attribute: false
wrapped: false
RecXferAddRq:
title: RecXferAddRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
dupChkOverride:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: DupChkOverride
attribute: false
wrapped: false
enum:
- '0'
- '1'
recModelInfo:
$ref: '#/components/schemas/RecModelInfo'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xferInfo:
$ref: '#/components/schemas/XferInfo'
xml:
name: RecXferAddRq
attribute: false
wrapped: false
RecXferAddRs:
title: RecXferAddRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
dupChkOverride:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: DupChkOverride
attribute: false
wrapped: false
enum:
- '0'
- '1'
recModelInfo:
$ref: '#/components/schemas/RecModelInfo'
recXferRec:
$ref: '#/components/schemas/RecXferRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
xferInfo:
$ref: '#/components/schemas/XferInfo'
RecXferAudRq:
title: RecXferAudRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
recXferId:
type: array
xml:
name: RecXferId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
xml:
name: RecXferAudRq
attribute: false
wrapped: false
RecXferAudRs:
title: RecXferAudRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
recXferId:
type: array
xml:
name: RecXferId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
recXferMsgRec:
type: array
xml:
name: RecXferMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/RecXferMsgRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
status:
$ref: '#/components/schemas/StatusType'
xml:
name: RecXferAudRs
attribute: false
wrapped: false
RecXferCanRq:
title: RecXferCanRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cascadeDel:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: CascadeDel
attribute: false
wrapped: false
enum:
- '0'
- '1'
custId:
$ref: '#/components/schemas/CustId'
recXferId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RecXferId
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: RecXferCanRq
attribute: false
wrapped: false
RecXferCanRs:
title: RecXferCanRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cascadeDel:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: CascadeDel
attribute: false
wrapped: false
enum:
- '0'
- '1'
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
dependentType:
minLength: 1
type: string
xml:
name: DependentType
attribute: false
wrapped: false
recXferId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RecXferId
attribute: false
wrapped: false
recXferRec:
$ref: '#/components/schemas/RecXferRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
RecXferInqRq:
title: RecXferInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctIdFrom:
$ref: '#/components/schemas/CardAcctIdFrom'
csprefId:
type: array
items:
maxLength: 36
minLength: 1
type: string
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
depAcctIdFrom:
$ref: '#/components/schemas/DepAcctIdFrom'
incToken:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncToken
attribute: false
wrapped: false
enum:
- '0'
- '1'
loanAcctIdFrom:
$ref: '#/components/schemas/LoanAcctIdFrom'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
recXferId:
type: array
xml:
name: RecXferId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeCurAmt:
$ref: '#/components/schemas/SelRangeCurAmt'
sprefId:
type: array
items:
type: string
xml:
name: RecXferInqRq
attribute: false
wrapped: false
RecXferInqRs:
title: RecXferInqRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctIdFrom:
$ref: '#/components/schemas/CardAcctIdFrom'
csprefId:
type: array
items:
maxLength: 36
minLength: 1
type: string
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
depAcctIdFrom:
$ref: '#/components/schemas/DepAcctIdFrom'
incToken:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncToken
attribute: false
wrapped: false
enum:
- '0'
- '1'
loanAcctIdFrom:
$ref: '#/components/schemas/LoanAcctIdFrom'
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
recXferId:
type: array
xml:
name: RecXferId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
recXferRec:
type: array
xml:
name: RecXferRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/RecXferRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeCurAmt:
$ref: '#/components/schemas/SelRangeCurAmt'
sprefId:
type: array
items:
type: string
status:
$ref: '#/components/schemas/StatusType'
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: RecXferInqRs
attribute: false
wrapped: false
RecXferModRq:
title: RecXferModRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
modPending:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: ModPending
attribute: false
wrapped: false
enum:
- '0'
- '1'
recModelInfo:
$ref: '#/components/schemas/RecModelInfo'
recXferId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RecXferId
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xferInfo:
$ref: '#/components/schemas/XferInfo'
xml:
name: RecXferModRq
attribute: false
wrapped: false
RecXferModRs:
title: RecXferModRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
modPending:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: ModPending
attribute: false
wrapped: false
enum:
- '0'
- '1'
recModelInfo:
$ref: '#/components/schemas/RecModelInfo'
recXferId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RecXferId
attribute: false
wrapped: false
recXferRec:
$ref: '#/components/schemas/RecXferRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
xferInfo:
$ref: '#/components/schemas/XferInfo'
RecXferMsgRec:
title: RecXferMsgRec
type: object
properties:
custId:
$ref: '#/components/schemas/CustId'
msgRecDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: MsgRecDt
attribute: false
wrapped: false
recXferAddRs:
$ref: '#/components/schemas/RecXferAddRs'
recXferCanRs:
$ref: '#/components/schemas/RecXferCanRs'
recXferModRs:
$ref: '#/components/schemas/RecXferModRs'
RecXferProf:
title: RecXferProf
type: object
properties:
freq:
type: array
xml:
name: Freq
attribute: false
wrapped: false
items:
minLength: 1
type: string
modPendingType:
minLength: 1
type: string
xml:
name: ModPendingType
attribute: false
wrapped: false
RecXferRec:
title: RecXferRec
type: object
properties:
recModelInfo:
$ref: '#/components/schemas/RecModelInfo'
recXferId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RecXferId
attribute: false
wrapped: false
remainingInsts:
type: integer
format: int64
xml:
name: RemainingInsts
attribute: false
wrapped: false
xferInfo:
$ref: '#/components/schemas/XferInfo'
RecXferSyncRq:
title: RecXferSyncRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctIdFrom:
$ref: '#/components/schemas/CardAcctIdFrom'
custId:
$ref: '#/components/schemas/CustId'
depAcctIdFrom:
$ref: '#/components/schemas/DepAcctIdFrom'
loanAcctIdFrom:
$ref: '#/components/schemas/LoanAcctIdFrom'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: RecXferSyncRq
attribute: false
wrapped: false
RecXferSyncRs:
title: RecXferSyncRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctIdFrom:
$ref: '#/components/schemas/CardAcctIdFrom'
custId:
$ref: '#/components/schemas/CustId'
depAcctIdFrom:
$ref: '#/components/schemas/DepAcctIdFrom'
loanAcctIdFrom:
$ref: '#/components/schemas/LoanAcctIdFrom'
newToken:
maxLength: 36
minLength: 1
type: string
xml:
name: NewToken
attribute: false
wrapped: false
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
recXferMsgRec:
type: array
xml:
name: RecXferMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/RecXferMsgRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
xml:
name: RecXferSyncRs
attribute: false
wrapped: false
RefInfo:
title: RefInfo
type: object
properties:
refId:
maxLength: 64
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RefId
attribute: false
wrapped: false
refType:
minLength: 1
type: string
xml:
name: RefType
attribute: false
wrapped: false
RegPmtCurAmt:
title: RegPmtCurAmt
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
RemitAddRq:
title: RemitAddRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
dupChkOverride:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: DupChkOverride
attribute: false
wrapped: false
enum:
- '0'
- '1'
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
remitInfo:
$ref: '#/components/schemas/RemitInfoType'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: RemitAddRq
attribute: false
wrapped: false
RemitAddRs:
title: RemitAddRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
dupChkOverride:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: DupChkOverride
attribute: false
wrapped: false
enum:
- '0'
- '1'
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
remitInfo:
$ref: '#/components/schemas/RemitInfoType'
remitRec:
$ref: '#/components/schemas/RemitRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
RemitAddr:
title: RemitAddr
type: object
properties:
addr1:
maxLength: 35
minLength: 1
type: string
xml:
name: Addr1
attribute: false
wrapped: false
addr2:
maxLength: 35
minLength: 1
type: string
xml:
name: Addr2
attribute: false
wrapped: false
addr3:
maxLength: 35
minLength: 1
type: string
xml:
name: Addr3
attribute: false
wrapped: false
addr4:
maxLength: 35
minLength: 1
type: string
xml:
name: Addr4
attribute: false
wrapped: false
addrType:
minLength: 1
type: string
xml:
name: AddrType
attribute: false
wrapped: false
city:
maxLength: 35
minLength: 1
type: string
xml:
name: City
attribute: false
wrapped: false
country:
maxLength: 35
minLength: 1
type: string
xml:
name: Country
attribute: false
wrapped: false
endDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: EndDt
attribute: false
wrapped: false
postalCode:
maxLength: 35
minLength: 1
type: string
xml:
name: PostalCode
attribute: false
wrapped: false
startDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: StartDt
attribute: false
wrapped: false
stateProv:
maxLength: 32
minLength: 1
type: string
xml:
name: StateProv
attribute: false
wrapped: false
RemitAudRq:
title: RemitAudRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
remitId:
type: array
xml:
name: RemitId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
xml:
name: RemitAudRq
attribute: false
wrapped: false
RemitAudRs:
title: RemitAudRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
remitId:
type: array
xml:
name: RemitId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
remitMsgRec:
type: array
xml:
name: RemitMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/RemitMsgRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
status:
$ref: '#/components/schemas/StatusType'
xml:
name: RemitAudRs
attribute: false
wrapped: false
RemitCurAmt:
title: RemitCurAmt
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
RemitDelRq:
title: RemitDelRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
remitId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RemitId
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: RemitDelRq
attribute: false
wrapped: false
RemitDelRs:
title: RemitDelRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
remitId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RemitId
attribute: false
wrapped: false
remitRec:
$ref: '#/components/schemas/RemitRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
RemitDetail:
title: RemitDetail
type: object
properties:
billId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: BillId
attribute: false
wrapped: false
billRefInfo:
maxLength: 80
minLength: 1
type: string
xml:
name: BillRefInfo
attribute: false
wrapped: false
billingAcct:
maxLength: 32
minLength: 1
type: string
xml:
name: BillingAcct
attribute: false
wrapped: false
curAmt:
$ref: '#/components/schemas/CurAmt'
invoiceInfo:
type: array
xml:
name: InvoiceInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/InvoiceInfo'
invoiceReceiver:
$ref: '#/components/schemas/InvoiceReceiver'
invoiceSender:
$ref: '#/components/schemas/InvoiceSender'
memo:
maxLength: 1024
minLength: 1
type: string
xml:
name: Memo
attribute: false
wrapped: false
pmtSummAmt:
type: array
xml:
name: PmtSummAmt
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/PmtSummAmt'
refInfo:
type: array
xml:
name: RefInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/RefInfo'
RemitInfoType:
title: RemitInfoType
type: object
properties:
billId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: BillId
attribute: false
wrapped: false
billRefInfo:
maxLength: 80
minLength: 1
type: string
xml:
name: BillRefInfo
attribute: false
wrapped: false
billingAcct:
maxLength: 32
minLength: 1
type: string
xml:
name: BillingAcct
attribute: false
wrapped: false
chkInfo:
$ref: '#/components/schemas/ChkInfo'
chkURL:
maxLength: 1024
minLength: 1
type: string
xml:
name: ChkURL
attribute: false
wrapped: false
counterpartyInfo:
$ref: '#/components/schemas/CounterpartyInfoType'
curAmt:
$ref: '#/components/schemas/CurAmt'
custPayeeId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: CustPayeeId
attribute: false
wrapped: false
custPayeeInfo:
$ref: '#/components/schemas/CustPayeeInfo'
invoiceInfo:
type: array
xml:
name: InvoiceInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/InvoiceInfo'
memo:
maxLength: 1024
minLength: 1
type: string
xml:
name: Memo
attribute: false
wrapped: false
orderingPartyInfo:
type: array
xml:
name: OrderingPartyInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/OrderingPartyInfoType'
pmtId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: PmtId
attribute: false
wrapped: false
pmtLegalRpt:
$ref: '#/components/schemas/PmtLegalRpt'
pmtRemitRefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: PmtRemitRefId
attribute: false
wrapped: false
pmtSummAmt:
type: array
xml:
name: PmtSummAmt
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/PmtSummAmt'
remitDetail:
type: array
xml:
name: RemitDetail
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/RemitDetail'
remitInfo:
$ref: '#/components/schemas/RemitInfoType'
remitInstruction:
$ref: '#/components/schemas/RemitInstruction'
settlementInfo:
$ref: '#/components/schemas/SettlementInfoType'
RemitInqRq:
title: RemitInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
remitId:
type: array
xml:
name: RemitId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeCurAmt:
$ref: '#/components/schemas/SelRangeCurAmt'
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
xml:
name: RemitInqRq
attribute: false
wrapped: false
RemitInqRs:
title: RemitInqRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
remitId:
type: array
xml:
name: RemitId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
remitRec:
type: array
xml:
name: RemitRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/RemitRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeCurAmt:
$ref: '#/components/schemas/SelRangeCurAmt'
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
status:
$ref: '#/components/schemas/StatusType'
xml:
name: RemitInqRs
attribute: false
wrapped: false
RemitInstruction:
title: RemitInstruction
type: object
properties:
contactInfo:
$ref: '#/components/schemas/ContactInfo'
deliveryInstruction:
minLength: 1
type: string
xml:
name: DeliveryInstruction
attribute: false
wrapped: false
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
pmtRefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: PmtRefId
attribute: false
wrapped: false
remitRefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RemitRefId
attribute: false
wrapped: false
RemitModRq:
title: RemitModRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
dupChkOverride:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: DupChkOverride
attribute: false
wrapped: false
enum:
- '0'
- '1'
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
remitId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RemitId
attribute: false
wrapped: false
remitInfo:
$ref: '#/components/schemas/RemitInfoType'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: RemitModRq
attribute: false
wrapped: false
RemitModRs:
title: RemitModRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
dupChkOverride:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: DupChkOverride
attribute: false
wrapped: false
enum:
- '0'
- '1'
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
remitId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RemitId
attribute: false
wrapped: false
remitInfo:
$ref: '#/components/schemas/RemitInfoType'
remitRec:
$ref: '#/components/schemas/RemitRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
RemitMsgRec:
title: RemitMsgRec
type: object
properties:
custId:
$ref: '#/components/schemas/CustId'
msgRecDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: MsgRecDt
attribute: false
wrapped: false
remitAddRs:
$ref: '#/components/schemas/RemitAddRs'
remitDelRs:
$ref: '#/components/schemas/RemitDelRs'
remitModRs:
$ref: '#/components/schemas/RemitModRs'
remitStatusModRs:
$ref: '#/components/schemas/RemitStatusModRs'
RemitRec:
title: RemitRec
type: object
properties:
remitId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RemitId
attribute: false
wrapped: false
remitInfo:
$ref: '#/components/schemas/RemitInfoType'
remitStatus:
$ref: '#/components/schemas/RemitStatus'
RemitStatus:
title: RemitStatus
type: object
properties:
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
memo:
maxLength: 1024
minLength: 1
type: string
xml:
name: Memo
attribute: false
wrapped: false
remitStatusCode:
minLength: 1
type: string
description: StatusCode as Per IFX XML
xml:
name: RemitStatusCode
attribute: false
wrapped: false
statusDesc:
maxLength: 255
minLength: 1
type: string
description: Text description for status code
xml:
name: StatusDesc
attribute: false
wrapped: false
statusModBy:
minLength: 1
type: string
xml:
name: StatusModBy
attribute: false
wrapped: false
RemitStatusModRq:
title: RemitStatusModRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
remitId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RemitId
attribute: false
wrapped: false
remitStatus:
$ref: '#/components/schemas/RemitStatus'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: RemitStatusModRq
attribute: false
wrapped: false
RemitStatusModRs:
title: RemitStatusModRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
remitId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RemitId
attribute: false
wrapped: false
remitStatus:
$ref: '#/components/schemas/RemitStatus'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
RemitSyncRq:
title: RemitSyncRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: RemitSyncRq
attribute: false
wrapped: false
RemitSyncRs:
title: RemitSyncRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
newToken:
maxLength: 36
minLength: 1
type: string
xml:
name: NewToken
attribute: false
wrapped: false
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
remitMsgRec:
type: array
xml:
name: RemitMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/RemitMsgRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: RemitSyncRs
attribute: false
wrapped: false
SPRefIdCorrect:
title: SPRefIdCorrect
type: object
properties:
correctAction:
minLength: 1
type: string
xml:
name: CorrectAction
attribute: false
wrapped: false
sprefId:
type: string
SecretList:
title: SecretList
type: object
properties:
cryptSecret:
$ref: '#/components/schemas/CryptSecret'
cryptType:
minLength: 1
type: string
xml:
name: CryptType
attribute: false
wrapped: false
secret:
maxLength: 80
minLength: 1
type: string
xml:
name: Secret
attribute: false
wrapped: false
secretId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: SecretId
attribute: false
wrapped: false
SecretPrompt:
title: SecretPrompt
type: object
properties:
memo:
maxLength: 1024
minLength: 1
type: string
xml:
name: Memo
attribute: false
wrapped: false
prompt:
maxLength: 20
minLength: 1
type: string
xml:
name: Prompt
attribute: false
wrapped: false
secretFormat:
maxLength: 1024
minLength: 1
type: string
xml:
name: SecretFormat
attribute: false
wrapped: false
secretId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: SecretId
attribute: false
wrapped: false
secretMask:
maxLength: 80
minLength: 1
type: string
xml:
name: SecretMask
attribute: false
wrapped: false
secretOptional:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: SecretOptional
attribute: false
wrapped: false
enum:
- '0'
- '1'
SelRangeCurAmt:
title: SelRangeCurAmt
type: object
properties:
highCurAmt:
$ref: '#/components/schemas/HighCurAmt'
lowCurAmt:
$ref: '#/components/schemas/LowCurAmt'
SelRangeDt:
title: SelRangeDt
type: object
properties:
endDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: EndDt
attribute: false
wrapped: false
startDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: StartDt
attribute: false
wrapped: false
SelRangeDtType:
title: SelRangeDtType
type: object
properties:
endDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: EndDt
attribute: false
wrapped: false
startDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: StartDt
attribute: false
wrapped: false
xml:
name: SelRangeDt_Type
attribute: false
wrapped: false
SelRangeDueDt:
title: SelRangeDueDt
type: object
properties:
endDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: EndDt
attribute: false
wrapped: false
startDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: StartDt
attribute: false
wrapped: false
SelRangePrcDt:
title: SelRangePrcDt
type: object
properties:
endDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: EndDt
attribute: false
wrapped: false
startDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: StartDt
attribute: false
wrapped: false
SellAmtType:
title: SellAmtType
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
SeqNbr15AType:
title: SeqNbr15AType
type: object
properties:
blockTrdInd:
maxLength: 1
minLength: 1
type: string
xml:
name: BlockTrdInd
attribute: false
wrapped: false
comRef:
$ref: '#/components/schemas/ComRefType'
fxdealCntrPrty:
type: array
items:
$ref: '#/components/schemas/FXDealCntrPrtyType'
opScope:
minLength: 1
type: string
xml:
name: OpScope
attribute: false
wrapped: false
enum:
- AGNT
- BILA
- BROK
opType:
minLength: 1
type: string
xml:
name: OpType
attribute: false
wrapped: false
enum:
- NEWT
- AMND
- CANC
- EXOP
- DUPL
relRefNbr:
maxLength: 16
minLength: 1
type: string
xml:
name: RelRefNbr
attribute: false
wrapped: false
sendRefNbr:
maxLength: 16
minLength: 1
type: string
xml:
name: SendRefNbr
attribute: false
wrapped: false
splitSettlInd:
maxLength: 1
minLength: 1
type: string
xml:
name: SplitSettlInd
attribute: false
wrapped: false
termCond:
maxLength: 210
minLength: 1
type: string
xml:
name: TermCond
attribute: false
wrapped: false
SeqNbr15BType:
title: SeqNbr15BType
type: object
properties:
agtInterBuyCntrPrty:
type: array
xml:
name: AgtInterBuyCntrPrty
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/AgtInterBuyCntrPrtyType'
agtInterSellCntrPrty:
type: array
xml:
name: AgtInterSellCntrPrty
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/AgtInterSellCntrPrtyType'
buyAmt:
$ref: '#/components/schemas/BuyAmtType'
sellAmt:
$ref: '#/components/schemas/SellAmtType'
tradeDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: TradeDt
attribute: false
wrapped: false
valDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: ValDt
attribute: false
wrapped: false
SeqNbr15CType:
title: SeqNbr15CType
type: object
properties:
brkrComm:
$ref: '#/components/schemas/BrkrCommType'
brkrRef:
maxLength: 16
minLength: 1
type: string
xml:
name: BrkrRef
attribute: false
wrapped: false
cntrPrtyRef:
maxLength: 16
minLength: 1
type: string
xml:
name: CntrPrtyRef
attribute: false
wrapped: false
contInfo:
$ref: '#/components/schemas/ContInfoType'
dealMeth:
$ref: '#/components/schemas/DealMethType'
dealingBranchCntrPrty:
type: array
xml:
name: DealingBranchCntrPrty
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/DealingBranchCntrPrtyType'
partyContactInfo:
$ref: '#/components/schemas/PartyContactInfoType'
statusCode:
minLength: 1
type: string
description: StatusCode as Per IFX XML
xml:
name: StatusCode
attribute: false
wrapped: false
SeqNbr15DType:
title: SeqNbr15DType
type: object
properties:
nbrSettle:
type: number
xml:
name: NbrSettle
attribute: false
wrapped: false
splitSettleCntrPrty:
type: array
xml:
name: SplitSettleCntrPrty
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/SplitSettleCntrPrtyType'
splitSettleDet:
$ref: '#/components/schemas/SplitSettleDetType'
SettlementInfoType:
title: SettlementInfoType
type: object
properties:
contactInfo:
$ref: '#/components/schemas/ContactInfo'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
memo:
maxLength: 1024
minLength: 1
type: string
xml:
name: Memo
attribute: false
wrapped: false
orgContact:
$ref: '#/components/schemas/OrgContact'
pmtInstruction:
type: array
xml:
name: PmtInstruction
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/PmtInstruction'
settlementId:
maxLength: 20
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: SettlementId
attribute: false
wrapped: false
settlementMethod:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: SettlementMethod
attribute: false
wrapped: false
SignoffRqType:
title: SignoffRqType
type: object
properties:
custId:
$ref: '#/components/schemas/CustId'
SignoffRsType:
title: SignoffRsType
type: object
properties:
custId:
$ref: '#/components/schemas/CustId'
status:
$ref: '#/components/schemas/StatusType'
SignonCertType:
title: SignonCertType
type: object
properties:
certificate:
$ref: '#/components/schemas/Certificate'
custId:
$ref: '#/components/schemas/CustId'
genSessKey:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: GenSessKey
attribute: false
wrapped: false
enum:
- '0'
- '1'
signonRole:
minLength: 1
type: string
xml:
name: SignonRole
attribute: false
wrapped: false
SignonInfo:
title: SignonInfo
type: object
properties:
authSupt:
type: array
xml:
name: AuthSupt
attribute: false
wrapped: false
items:
type: string
caseSen:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: CaseSen
attribute: false
wrapped: false
enum:
- '0'
- '1'
charType:
minLength: 1
type: string
xml:
name: CharType
attribute: false
wrapped: false
cryptType:
type: array
xml:
name: CryptType
attribute: false
wrapped: false
items:
minLength: 1
type: string
max:
type: integer
format: int64
xml:
name: Max
attribute: false
wrapped: false
memo:
maxLength: 1024
minLength: 1
type: string
xml:
name: Memo
attribute: false
wrapped: false
min:
type: integer
format: int64
xml:
name: Min
attribute: false
wrapped: false
modPswdFirst:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: ModPswdFirst
attribute: false
wrapped: false
enum:
- '0'
- '1'
spaceAlwd:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: SpaceAlwd
attribute: false
wrapped: false
enum:
- '0'
- '1'
SignonMagPIN:
title: SignonMagPIN
type: object
properties:
cardMagData:
$ref: '#/components/schemas/CardMagDataType'
genSessKey:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: GenSessKey
attribute: false
wrapped: false
enum:
- '0'
- '1'
pinblock:
maxLength: 32
minLength: 1
type: string
SignonOverride:
title: SignonOverride
type: object
properties:
overrideType:
minLength: 1
type: string
xml:
name: OverrideType
attribute: false
wrapped: false
signonCert:
$ref: '#/components/schemas/SignonCertType'
signonMagPIN:
$ref: '#/components/schemas/SignonMagPIN'
signonPswd:
$ref: '#/components/schemas/SignonPswdType'
SignonPswdType:
title: SignonPswdType
type: object
properties:
custId:
$ref: '#/components/schemas/CustId'
custPswd:
$ref: '#/components/schemas/CustPswd'
genSessKey:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: GenSessKey
attribute: false
wrapped: false
enum:
- '0'
- '1'
signonRole:
minLength: 1
type: string
xml:
name: SignonRole
attribute: false
wrapped: false
SignonRqType:
title: SignonRqType
type: object
properties:
clientApp:
$ref: '#/components/schemas/ClientApp'
clientDt:
maxLength: 19
pattern: '[^"']*'
type: string
description: >-
Customer date and time for the message. Header -Date/Time
'yyyy-mm-ddThh:mm:ss'. Will be stored for use in service related
issues.
xml:
name: ClientDt
attribute: false
wrapped: false
custLangPref:
minLength: 1
type: string
description: >-
Always set to ENGLISH. Only English language is supported. Value in
this parameter will be ignored.
xml:
name: CustLangPref
attribute: false
wrapped: false
enum:
- ENGLISH
eucur:
minLength: 1
type: string
proxyClient:
$ref: '#/components/schemas/ProxyClient'
sessKey:
maxLength: 64
minLength: 1
type: string
xml:
name: SessKey
attribute: false
wrapped: false
signonCert:
$ref: '#/components/schemas/SignonCertType'
signonMagPIN:
$ref: '#/components/schemas/SignonMagPIN'
signonOverride:
$ref: '#/components/schemas/SignonOverride'
signonPswd:
$ref: '#/components/schemas/SignonPswdType'
signonTransport:
$ref: '#/components/schemas/SignonTransport'
suppressEcho:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: SuppressEcho
attribute: false
wrapped: false
enum:
- '0'
- '1'
SignonRs:
title: SignonRs
type: object
properties:
clientApp:
$ref: '#/components/schemas/ClientApp'
clientDt:
pattern: '[^"']*'
type: string
description: Customer date and time for the message
xml:
name: ClientDt
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
custLangPref:
maxLength: 35
type: string
description: >-
Always set to ENGLISH. Only English language is supported. Value in
this parameter will be ignored.
xml:
name: CustLangPref
attribute: false
wrapped: false
enum:
- ENGLISH
eucur:
minLength: 1
type: string
expDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
description: Contract Expiry Datetime
xml:
name: ExpDt
attribute: false
wrapped: false
genSessKey:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: GenSessKey
attribute: false
wrapped: false
enum:
- '0'
- '1'
language:
maxLength: 17
minLength: 1
type: string
xml:
name: Language
attribute: false
wrapped: false
proxyClient:
$ref: '#/components/schemas/ProxyClient'
serverDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: ServerDt
attribute: false
wrapped: false
sessKey:
maxLength: 64
minLength: 1
type: string
xml:
name: SessKey
attribute: false
wrapped: false
signonRole:
minLength: 1
type: string
xml:
name: SignonRole
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
SignonTransport:
title: SignonTransport
type: object
properties:
custId:
$ref: '#/components/schemas/CustId'
genSessKey:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: GenSessKey
attribute: false
wrapped: false
enum:
- '0'
- '1'
signonRole:
minLength: 1
type: string
xml:
name: SignonRole
attribute: false
wrapped: false
SplitSettleAmtType:
title: SplitSettleAmtType
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
SplitSettleCntrPrtyType:
title: SplitSettleCntrPrtyType
type: object
properties:
acctId:
maxLength: 255
minLength: 1
pattern: '[^"']*'
type: string
description: FROM account number
xml:
name: AcctId
attribute: false
wrapped: false
bankId:
maxLength: 34
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: BankId
attribute: false
wrapped: false
bankIdType:
minLength: 1
type: string
xml:
name: BankIdType
attribute: false
wrapped: false
cntrPrtyType:
minLength: 1
type: string
xml:
name: CntrPrtyType
attribute: false
wrapped: false
enum:
- PARTY_A
- PARTY_B
- FUND_BENE_CUST
- DELIVERY_AGENT
- INTERMEDIARY
- RECEIVING_AGENT
- BENEFICIARY_INSTITUTION
- DEALING_BRANCH_PARTY_A
- DEALING_BRANCH_PARTY_B
- BROKER_IDENTIFICATION
name:
maxLength: 40
minLength: 1
type: string
xml:
name: Name
attribute: false
wrapped: false
postAddr:
$ref: '#/components/schemas/PostAddr'
SplitSettleDetType:
title: SplitSettleDetType
type: object
properties:
buySellInd:
maxLength: 1
minLength: 1
type: string
xml:
name: BuySellInd
attribute: false
wrapped: false
splitSettleAmt:
$ref: '#/components/schemas/SplitSettleAmtType'
StatusType:
title: StatusType
type: object
properties:
additionalStatus:
type: array
xml:
name: AdditionalStatus
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/AdditionalStatus'
asyncRsInfo:
$ref: '#/components/schemas/AsyncRsInfo'
serverStatusCode:
maxLength: 35
minLength: 1
type: string
description: Backend Status Code
xml:
name: ServerStatusCode
attribute: false
wrapped: false
severity:
maxLength: 5
minLength: 1
type: string
description: >-
Error,Warn,Info. NONE for code 000, HIGH for all the other status
codes.
xml:
name: Severity
attribute: false
wrapped: false
statusCode:
maxLength: 35
minLength: 1
type: string
description: >-
StatusCode as Per IFX XML. PROCESSED for code 000 and 120 (Rate
returned and value date changed) FAILED for all other codes
(Rejects)
xml:
name: StatusCode
attribute: false
wrapped: false
statusDesc:
maxLength: 255
minLength: 1
type: string
description: >-
Text description for status code. 991 : Application
program abend has occurred 000 : Rate
Returned
xml:
name: StatusDesc
attribute: false
wrapped: false
StdPayeeId:
title: StdPayeeId
type: object
properties:
billerNum:
maxLength: 36
minLength: 1
type: string
xml:
name: BillerNum
attribute: false
wrapped: false
spname:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Always set to CTSI
StdPayeeInfo:
title: StdPayeeInfo
type: object
properties:
acctMask:
type: array
xml:
name: AcctMask
attribute: false
wrapped: false
items:
maxLength: 32
minLength: 1
type: string
daysToPay:
type: integer
format: int64
xml:
name: DaysToPay
attribute: false
wrapped: false
industId:
$ref: '#/components/schemas/IndustId'
name:
maxLength: 40
minLength: 1
type: string
xml:
name: Name
attribute: false
wrapped: false
postAddr:
$ref: '#/components/schemas/PostAddr'
StdPayeeInqRqType:
title: StdPayeeInqRqType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
billingAcct:
type: array
xml:
name: BillingAcct
attribute: false
wrapped: false
items:
maxLength: 32
minLength: 1
type: string
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
industId:
type: array
xml:
name: IndustId
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/IndustId'
name:
type: array
xml:
name: Name
attribute: false
wrapped: false
items:
maxLength: 40
minLength: 1
type: string
postalCode:
type: array
xml:
name: PostalCode
attribute: false
wrapped: false
items:
maxLength: 35
minLength: 1
type: string
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request.
xml:
name: RqUID
attribute: false
wrapped: false
stdPayeeId:
type: array
xml:
name: StdPayeeId
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/StdPayeeId'
xml:
name: StdPayeeInqRq_Type
attribute: false
wrapped: false
StdPayeeInqRs:
title: StdPayeeInqRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
billingAcct:
type: array
xml:
name: BillingAcct
attribute: false
wrapped: false
items:
maxLength: 32
minLength: 1
type: string
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
industId:
type: array
xml:
name: IndustId
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/IndustId'
name:
type: array
xml:
name: Name
attribute: false
wrapped: false
items:
maxLength: 40
minLength: 1
type: string
postalCode:
type: array
xml:
name: PostalCode
attribute: false
wrapped: false
items:
maxLength: 35
minLength: 1
type: string
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request. Echoed from customer request.
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
stdPayeeId:
type: array
xml:
name: StdPayeeId
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/StdPayeeId'
stdPayeeRec:
type: array
xml:
name: StdPayeeRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/StdPayeeRec'
xml:
name: StdPayeeInqRs
attribute: false
wrapped: false
StdPayeeRec:
title: StdPayeeRec
type: object
properties:
stdPayeeId:
$ref: '#/components/schemas/StdPayeeId'
stdPayeeInfo:
$ref: '#/components/schemas/StdPayeeInfo'
StmtImage:
title: StmtImage
type: object
properties:
expDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
description: Contract Expiry Datetime
xml:
name: ExpDt
attribute: false
wrapped: false
imageURL:
maxLength: 1024
minLength: 1
type: string
xml:
name: ImageURL
attribute: false
wrapped: false
prefetchURL:
type: array
xml:
name: PrefetchURL
attribute: false
wrapped: false
items:
maxLength: 1024
minLength: 1
type: string
StmtSummAmt:
title: StmtSummAmt
type: object
properties:
count:
type: integer
format: int64
xml:
name: Count
attribute: false
wrapped: false
curAmt:
$ref: '#/components/schemas/CurAmt'
stmtSummType:
minLength: 1
type: string
xml:
name: StmtSummType
attribute: false
wrapped: false
StopChkAddRq:
title: StopChkAddRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
chkRange:
$ref: '#/components/schemas/ChkRangeType'
custId:
$ref: '#/components/schemas/CustId'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
loanAcctId:
$ref: '#/components/schemas/LoanAcctId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
stopChkInfo:
$ref: '#/components/schemas/StopChkInfo'
xml:
name: StopChkAddRq
attribute: false
wrapped: false
StopChkAddRs:
title: StopChkAddRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
chkRange:
$ref: '#/components/schemas/ChkRangeType'
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
loanAcctId:
$ref: '#/components/schemas/LoanAcctId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Dealoffer ID if this is not a commited Deal
status:
$ref: '#/components/schemas/StatusType'
stopChkInfo:
$ref: '#/components/schemas/StopChkInfo'
stopChkRec:
type: array
xml:
name: StopChkRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/StopChkRec'
StopChkAudRq:
title: StopChkAudRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
chkRange:
$ref: '#/components/schemas/ChkRangeType'
custId:
$ref: '#/components/schemas/CustId'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
loanAcctId:
$ref: '#/components/schemas/LoanAcctId'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
xml:
name: StopChkAudRq
attribute: false
wrapped: false
StopChkAudRs:
title: StopChkAudRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
chkRange:
$ref: '#/components/schemas/ChkRangeType'
custId:
$ref: '#/components/schemas/CustId'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
loanAcctId:
$ref: '#/components/schemas/LoanAcctId'
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
status:
$ref: '#/components/schemas/StatusType'
stopChkMsgRec:
type: array
xml:
name: StopChkMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/StopChkMsgRec'
xml:
name: StopChkAudRs
attribute: false
wrapped: false
StopChkCanRq:
title: StopChkCanRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
chkRange:
$ref: '#/components/schemas/ChkRangeType'
custId:
$ref: '#/components/schemas/CustId'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
loanAcctId:
$ref: '#/components/schemas/LoanAcctId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
stopChkInfo:
$ref: '#/components/schemas/StopChkInfo'
xml:
name: StopChkCanRq
attribute: false
wrapped: false
StopChkCanRs:
title: StopChkCanRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
chkRange:
$ref: '#/components/schemas/ChkRangeType'
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
loanAcctId:
$ref: '#/components/schemas/LoanAcctId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
stopChkInfo:
$ref: '#/components/schemas/StopChkInfo'
stopChkRec:
type: array
xml:
name: StopChkRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/StopChkRec'
StopChkInfo:
title: StopChkInfo
type: object
properties:
chkNum:
maxLength: 12
minLength: 1
type: string
xml:
name: ChkNum
attribute: false
wrapped: false
curAmt:
$ref: '#/components/schemas/CurAmt'
desc:
maxLength: 80
minLength: 1
type: string
xml:
name: Desc
attribute: false
wrapped: false
name:
maxLength: 40
minLength: 1
type: string
xml:
name: Name
attribute: false
wrapped: false
origDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
StopChkInqRq:
title: StopChkInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
chkRange:
$ref: '#/components/schemas/ChkRangeType'
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
depAcctId:
$ref: '#/components/schemas/DepAcctId'
incToken:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncToken
attribute: false
wrapped: false
enum:
- '0'
- '1'
loanAcctId:
$ref: '#/components/schemas/LoanAcctId'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
stopChkInfo:
type: array
xml:
name: StopChkInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/StopChkInfo'
xml:
name: StopChkInqRq
attribute: false
wrapped: false
StopChkInqRs:
title: StopChkInqRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
chkRange:
$ref: '#/components/schemas/ChkRangeType'
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
depAcctId:
$ref: '#/components/schemas/DepAcctId'
loanAcctId:
$ref: '#/components/schemas/LoanAcctId'
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
status:
$ref: '#/components/schemas/StatusType'
stopChkInfo:
type: array
xml:
name: StopChkInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/StopChkInfo'
stopChkRec:
type: array
xml:
name: StopChkRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/StopChkRec'
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: StopChkInqRs
attribute: false
wrapped: false
StopChkMsgRec:
title: StopChkMsgRec
type: object
properties:
custId:
$ref: '#/components/schemas/CustId'
msgRecDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: MsgRecDt
attribute: false
wrapped: false
stopChkAddRs:
$ref: '#/components/schemas/StopChkAddRs'
stopChkCanRs:
$ref: '#/components/schemas/StopChkCanRs'
StopChkProf:
title: StopChkProf
type: object
properties:
fee:
type: array
xml:
name: Fee
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/FeeType'
optSupt:
type: array
xml:
name: OptSupt
attribute: false
wrapped: false
items:
minLength: 1
type: string
prcSched:
$ref: '#/components/schemas/PrcSched'
StopChkRec:
title: StopChkRec
type: object
properties:
postedDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
statusDesc:
maxLength: 255
minLength: 1
type: string
description: Text description for status code
xml:
name: StatusDesc
attribute: false
wrapped: false
stopChkInfo:
$ref: '#/components/schemas/StopChkInfo'
stopChkStatusCode:
minLength: 1
type: string
description: StatusCode as Per IFX XML
xml:
name: StopChkStatusCode
attribute: false
wrapped: false
StopChkSyncRq:
title: StopChkSyncRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
custId:
$ref: '#/components/schemas/CustId'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
loanAcctId:
$ref: '#/components/schemas/LoanAcctId'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: StopChkSyncRq
attribute: false
wrapped: false
StopChkSyncRs:
title: StopChkSyncRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
custId:
$ref: '#/components/schemas/CustId'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
loanAcctId:
$ref: '#/components/schemas/LoanAcctId'
newToken:
maxLength: 36
minLength: 1
type: string
xml:
name: NewToken
attribute: false
wrapped: false
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
stopChkMsgRec:
type: array
xml:
name: StopChkMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/StopChkMsgRec'
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: StopChkSyncRs
attribute: false
wrapped: false
SumEntries:
title: SumEntries
type: object
properties:
creditEntries:
$ref: '#/components/schemas/CreditEntries'
debitEntries:
$ref: '#/components/schemas/DebitEntries'
SvcAcctAddRqType:
title: SvcAcctAddRqType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cryptType:
minLength: 1
type: string
xml:
name: CryptType
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
custNameAddr:
type: array
xml:
name: CustNameAddr
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CustNameAddr'
personInfo:
type: array
xml:
name: PersonInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/PersonInfo'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
secretList:
type: array
xml:
name: SecretList
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/SecretList'
svcAcctId:
$ref: '#/components/schemas/SvcAcctId'
svcAcctInfo:
$ref: '#/components/schemas/SvcAcctInfo'
xml:
name: SvcAcctAddRq_Type
attribute: false
wrapped: false
SvcAcctAddRsType:
title: SvcAcctAddRsType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
discRec:
type: array
xml:
name: DiscRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/DiscRec'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
svcAcctId:
$ref: '#/components/schemas/SvcAcctId'
svcAcctInfo:
$ref: '#/components/schemas/SvcAcctInfo'
svcAcctRec:
$ref: '#/components/schemas/SvcAcctRec'
SvcAcctAudRq:
title: SvcAcctAudRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
xml:
name: SvcAcctAudRq
attribute: false
wrapped: false
SvcAcctAudRs:
title: SvcAcctAudRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
status:
$ref: '#/components/schemas/StatusType'
svcAcctMsgRec:
type: array
xml:
name: SvcAcctMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/SvcAcctMsgRec'
xml:
name: SvcAcctAudRs
attribute: false
wrapped: false
SvcAcctDelRq:
title: SvcAcctDelRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cascadeDel:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: CascadeDel
attribute: false
wrapped: false
enum:
- '0'
- '1'
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
svcAcctId:
$ref: '#/components/schemas/SvcAcctId'
xml:
name: SvcAcctDelRq
attribute: false
wrapped: false
SvcAcctDelRs:
title: SvcAcctDelRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cascadeDel:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: CascadeDel
attribute: false
wrapped: false
enum:
- '0'
- '1'
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
dependentType:
type: array
xml:
name: DependentType
attribute: false
wrapped: false
items:
minLength: 1
type: string
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
svcAcctId:
$ref: '#/components/schemas/SvcAcctId'
svcAcctRec:
$ref: '#/components/schemas/SvcAcctRec'
SvcAcctId:
title: SvcAcctId
type: object
properties:
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
custSvcId:
$ref: '#/components/schemas/CustSvcId'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
loanAcctId:
$ref: '#/components/schemas/LoanAcctId'
presAcctId:
$ref: '#/components/schemas/PresAcctId'
presAcctInfo:
$ref: '#/components/schemas/PresAcctInfo'
SvcAcctIdModRq:
title: SvcAcctIdModRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
custId:
$ref: '#/components/schemas/CustId'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
loanAcctId:
$ref: '#/components/schemas/LoanAcctId'
presAcctId:
$ref: '#/components/schemas/PresAcctId'
presAcctInfo:
$ref: '#/components/schemas/PresAcctInfo'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
svcAcctId:
$ref: '#/components/schemas/SvcAcctId'
xml:
name: SvcAcctIdModRq
attribute: false
wrapped: false
SvcAcctIdModRs:
title: SvcAcctIdModRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctId:
$ref: '#/components/schemas/CardAcctId'
custId:
$ref: '#/components/schemas/CustId'
depAcctId:
$ref: '#/components/schemas/DepAcctId'
loanAcctId:
$ref: '#/components/schemas/LoanAcctId'
presAcctId:
$ref: '#/components/schemas/PresAcctId'
presAcctInfo:
$ref: '#/components/schemas/PresAcctInfo'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
svcAcctId:
$ref: '#/components/schemas/SvcAcctId'
svcAcctRec:
$ref: '#/components/schemas/SvcAcctRec'
SvcAcctInfo:
title: SvcAcctInfo
type: object
properties:
nickname:
maxLength: 40
minLength: 1
type: string
xml:
name: Nickname
attribute: false
wrapped: false
SvcAcctInqRq:
title: SvcAcctInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardMagData:
$ref: '#/components/schemas/CardMagDataType'
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
incBal:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncBal
attribute: false
wrapped: false
enum:
- '0'
- '1'
incDetail:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncDetail
attribute: false
wrapped: false
enum:
- '0'
- '1'
incToken:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncToken
attribute: false
wrapped: false
enum:
- '0'
- '1'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
svcName:
type: array
xml:
name: SvcName
attribute: false
wrapped: false
items:
minLength: 1
type: string
upDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
xml:
name: SvcAcctInqRq
attribute: false
wrapped: false
SvcAcctInqRs:
title: SvcAcctInqRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
bankAcctRec:
type: array
xml:
name: BankAcctRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/BankAcctRec'
cardMagData:
$ref: '#/components/schemas/CardMagDataType'
custId:
$ref: '#/components/schemas/CustId'
custSvcRec:
type: array
xml:
name: CustSvcRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CustSvcRec'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
incBal:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncBal
attribute: false
wrapped: false
enum:
- '0'
- '1'
incDetail:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncDetail
attribute: false
wrapped: false
enum:
- '0'
- '1'
incToken:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncToken
attribute: false
wrapped: false
enum:
- '0'
- '1'
newUpDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
presAcctRec:
type: array
xml:
name: PresAcctRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/PresAcctRec'
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
svcAcctRec:
type: array
xml:
name: SvcAcctRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/SvcAcctRec'
svcName:
type: array
xml:
name: SvcName
attribute: false
wrapped: false
items:
minLength: 1
type: string
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
upDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
xml:
name: SvcAcctInqRs
attribute: false
wrapped: false
SvcAcctModRqType:
title: SvcAcctModRqType
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cryptType:
minLength: 1
type: string
xml:
name: CryptType
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
custNameAddr:
type: array
xml:
name: CustNameAddr
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CustNameAddr'
personInfo:
type: array
xml:
name: PersonInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/PersonInfo'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
secretList:
type: array
xml:
name: SecretList
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/SecretList'
svcAcctId:
$ref: '#/components/schemas/SvcAcctId'
svcAcctInfo:
$ref: '#/components/schemas/SvcAcctInfo'
xml:
name: SvcAcctModRq_Type
attribute: false
wrapped: false
SvcAcctModRs:
title: SvcAcctModRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custDiscRec:
type: array
xml:
name: CustDiscRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/CustDiscRec'
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
svcAcctId:
$ref: '#/components/schemas/SvcAcctId'
svcAcctInfo:
$ref: '#/components/schemas/SvcAcctInfo'
svcAcctRec:
$ref: '#/components/schemas/SvcAcctRec'
SvcAcctMsgRec:
title: SvcAcctMsgRec
type: object
properties:
custId:
$ref: '#/components/schemas/CustId'
msgRecDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: MsgRecDt
attribute: false
wrapped: false
svcAcctAddRs:
$ref: '#/components/schemas/SvcAcctAddRsType'
svcAcctDelRs:
$ref: '#/components/schemas/SvcAcctDelRs'
svcAcctIdModRs:
$ref: '#/components/schemas/SvcAcctIdModRs'
svcAcctModRs:
$ref: '#/components/schemas/SvcAcctModRs'
svcAcctStatusModRs:
$ref: '#/components/schemas/SvcAcctStatusModRs'
SvcAcctRec:
title: SvcAcctRec
type: object
properties:
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
svcAcctId:
$ref: '#/components/schemas/SvcAcctId'
svcAcctInfo:
$ref: '#/components/schemas/SvcAcctInfo'
svcAcctStatus:
$ref: '#/components/schemas/SvcAcctStatus'
SvcAcctStatus:
title: SvcAcctStatus
type: object
properties:
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
resolvePendingDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
statusDesc:
maxLength: 255
minLength: 1
type: string
description: Text description for status code
xml:
name: StatusDesc
attribute: false
wrapped: false
statusModBy:
minLength: 1
type: string
xml:
name: StatusModBy
attribute: false
wrapped: false
svcAcctStatusCode:
minLength: 1
type: string
description: StatusCode as Per IFX XML
xml:
name: SvcAcctStatusCode
attribute: false
wrapped: false
SvcAcctStatusModRq:
title: SvcAcctStatusModRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
svcAcctId:
$ref: '#/components/schemas/SvcAcctId'
svcAcctStatus:
$ref: '#/components/schemas/SvcAcctStatus'
xml:
name: SvcAcctStatusModRq
attribute: false
wrapped: false
SvcAcctStatusModRs:
title: SvcAcctStatusModRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
svcAcctId:
$ref: '#/components/schemas/SvcAcctId'
svcAcctRec:
$ref: '#/components/schemas/SvcAcctRec'
svcAcctStatus:
$ref: '#/components/schemas/SvcAcctStatus'
SvcAcctSyncRq:
title: SvcAcctSyncRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: SvcAcctSyncRq
attribute: false
wrapped: false
SvcAcctSyncRs:
title: SvcAcctSyncRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
newToken:
maxLength: 36
minLength: 1
type: string
xml:
name: NewToken
attribute: false
wrapped: false
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
svcAcctMsgRec:
type: array
xml:
name: SvcAcctMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/SvcAcctMsgRec'
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: SvcAcctSyncRs
attribute: false
wrapped: false
SvcCoreType:
title: SvcCoreType
type: object
properties:
contactInfo:
type: array
xml:
name: ContactInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/ContactInfo'
holdCoId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: HoldCoId
attribute: false
wrapped: false
language:
type: array
xml:
name: Language
attribute: false
wrapped: false
items:
maxLength: 17
minLength: 1
type: string
legalName:
maxLength: 35
minLength: 1
type: string
xml:
name: LegalName
attribute: false
wrapped: false
nickname:
maxLength: 40
minLength: 1
type: string
xml:
name: Nickname
attribute: false
wrapped: false
orgContact:
type: array
xml:
name: OrgContact
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/OrgContact'
spname:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Always set to CTSI
url:
maxLength: 1024
minLength: 1
type: string
xml:
name: URL
attribute: false
wrapped: false
usartn:
maxLength: 9
minLength: 1
type: string
xml:
name: USA.RTN
attribute: false
wrapped: false
version:
maxLength: 12
minLength: 1
type: string
description: Customer system application version
xml:
name: Version
attribute: false
wrapped: false
SvcProfInqRq:
title: SvcProfInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
upDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
xml:
name: SvcProfInqRq
attribute: false
wrapped: false
SvcProfInqRs:
title: SvcProfInqRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
bankSvcProfInfo:
type: array
xml:
name: BankSvcProfInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/BankSvcProfInfo'
baseSvcProfInfo:
type: array
xml:
name: BaseSvcProfInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/BaseSvcProfInfo'
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
mediaSvcProfInfo:
type: array
xml:
name: MediaSvcProfInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/MediaSvcProfInfo'
newUpDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
paySvcProfInfo:
type: array
xml:
name: PaySvcProfInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/PaySvcProfInfo'
presSvcProfInfo:
type: array
xml:
name: PresSvcProfInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/PresSvcProfInfo'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
upDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
xml:
name: SvcProfInqRs
attribute: false
wrapped: false
TINInfoType:
title: TINInfoType
type: object
properties:
certCode:
minLength: 1
type: string
xml:
name: CertCode
attribute: false
wrapped: false
taxId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: TaxId
attribute: false
wrapped: false
tintype:
minLength: 1
type: string
TaxAmt:
title: TaxAmt
type: object
properties:
curAmt:
$ref: '#/components/schemas/CurAmt'
taxAmtType:
minLength: 1
type: string
xml:
name: TaxAmtType
attribute: false
wrapped: false
TaxInfoType:
title: TaxInfoType
type: object
properties:
curAmt:
$ref: '#/components/schemas/CurAmt'
org:
maxLength: 36
minLength: 1
type: string
description: Customer System application manufacturer
xml:
name: Org
attribute: false
wrapped: false
rate:
type: number
xml:
name: Rate
attribute: false
wrapped: false
ustaxPmt:
$ref: '#/components/schemas/USTaxPmt'
TaxPaidCurAmt:
title: TaxPaidCurAmt
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
Term:
title: Term
type: object
properties:
count:
type: integer
format: int64
xml:
name: Count
attribute: false
wrapped: false
daysCall:
type: integer
format: int64
xml:
name: DaysCall
attribute: false
wrapped: false
desc:
maxLength: 80
minLength: 1
type: string
xml:
name: Desc
attribute: false
wrapped: false
termUnits:
minLength: 1
type: string
xml:
name: TermUnits
attribute: false
wrapped: false
TotalCurAmt:
title: TotalCurAmt
type: object
properties:
amt:
type: number
xml:
name: Amt
attribute: false
wrapped: false
curCode:
minLength: 1
pattern: '[^"']*'
type: string
xml:
name: CurCode
attribute: false
wrapped: false
enum:
- ADF
- PLN
- ADP
- AED
- AFA
- ALL
- ANG
- AON
- ARA
- ARS
- ATS
- AUD
- AWG
- BBD
- BDT
- BEF
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BRC
- BRL
- BSD
- BTN
- BWP
- BZD
- CAD
- CHF
- CLP
- CNY
- COP
- CRC
- CZK
- CUP
- CVE
- CYP
- DEM
- DJF
- DKK
- DOP
- DZD
- ECS
- EEK
- EGP
- ESP
- ETB
- EUR
- FIM
- FJD
- FKP
- FRF
- GBP
- GHC
- GIP
- GMD
- GNF
- GRD
- GTQ
- GWP
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- IEP
- ILS
- INR
- IQD
- IRR
- ISK
- ITL
- ITN
- JMD
- JOD
- JPY
- KES
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LUF
- LVL
- LYD
- MAD
- MGF
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXP
- MYR
- MZM
- NAD
- NGN
- NIO
- NLG
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLZ
- PTE
- PYG
- QAR
- ROL
- RON
- RUB
- SAR
- SBD
- SCR
- SDD
- SDP
- SEK
- SGD
- SHP
- SIT
- SKK
- SLL
- SOS
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TND
- TOP
- TRL
- TRY
- TTD
- TWD
- TZS
- UAG
- UAK
- UGS
- USD
- USN
- UYP
- VEB
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XOF
- XPD
- XPT
- YUN
- ZAR
- ZMK
- ZWD
- MXN
- ACU
- AFN
- AMD
- AOA
- AZN
- BAM
- BGN
- BYB
- BYR
- CDF
- CLF
- CSD
- ERN
- GEL
- GHS
- MDL
- MGA
- MKD
- MZN
- NIC
- RSD
- RUR
- RWF
- SDG
- SRD
- TMM
- UAH
- UGX
- UYU
- UZS
- XCD
- XPF
- YER
- YUM
- GRN
- ZMW
curConvertRule:
minLength: 1
type: string
description: Currency conversion method Direct/Indirect
xml:
name: CurConvertRule
attribute: false
wrapped: false
enum:
- DIRECT
- INDIRECT
- INTERBANK
curRate:
type: number
xml:
name: CurRate
attribute: false
wrapped: false
TotalFeeChargeType:
title: TotalFeeChargeType
type: object
properties:
compositeCurAmt:
$ref: '#/components/schemas/CompositeCurAmt'
count:
type: integer
format: int64
xml:
name: Count
attribute: false
wrapped: false
TrnImage:
title: TrnImage
type: object
properties:
binData:
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
type: string
format: byte
xml:
name: BinData
attribute: false
wrapped: false
binLength:
type: integer
format: int64
xml:
name: BinLength
attribute: false
wrapped: false
contentType:
minLength: 1
type: string
xml:
name: ContentType
attribute: false
wrapped: false
USAACHProf:
title: USAACHProf
type: object
properties:
canWind:
type: integer
format: int64
xml:
name: CanWind
attribute: false
wrapped: false
daysWith:
type: integer
format: int64
xml:
name: DaysWith
attribute: false
wrapped: false
dfltDaysToPay:
type: integer
format: int64
xml:
name: DfltDaysToPay
attribute: false
wrapped: false
USAACHTrnInfo:
title: USAACHTrnInfo
type: object
properties:
originatorName:
maxLength: 40
minLength: 1
type: string
xml:
name: OriginatorName
attribute: false
wrapped: false
usartn:
maxLength: 9
minLength: 1
type: string
xml:
name: USA.RTN
attribute: false
wrapped: false
USTaxPmt:
title: USTaxPmt
type: object
properties:
taxAmt:
type: array
xml:
name: TaxAmt
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/TaxAmt'
taxPayerId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: TaxPayerId
attribute: false
wrapped: false
taxPeriodEndDate:
minLength: 1
pattern: ([0-9]){2}([0-1]){1}([0-9]){1}([0-3]){1}([0-9]){1}
type: string
description: >-
Elements of type narrow character are elements of character data
type with the additional restriction that the only allowable
characters are those contained within the ISO Latin-1 character
xml:
name: TaxPeriodEndDate
attribute: false
wrapped: false
taxTypeCode:
minLength: 1
type: string
xml:
name: TaxTypeCode
attribute: false
wrapped: false
taxpayerVerification:
minLength: 1
type: string
xml:
name: TaxpayerVerification
attribute: false
wrapped: false
ValidationString:
title: ValidationString
type: object
properties:
valString:
minLength: 1
type: string
description: >-
Elements of type narrow character are elements of character data
type with the additional restriction that the only allowable
characters are those contained within the ISO Latin-1 character
xml:
name: ValString
attribute: false
wrapped: false
View:
title: View
type: object
properties:
contentType:
type: string
WLInfoTlxInqRq:
title: WLInfoTlxInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custTranRefNbr:
maxLength: 16
minLength: 1
type: string
xml:
name: CustTranRefNbr
attribute: false
wrapped: false
delUndel:
type: string
xml:
name: DelUndel
attribute: false
wrapped: false
enum:
- DELIVERED
- UNDELIVERED
- BOTH
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
xml:
name: WLInfoTlxInqRq
attribute: false
wrapped: false
WLInfoTlxInqRs:
title: WLInfoTlxInqRs
type: object
properties:
custTranRefNbr:
maxLength: 16
minLength: 1
type: string
xml:
name: CustTranRefNbr
attribute: false
wrapped: false
delUndel:
minLength: 1
type: string
xml:
name: DelUndel
attribute: false
wrapped: false
enum:
- DELIVERED
- UNDELIVERED
- BOTH
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
xml:
name: WLInfoTlxInqRs
attribute: false
wrapped: false
WLInfoTlxRq:
title: WLInfoTlxRq
type: object
properties:
companyName:
maxLength: 35
minLength: 1
type: string
xml:
name: CompanyName
attribute: false
wrapped: false
contactName:
maxLength: 35
minLength: 1
type: string
xml:
name: ContactName
attribute: false
wrapped: false
custTranRefNbr:
maxLength: 16
minLength: 1
type: string
xml:
name: CustTranRefNbr
attribute: false
wrapped: false
detSeqTag50:
type: array
xml:
name: DetSeqTag50
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/DetSeqTag50'
detSeqTag51:
type: array
xml:
name: DetSeqTag51
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/DetSeqTag51'
detSeqTag9X:
$ref: '#/components/schemas/DetSeqTag9X'
messageDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
pmtFieldTypeInfo:
type: array
xml:
name: PmtFieldTypeInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/PmtFieldTypeInfo'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xml:
name: WLInfoTlxRq
attribute: false
wrapped: false
WLInfoTlxRs:
title: WLInfoTlxRs
type: object
properties:
custTranRefNbr:
maxLength: 16
minLength: 1
type: string
xml:
name: CustTranRefNbr
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
xml:
name: WLInfoTlxRs
attribute: false
wrapped: false
WLInfoTlxRsType:
title: WLInfoTlxRsType
type: object
properties:
custTranRefNbr:
maxLength: 16
minLength: 1
type: string
xml:
name: CustTranRefNbr
attribute: false
wrapped: false
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
xml:
name: WLInfoTlxRs_Type
attribute: false
wrapped: false
XMLGregorianCalendar:
title: XMLGregorianCalendar
type: object
properties:
day:
type: integer
format: int32
eon:
type: integer
eonAndYear:
type: integer
fractionalSecond:
type: number
hour:
type: integer
format: int32
millisecond:
type: integer
format: int32
minute:
type: integer
format: int32
month:
type: integer
format: int32
second:
type: integer
format: int32
timezone:
type: integer
format: int32
valid:
type: boolean
xmlschemaType:
$ref: '#/components/schemas/QName'
year:
type: integer
format: int32
XferAddRq:
title: XferAddRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
dupChkOverride:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: DupChkOverride
attribute: false
wrapped: false
enum:
- '0'
- '1'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xferInfo:
$ref: '#/components/schemas/XferInfo'
xml:
name: XferAddRq
attribute: false
wrapped: false
XferAddRs:
title: XferAddRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
dupChkOverride:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: DupChkOverride
attribute: false
wrapped: false
enum:
- '0'
- '1'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
xferInfo:
$ref: '#/components/schemas/XferInfo'
xferRec:
$ref: '#/components/schemas/XferRec'
XferAudRq:
title: XferAudRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
recXferId:
type: array
xml:
name: RecXferId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
xferId:
type: array
xml:
name: XferId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
xml:
name: XferAudRq
attribute: false
wrapped: false
XferAudRs:
title: XferAudRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
method:
type: array
xml:
name: Method
attribute: false
wrapped: false
items:
minLength: 1
type: string
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
recXferId:
type: array
xml:
name: RecXferId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeDt:
$ref: '#/components/schemas/SelRangeDt'
status:
$ref: '#/components/schemas/StatusType'
xferId:
type: array
xml:
name: XferId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
xferMsgRec:
type: array
xml:
name: XferMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/XferMsgRec'
xml:
name: XferAudRs
attribute: false
wrapped: false
XferCanRq:
title: XferCanRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xferId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: XferId
attribute: false
wrapped: false
xml:
name: XferCanRq
attribute: false
wrapped: false
XferCanRs:
title: XferCanRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
xferId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: XferId
attribute: false
wrapped: false
xferRec:
$ref: '#/components/schemas/XferRec'
XferFromSupt:
title: XferFromSupt
type: object
properties:
maxCurAmt:
$ref: '#/components/schemas/MaxCurAmt'
minCurAmt:
$ref: '#/components/schemas/MinCurAmt'
XferInfo:
title: XferInfo
type: object
properties:
cardAcctIdFrom:
$ref: '#/components/schemas/CardAcctIdFrom'
cardAcctIdTo:
$ref: '#/components/schemas/CardAcctIdTo'
category:
maxLength: 40
minLength: 1
type: string
xml:
name: Category
attribute: false
wrapped: false
curAmt:
$ref: '#/components/schemas/CurAmt'
depAcctIdFrom:
$ref: '#/components/schemas/DepAcctIdFrom'
depAcctIdTo:
$ref: '#/components/schemas/DepAcctIdTo'
dueDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
forExRateInfo:
$ref: '#/components/schemas/ForExRateInfo'
immediateXfer:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: ImmediateXfer
attribute: false
wrapped: false
enum:
- '0'
- '1'
loanAcctIdFrom:
$ref: '#/components/schemas/LoanAcctIdFrom'
loanAcctIdTo:
$ref: '#/components/schemas/LoanAcctIdTo'
refInfo:
type: array
xml:
name: RefInfo
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/RefInfo'
XferInqRq:
title: XferInqRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctIdFrom:
$ref: '#/components/schemas/CardAcctIdFrom'
cardAcctIdTo:
$ref: '#/components/schemas/CardAcctIdTo'
csprefId:
type: array
items:
maxLength: 36
minLength: 1
type: string
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
depAcctIdFrom:
$ref: '#/components/schemas/DepAcctIdFrom'
depAcctIdTo:
$ref: '#/components/schemas/DepAcctIdTo'
incToken:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: IncToken
attribute: false
wrapped: false
enum:
- '0'
- '1'
loanAcctIdFrom:
$ref: '#/components/schemas/LoanAcctIdFrom'
loanAcctIdTo:
$ref: '#/components/schemas/LoanAcctIdTo'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
recXferId:
type: array
xml:
name: RecXferId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeCurAmt:
$ref: '#/components/schemas/SelRangeCurAmt'
selRangeDueDt:
$ref: '#/components/schemas/SelRangeDueDt'
sprefId:
type: array
items:
type: string
xferId:
type: array
xml:
name: XferId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
xferStatusCode:
type: array
xml:
name: XferStatusCode
attribute: false
wrapped: false
items:
minLength: 1
type: string
xml:
name: XferInqRq
attribute: false
wrapped: false
XferInqRs:
title: XferInqRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctIdFrom:
$ref: '#/components/schemas/CardAcctIdFrom'
cardAcctIdTo:
$ref: '#/components/schemas/CardAcctIdTo'
csprefId:
type: array
items:
maxLength: 36
minLength: 1
type: string
custId:
$ref: '#/components/schemas/CustId'
deliveryMethod:
minLength: 1
type: string
description: DEALID6 or DEALID16
xml:
name: DeliveryMethod
attribute: false
wrapped: false
depAcctIdFrom:
$ref: '#/components/schemas/DepAcctIdFrom'
depAcctIdTo:
$ref: '#/components/schemas/DepAcctIdTo'
loanAcctIdFrom:
$ref: '#/components/schemas/LoanAcctIdFrom'
loanAcctIdTo:
$ref: '#/components/schemas/LoanAcctIdTo'
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
recXferId:
type: array
xml:
name: RecXferId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
selRangeCurAmt:
$ref: '#/components/schemas/SelRangeCurAmt'
selRangeDueDt:
$ref: '#/components/schemas/SelRangeDueDt'
sprefId:
type: array
items:
type: string
status:
$ref: '#/components/schemas/StatusType'
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xferId:
type: array
xml:
name: XferId
attribute: false
wrapped: false
items:
maxLength: 36
minLength: 1
type: string
description: UUID elements are narrow character with a maximum length of 36
xferRec:
type: array
xml:
name: XferRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/XferRec'
xferStatusCode:
type: array
xml:
name: XferStatusCode
attribute: false
wrapped: false
items:
minLength: 1
type: string
xml:
name: XferInqRs
attribute: false
wrapped: false
XferModRq:
title: XferModRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
dupChkOverride:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: DupChkOverride
attribute: false
wrapped: false
enum:
- '0'
- '1'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xferId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: XferId
attribute: false
wrapped: false
xferInfo:
$ref: '#/components/schemas/XferInfo'
xml:
name: XferModRq
attribute: false
wrapped: false
XferModRs:
title: XferModRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
dupChkOverride:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: DupChkOverride
attribute: false
wrapped: false
enum:
- '0'
- '1'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
xferId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: XferId
attribute: false
wrapped: false
xferInfo:
$ref: '#/components/schemas/XferInfo'
xferRec:
$ref: '#/components/schemas/XferRec'
XferMsgRec:
title: XferMsgRec
type: object
properties:
custId:
$ref: '#/components/schemas/CustId'
msgRecDt:
pattern: >-
[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9]{6})?(-[0-9]{2}:[0-9]{2})?)?
type: string
xml:
name: MsgRecDt
attribute: false
wrapped: false
xferAddRs:
$ref: '#/components/schemas/XferAddRs'
xferCanRs:
$ref: '#/components/schemas/XferCanRs'
xferModRs:
$ref: '#/components/schemas/XferModRs'
xferStatusModRs:
$ref: '#/components/schemas/XferStatusModRs'
XferPayee:
title: XferPayee
type: object
properties:
depAcctIdTo:
$ref: '#/components/schemas/DepAcctIdTo'
XferProf:
title: XferProf
type: object
properties:
optSupt:
type: array
xml:
name: OptSupt
attribute: false
wrapped: false
items:
minLength: 1
type: string
prcSched:
$ref: '#/components/schemas/PrcSched'
recXferProf:
$ref: '#/components/schemas/RecXferProf'
XferRec:
title: XferRec
type: object
properties:
recXferId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: RecXferId
attribute: false
wrapped: false
recXferMod:
type: string
description: >-
Boolean indicates a logical True or False condition. The physical
representation of Boolean data is specified by each implementation
specification corresponding to this message specification
xml:
name: RecXferMod
attribute: false
wrapped: false
enum:
- '0'
- '1'
xferId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: XferId
attribute: false
wrapped: false
xferInfo:
$ref: '#/components/schemas/XferInfo'
xferStatus:
$ref: '#/components/schemas/XferStatus'
XferStatus:
title: XferStatus
type: object
properties:
effDt:
$ref: '#/components/schemas/XMLGregorianCalendar'
statusDesc:
maxLength: 255
minLength: 1
type: string
description: Text description for status code
xml:
name: StatusDesc
attribute: false
wrapped: false
statusModBy:
minLength: 1
type: string
xml:
name: StatusModBy
attribute: false
wrapped: false
xferStatusCode:
minLength: 1
type: string
description: StatusCode as Per IFX XML
xml:
name: XferStatusCode
attribute: false
wrapped: false
XferStatusModRq:
title: XferStatusModRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
xferId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: XferId
attribute: false
wrapped: false
xferStatus:
$ref: '#/components/schemas/XferStatus'
xml:
name: XferStatusModRq
attribute: false
wrapped: false
XferStatusModRs:
title: XferStatusModRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
csprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
custId:
$ref: '#/components/schemas/CustId'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
sprefId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
status:
$ref: '#/components/schemas/StatusType'
xferId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
xml:
name: XferId
attribute: false
wrapped: false
xferStatus:
$ref: '#/components/schemas/XferStatus'
XferSyncRq:
title: XferSyncRq
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctIdFrom:
$ref: '#/components/schemas/CardAcctIdFrom'
custId:
$ref: '#/components/schemas/CustId'
depAcctIdFrom:
$ref: '#/components/schemas/DepAcctIdFrom'
loanAcctIdFrom:
$ref: '#/components/schemas/LoanAcctIdFrom'
recCtrlIn:
$ref: '#/components/schemas/RecCtrlIn'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xml:
name: XferSyncRq
attribute: false
wrapped: false
XferSyncRs:
title: XferSyncRs
type: object
properties:
asyncRqUID:
maxLength: 36
minLength: 1
type: string
xml:
name: AsyncRqUID
attribute: false
wrapped: false
cardAcctIdFrom:
$ref: '#/components/schemas/CardAcctIdFrom'
custId:
$ref: '#/components/schemas/CustId'
depAcctIdFrom:
$ref: '#/components/schemas/DepAcctIdFrom'
loanAcctIdFrom:
$ref: '#/components/schemas/LoanAcctIdFrom'
newToken:
maxLength: 36
minLength: 1
type: string
xml:
name: NewToken
attribute: false
wrapped: false
recCtrlOut:
$ref: '#/components/schemas/RecCtrlOut'
rqUID:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: Customer Ref No for the request
xml:
name: RqUID
attribute: false
wrapped: false
status:
$ref: '#/components/schemas/StatusType'
token:
maxLength: 36
minLength: 1
type: string
xml:
name: Token
attribute: false
wrapped: false
xferMsgRec:
type: array
xml:
name: XferMsgRec
attribute: false
wrapped: false
items:
$ref: '#/components/schemas/XferMsgRec'
xml:
name: XferSyncRs
attribute: false
wrapped: false
XferToSupt:
title: XferToSupt
type: object
properties:
maxCurAmt:
$ref: '#/components/schemas/MaxCurAmt'
minCurAmt:
$ref: '#/components/schemas/MinCurAmt'
IFXResponse-Book-FX:
type: object
description: Book Fx Response
xml:
name: IFX
properties:
BankSvcRs:
type: object
properties:
Status:
type: object
properties:
StatusCode:
maxLength: 35
type: string
description: >-
StatusCode as Per IFX XML. PROCESSED for code 000 and 120
(Rate returned and value date changed) FAILED for all other
codes
(Rejects)
Severity:
maxLength: 5
type: string
description: >-
Error,Warn,Info. NONE for code 000, HIGH for all the other
status codes.
StatusDesc:
maxLength: 255
type: string
description: >-
Text description for status code. 991 :
Application program abend has occurred
000 : Rate Returned
RqUID:
type: string
description: Customer Ref No for the request.
example: 99dc17a3-6bbf-4310-973a-a369e5
PrefPrice:
maxLength: 1
type: string
description: >-
Preferred pricing indicator.
N - Default value for standard
pricing.
Value must be 'W' for Alipay Wallet payments, 'E'
for UPI Cards payment and ‘Z’ for Dandelion Wallet payments.
BaseNo:
maxLength: 10
type: string
description: >-
FXLM Base Number. If provided this base number will be passed to
FXLM for pricing and settlement. Only one of or
may be provided. If neither is present the OLR to
base number configuration will be used. Echoed from customer
request.
FXLMEntity:
maxLength: 10
type: string
description: >-
FXLM Entity. If provided this Entity will be passed to FXLM for
pricing and settlement. Only one of or may
be provided. If neither is present the OLR to base number
configuration will be used. Echoed from customer request.
WLFlag:
maxLength: 1
type: string
description: >-
Account processing and settlement. W - Standard WorldLink
account processing and settlement
N- Bypass all WorldLink
account processing and settlement. Pass the numeric detail TRN
to FXLM.
O - Bypass all WorldLink account processing and
settlement. Pass the OLR numeric sequence number as the TRN to
FXLM.
If not provided default will be W.
DealType:
maxLength: 1
type: string
description: >-
Deal type. Deal type- 'B' for all bench deals for bench fixing
rates
Deal type- `Q` for all real time quoted rate deals This
must be coordinated with QUOTED fixing type
Deal Type- 'O'
book per OLR parameters
Default value will be O, if not
provided.
ForExRateDealAddRs:
type: object
properties:
Status:
type: object
properties:
StatusCode:
maxLength: 35
type: string
description: >-
StatusCode as Per IFX XML. PROCESSED for code 000 and
120 (Rate returned and value date changed) FAILED for
all other codes
(Rejects)
ServerStatusCode:
maxLength: 35
type: string
description: Backend Status Code
Severity:
maxLength: 5
type: string
description: >-
Error,Warn,Info. NONE for code 000, HIGH for all the
other status codes.
StatusDesc:
maxLength: 255
type: string
description: >-
Text description for status code. 991 :
Application program abend has occurred
000 : Rate Returned
RqUID:
maxLength: 35
type: string
description: >-
Customer Ref No for the request. Header - Client Reference
Number. Echoed from customer request.
example: 99dc17a3-6bbf-4310-973a-a369e5
CustId:
type: object
properties:
SPName:
maxLength: 35
type: string
description: Always set to "CTSI".
CustPermId:
maxLength: 9
type: string
description: >-
WL Client Number + WorldLink Branch Number. It is used
to validate client id. Please note this will be same for
all requests in a single message as per existing CMX
flow.
ResTime:
maxLength: 19
type: string
description: Date & Time when the response is generated
ForExDealInfo:
type: object
properties:
ForExRateDealType:
maxLength: 4
minLength: 1
type: string
description: >-
Buy or Sell. Default is Buy. Echoed from Customer
Request.
ForExValDtType:
maxLength: 35
type: string
description: >-
Daily, Spot or Future. Default value is Spot, if no
value is provided.
ForExTnr:
maxLength: 2
type: string
description: >-
Tenor value from frontend. Two Alphanumeric code for
tenor.0 SP, TN, SD & BA. Conditional when FX request has
Tenor listed as SD or TN or SP, OLR will book the FX and
respond with the same requested tenor value. If the
request is having BA as tenor value, OLR will determine
tenor value either as SD or TN or SP based on FX
availablity.
ForExValDt:
maxLength: 10
type: string
description: >-
Value date required only if ForExValDtType is Future.
Data type is "Date" as defined in IFX XML. FX contract
Value Date mapped as yyyy-mm-dd. Value date is required
if ForExValDtType is Future
GPP to map the value
date if Client profile is set up for FX Request type as
Value date
CurConvertRule:
maxLength: 35
type: string
description: Currency conversion method Direct/Indirect
enum:
- DIRECT
- INDIRECT
- INTERBANK
IssueAmt:
maxLength: 15
type: string
description: >-
Amount to Buy or Sell. If IssueAmt is provided it means
you are buying the currency.
IssueCurCode:
maxLength: 3
type: string
description: >-
Issue Currency. It is an ISO currency code. It is
mandatory field for rate request if issueAmt is provided
and will be used for validating currency code.
RemitAmt:
maxLength: 15
type: string
description: >-
Amount to Buy or Sell. If RemitAmt is provided it means
you are selling the currency.
RemitCurCode:
maxLength: 3
type: string
description: >-
Remit Currency. It is an ISO currency code. It is
mandatory field for rate request if RemitAmt is provided
and will be used for validating currency code.
SPRefId:
maxLength: 36
type: string
description: >-
Object identifiers in the IFX specification are of the
data type "Identifier." This is a narrow character data
type with a maximum length of 36.
DeliveryMethod:
maxLength: 35
type: string
description: DEALID6 or DEALID16
ForExDealRec:
type: object
properties:
ForExDealId:
maxLength: 35
type: string
description: >-
The commited FX contract ID. This element is present if
the deal was ssuccessfully booked. Deal Id should be
combination of Deal Number(6x) & OLR Deal Sequence
number(9n).
ForExDealInfo:
type: object
properties:
ExpDt:
type: string
maxLength: 19
description: >-
Contract Expiry Datetime. This is the expiry
datetime for this contract. This may be a few
minutes for a rate offer and may be few days for a
committed rate.
CurRate:
type: number
description: FX Rate
CurConvertRule:
maxLength: 35
type: string
description: Currency conversion method Direct/Indirect
enum:
- DIRECT
- INDIRECT
- INTERBANK
IssueAmt:
maxLength: 15
type: string
description: >-
Amount to Buy or Sell. If IssueAmt is provided it
means you are buying the currency.
IssueCurCode:
maxLength: 3
type: string
description: >-
Issue Currency. It is an ISO currency code. It is
mandatory field for rate request if issueAmt is
provided and will be used for validating currency
code.
RemitAmt:
maxLength: 15
type: string
description: >-
Amount to Buy or Sell. If RemitAmt is provided it
means you are selling the currency.
RemitCurCode:
maxLength: 3
type: string
description: >-
Remit Currency. It is an ISO currency code. It is
mandatory field for rate request if RemitAmt is
provided and will be used for validating currency
code.
SPRefId:
maxLength: 36
type: string
description: >-
Object identifiers in the IFX specification are of
the data type "Identifier." This is a narrow
character data type with a maximum length of 36.
BenchFixing:
maxLength: 20
type: string
description: Bench Fixing. Required only for Bench Deals
IFXResponse-FX-Rate:
type: object
description: Fx Rate Response
xml:
name: IFX
properties:
BankSvcRs:
type: object
properties:
Status:
type: object
properties:
StatusCode:
maxLength: 35
type: string
description: >-
StatusCode as Per IFX XML. PROCESSED for code 000 and 120
(Rate returned and value date changed) FAILED for all other
codes
(Rejects)
Severity:
maxLength: 5
type: string
description: >-
Error,Warn,Info. NONE for code 000, HIGH for all the other
status codes.
StatusDesc:
maxLength: 255
type: string
description: >-
Text description for status code. 991 :
Application program abend has occurred
000 : Rate Returned
RqUID:
type: string
description: Customer Ref No for the request.
example: 99dc17a3-6bbf-4310-973a-a369e5
PrefPrice:
maxLength: 1
type: string
description: >-
Preferred pricing indicator.
N - Default value for standard
pricing.
Value must be 'W' for Alipay Wallet payments, 'E'
for UPI Cards payment and ‘Z’ for Dandelion Wallet payments.
BaseNo:
maxLength: 10
type: string
description: >-
FXLM Base Number. If provided this base number will be passed to
FXLM for pricing and settlement. Only one of or
may be provided. If neither is present the OLR to
base number configuration will be used. Echoed from customer
request.
FXLMEntity:
maxLength: 10
type: string
description: >-
FXLM Entity. If provided this Entity will be passed to FXLM for
pricing and settlement. Only one of or may
be provided. If neither is present the OLR to base number
configuration will be used. Echoed from customer request.
WLFlag:
maxLength: 1
type: string
description: >-
Account processing and settlement. W - Standard WorldLink
account processing and settlement
N- Bypass all WorldLink
account processing and settlement. Pass the numeric detail TRN
to FXLM.
O - Bypass all WorldLink account processing and
settlement. Pass the OLR numeric sequence number as the TRN to
FXLM.
If not provided default will be W.
DealType:
maxLength: 1
type: string
description: >-
Deal type. Deal type- 'B' for all bench deals for bench fixing
rates
Deal type- `Q` for all real time quoted rate deals This
must be coordinated with QUOTED fixing type
Deal Type- 'O'
book per OLR parameters
Default value will be O, if not
provided.
ForExRateInqRs:
type: object
properties:
Status:
type: object
properties:
StatusCode:
maxLength: 35
type: string
description: >-
StatusCode as Per IFX XML. PROCESSED for code 000 and
120 (Rate returned and value date changed) FAILED for
all other codes
(Rejects)
ServerStatusCode:
maxLength: 35
type: string
description: Backend Status Code
Severity:
maxLength: 5
type: string
description: >-
Error,Warn,Info. NONE for code 000, HIGH for all the
other status codes.
StatusDesc:
maxLength: 255
type: string
description: >-
Text description for status code. 991 :
Application program abend has occurred
000 : Rate Returned
RqUID:
maxLength: 35
type: string
description: >-
Customer Ref No for the request. Header - Client Reference
Number. Echoed from customer request.
example: 99dc17a3-6bbf-4310-973a-a369e5
CustId:
type: object
properties:
SPName:
maxLength: 35
type: string
description: Always set to "CTSI".
CustPermId:
maxLength: 9
type: string
description: >-
WL Client Number + WorldLink Branch Number. It is used
to validate client id. Please note this will be same for
all requests in a single message as per existing CMX
flow.
ResTime:
maxLength: 19
type: string
description: Date & Time when the response is generated
RemitAmt:
maxLength: 15
type: string
description: >-
Amount to Buy or Sell. If RemitAmt is provided it means you
are selling the currency.
IssueAmt:
maxLength: 15
type: string
description: >-
Amount to Buy or Sell. If IssueAmt is provided it means you
are buying the currency.
RemitCurCode:
maxLength: 3
type: string
description: >-
Remit Currency. It is an ISO currency code. It is mandatory
field for rate request if RemitAmt is provided and will be
used for validating currency code.
IssueCurCode:
maxLength: 3
type: string
description: >-
Issue Currency. It is an ISO currency code. It is mandatory
field for rate request if issueAmt is provided and will be
used for validating currency code.
CurConvertRule:
maxLength: 35
type: string
description: Currency conversion method Direct/Indirect
enum:
- DIRECT
- INDIRECT
- INTERBANK
DepAcctId:
type: object
properties:
AcctId:
maxLength: 35
minLength: 1
type: string
description: >-
FROM account number. Not used. Echoed from Customer
Request ForExRateInqRq
AcctType:
maxLength: 4
minLength: 1
type: string
description: >-
FROM account type. Not used. Echoed from Customer
Request ForExRateInqRq
BankInfo:
$ref: '#/components/schemas/BankInfo'
ForExRateRec:
type: object
properties:
ForExRateId:
maxLength: 15
type: string
description: >-
The commited FX contract ID. This parameter is present
if the ForExRateRq had ForExRateType=Committed and the
deal was successfully booked.
ForExValDt:
maxLength: 10
type: string
description: Value date
ForExRateInfo:
type: object
properties:
RemitAmt:
maxLength: 15
type: string
description: >-
Amount to Buy or Sell. If RemitAmt is provided it
means you are selling the currency.
IssueAmt:
maxLength: 15
type: string
description: >-
Amount to Buy or Sell. If IssueAmt is provided it
means you are buying the currency.
RemitCurCode:
maxLength: 3
type: string
description: >-
Remit Currency. It is an ISO currency code. It is
mandatory field for rate request if RemitAmt is
provided and will be used for validating currency
code.
IssueCurCode:
maxLength: 3
type: string
description: >-
Issue Currency. It is an ISO currency code. It is
mandatory field for rate request if issueAmt is
provided and will be used for validating currency
code.
CurRate:
type: number
description: FX Rate
CurConvertRule:
maxLength: 35
type: string
description: Currency conversion method Direct/Indirect
enum:
- DIRECT
- INDIRECT
- INTERBANK
ExpDt:
type: string
maxLength: 19
description: >-
Contract Expiry Datetime. This is the expiry
datetime for this contract. This may be a few
minutes for a rate offer and may be few days for a
committed rate.
SPRefId:
maxLength: 36
type: string
description: >-
Object identifiers in the IFX specification are of
the data type "Identifier." This is a narrow
character data type with a maximum length of
36.
ForExValDtType:
maxLength: 35
type: string
description: >-
Daily, Spot or Future. Default value is Spot, if no
value is provided.
ForExTnr:
maxLength: 2
type: string
description: >-
Tenor value from frontend. Two Alphanumeric code for
tenor.0 SP, TN, SD & BA. Conditional when FX request
has Tenor listed as SD or TN or SP, OLR will book
the FX and respond with the same requested tenor
value. If the request is having BA as tenor value,
OLR will determine tenor value either as SD or TN or
SP based on FX availablity.
BenchFixing:
maxLength: 20
type: string
description: Bench Fixing. Required only for Bench Deals
IFXRequest-FX-Rate:
type: object
description: FX Rate Request
xml:
name: IFX
required:
- SignonRq
- BankSvcRq
properties:
SignonRq:
required:
- ClientDt
- CustLangPref
- ClientApp
type: object
properties:
ClientDt:
maxLength: 19
type: string
description: >-
Customer date and time for the message. Format: Header
-Date/Time 'yyyy-mm-ddThh:mm:ss'. Will be stored for use in
service related issues.
example: '2017-08-30T05:21:02'
CustLangPref:
maxLength: 35
type: string
description: >-
Always set to "ENGLISH". Only English language is supported.
Value in this parameter will be ignored.
example: ENGLISH
ClientApp:
type: object
required:
- Name
- Org
- Version
properties:
Name:
maxLength: 140
type: string
description: >-
Customer System application name. CTSI INTERFACE/ GPP would
map this as default - GPP
Org:
maxLength: 140
type: string
description: >-
Customer System application manufacturer. CTSI INTERFACE/
GPP would map this as default - GPP
Version:
maxLength: 3
type: string
description: 'Customer system application version. '
BankSvcRq:
type: array
description: Bank Service Request for FX Rate
items:
required:
- RqUID
- ForExRateInqRq
type: object
properties:
RqUID:
maxLength: 35
type: string
description: Customer Ref No for the BankSvcRq request.Needs to be unique.
example: 99dc17a3-6bbf-4310-973a-a369e5
PrefPrice:
maxLength: 1
type: string
description: >-
Preferred pricing indicator.
N - Default value for standard
pricing.
Value must be 'W' for Alipay Wallet payments, 'E'
for UPI Cards payment and ‘Z’ for Dandelion Wallet payments.
BaseNo:
maxLength: 10
type: string
description: >-
FXLM Base Number. If provided this base number will be passed
to FXLM for pricing and settlement. Only one of or
may be provided. If neither is present the OLR to
base number configuration will be used. Echoed from customer
request.
FXLMEntity:
maxLength: 10
type: string
description: >-
FXLM Entity. If provided this Entity will be passed to FXLM
for pricing and settlement. Only one of or
may be provided. If neither is present the OLR to
base number configuration will be used. Echoed from customer
request.
WLFlag:
maxLength: 1
type: string
description: >-
Account processing and settlement. W - Standard WorldLink
account processing and settlement
N- Bypass all WorldLink
account processing and settlement. Pass the numeric detail TRN
to FXLM.
O - Bypass all WorldLink account processing and
settlement. Pass the OLR numeric sequence number as the TRN to
FXLM.
If not provided default will be W.
DealType:
maxLength: 1
type: string
description: >-
Deal type. Deal type- 'B' for all bench deals for bench fixing
rates
Deal type- `Q` for all real time quoted rate deals
This must be coordinated with QUOTED fixing type
Deal Type-
'O' book per OLR parameters
Default value will be O, if not
provided.
ForExRateInqRq:
type: array
description: FX Rate inquiry request array.
items:
required:
- RqUID
- CustId
- DepAcctId
- RemitCurCode
- IssueCurCode
type: object
properties:
RqUID:
maxLength: 35
type: string
description: >-
Customer Ref No for the request. Will be used to track
individual ForExRateInqRq blocks. Needs to be unique.
example: 99dc17a3-6bbf-4310-973a-a369e5
CustId:
required:
- CustPermId
- SPName
type: object
properties:
SPName:
maxLength: 35
type: string
description: Always set to "CTSI".
CustPermId:
maxLength: 9
type: string
description: >-
WL Client Number + WorldLink Branch Number. It is
used to validate client id. Please note this will be
same for all requests in a single message as per
existing CMX flow.
DepAcctId:
required:
- AcctId
- AcctType
- BankInfo
type: object
properties:
AcctId:
maxLength: 35
minLength: 1
type: string
description: >-
FROM account number. Not used. Echoed from Customer
Request ForExRateInqRq
AcctType:
maxLength: 4
minLength: 1
type: string
description: >-
FROM account type. Not used. Echoed from Customer
Request ForExRateInqRq
BankInfo:
$ref: '#/components/schemas/BankInfo'
RemitAmt:
maxLength: 15
type: string
description: >-
Amount to Buy or Sell. If RemitAmt is provided it means
you are selling the currency.
IssueAmt:
maxLength: 15
type: string
description: >-
Amount to Buy or Sell. If IssueAmt is provided it means
you are buying the currency.
RemitCurCode:
maxLength: 3
type: string
description: >-
Remit Currency. It is an ISO currency code. It is
mandatory field for rate request if RemitAmt is provided
and will be used for validating currency code.
IssueCurCode:
maxLength: 3
type: string
description: >-
Issue Currency. It is an ISO currency code. It is
mandatory field for rate request if issueAmt is provided
and will be used for validating currency code.
CurConvertRule:
maxLength: 35
type: string
description: Currency conversion method Direct/Indirect
enum:
- DIRECT
- INDIRECT
- INTERBANK
ForExRateType:
maxLength: 35
type: string
description: >-
If value is Indicated > Interactive and if the value is
Committed, its Auto-accept.
enum:
- Indicated
- Committed
ForExRateDealType:
maxLength: 4
type: string
description: Buy or Sell. Default is Buy.
ForExValDtType:
maxLength: 35
type: string
description: >-
Daily, Spot or Future. Default value is Spot, if no
value is provided.
ForExTnr:
maxLength: 2
type: string
description: >-
Tenor value from frontend. Two Alphanumeric code for
tenor.0 SP, TN, SD & BA. Conditional when FX request has
Tenor listed as SD or TN or SP, OLR will book the FX and
respond with the same requested tenor value. If the
request is having BA as tenor value, OLR will determine
tenor value either as SD or TN or SP based on FX
availablity.
ForExValDt:
maxLength: 10
type: string
description: >-
Value date required only if ForExValDtType is Future.
Data type is
"Date" as defined in IFX XML. FX contract Value Date mapped as
yyyy-mm-dd. Value date is required if ForExValDtType is
Future
GPP to map the value date if Client profile
is set up for FX Request type as Value date
DeliveryMethod:
maxLength: 35
type: string
description: DEALID6 or DEALID16
PayAcct:
maxLength: 35
type: string
description: >-
Citi Account held at Citi Branch routing id (valid Citi
acct). This is only passed if requesting OLR to credit a
source requested Citi account. Previous tag must also be
sent in conjunction with this tag.
PayBrnch:
maxLength: 3
type: string
description: >-
Citi Branch routing id (valid Citi Branch). This is only
passed if requesting OLR to credit a source requested
Citi account. Next tag must also be sent in conjunction
with this tag.
RemitAcct:
maxLength: 35
type: string
description: >-
Citi Account held at Citi Branch routing id (valid Citi
acct). This is only passed if requesting OLR to debit a
source requested Citi account. remitBrnch must also be
sent.
RemitBrnch:
maxLength: 3
type: string
description: >-
Citi Branch routing ID (valid Citi Branch). This is only
passed if the requesting OLR to debit a source requested
Citi account. RemitAcct must also be sent.
BenchFixing:
maxLength: 20
type: string
description: Bench Fixing. Required only for Bench Deals
IFXRequest-Book-FX:
type: object
description: Book FX Request
xml:
name: IFX
required:
- SignonRq
- BankSvcRq
properties:
SignonRq:
required:
- ClientDt
- CustLangPref
- ClientApp
type: object
properties:
ClientDt:
maxLength: 19
type: string
description: >-
Customer date and time for the message. Format: Header
-Date/Time 'yyyy-mm-ddThh:mm:ss'. Will be stored for use in
service related issues.
example: '2017-08-30T05:21:02'
CustLangPref:
maxLength: 35
type: string
description: >-
Always set to "ENGLISH". Only English language is supported.
Value in this parameter will be ignored.
example: ENGLISH
ClientApp:
required:
- Name
- Org
- Version
type: object
properties:
Name:
maxLength: 140
type: string
description: >-
Customer System application name. CTSI INTERFACE/ GPP would
map this as default - GPP
Org:
maxLength: 140
type: string
description: >-
Customer System application manufacturer. CTSI INTERFACE/
GPP would map this as default - GPP
Version:
maxLength: 3
type: string
description: 'Customer system application version. '
BankSvcRq:
type: array
description: Bank Service Request for Book FX
items:
required:
- RqUID
- ForExRateDealAddRq
type: object
properties:
RqUID:
maxLength: 35
type: string
description: Customer Ref No for the BankSvcRq request.Needs to be unique.
example: 99dc17a3-6bbf-4310-973a-a369e5
PrefPrice:
maxLength: 1
type: string
description: >-
Preferred pricing indicator.
N - Default value for standard
pricing.
Value must be 'W' for Alipay Wallet payments, 'E'
for UPI Cards payment and ‘Z’ for Dandelion Wallet payments.
BaseNo:
maxLength: 10
type: string
description: >-
FXLM Base Number. If provided this base number will be passed
to FXLM for pricing and settlement. Only one of or
may be provided. If neither is present the OLR to
base number configuration will be used. Echoed from customer
request.
FXLMEntity:
maxLength: 10
type: string
description: >-
FXLM Entity. If provided this Entity will be passed to FXLM
for pricing and settlement. Only one of or
may be provided. If neither is present the OLR to
base number configuration will be used. Echoed from customer
request.
WLFlag:
maxLength: 1
type: string
description: >-
Account processing and settlement. W - Standard WorldLink
account processing and settlement
N- Bypass all WorldLink
account processing and settlement. Pass the numeric detail TRN
to FXLM.
O - Bypass all WorldLink account processing and
settlement. Pass the OLR numeric sequence number as the TRN to
FXLM.
If not provided default will be W.
DealType:
maxLength: 1
type: string
description: >-
Deal type. Deal type- 'B' for all bench deals for bench fixing
rates
Deal type- `Q` for all real time quoted rate deals
This must be coordinated with QUOTED fixing type
Deal Type-
'O' book per OLR parameters
Default value will be O, if not
provided.
ForExRateDealAddRq:
type: array
description: Book FX Deal Add request array.
items:
required:
- RqUID
- CustId
- ForExDealInfo
type: object
properties:
RqUID:
maxLength: 35
type: string
description: >-
Customer Ref No for this ForExRateDealAddRq block. Can
be the same as reference for Rate request.
example: 99dc17a3-6bbf-4310-973a-a369e5
CustId:
required:
- CustPermId
- SPName
type: object
properties:
SPName:
maxLength: 35
type: string
description: Always set to "CTSI".
CustPermId:
maxLength: 9
type: string
description: >-
WL Client Number + WorldLink Branch Number. It is
used to validate client id. Please note this will be
same for all requests in a single message as per
existing CMX flow.
ForExDealInfo:
description: Deal Info request.
type: object
required:
- CurConvertRule
- IssueCurCode
- RemitCurCode
- SPRefId
properties:
ForExRateDealType:
maxLength: 4
type: string
description: Buy or Sell. Default is Buy.
ForExValDtType:
maxLength: 35
type: string
description: >-
Daily, Spot or Future. Default value is Spot, if no
value is provided.
ForExTnr:
maxLength: 2
type: string
description: >-
Tenor value from frontend. Two Alphanumeric code for
tenor.0 SP, TN, SD & BA. Conditional when FX request
has Tenor listed as SD or TN or SP, OLR will book
the FX and respond with the same requested tenor
value. If the request is having BA as tenor value,
OLR will determine tenor value either as SD or TN or
SP based on FX availablity.
ForExValDt:
maxLength: 10
type: string
description: >-
Value date required only if ForExValDtType is
Future. Data type is "Date" as defined in IFX XML.
FX contract Value Date mapped as yyyy-mm-dd. Value
date is required if ForExValDtType is Future
GPP
to map the value date if Client profile is set up
for FX Request type as Value date
CurConvertRule:
maxLength: 35
type: string
description: Currency conversion method Direct/Indirect
enum:
- DIRECT
- INDIRECT
- INTERBANK
IssueAmt:
maxLength: 15
type: string
description: >-
Amount to Buy or Sell. If IssueAmt is provided it
means you are buying the currency.
IssueCurCode:
maxLength: 3
type: string
description: >-
Issue Currency. It is an ISO currency code. It is
mandatory field for rate request if issueAmt is
provided and will be used for validating currency
code.
RemitAmt:
maxLength: 15
type: string
description: >-
Amount to Buy or Sell. If RemitAmt is provided it
means you are selling the currency.
RemitCurCode:
maxLength: 3
type: string
description: >-
Remit Currency. It is an ISO currency code. It is
mandatory field for rate request if RemitAmt is
provided and will be used for validating currency
code.
ForExUnw:
type: string
description: Unwind time.
SPRefId:
maxLength: 36
type: string
description: >-
Object identifiers in the IFX specification are of
the data type "Identifier." This is a narrow
character data type with a maximum length of 36.
DeliveryMethod:
maxLength: 35
type: string
description: DEALID6 or DEALID16
Response:
type: object
properties:
correlationId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Object identifiers in the IFX specification are of the data type
"Identifier." This is a narrow character data type with a maximum
length of 36.
message:
type: string
status:
maxLength: 3
type: string
description: Error response code
Error-Response:
type: object
properties:
httpMessage:
type: string
httpCode:
type: string
moreInformation:
type: string
description: Error response body.
Pain001:
required:
- CstmrCdtTrfInitn
type: object
properties:
CstmrCdtTrfInitn:
$ref: '#/components/schemas/CustomerCreditTransferInitiationV03'
description: >-
Customer credit transfer initiation request body. This request body is
encoded with Base64 and placed in tags.
example:
CstmrCdtTrfInitn:
GrpHdr:
MsgId: HKLCLLAN0706BX1
CreDtTm: '2020-04-03T16:13:12'
NbOfTxs: '1'
InitgPty:
Nm: SIT ORDERING PARTY FORXXXXXXXXXXXXX
Id:
OrgId:
Othr:
Id: '438152'
PmtInf:
PmtInfId: HKLCLLAN0706BX1
PmtMtd: TRF
NbOfTxs: '1'
PmtTpInf:
SvcLvl:
Cd: OTHR
CtgyPurp:
Cd: CASH
ReqdExctnDt: '2020-07-08'
Dbtr:
Nm: HOKOBUY LTD
PstlAdr:
Ctry: HK
AdrLine:
- No. 10 Chun Yat Street
Id:
OrgId:
Othr:
Id: '438152'
DbtrAcct:
Id:
Othr:
Id: '1244712017'
SchmeNm:
Prtry: Sundry Credit
Ccy: HKD
DbtrAgt:
FinInstnId:
BIC: CITIHKHX
ClrSysMmbId:
MmbId: '006000'
PstlAdr:
Ctry: HK
ChrgBr: SHAR
CdtTrfTxInf:
PmtId:
EndToEndId: HKLCLLAN0706BX1
PmtTpInf:
SvcLvl:
Cd: NURG
CtgyPurp:
Cd: CASH
Amt:
InstdAmt:
_Ccy: HKD
__text: '10'
ChrgBr: SHAR
CdtrAgt:
FinInstnId:
ClrSysMmbId:
MmbId: '185000'
Nm: A ONE INVESTMENT CO.
PstlAdr:
StrtNm: CDAGTSTREETNAMEXXXX2
BldgNb: BLOCK1
PstCd: PSTCD67
TwnNm: thomsontown
Ctry: HK
AdrLine:
- ADDRESS LINE2XXXXXXXXXXXXXXXXX1
- ADDRESS LINE2XXXXXXXXXXXXXXXXX2
- ADDRESS LINE2XXXXXXXXXXXXXXXXX3
BrnchId:
Nm: AB BANK LTD.
PstlAdr:
StrtNm: CDAGTSTREETNAMEXXXX1
BldgNb: block81
PstCd: PSTCD58
TwnNm: christmastownn
Ctry: HK
AdrLine:
- ADDRESS LINE1XXXXXXXXXXXXXXXXX1
- ADDRESS LINE1XXXXXXXXXXXXXXXXX2
- ADDRESS LINE1XXXXXXXXXXXXXXXXX3
Cdtr:
Nm: BENE NAME1
PstlAdr:
StrtNm: BENESTREETNAME
BldgNb: '10'
PstCd: PSTCD12
TwnNm: xristmastown
CtrySubDvsn: '45'
Ctry: HK
AdrLine:
- BENADD1XXXXXXXXXXXXXXXXXXXXXXXX1
- BENADD1XXXXXXXXXXXXXXXXXXXXXXXX2
- BENADD1XXXXXXXXXXXXXXXXXXXXXXXX3
CdtrAcct:
Id:
Othr:
Id: '30010501988'
InstrForCdtrAgt:
InstrInf: UETR/a937c526-38c1-4ad9-b236-7e6a6383890f
InstrForDbtrAgt: /CONFIDENTIAL/
Purp:
Prtry: '23'
RltdRmtInf:
RmtLctnMtd: EMAL
RmtLctnElctrncAdr: sudipta.majhi@citi.com
RmtInf:
Ustrd: /PMDH/abcdeabcde
xml:
name: Document
Pain002:
required:
- CstmrPmtStsRpt
type: object
properties:
CstmrPmtStsRpt:
$ref: '#/components/schemas/CustomerPaymentStatusReportV03'
description: >-
This response body is encoded with Base64 and placed in < Response><
paymentBase64>{Base64 encrypted response}< /paymentBase64>< /Response>
tags.
OriginalPaymentInstruction33:
required:
- OrgnlPmtInfId
type: object
properties:
RvslPmtInfId:
maxLength: 36
minLength: 1
pattern: '[^"']*'
type: string
description: >-
Unique identification, as assigned by an instructing party for an
instructed party, to unambiguously identify the reversed payment
information group. Usage: The instructing party is the party sending
the reversal message and not the party that sent the original.
OrgnlPmtInfId:
maxLength: 35
minLength: 1
type: string
description: >-
Unique identification, as assigned by the original sending party, to
unambiguously identify the original payment information group.
OrgnlNbOfTxs:
pattern: '[0-9]{1,15}'
type: string
description: >-
Number of individual transactions contained in the original payment
information group.
OrgnlCtrlSum:
maxLength: 18
minLength: 1
type: string
description: >-
Total of all individual amounts included in the original payment
information group, irrespective of currencies.Number of objects
represented as a decimal number, for example 0.75 or 45.6. Upto 17
fractional digit allowed.
BtchBookg:
type: boolean
description: >-
Identifies whether a single entry per individual transaction or a
batch entry for the sum of the amounts of all transactions within
the group of a message is requested.Batch booking is used to request
and not order a possible batch booking.
PmtInfRvsl:
type: boolean
description: >-
Indicates whether or not the reversal applies to the complete
original payment information group or to individual transactions
within that group.A flag indicating a True or False value.
RvslRsnInf:
type: array
description: >-
Provides further details on the reason of the reversal of the
transaction.
items:
$ref: '#/components/schemas/PaymentReversalReason9'
TxInf:
type: array
description: >-
Provides information on the original transactions to which the
reversal message refers.
items:
$ref: '#/components/schemas/PaymentTransaction108'
PaymentTransaction108:
required:
- OrgnlEndToEndId
- RvsdInstdAmt
type: object
properties:
RvslId:
maxLength: 35
minLength: 1
type: string
description: >-
Unique identification, as assigned by an instructing party for an
instructed party, to unambiguously identify the reversed
transaction.
OrgnlInstrId:
maxLength: 35
minLength: 1
type: string
description: >-
Unique identification, as assigned by the original instructing party
for the original instructed party, to unambiguously identify the
original instruction.
OrgnlEndToEndId:
maxLength: 35
minLength: 1
type: string
description: >-
Unique identification, as assigned by the original initiating party,
to unambiguously identify the original transaction.
OrgnlUETR:
pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}'
type: string
description: >-
Universally unique identifier to provide the original end-to-end
reference of a payment transaction.Universally Unique IDentifier
(UUID) version 4, as described in IETC RFC 4122 Universally Unique
IDentifier (UUID) URN Namespace
OrgnlInstdAmt:
type: object
description: >-
Amount of money, as provided in the original transaction, to be
moved between the debtor and the creditor, before deduction of
charges, expressed in the currency, as ordered by the original
initiating party.This amount has to be transported unchanged through
the transaction chain.Upto 5 fractional digits allowed.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
RvsdInstdAmt:
type: object
description: >-
Amount of money to be moved between the debtor and the creditor,
before deduction of charges, in the reversed transaction.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
ChrgBr:
type: object
description: >-
The ChargeBearer applies to the reversal message, not to the
original instruction.Specifies if the creditor and/or debtor will
bear the charges associated with the processing of the payment
transaction.
allOf:
- $ref: '#/components/schemas/ChargeBearerType1Code'
RvslRsnInf:
type: array
description: >-
Provides detailed information on the reversal reason.Provides
further details on the reason of the reversal of the transaction.
items:
$ref: '#/components/schemas/PaymentReversalReason9'
OrgnlTxRef:
type: object
description: >-
Set of Key elements used to identify the original transaction that
is being referred to.
allOf:
- $ref: '#/components/schemas/OriginalTransactionReference28'
SplmtryData:
type: array
description: >-
Additional information that cannot be captured in the structured
elements and/or any other specific block.
items:
$ref: '#/components/schemas/SupplementaryData1'
SupplementaryData1:
required:
- Envlp
type: object
properties:
PlcAndNm:
maxLength: 350
minLength: 1
type: string
description: >-
Unambiguous reference to the location where the supplementary data
must be inserted in the message instance.
Envlp:
type: object
description: >-
Technical element wrapping the supplementary data.Technical
component that contains the validated supplementary data
information. This technical envelope allows to segregate the
supplementary data information from any other information. Elements
from any namespace is allowed and the proces Contents is lax so if
the schema cannot be obtained, no errors will occur.
xml:
namespace: http://com.citi.citiconnect/services/types/citiconnect/v1
OriginalTransactionReference28:
required:
- DbtrAcct
- ReqdExctnDt
type: object
properties:
IntrBkSttlmAmt:
type: object
description: >-
Amount of money moved between the instructing agent and the
instructed agent.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
Amt:
type: object
allOf:
- $ref: '#/components/schemas/AmountType4Choice'
IntrBkSttlmDt:
type: string
description: >-
Date on which the amount of money ceases to be available to the
agent that owes it and when the amount of money becomes available to
the agent to which it is due.
format: date
ReqdColltnDt:
type: string
description: >-
Date and time at which the creditor requests that the amount of
money is to be collected from the debtor.
format: date
ReqdExctnDt:
type: object
description: >-
Date at which the initiating party requests the clearing agent to
process the payment.
allOf:
- $ref: '#/components/schemas/DateAndDateTime2Choice'
CdtrSchmeId:
type: object
description: Credit party that signs the mandate.
allOf:
- $ref: '#/components/schemas/PartyIdentification135'
SttlmInf:
$ref: '#/components/schemas/SettlementInstruction7'
PmtTpInf:
$ref: '#/components/schemas/PaymentTypeInformation27'
PmtMtd:
$ref: '#/components/schemas/PaymentMethod4Code'
MndtRltdInf:
$ref: '#/components/schemas/MandateRelatedInformation14'
RmtInf:
$ref: '#/components/schemas/RemittanceInformation16'
UltmtDbtr:
type: object
description: >-
Ultimate party that owes an amount of money to the (ultimate)
creditor.
allOf:
- $ref: '#/components/schemas/Party40Choice'
Dbtr:
type: object
description: Party that owes an amount of money to the (ultimate) creditor.
allOf:
- $ref: '#/components/schemas/Party40Choice'
DbtrAcct:
type: object
description: >-
Unambiguous identification of the account of the debtor to which a
debit entry will be made as a result of the transaction.
allOf:
- $ref: '#/components/schemas/CashAccount38'
DbtrAgt:
type: object
description: Financial institution servicing an account for the debtor.
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification6
DbtrAgtAcct:
type: object
description: >-
Unambiguous identification of the account of the debtor agent at its
servicing agent in the payment chain.
allOf:
- $ref: '#/components/schemas/CashAccount38'
CdtrAgt:
type: object
description: Financial institution servicing an account for the creditor.
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification6
CdtrAgtAcct:
type: object
description: >-
Unambiguous identification of the account of the creditor agent at
its servicing agent to which a credit entry will be made as a result
of the payment transaction.
allOf:
- $ref: '#/components/schemas/CashAccount38'
Cdtr:
type: object
description: Party to which an amount of money is due.
allOf:
- $ref: '#/components/schemas/Party40Choice'
CdtrAcct:
type: object
description: >-
Unambiguous identification of the account of the creditor to which a
credit entry will be posted as a result of the payment transaction.
allOf:
- $ref: '#/components/schemas/CashAccount38'
UltmtCdtr:
type: object
description: Ultimate party to which an amount of money is due.
allOf:
- $ref: '#/components/schemas/Party40Choice'
Purp:
type: object
description: Underlying reason for the payment transaction.
allOf:
- $ref: '#/components/schemas/Purpose2Choice'
description: >-
Set of key elements used to identify the original transaction that is
being referred to.
Purpose2Choice:
type: object
properties:
Cd:
maxLength: 4
minLength: 1
type: string
description: >-
Specifies the external purpose code in the format of character
string with a maximum length of 4 characters.The list of valid codes
is an external code list published separately.
Prtry:
maxLength: 35
minLength: 1
type: string
description: Propreitary Details
description: >-
Purpose is used by the end customers, that is initiating party,
(ultimate) debtor, (ultimate) creditor to provide information concerning
the nature of the payment. Purpose is a content element, which is not
used for processing by any of the agents involved in the payment chain.
Either Code Or Proprietary is required.
Party40Choice:
required:
- Pty
type: object
properties:
Pty:
type: object
description: Specifies the identification of a person or an organisation.
allOf:
- $ref: '#/components/schemas/PartyIdentification135'
Agt:
type: object
description: >-
Unique and unambiguous identification of a financial institution or
a branch of a financial institution.
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification6
description: Specifies the identification of a party or an agent.
RemittanceInformation16:
type: object
properties:
Strd:
type: array
description: >-
Information supplied to enable the matching of an entry with the
items that the transfer is intended to settle, such as commercial
invoices in an accounts' receivable system.
items:
$ref: '#/components/schemas/StructuredRemittanceInformation16'
Ustrd:
type: array
description: >-
Information supplied to enable the matching/reconciliation of an
entry with the items that the payment is intended to settle, such as
commercial invoices in an accounts' receivable system, in an
unstructured form.
items:
$ref: '#/components/schemas/Max140Text'
StructuredRemittanceInformation16:
type: object
properties:
RfrdDocInf:
type: array
description: >-
Set of elements used to identify the documents referred to in the
remittance information.
items:
$ref: '#/components/schemas/ReferredDocumentInformation7'
RfrdDocAmt:
$ref: '#/components/schemas/RemittanceAmount3'
CdtrRefInf:
$ref: '#/components/schemas/CreditorReferenceInformation2'
Invcr:
type: object
description: >-
Identification of the organisation issuing the invoice, when it is
different from the creditor or ultimate creditor.
allOf:
- $ref: '#/components/schemas/PartyIdentification135'
Invcee:
type: object
description: >-
Identification of the party to whom an invoice is issued, when it is
different from the debtor or ultimate debtor.
allOf:
- $ref: '#/components/schemas/PartyIdentification135'
TaxRmt:
type: object
description: >-
Provides remittance information about a payment made for tax-related
purposes.
allOf:
- $ref: '#/components/schemas/TaxInformation7'
GrnshmtRmt:
type: object
description: >-
Provides remittance information about a payment for
garnishment-related purposes.
allOf:
- $ref: '#/components/schemas/Garnishment3'
AddtlRmtInf:
maxItems: 3
type: array
description: >-
Additional information, in free text form, to complement the
structured remittance information.
items:
$ref: '#/components/schemas/Max140Text'
Garnishment3:
required:
- Tp
type: object
properties:
Tp:
type: object
description: Specifies the type of garnishment.
allOf:
- $ref: '#/components/schemas/GarnishmentType1'
Grnshee:
type: object
description: >-
Ultimate party that owes an amount of money to the (ultimate)
creditor, in this case, to the garnisher.
allOf:
- $ref: '#/components/schemas/PartyIdentification135'
GrnshmtAdmstr:
type: object
description: >-
Party on the credit side of the transaction who administers the
garnishment on behalf of the ultimate beneficiary.
allOf:
- $ref: '#/components/schemas/PartyIdentification135'
RefNb:
maxLength: 140
minLength: 1
type: string
description: >-
Reference information that is specific to the agency receiving the
garnishment.
Dt:
type: string
description: Date of payment which garnishment was taken from.
format: date
RmtdAmt:
type: object
description: Amount of money remitted for the referred document.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
FmlyMdclInsrncInd:
type: boolean
description: >-
Indicates if the person to whom the garnishment applies (that is,
the ultimate debtor) has family medical insurance coverage
available.A flag indicating a True or False value.
MplyeeTermntnInd:
type: boolean
description: >-
Indicates if the employment of the person to whom the garnishment
applies (that is, the ultimate debtor) has been terminated.A flag
indicating a True or False value.
description: >-
Provides remittance information about a payment for garnishment-related
purposes.
GarnishmentType1:
required:
- CdOrPrtry
type: object
properties:
CdOrPrtry:
type: object
properties:
Cd:
maxLength: 4
minLength: 1
type: string
description: >-
Specifies the garnishment type as published in an external
document type code list.
Prtry:
maxLength: 35
minLength: 1
type: string
description: Proprietary Details
description: >-
Provides the type details of the garnishment.Either Code or Prtry is
required
Issr:
maxLength: 35
minLength: 1
type: string
description: Identification of the issuer of the garnishment type.
TaxParty1:
type: object
properties:
RegnId:
type: object
description: >-
Unique identification, as assigned by an organisation, to
unambiguously identify a party.
allOf:
- $ref: '#/components/schemas/Max35Text'
TaxId:
type: object
description: Tax identification number of the creditor.
allOf:
- $ref: '#/components/schemas/Max35Text'
TaxTp:
type: object
description: Type of tax payer.
allOf:
- $ref: '#/components/schemas/Max35Text'
description: Party on the credit side of the transaction to which the tax applies
TaxAuthorisation1:
type: object
properties:
Nm:
type: object
description: Name of the debtor or the debtor's authorised representative.
allOf:
- $ref: '#/components/schemas/Max140Text'
Titl:
type: object
description: >-
Title or position of debtor or the debtor's authorised
representative.
allOf:
- $ref: '#/components/schemas/Max35Text'
description: Details of the authorised tax paying party.
TaxParty2:
type: object
properties:
Authstn:
type: object
allOf:
- $ref: '#/components/schemas/TaxAuthorisation1'
RegnId:
type: object
description: >-
Unique identification, as assigned by an organisation, to
unambiguously identify a party.
allOf:
- $ref: '#/components/schemas/Max35Text'
TaxId:
type: object
description: Tax identification number of the debtor.
allOf:
- $ref: '#/components/schemas/Max35Text'
TaxTp:
type: object
description: Type of tax payer.
allOf:
- $ref: '#/components/schemas/Max35Text'
description: >-
Set of elements used to identify the party on the debit side of the
transaction to which the tax applies.
TaxInformation7:
type: object
properties:
Cdtr:
type: object
allOf:
- $ref: '#/components/schemas/TaxParty1'
Dbtr:
type: object
allOf:
- $ref: '#/components/schemas/TaxParty2'
AdmstnZone:
type: object
description: Territorial part of a country to which the tax payment is related.
allOf:
- $ref: '#/components/schemas/Max35Text'
RefNb:
type: object
description: Tax reference information that is specific to a taxing agency.
allOf:
- $ref: '#/components/schemas/Max140Text'
Mtd:
type: object
description: >-
Method used to indicate the underlying business or how the tax is
paid.
allOf:
- $ref: '#/components/schemas/Max35Text'
TtlTaxblBaseAmt:
type: object
description: Total amount of money on which the tax is based.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
TtlTaxAmt:
type: object
description: Total amount of money as result of the calculation of the tax.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
Dt:
type: object
description: Date by which tax is due.
allOf:
- $ref: '#/components/schemas/ISODate'
SeqNb:
maxLength: 18
type: string
description: Sequential number of the tax report.
Rcrd:
type: array
description: Record of tax details.
items:
$ref: '#/components/schemas/TaxRecord2'
description: >-
Provides remittance information about a payment made for tax-related
purposes.
TaxRecord2:
type: object
properties:
Tp:
type: object
description: High level code to identify the type of tax details.
allOf:
- $ref: '#/components/schemas/Max35Text'
Ctgy:
type: object
description: Specifies the tax code as published by the tax authority.
allOf:
- $ref: '#/components/schemas/Max35Text'
CtgyDtls:
type: object
description: Provides further details of the category tax code.
allOf:
- $ref: '#/components/schemas/Max35Text'
DbtrSts:
type: object
description: >-
Code provided by local authority to identify the status of the party
that has drawn up the settlement document.
allOf:
- $ref: '#/components/schemas/Max35Text'
CertId:
type: object
description: >-
Identification number of the tax report as assigned by the taxing
authority.
allOf:
- $ref: '#/components/schemas/Max35Text'
FrmsCd:
type: object
description: >-
Identifies, in a coded form, on which template the tax report is to
be provided.
allOf:
- $ref: '#/components/schemas/Max35Text'
Prd:
type: object
allOf:
- $ref: '#/components/schemas/TaxPeriod2'
TaxAmt:
type: object
allOf:
- $ref: '#/components/schemas/TaxAmount2'
AddtlInf:
type: object
description: Further details of the tax record.
allOf:
- $ref: '#/components/schemas/Max140Text'
TaxRecordDetails2:
required:
- Amt
type: object
properties:
Amt:
type: object
description: Underlying tax amount related to the specified period.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
Prd:
type: object
allOf:
- $ref: '#/components/schemas/TaxPeriod2'
TaxAmount2:
type: object
properties:
Dtls:
type: array
description: >-
Set of elements used to provide details on the tax period and
amount.
items:
$ref: '#/components/schemas/TaxRecordDetails2'
Rate:
maxLength: 11
type: string
description: Rate used to calculate the tax.Upto 10 fractional digits.
TaxblBaseAmt:
type: object
description: Amount of money on which the tax is based.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
TtlAmt:
type: object
description: >-
Total amount that is the result of the calculation of the tax for
the record.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
description: >-
Set of elements used to provide information on the amount of the tax
record.
TaxPeriod2:
type: object
properties:
FrToDt:
type: object
description: >-
Range of time between a start date and an end date for which the tax
report is provided.
allOf:
- $ref: '#/components/schemas/DatePeriod2'
Tp:
type: object
allOf:
- $ref: '#/components/schemas/TaxRecordPeriod1Code'
Yr:
type: object
description: Year related to the tax payment.
allOf:
- $ref: '#/components/schemas/ISODate'
description: >-
Set of elements used to provide details on the period of time related to
the tax payment.
DatePeriod2:
required:
- FrDt
- ToDt
type: object
properties:
FrDt:
type: object
description: Start date of the range.
allOf:
- $ref: '#/components/schemas/ISODate'
ToDt:
type: object
description: End date of the range.
allOf:
- $ref: '#/components/schemas/ISODate'
TaxRecordPeriod1Code:
type: string
description: >-
Identification of the period related to the tax payment.
MM01 : Tax is related to the first month of the period.
MM02 : Tax is related to the second month of the
period.
MM03 : Tax is related to the third month of the
period.
MM04 : Tax is related to the fourth month of the
period.
MM05 : Tax is related to the fifth month of the
period.
MM06 : Tax is related to the sixth month of the
period.
MM07 : Tax is related to the seventh month of the
period.
MM08 : Tax is related to the eighth month of the
period.
MM09 : Tax is related to the ninth month of the
period.
MM10 : Tax is related to the tenth month of the
period.
MM11 : Tax is related to the eleventh month of the
period.
MM12 : Tax is related to the twelfth month of the
period.
QTR1 : Tax is related to the first quarter of the
period.
QTR2 : Tax is related to the second quarter of the
period.
QTR3 : Tax is related to the third quarter of the
period.
QTR4 : Tax is related to the fourth quarter of the
period.
HLF1 : Tax is related to the first half of the
period.
HLF2 : Tax is related to the second half of the
period.
enum:
- MM01
- MM02
- MM03
- MM04
- MM05
- MM06
- MM07
- MM08
- MM09
- MM10
- MM11
- MM12
- QTR1
- QTR2
- QTR3
- QTR4
- HLF1
- HLF2
DocumentType3Code:
type: string
description: >-
Type of creditor reference, in a coded form.
RADM :
Document is a remittance advice sent separately from the current
transaction.
RPIN : Document is a linked payment
instruction to which the current payment instruction is related, for
example, in a cover scenario.
FXDR : Document is a
pre-agreed or pre-arranged foreign exchange transaction to which the
payment transaction refers.
DISP : Document is a dispatch
advice.
PUOR : Document is a purchase order
SCOR : Document is a structured communication reference
provided by the creditor to identify the referred transaction.
enum:
- RADM
- RPIN
- FXDR
- DISP
- PUOR
- SCOR
CreditorReferenceType1Choice:
type: object
properties:
Cd:
$ref: '#/components/schemas/DocumentType3Code'
Prtry:
type: object
description: Creditor reference type, in a proprietary form.
allOf:
- $ref: '#/components/schemas/Max35Text'
description: >-
Coded or proprietary format creditor reference type. Either Code or
Proprietary field value should be passed on request.
CreditorReferenceType2:
required:
- CdOrPrtry
type: object
properties:
CdOrPrtry:
$ref: '#/components/schemas/CreditorReferenceType1Choice'
Issr:
type: object
description: Entity that assigns the credit reference type.
allOf:
- $ref: '#/components/schemas/Max35Text'
description: Specifies the type of creditor reference.
CreditorReferenceInformation2:
type: object
properties:
Ref:
type: object
description: >-
Unique reference, as assigned by the creditor, to unambiguously
refer to the payment transaction.
allOf:
- $ref: '#/components/schemas/Max35Text'
Tp:
$ref: '#/components/schemas/CreditorReferenceType2'
description: >-
Reference information provided by the creditor to allow the
identification of the underlying documents.
ReferredDocumentInformation7:
type: object
properties:
Nb:
type: object
description: Unique and unambiguous identification of the referred document.
allOf:
- $ref: '#/components/schemas/Max35Text'
RltdDt:
type: object
description: Date associated with the referred document.
allOf:
- $ref: '#/components/schemas/ISODate'
Tp:
$ref: '#/components/schemas/ReferredDocumentType4'
LineDtls:
type: array
description: >-
Set of elements used to provide the content of the referred document
line.
items:
$ref: '#/components/schemas/DocumentLineInformation1'
DocumentLineInformation1:
required:
- Id
type: object
properties:
Id:
type: array
description: Provides identification of the document line.
items:
$ref: '#/components/schemas/DocumentLineIdentification1'
Desc:
maxLength: 2048
minLength: 1
type: string
description: Description associated with the document line.
Amt:
type: object
allOf:
- $ref: '#/components/schemas/RemittanceAmount3'
RemittanceAmount3:
type: object
properties:
DuePyblAmt:
type: object
description: >-
Amount specified is the exact amount due and payable to the
creditor.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
DscntApldAmt:
type: array
description: >-
Amount of money that results from the application of an agreed
discount to the amount due and payable to the creditor.
items:
$ref: '#/components/schemas/DiscountAmountAndType1'
CdtNoteAmt:
type: object
description: >-
Amount specified for the referred document is the amount of a credit
note.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
TaxAmt:
type: array
description: Amount of the tax
items:
$ref: '#/components/schemas/TaxAmountAndType1'
AdjstmntAmtAndRsn:
type: array
description: >-
Set of elements used to provide information on the amount and reason
of the document adjustment.
items:
$ref: '#/components/schemas/DocumentAdjustment1'
RmtdAmt:
type: object
description: Amount of money remitted for the referred document.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
description: >-
Set of elements used to provide details on the amounts of the referred
document.
DocumentAdjustment1:
required:
- Amt
type: object
properties:
AddtlInf:
type: object
description: Provides further details on the document adjustment.
allOf:
- $ref: '#/components/schemas/Max140Text'
Amt:
type: object
description: Amount of money of the document adjustment.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
CdtDbtInd:
$ref: '#/components/schemas/CreditDebitCode'
Rsn:
type: object
description: Specifies the reason for the adjustment.
allOf:
- $ref: '#/components/schemas/Max4Text'
Max4Text:
maxLength: 4
minLength: 1
type: string
CreditDebitCode:
type: string
description: >-
Specifies whether the adjustment must be subtracted or added to the
total amount.
CRDT : Operation is an increase.
DBIT : Operation is a decrease.
enum:
- CRDT
- DBIT
TaxAmountAndType1:
type: object
properties:
Tp:
type: object
allOf:
- $ref: '#/components/schemas/TaxAmountType1Choice'
Amt:
type: object
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
description: Amount of the tax.
TaxAmountType1Choice:
type: object
properties:
Cd:
maxLength: 4
minLength: 1
type: string
description: >-
Specifies the nature, or use, of the amount in the format of
character string with a maximum length of 4 characters.The list of
valid codes is an external code list published separately.
Prtry:
maxLength: 35
minLength: 1
type: string
description: Propreitary Details
description: Specifies the type of the amount.Either Propreitary or Code is required
DiscountAmountAndType1:
type: object
properties:
Tp:
type: object
properties:
Cd:
maxLength: 4
minLength: 1
type: string
description: >-
Specifies the nature, or use, of the amount in the format of
character string with a maximum length of 4 characters.The list
of valid codes is an external code list published separately.
Prtry:
maxLength: 4
minLength: 1
type: string
description: Proprietary Details
description: >-
Specifies the type of the amount. Either Code or Proprietary is
required
Amt:
type: object
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
DocumentLineIdentification1:
type: object
properties:
Tp:
type: object
allOf:
- $ref: '#/components/schemas/DocumentLineType1'
Nb:
maxLength: 35
minLength: 1
type: string
description: Identification of the type specified for the referred document line.
RltdDt:
type: string
description: Date associated with the referred document line.
format: date
DocumentLineType1:
required:
- CdOrPrtry
type: object
properties:
CdOrPrtry:
type: object
description: >-
Provides the type details of the referred document line
identification. Either Code Or Proprietary is required
allOf:
- $ref: '#/components/schemas/DocumentLineType1Choice'
Issr:
maxLength: 35
minLength: 1
type: string
description: >-
Identification of the issuer of the reference document line
identificationtype.
DocumentLineType1Choice:
type: object
properties:
Cd:
maxLength: 4
minLength: 1
type: string
description: >-
Specifies the document line type as published in an external
document type code list.
Prtry:
maxLength: 35
minLength: 1
type: string
description: Propreitary Description
description: Either Code or Proprietary is required
ReferredDocumentType4:
required:
- CdOrPrtry
type: object
properties:
CdOrPrtry:
$ref: '#/components/schemas/ReferredDocumentType3Choice'
Issr:
type: object
description: Identification of the issuer of the reference document type.
allOf:
- $ref: '#/components/schemas/Max35Text'
description: Specifies the type of referred document.
ReferredDocumentType3Choice:
type: object
properties:
Cd:
$ref: '#/components/schemas/DocumentType6Code'
Prtry:
type: object
description: Proprietary identification of the type of the remittance document.
allOf:
- $ref: '#/components/schemas/Max35Text'
description: >-
Provides the type details of the referred document. Either Code or
Proprietary field value should be passed on request.
DocumentType6Code:
type: string
description: >-
Document type in a coded form. Specifies a type of financial or
commercial document.
MSIN : Document is an invoice
claiming payment for the supply of metered services, for example gas or
electricity supplied to a fixed meter.
CNFA : Document is
a credit note for the final amount settled for a commercial transaction.
DNFA : Document is a debit note for the final amount
settled for a commercial transaction.
CINV : Document
is an invoice.
CREN : Document is a credit note.
DEBN : Document is a debit note.
HIRI :
Document is an invoice for the hiring of human resources or renting
goods or equipment.
SBIN : Document is an invoice issued
by the debtor.
SVGS : Account used for savings.
CMCN : Document is an agreement between the parties,
stipulating the terms and conditions of the delivery of goods or
services.
SOAC : Document is a statement of the
transactions posted to the debtor's account at the supplier.
DISP : Document is a dispatch advice.
BOLD
: Document is a shipping notice.
VCHR : Document is an
electronic payment document.
AROI : Document is a payment
that applies to a specific source document.
TSUT :
Document is a transaction identifier as assigned by the Trade Services
Utility
TSUT : Document is a purchase order.
enum:
- MSIN
- CNFA
- DNFA
- CINV
- CREN
- DEBN
- HIRI
- SBIN
- CMCN
- SOAC
- DISP
- BOLD
- VCHR
- AROI
- TSUT
- PUOR
MandateRelatedInformation14:
required:
- ElctrncSgntr
type: object
properties:
MndtId:
type: object
description: >-
Unique identification, as assigned by the creditor, to unambiguously
identify the mandate.
allOf:
- $ref: '#/components/schemas/Max35Text'
DtOfSgntr:
type: string
description: >-
Date on which the direct debit mandate has been signed by the
debtor.
format: date
AmdmntInd:
type: boolean
description: >-
Indicator notifying whether the underlying mandate is amended or
not.
AmdmntInfDtls:
type: object
allOf:
- $ref: '#/components/schemas/AmendmentInformationDetails13'
ElctrncSgntr:
maxLength: 1025
minLength: 1
type: string
description: >-
Additional security provisions, such as a digital signature, as
provided by the debtor.
FrstColltnDt:
type: string
description: Date of the first collection of a direct debit as per the mandate.
format: date
FnlColltnDt:
type: string
description: Date of the final collection of a direct debit as per the mandate.
format: date
Frqcy:
type: object
allOf:
- $ref: '#/components/schemas/Frequency36Choice'
Rsn:
type: object
allOf:
- $ref: '#/components/schemas/MandateSetupReason1Choice'
TrckgDays:
pattern: '[0-9]{2}'
type: string
description: >-
Specifies the number of days the direct debit instruction must be
tracked.
description: >-
Provides further details of the mandate signed between the creditor and
the debtor.If AmendmentIndicator is true, then
AmendementInformationDetails must be present.If AmendmentIndicator is
false, then AmendmentInformationDetails is not allowed.
AmendmentInformationDetails13:
type: object
properties:
OrgnlMndtId:
type: object
description: >-
Unique identification, as assigned by the creditor, to unambiguously
identify the original mandate.
allOf:
- $ref: '#/components/schemas/Max35Text'
OrgnlCdtrSchmeId:
type: object
description: Original creditor scheme identification that has been modified.
allOf:
- $ref: '#/components/schemas/PartyIdentification135'
OrgnlCdtrAgt:
type: object
description: Original creditor agent that has been modified.
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification6
OrgnlCdtrAgtAcct:
type: object
description: Original creditor agent acount that has been modified.
allOf:
- $ref: '#/components/schemas/CashAccount38'
OrgnlDbtr:
type: object
description: Original debtor that has been modified.
allOf:
- $ref: '#/components/schemas/PartyIdentification135'
OrgnlDbtrAcct:
type: object
description: Original debtor account that has been modified.
allOf:
- $ref: '#/components/schemas/CashAccount38'
OrgnlDbtrAgt:
type: object
description: Original debtor agent that has been modified.
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification6
OrgnlDbtrAgtAcct:
type: object
description: Original debtor agent account that has been modified.
allOf:
- $ref: '#/components/schemas/CashAccount38'
OrgnlFnlColltnDt:
type: string
description: Original final collection date that has been modified.
format: date
OrgnlFrqcy:
type: object
allOf:
- $ref: '#/components/schemas/Frequency36Choice'
OrgnlRsn:
type: object
allOf:
- $ref: '#/components/schemas/MandateSetupReason1Choice'
OrgnlTrckgDays:
pattern: '[0-9]{2}'
type: string
description: Original number of tracking days that has been modified.
description: List of mandate elements that have been modified.
MandateSetupReason1Choice:
type: object
properties:
Cd:
maxLength: 4
minLength: 1
type: string
description: >-
Specifies the external mandate setup reason code in the format of
character string with a maximum length of 4 characters.
Prtry:
maxLength: 70
minLength: 1
type: string
description: Proprietary Details
description: Either of Code or Proprietary is required.
Frequency36Choice:
required:
- Prd
- PtInTm
- Tp
type: object
properties:
Tp:
type: object
allOf:
- $ref: '#/components/schemas/Frequency6Code'
Prd:
required:
- CntPerPrd
- Tp
type: object
properties:
Tp:
type: object
description: >-
Period for which the number of instructions are to be created
and processed.
allOf:
- $ref: '#/components/schemas/Frequency6Code'
CntPerPrd:
maxLength: 18
type: string
description: >-
Number of instructions to be created and processed during the
specified period.Number of objects represented as a decimal
number, for example 0.75 or 45.6. Fractional Digits Upto 17
allowed
description: >-
Defines a frequency in terms on counts per period for a specific
period type.
PtInTm:
type: object
allOf:
- $ref: '#/components/schemas/FrequencyAndMoment1'
FrequencyAndMoment1:
required:
- PtInTm
- Tp
type: object
properties:
Tp:
type: object
allOf:
- $ref: '#/components/schemas/Frequency6Code'
PtInTm:
pattern: '[0-9]{2}'
type: string
description: >-
Further information on the exact point in time the event should take
place.
description: >-
Defines a frequency in terms a specific moment within a specified period
type.
Frequency6Code:
type: string
description: >-
Specifies the regularity of an event.
YEAR : Event takes
place every year or once a year.
MNTH : Event takes place
every month or once a month.
QURT : Event takes place
every three months or four times a year.
MIAN : Event
takes place every six months or two times a year.
WEEK :
Event takes place once a week.
DAIL : Event takes place
every day.
ADHO : Event takes place on request or as
necessary.
INDA : Event takes place several times a day.
FRTN : Event takes place every two weeks.
enum:
- YEAR
- MNTH
- QURT
- MIAN
- WEEK
- DAIL
- ADHO
- INDA
- FRTN
PaymentMethod4Code:
type: string
description: >-
Specifies the means of payment that will be used to move the amount of
money.
CHK : Written order to a bank to pay a certain
amount of money from one person to another person.
TRF :
Transfer of an amount of money in the books of the account servicer.
DD : Collection of an amount of money from the debtor's
bank account by the creditor. The amount of money and dates of
collections may vary.
TRA : Transfer of an amount of
money in the books of the account servicer. An advice should be sent
back to the account owner.
enum:
- CHK
- TRF
- DD
- TRA
PaymentTypeInformation27:
type: object
properties:
InstrPrty:
$ref: '#/components/schemas/Priority2Code'
ClrChanl:
type: string
description: >-
Specifies the clearing channel to be used to process the payment
instruction.
RTGS : Clearing channel is a real-time
gross settlement system.
RTNS : Clearing channel is a
real-time net settlement system.
MPNS : Clearing
channel is a mass payment net settlement system.
BOOK
: Payment through internal book transfer.
enum:
- RTGS
- RTNS
- MPNS
- BOOK
SvcLvl:
type: array
items:
$ref: '#/components/schemas/ServiceLevel8Choice'
LclInstrm:
$ref: '#/components/schemas/LocalInstrument2Choice'
SeqTp:
type: string
description: >-
Identifies the direct debit sequence, such as first, recurrent,
final or one-off.
FRST : First collection of a series
of direct debit instructions.
RCUR : Direct debit
instruction where the debtor's authorisation is used for regular
direct debit transactions initiated by the creditor.
FNAL : Final collection of a series of direct debit
instructions.
OOFF : Direct debit instruction where
the debtor's authorisation is used to initiate one single direct
debit transaction.
RPRE :Collection used to re-present
previously reversed or returned direct debit transactions.
enum:
- FRST
- RCUR
- FNAL
- OOFF
- RPRE
CtgyPurp:
type: object
description: >-
Specifies the high level purpose of the instruction based on a set
of pre-defined categories.
allOf:
- $ref: '#/components/schemas/CategoryPurpose1Choice'
description: Set of elements used to further specify the type of transaction.
CategoryPurpose1Choice:
type: object
properties:
Cd:
maxLength: 4
minLength: 1
type: string
description: >-
Category purpose, as published in an external category purpose code
list.
Prtry:
type: object
description: Category purpose, in a proprietary form.
allOf:
- $ref: '#/components/schemas/Max35Text'
description: >-
Specifies the high level purpose of the instruction based on a set of
pre-defined categories. Either Code or Proprietary field value should be
passed in request.
Priority2Code:
type: string
description: >-
Indicator of the urgency or order of importance that the instructing
party would like the instructed party to apply to the processing of the
instruction.
HIGH : Priority level is high.
NORM : Priority level is normal.
enum:
- HIGH
- NORM
ServiceLevel8Choice:
type: object
properties:
Cd:
maxLength: 4
minLength: 1
type: string
description: >-
Specifies the external service level code in the format of character
string with a maximum length of 4 characters.The list of valid codes
is an external code list published separately.
Prtry:
type: object
description: >-
Specifies a pre-agreed service or level of service between the
parties, as a proprietary code.
allOf:
- $ref: '#/components/schemas/Max35Text'
description: >-
Agreement under which or rules under which the transaction should be
processed. Either code or proprietary field values should be sent in
request.
LocalInstrument2Choice:
type: object
properties:
Cd:
type: object
description: >-
Specifies the external local instrument code in the format of
character string with a maximum length of 35 characters.The list of
valid codes is an external code list published separately.
allOf:
- $ref: '#/components/schemas/Max35Text'
Prtry:
type: object
description: Specifies the local instrument, as a proprietary code.
allOf:
- $ref: '#/components/schemas/Max35Text'
description: >-
User community specific instrument. Either Code or Proprietary field
value should be passed in request.
SettlementInstruction7:
required:
- SttlmMtd
type: object
properties:
SttlmMtd:
type: object
allOf:
- $ref: '#/components/schemas/SettlementMethod1Code'
SttlmAcct:
type: object
description: >-
A specific purpose account used to post debit and credit entries as
a result of the transaction.
allOf:
- $ref: '#/components/schemas/CashAccount38'
ClrSys:
$ref: '#/components/schemas/ClearingSystemIdentification3Choice'
InstgRmbrsmntAgt:
type: object
description: >-
Agent through which the instructing agent will reimburse the
instructed agent.
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification6
InstgRmbrsmntAgtAcct:
type: object
description: >-
Unambiguous identification of the account of the instructing
reimbursement agent account at its servicing agent in the payment
chain.
allOf:
- $ref: '#/components/schemas/CashAccount38'
InstdRmbrsmntAgt:
type: object
description: Agent at which the instructed agent will be reimbursed.
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification6
InstdRmbrsmntAgtAcct:
type: object
description: >-
Unambiguous identification of the account of the instructed
reimbursement agent account at its servicing agent in the payment
chain.
allOf:
- $ref: '#/components/schemas/CashAccount38'
ThrdRmbrsmntAgtAcct:
type: object
description: >-
Unambiguous identification of the account of the third reimbursement
agent account at its servicing agent in the payment chain.
allOf:
- $ref: '#/components/schemas/CashAccount38'
ThrdRmbrsmntAgt:
type: object
description: Agent at which the instructed agent will be reimbursed.
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification6
description: >-
Specifies the details on how the settlement of the original
transaction(s) between the instructing agent and the instructed agent
was completed. If ThirdReimbursementAgent is present, then
InstructingReimbursementAgent and InstructedReimbursementAgent must both
be present. If SettlementMethod is equal to INDA or INGA, then
ReimbursementAgent(s) and ClearingSystem are not allowed.If
SettlementMethod is equal to COVE, then SettlementAccount and
ClearingSystem are not allowed.If SettlementMethod is equal to COVE,
then InstructedReimbursementAgent or InstructingReimbursementAgent must
be present.If SettlementMethod is equal to CLRG, then SettlementAccount
and ReimbursementAgent(s) are not allowed.If
InstructingReimbursementAgentAccount is present, then
InstructingReimbursementAgent must be present.If
InstructedReimbursementAgentAccount is present, then
InstructedReimbursementAgent must be present.If
ThirdReimbursementAgentAccount is present, then ThirdReimbursementAgent
must be present.
ClearingSystemIdentification3Choice:
type: object
properties:
Cd:
maxLength: 3
minLength: 1
type: string
description: >-
Infrastructure through which the payment instruction is processed,
as published in an external clearing system identification code
list.Specifies the cash clearing system, as published in an external
cash clearing system code list.
Prtry:
type: object
description: Clearing system identification in a proprietary form.
allOf:
- $ref: '#/components/schemas/Max35Text'
description: >-
Specification of a pre-agreed offering between clearing agents or the
channel through which the payment instruction is processed. Either Code
or Proprietary field value should be passed in request.
CashAccount38:
required:
- Id
type: object
properties:
Ccy:
type: object
description: Identification of the currency in which the account is held.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
Id:
$ref: '#/components/schemas/AccountIdentification4Choice'
Nm:
type: object
description: >-
Name of the account, as assigned by the account servicing
institution, in agreement with the account owner in order to provide
an additional means of identification of the account.
allOf:
- $ref: '#/components/schemas/Max70Text'
Tp:
type: object
allOf:
- $ref: '#/components/schemas/CashAccountType2Choice'
Prxy:
required:
- Id
type: object
properties:
Tp:
type: object
properties:
Cd:
maxLength: 4
minLength: 1
type: string
description: >-
Specifies the external proxy account type code, as published
in the proxy account type external code set.
Prtry:
maxLength: 35
minLength: 1
type: string
description: Proprietary details
description: >-
Type of the proxy identification.Either of Code or Propreitary
is required.
Id:
maxLength: 2048
minLength: 1
type: string
description: >-
Identification used to indicate the account identification under
another specified name.
description: >-
Specifies an alternate assumed name for the identification of the
account.
CashAccountType2Choice:
type: object
properties:
Cd:
maxLength: 4
minLength: 1
type: string
description: >-
Specifies the nature, or use, of the cash account in the format of
character string with a maximum length of 4 characters.The list of
valid codes is an external code list published separately.
Prtry:
type: object
description: Nature or use of the account in a proprietary form.
allOf:
- $ref: '#/components/schemas/Max35Text'
description: >-
Specifies the nature, or use of the account. Either Code or Proprietary
field value should be passed on request.
AccountIdentification4Choice:
type: object
properties:
IBAN:
$ref: '#/components/schemas/IBAN2007Identifier'
Othr:
$ref: '#/components/schemas/GenericAccountIdentification1'
description: >-
Unique and unambiguous identification for the account between the
account owner and the account servicer. Either iban or Othr field value
should be passed on request.
GenericAccountIdentification1:
required:
- Id
type: object
properties:
Id:
maxLength: 34
minLength: 1
type: string
description: Identification assigned by an institution.
Issr:
type: object
description: Entity that assigns the identification.
allOf:
- $ref: '#/components/schemas/Max35Text'
SchmeNm:
type: object
description: >-
Name of the identification scheme.Either Code or Proprietary is
required
allOf:
- $ref: '#/components/schemas/FinancialIdentificationSchemeName1Choice'
description: >-
Unique identification of an account, as assigned by the account
servicer, using an identification scheme.
IBAN2007Identifier:
pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$
type: string
description: >-
>- International Bank Account Number (IBAN) - identifier used
internationally by financial institutions to uniquely identify the
account of a customer. Further specifications of the format and content
of the IBAN can be found in the standard ISO 13616 "Banking and related
financial services - International Bank Account Number (IBAN)" version
1997-10-01, or later revisions.
SettlementMethod1Code:
type: string
description: >-
Method used to settle the (batch of) payment instructions.
INDA : Settlement is done by the agent instructed to
execute a payment instruction.
INGA : Settlement is done
by the agent instructing and forwarding the payment to the next party in
the payment chain.
COVE : Settlement is done through a
cover payment.
CLRG : Settlement is done through a
payment clearing system.
enum:
- INDA
- INGA
- COVE
- CLRG
DateAndDateTime2Choice:
type: object
properties:
Dt:
type: string
description: >-
Date at which the initiating party requests the clearing agent to
process the payment.
format: date
DtTm:
type: string
description: >-
Date and Time at which the initiating party requests the clearing
agent to process the payment.
format: date-time
description: Either Choice between a date or a date and time format.
AmountType4Choice:
type: object
properties:
EqvtAmt:
$ref: '#/components/schemas/EquivalentAmount2'
InstdAmt:
type: object
description: >-
Amount of money to be moved between the debtor and creditor, before
deduction of charges, expressed in the currency as ordered by the
initiating party.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
description: >-
Amount of money to be moved between the debtor and creditor, before
deduction of charges, expressed in the currency as ordered by the
initiating party. Either EqvtAmt or InstdAmt field value should be
passed on request.
EquivalentAmount2:
required:
- Amt
- CcyOfTrf
type: object
properties:
Amt:
type: object
description: >-
Amount of money to be moved between debtor and creditor, before
deduction of charges, expressed in the currency of the debtor's
account, and to be moved in a different currency.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
CcyOfTrf:
type: object
description: >-
Specifies the currency of the to be transferred amount, which is
different from the currency of the debtor's account.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
description: >-
Amount of money to be moved between the debtor and creditor, expressed
in the currency of the debtor's account, and the currency in which the
amount is to be moved.
ChargeBearerType1Code:
type: string
description: >-
Specifies which party/parties will bear the charges associated with the
processing of the payment transaction.
DEBT : All
transaction charges are to be borne by the debtor.
CRED :
All transaction charges are to be borne by the creditor.
SHAR : In a credit transfer context, means that
transaction charges on the sender side are to be borne by the debtor,
transaction charges on the receiver side are to be borne by the
creditor. In a direct debit context, means that transaction charges on
the sender side are to be borne by the creditor, transaction charges on
the receiver side are to be borne by the debtor.
SLEV :
Charges are to be applied following the rules agreed in the service
level and/or scheme.
enum:
- DEBT
- CRED
- SHAR
- SLEV
ActiveOrHistoricCurrencyAndAmount:
required:
- Ccy
type: object
properties:
Ccy:
type: object
description: >-
Currency code. Passed as the tag attribute.The unit of currency is
explicit and compliant with ISO 4217
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
$:
$ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount_SimpleType'
ActiveOrHistoricCurrencyAndAmount_SimpleType:
maxLength: 18
type: string
description: >-
The number of fractional digits (or minor unit of currency) must comply
with ISO 4217. Note: The decimal separator is a dot.A number of monetary
units specified in an active or a historic currency where the unit of
currency is explicit and compliant with ISO 4217. The number of
fractional digits should be 5.
ActiveOrHistoricCurrencyCode:
pattern: '[A-Z]{3,3}'
type: string
OriginalGroupHeader16:
required:
- OrgnlMsgId
- OrgnlMsgNmId
type: object
properties:
OrgnlMsgId:
maxLength: 35
minLength: 1
type: string
description: >-
Point to point reference, as assigned by the original instructing
party, to unambiguously identify the original message.
OrgnlMsgNmId:
maxLength: 35
minLength: 1
type: string
description: >-
Specifies the original message name identifier to which the message
refers.
OrgnlCreDtTm:
type: string
description: Date and time at which the original message was created.
format: date-time
RvslRsnInf:
type: array
description: Provides detailed information on the reversal reason.
items:
$ref: '#/components/schemas/PaymentReversalReason9'
PaymentReversalReason9:
type: object
properties:
Orgtr:
type: object
description: Party that issues the reversal.
allOf:
- $ref: '#/components/schemas/PartyIdentification135'
Rsn:
type: object
description: >-
Specifies the reason for the reversal.Either from Code or
Proprietary is required
allOf:
- $ref: '#/components/schemas/ReversalReason4Choice'
AddtlInf:
type: array
description: Further details on the reversal reason.
items:
type: string
ReversalReason4Choice:
required:
- Cd
type: object
properties:
Cd:
maxLength: 4
minLength: 1
type: string
description: >-
Specifies the reversal reason, as published in an external reversal
reason code list.
Prtry:
maxLength: 35
minLength: 1
type: string
description: Specifies about the proprietary
description: Either from Code or Proprietary is required
GroupHeader88:
required:
- CreDtTm
- MsgId
- NbOfTxs
type: object
properties:
MsgId:
maxLength: 35
minLength: 1
type: string
description: >-
Point to point reference, as assigned by the instructing party, and
sent to the next party in the chain to unambiguously identify the
message.
CreDtTm:
type: string
description: >-
This field specifies the date when the Refund is initiated. The date
format is: YYYY-MM-DDThh:mm:ss.Date and time at which the message
was created.
format: date-time
Authstn:
maxItems: 2
minItems: 1
type: array
description: >-
User identification or any user key to be used to check whether the
initiating party is allowed to initiate transactions from the
account specified in the message.
items:
$ref: '#/components/schemas/Authorisation1Choice'
NbOfTxs:
pattern: '[0-9]{1,15}'
type: string
description: >-
Number of individual transactions contained in the message. If
GroupReversal is true, then NumberOfTransactions equals the number
of transactions in the original message.
CtrlSum:
maxLength: 18
minLength: 1
type: string
description: >-
Total of all individual amounts included in the message,
irrespective of currencies. Upto 17 fractional digits. If
GroupReversal is true, then ControlSum is not allowed.
GrpRvsl:
type: boolean
description: >-
Indicates whether the reversal applies to the whole group of
transactions or to individual transactions within the original
group.A flag indicating a True or False value.
InitgPty:
type: object
description: >-
Party that initiates the reversal message.This can be either the
creditor or a party that initiates the reversal of the direct debit
on behalf of the creditor.
allOf:
- $ref: '#/components/schemas/PartyIdentification135'
FwdgAgt:
type: object
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification6
DbtrAgt:
type: object
description: Financial institution servicing an account for the debtor.
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification6
CdtrAgt:
type: object
description: Financial institution servicing an account for the creditor.
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification6
BranchAndFinancialInstitutionIdentification6:
required:
- FinInstnId
type: object
properties:
BrnchId:
$ref: '#/components/schemas/BranchData3'
FinInstnId:
$ref: '#/components/schemas/FinancialInstitutionIdentification18'
BranchData3:
required:
- Id
type: object
properties:
Id:
type: object
description: >-
Unique and unambiguous identification of a branch of a financial
institution.
allOf:
- $ref: '#/components/schemas/Max35Text'
LEI:
pattern: '[A-Z0-9]{18,18}[0-9]{2,2}'
type: string
description: >-
Legal entity identification for the branch of the financial
institution.Legal Entity Identifier is a code allocated to a party
as described in ISO 17442 Financial Services - Legal Entity
Identifier (LEI).
Nm:
type: object
description: >-
Name by which an agent is known and which is usually used to
identify that agent.
allOf:
- $ref: '#/components/schemas/Max140Text'
PstlAdr:
type: object
allOf:
- $ref: '#/components/schemas/PostalAddress24'
description: Identifies a specific branch of a financial institution.
FinancialInstitutionIdentification18:
required:
- Nm
type: object
properties:
BICFI:
pattern: '[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}'
type: string
description: >-
Code allocated to a financial institution by the ISO 9362
Registration Authority as described in ISO 9362 "Banking - Banking
telecommunication messages - Business identifier code (BIC)".
ClrSysMmbId:
$ref: '#/components/schemas/ClearingSystemMemberIdentification2'
LEI:
pattern: '[A-Z0-9]{18,18}[0-9]{2,2}'
type: string
description: Legal entity identifier of the financial institution.
Nm:
type: object
description: >-
Name by which an agent is known and which is usually used to
identify that agent.
allOf:
- $ref: '#/components/schemas/Max140Text'
PstlAdr:
type: object
allOf:
- $ref: '#/components/schemas/PostalAddress24'
Othr:
type: object
allOf:
- $ref: '#/components/schemas/GenericFinancialIdentification1'
description: >-
Unique and unambiguous identification of a financial institution, as
assigned under an internationally recognised or proprietary
identification scheme.
GenericFinancialIdentification1:
required:
- Id
type: object
properties:
Id:
type: object
description: Unique and unambiguous identification of a person.
allOf:
- $ref: '#/components/schemas/Max35Text'
Issr:
type: object
description: Entity that assigns the identification.
allOf:
- $ref: '#/components/schemas/Max35Text'
SchmeNm:
$ref: '#/components/schemas/FinancialIdentificationSchemeName1Choice'
description: >-
Unique identification of an agent, as assigned by an institution, using
an identification scheme.
FinancialIdentificationSchemeName1Choice:
type: object
properties:
Cd:
maxLength: 4
minLength: 1
type: string
description: >-
Specifies the external financial institution identification scheme
name code in the format of character string with a maximum length of
4 characters.The list of valid codes is an external code list
published separately.
Prtry:
type: object
description: Name of the identification scheme, in a free text form.
allOf:
- $ref: '#/components/schemas/Max35Text'
description: >-
Name of the identification scheme. Either Code or Proprietary field
value should be passed on request.
ClearingSystemMemberIdentification2:
required:
- MmbId
type: object
properties:
ClrSysId:
type: object
properties:
Cd:
maxLength: 5
minLength: 1
type: string
description: >-
It Specifies the clearing system identification code, as
published in an external clearing system identification code
list.
Prtry:
type: object
description: >-
Identification code for a clearing system, that has not yet been
identified in the list of clearing systems.
allOf:
- $ref: '#/components/schemas/Max35Text'
description: >-
Specification of a pre-agreed offering between clearing agents or
the channel through which the payment instruction is
processed.Either from Code Or Proprietary is required
MmbId:
type: object
description: Identification of a member of a clearing system.
allOf:
- $ref: '#/components/schemas/Max35Text'
description: Information used to identify a member within a clearing system.
Authorisation1Choice:
type: object
properties:
Cd:
type: object
description: >-
Specifies the level of approval depending on a number of factors,
including payment type, threshold amount or local country or
operations practice.
AUTH : Indicates a file has been
pre authorised or approved within the originating customer
environment and no further approval is required.
FDET
: Indicates that a file requires additional file level approval,
with the ability to view both the payment information block and
supporting customer credit transaction detail.
FSUM :
Indicates that a file requires additional file level approval, with
the ability to view only the payment information block level
information.
ILEV : Indicates that a file requires
all customer transactions to be authorised or approved.
allOf:
- $ref: '#/components/schemas/Authorisation1Code'
Prtry:
maxLength: 128
minLength: 1
type: string
description: Specifies the proprietary description
description: Either of Code or Proprietary is required.
Authorisation1Code:
type: string
description: >-
AUTH : Indicates a file has been pre authorised or
approved within the originating customer environment and no further
approval is required.
FDET : Indicates that a file
requires additional file level approval, with the ability to view both
the payment information block and supporting customer credit transaction
detail.
FSUM : Indicates that a file requires additional
file level approval, with the ability to view only the payment
information block level information.
ILEV : Indicates
that a file requires all customer transactions to be authorised or
approved.
enum:
- AUTH
- FDET
- FSUM
- ILEV
PartyIdentification135:
type: object
properties:
Nm:
type: object
description: >-
Name by which a party is known and which is usually used to identify
that party.
allOf:
- $ref: '#/components/schemas/Max140Text'
PstlAdr:
type: object
description: >-
Information that locates and identifies a specific address, as
defined by postal services.
allOf:
- $ref: '#/components/schemas/PostalAddress24'
Id:
type: object
description: >-
Unique and unambiguous identification of a party. Should pass EITHER
OrgId or PrvtId for organisation and private respectively.
allOf:
- $ref: '#/components/schemas/Party38Choice'
CtryOfRes:
type: object
description: >-
Country in which a person resides (the place of a person's home). In
the case of a company, it is the country from which the affairs of
that company are directed.
allOf:
- $ref: '#/components/schemas/CountryCode'
CtctDtls:
type: object
description: Set of elements used to indicate how to contact the party.
allOf:
- $ref: '#/components/schemas/Contact4'
NamePrefix2Code:
type: string
description: >-
Specifies the terms used to formally address a person.
DOCT : Title of the person is Doctor or Dr.
MIST : Title of the person is Mister or Mr.
MISS : Title of the person is Miss.
MADM :
Title of the person is Madam.
MIKS : Title of the person
is Gender Neutral.
enum:
- DOCT
- MIST
- MISS
- MADM
- MIKS
Contact4:
type: object
properties:
NmPrfx:
type: object
allOf:
- $ref: '#/components/schemas/NamePrefix2Code'
Nm:
type: object
description: >-
Name by which a party is known and which is usually used to identify
that party.
allOf:
- $ref: '#/components/schemas/Max140Text'
PhneNb:
type: object
description: >-
Collection of information that identifies a phone number, as defined
by telecom services.
allOf:
- $ref: '#/components/schemas/PhoneNumber'
MobNb:
type: object
description: >-
Collection of information that identifies a mobile phone number, as
defined by telecom services.
allOf:
- $ref: '#/components/schemas/PhoneNumber'
FaxNb:
type: object
description: >-
Collection of information that identifies a FAX number, as defined
by telecom services.
allOf:
- $ref: '#/components/schemas/PhoneNumber'
EmailAdr:
type: object
description: Address for electronic mail (e-mail).
allOf:
- $ref: '#/components/schemas/Max2048Text'
EmailPurp:
maxLength: 35
minLength: 1
type: string
description: Purpose for which an email address may be used.
JobTitl:
maxLength: 35
minLength: 1
type: string
description: Title of the function.
Rspnsblty:
maxLength: 35
minLength: 1
type: string
description: Role of a person in an organisation.
Dept:
maxLength: 35
minLength: 1
type: string
description: Identification of a division of a large organisation or building.
Othr:
type: array
description: >-
Contact details in another form.Communication device number or
electronic address used for communication.
items:
$ref: '#/components/schemas/OtherContact1'
PrefrdMtd:
type: object
allOf:
- $ref: '#/components/schemas/PreferredContactMethod1Code'
description: Set of elements used to indicate how to contact the party.
PreferredContactMethod1Code:
type: string
description: >-
Preferred method used to reach the individual contact within an
organisation.
LETT : Preferred method used to reach the
contact is per letter.
FAXX : Preferred method used to
reach the contact is per fax.
PHON : Preferred method used
to reach the contact is per phone.
MAIL : Preferred
method used to reach the contact is per Email .
CELL :
Preferred method used to reach the contact is per mobile or cell phone.
enum:
- LETT
- FAXX
- PHON
- MAIL
- CELL
OtherContact1:
required:
- ChanlTp
type: object
properties:
ChanlTp:
maxLength: 4
minLength: 1
type: string
description: >-
Method used to contact the financial institution’s contact for the
specific tax region.
Id:
maxLength: 128
minLength: 1
type: string
description: Communication value such as phone number or email address.
PhoneNumber:
pattern: \+[0-9]{1,3}-[0-9()+\-]{1,30}
type: string
Party38Choice:
type: object
properties:
OrgId:
type: object
allOf:
- $ref: '#/components/schemas/OrganisationIdentification29'
PrvtId:
type: object
allOf:
- $ref: '#/components/schemas/PersonIdentification13'
description: >-
Either of Organisation Identification or Private Identification is
required
OrganisationIdentification29:
type: object
properties:
AnyBIC:
pattern: '[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}'
type: string
description: >-
Business identification code of the organisation.Code allocated to a
financial or non-financial institution by the ISO 9362 Registration
Authority, as described in ISO 9362: 2014 - Banking - Banking
telecommunication messages - Business identifier code (BIC).Only a
valid Business identifier code is allowed. Business identifier codes
for financial or non-financial institutions are registered and
published by the ISO 9362 Registration Authority in the ISO
directory of BICs, and consists of eight (8) or eleven (11)
contiguous characters.
LEI:
pattern: '[A-Z0-9]{18,18}[0-9]{2,2}'
type: string
description: >-
Legal entity identification as an alternate identification for a
party.Legal Entity Identifier is a code allocated to a party as
described in ISO 17442. Financial Services - Legal Entity Identifier
(LEI)
Othr:
type: array
description: >-
Unique identification of an organisation, as assigned by an
institution, using an identification scheme.Information related to
an identification of an organisation.
items:
$ref: '#/components/schemas/GenericOrganisationIdentification1'
description: Unique and unambiguous way to identify an organisation.
GenericOrganisationIdentification1:
required:
- Id
type: object
properties:
Id:
maxLength: 35
minLength: 1
type: string
SchmeNm:
type: object
allOf:
- $ref: '#/components/schemas/OrganisationIdentificationSchemeName1Choice'
Issr:
maxLength: 35
minLength: 1
type: string
description: >-
Unique identification of an organisation, as assigned by an institution,
using an identification scheme.
OrganisationIdentificationSchemeName1Choice:
type: object
properties:
Cd:
maxLength: 4
minLength: 1
type: string
description: >-
Specifies the external organisation identification scheme name code
in the format of character string with a maximum length of 4
characters.The list of valid codes is an external code list
published separately.
Prtry:
maxLength: 35
minLength: 1
type: string
description: Description for Proprietary
description: >-
Name of the identification scheme.Sets of elements to identify a name of
the organisation identification scheme. Either Code or Proprietary is
required
PersonIdentification13:
type: object
properties:
DtAndPlcOfBirth:
$ref: '#/components/schemas/DateAndPlaceOfBirth1'
Othr:
type: array
description: >-
Unique identification of a person, as assigned by an institution,
using an identification scheme.
items:
$ref: '#/components/schemas/GenericPersonIdentification1'
description: >-
Unique and unambiguous identification of a person, for example a
passport.
DateAndPlaceOfBirth1:
required:
- BirthDt
- CityOfBirth
- CtryOfBirth
type: object
properties:
BirthDt:
type: object
description: Date on which a person is born.
allOf:
- $ref: '#/components/schemas/ISODate'
PrvcOfBirth:
type: object
description: Province where a person was born.
allOf:
- $ref: '#/components/schemas/Max35Text'
CityOfBirth:
type: object
description: City where a person was born.
allOf:
- $ref: '#/components/schemas/Max35Text'
CtryOfBirth:
type: object
description: >-
Country where a person was born.Code to identify a country, a
dependency, or another area of particular geopolitical interest, on
the basis of country names obtained from the United Nations (ISO
3166, Alpha-2 code).
allOf:
- $ref: '#/components/schemas/CountryCode'
description: Date and place of birth of a person.
GenericPersonIdentification1:
required:
- Id
type: object
properties:
Id:
maxLength: 35
minLength: 1
type: string
description: Unique and unambiguous identification of a person.
Issr:
maxLength: 35
minLength: 1
type: string
description: Entity that assigns the identification.
SchmeNm:
type: object
description: >-
Name of the identification scheme.Sets of elements to identify a
name of the identification scheme. Either Code or Proprietary is
required
allOf:
- $ref: '#/components/schemas/PersonIdentificationSchemeName1Choice'
description: >-
Unique identification of a person, as assigned by an institution, using
an identification scheme.
PersonIdentificationSchemeName1Choice:
type: object
properties:
Cd:
maxLength: 4
minLength: 1
type: string
description: >-
Specifies the external person identification scheme name code in the
format of character string with a maximum length of 4 characters.The
list of valid codes is an external code list published separately.
Prtry:
maxLength: 35
minLength: 1
type: string
description: Description of Propreitary
description: Either Code or Proprietary is required
ISODate:
type: string
format: date
Max2048Text:
maxLength: 2048
minLength: 1
type: string
Max140Text:
maxLength: 140
minLength: 1
type: string
PostalAddress24:
type: object
properties:
AdrLine:
maxItems: 7
type: array
description: >-
Information that locates and identifies a specific address, as
defined by postal services, presented in free format text.
items:
type: string
AdrTp:
type: object
description: >-
Identifies the nature of the postal address.Either Code or
Proprietary is required
allOf:
- $ref: '#/components/schemas/AddressType3Choice'
BldgNm:
maxLength: 35
minLength: 1
type: string
description: Name of the building or house.
BldgNb:
type: object
description: Number that identifies the position of a building on a street.
allOf:
- $ref: '#/components/schemas/Max16Text'
Ctry:
$ref: '#/components/schemas/CountryCode'
CtrySubDvsn:
type: object
description: Identifies a subdivision of a country such as state, region, county.
allOf:
- $ref: '#/components/schemas/Max35Text'
Dept:
type: object
description: Identification of a division of a large organisation or building.
allOf:
- $ref: '#/components/schemas/Max70Text'
PstCd:
type: object
description: >-
Identifier consisting of a group of letters and/or numbers that is
added to a postal address to assist the sorting of mail.
allOf:
- $ref: '#/components/schemas/Max16Text'
StrtNm:
type: object
description: Name of a street or thoroughfare.
allOf:
- $ref: '#/components/schemas/Max70Text'
SubDept:
type: object
description: >-
Identification of a sub-division of a large organisation or
building.
allOf:
- $ref: '#/components/schemas/Max70Text'
TwnNm:
type: object
description: >-
Name of a built-up area, with defined boundaries, and a local
government.
allOf:
- $ref: '#/components/schemas/Max35Text'
TwnLctnNm:
maxLength: 35
minLength: 1
type: string
description: Specific location name within the town.
PstBx:
maxLength: 16
minLength: 1
type: string
description: >-
Name of a built-up area, with defined boundaries, and a local
government.
Flr:
maxLength: 70
minLength: 1
type: string
description: Floor or storey within a building.
Room:
maxLength: 70
minLength: 1
type: string
description: Building room number.
DstrctNm:
maxLength: 35
minLength: 1
type: string
description: Identifies a subdivision within a country sub-division.
description: >-
Information that locates and identifies a specific address, as defined
by postal services.
CountryCode:
pattern: '[A-Z]{2,2}'
type: string
description: >-
Nation with its own government. The code is checked against the list of
country names obtained from the United Nations (ISO 3166, Alpha-2 code).
AddressType3Choice:
type: object
properties:
Cd:
type: object
description: >-
Specifies the type of address.
ADDR : Address is the
complete postal address.
PBOX : Address is a postal
office (PO) box.
HOME : Address is the home address.
BIZZ : Address is the business
address.
MLTO : Address is the address to which mail
is sent.
DLVY : Address is the address to which
delivery is to take place.
allOf:
- $ref: '#/components/schemas/AddressType2Code'
Prtry:
type: object
description: >-
Information related to an identification, for example, party
identification or account identification.
allOf:
- $ref: '#/components/schemas/GenericIdentification30'
description: Either from Code or Proprietary is required
GenericIdentification30:
required:
- Id
- Issr
type: object
properties:
Id:
pattern: '[a-zA-Z0-9]{4}'
type: string
description: >-
Proprietary information, often a code, issued by the data source
scheme issuer.
Issr:
maxLength: 35
minLength: 1
type: string
description: Entity that assigns the identification.
SchmeNm:
maxLength: 35
minLength: 1
type: string
description: Short textual description of the scheme.
AddressType2Code:
type: string
description: >-
ADDR : Address is the complete postal address.
PBOX : Address is a postal office (PO) box.
HOME : Address is the home address.
BIZZ :
Address is the business address.
MLTO : Address is the
address to which mail is sent.
DLVY : Address is the
address to which delivery is to take place.
enum:
- ADDR
- PBOX
- HOME
- BIZZ
- MLTO
- DLVY
Max70Text:
maxLength: 70
minLength: 1
type: string
Max35Text:
maxLength: 35
minLength: 1
type: string
Max16Text:
maxLength: 16
minLength: 1
type: string
CustomerDirectDebitInitiationV02:
required:
- GrpHdr
- PmtInf
type: object
properties:
GrpHdr:
$ref: '#/components/schemas/GroupHeader39'
PmtInf:
minItems: 1
type: array
description: >-
Set of characteristics that apply to the debit side of the payment
transactions included in the credit transfer initiation.
items:
$ref: '#/components/schemas/PaymentInstructionInformation4'
description: >-
The CustomerDirectDebitInitiation message is sent by the initiating
party to the forwarding agent or creditor agent. It is used to request
single or bulk collection(s) of funds from one or various debtor's
account(s) for a creditor.
BranchAndFinancialInstitutionIdentification4:
required:
- FinInstnId
type: object
properties:
BrnchId:
$ref: '#/components/schemas/BranchData2'
FinInstnId:
$ref: '#/components/schemas/FinancialInstitutionIdentification7'
BranchData2:
type: object
properties:
Id:
type: object
description: >-
Unique and unambiguous identification of a branch of a financial
institution.
allOf:
- $ref: '#/components/schemas/Max35Text'
Nm:
type: object
description: >-
Name by which an agent is known and which is usually used to
identify that agent.
allOf:
- $ref: '#/components/schemas/Max140Text'
PstlAdr:
$ref: '#/components/schemas/PostalAddress6'
description: Identifies a specific branch of a financial institution.
CashAccount16:
required:
- Id
type: object
properties:
Ccy:
type: object
description: Identification of the currency in which the account is held.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
Id:
$ref: '#/components/schemas/AccountIdentification4Choice'
Nm:
type: object
description: >-
Name of the account, as assigned by the account servicing
institution, in agreement with the account owner in order to provide
an additional means of identification of the account.
allOf:
- $ref: '#/components/schemas/Max70Text'
Tp:
$ref: '#/components/schemas/CashAccountType2'
CashAccountType2:
type: object
properties:
Cd:
$ref: '#/components/schemas/CashAccountType4Code'
Prtry:
type: object
description: Nature or use of the account in a proprietary form.
allOf:
- $ref: '#/components/schemas/Max35Text'
description: >-
Specifies the nature, or use of the account. Either Code or Proprietary
field value should be passed on request.
CashAccountType4Code:
type: string
description: >-
Account type, in a coded form.
CASH : Account used for
the payment of cash.
CHAR : Account used for charges if
different from the account for payment.
COMM : Account
used for commission if different from the account for payment.
TAXE : Account used for taxes if different from the
account for payment.
CISH : Account used for payment of
income if different from the current cash account.
TRAS :
Account used for trading if different from the current cash account.
SACC : Account used to post debit and credit entries, as
a result of transactions cleared and settled through a specific clearing
and settlement system.
CACC : Account used to post debits
and credits when no specific account has been nominated.
SVGS : Account used for savings.
ONDP :
Account used for overnight deposits.
MGLD : Account used
for a marginal lending facility.
NREX : Account used for
non-resident external.
MOMA : Account used for money
markets if different from the cash account.
LOAN :
Account used for loans.
SLRY : Accounts used for salary
payments.
ODFT : Account is used for overdrafts.
enum:
- CASH
- CHAR
- COMM
- TAXE
- CISH
- TRAS
- SACC
- CACC
- SVGS
- ONDP
- MGLD
- NREX
- MOMA
- LOAN
- SLRY
- ODFT
DirectDebitTransaction6:
type: object
properties:
MndtRltdInf:
$ref: '#/components/schemas/MandateRelatedInformation6'
CdtrSchmeId:
type: object
description: Credit party that signs the mandate.
allOf:
- $ref: '#/components/schemas/PartyIdentification32'
PreNtfctnId:
type: object
description: >-
Unique and unambiguous identification of the pre-notification which
is sent separately from the direct debit instruction.
allOf:
- $ref: '#/components/schemas/Max35Text'
PreNtfctnDt:
type: object
description: >-
Date on which the creditor notifies the debtor about the amount and
date on which the direct debit instruction will be presented to the
debtor's agent.
allOf:
- $ref: '#/components/schemas/ISODate'
description: >-
Set of elements providing information specific to the direct debit
mandate.
DirectDebitTransactionInformation9:
required:
- DbtrAcct
- DbtrAgt
- InstdAmt
- PmtId
type: object
properties:
PmtId:
$ref: '#/components/schemas/PaymentIdentification1'
PmtTpInf:
$ref: '#/components/schemas/PaymentTypeInformation20'
InstdAmt:
type: object
description: >-
Amount of money to be moved between the debtor and creditor, before
deduction of charges, expressed in the currency as ordered by the
initiating party.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
ChrgBr:
$ref: '#/components/schemas/ChargeBearerType1Code'
DrctDbtTx:
$ref: '#/components/schemas/DirectDebitTransaction6'
UltmtCdtr:
type: object
description: Ultimate party to which an amount of money is due.
allOf:
- $ref: '#/components/schemas/PartyIdentification32'
Dbtr:
type: object
description: Party that owes an amount of money to the (ultimate) creditor.
allOf:
- $ref: '#/components/schemas/PartyIdentification32'
DbtrAcct:
type: object
description: >-
Unambiguous identification of the account of the debtor to which a
debit entry will be made as a result of the transaction.
allOf:
- $ref: '#/components/schemas/CashAccount16'
DbtrAgt:
type: object
description: Financial institution servicing an account for the debtor.
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification4
DbtrAgtAcct:
type: object
description: >-
Unambiguous identification of the account of the debtor agent at its
servicing agent in the payment chain.
allOf:
- $ref: '#/components/schemas/CashAccount16'
UltmtDbtr:
type: object
description: >-
Ultimate party that owes an amount of money to the (ultimate)
creditor.
allOf:
- $ref: '#/components/schemas/PartyIdentification32'
InstrForCdtrAgt:
type: object
description: >-
Further information, related to the processing of the payment
instruction, that may need to be acted upon by the creditor agent,
depending on agreement between creditor and the creditor agent.
allOf:
- $ref: '#/components/schemas/Max140Text'
Purp:
$ref: '#/components/schemas/Purpose2Choice'
RgltryRptg:
maxItems: 10
type: array
description: Information needed due to regulatory and statutory requirements.
items:
$ref: '#/components/schemas/RegulatoryReporting3'
Tax:
$ref: '#/components/schemas/TaxInformation3'
RltdRmtInf:
maxItems: 10
type: array
description: >-
Set of elements used to provide information related to the handling
of the remittance information by any of the agents in the
transaction processing chain.
items:
$ref: '#/components/schemas/RemittanceLocation2'
RmtInf:
type: object
description: >-
Information supplied to enable the matching of an entry with the
items that the transfer is intended to settle, such as commercial
invoices in an accounts' receivable system.
allOf:
- $ref: '#/components/schemas/RemittanceInformation5'
GroupHeader39:
required:
- CreDtTm
- InitgPty
- MsgId
- NbOfTxs
type: object
properties:
CtrlSum:
maxLength: 18
type: string
description: >-
Total of all individual amounts included in the message,
irrespective of currencies. The number of fractional digits should
not be more than 17.
CreDtTm:
type: string
description: Date and time at which the message was created.
format: date-time
FwdgAgt:
type: object
description: >-
Financial institution that receives the instruction from the
initiating party and forwards it to the next agent in the payment
chain for execution.
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification4
InitgPty:
type: object
description: >-
Party that initiates the payment. This can either be the debtor or
the party that initiates the credit transfer on behalf of the
debtor.
allOf:
- $ref: '#/components/schemas/PartyIdentification32'
MsgId:
maxLength: 35
minLength: 1
type: string
description: >-
Point to point reference, as assigned by the instructing party, and
sent to the next party in the chain to unambiguously identify the
message.
NbOfTxs:
type: object
description: Number of individual transactions contained in the message.
allOf:
- $ref: '#/components/schemas/Max15NumericText'
Authstn:
maxItems: 2
type: array
description: >-
User identification or any user key to be used to check whether the
initiating party is allowed to initiate transactions from the
account specified in the message.
items:
$ref: '#/components/schemas/Authorisation1Choice'
description: >-
Group header details. Set of characteristics shared by all individual
transactions included in the message.
PaymentInstructionInformation4:
required:
- Cdtr
- CdtrAcct
- CdtrAgt
- DrctDbtTxInf
- PmtInfId
- PmtMtd
- ReqdColltnDt
type: object
properties:
BtchBookg:
type: boolean
description: >-
Identifies whether a single entry per individual transaction or a
batch entry for the sum of the amounts of all transactions within
the group of a message is requested.
ChrgBr:
$ref: '#/components/schemas/ChargeBearerType1Code'
ChrgsAcct:
type: object
description: Account used to process charges associated with a transaction.
allOf:
- $ref: '#/components/schemas/CashAccount16'
ChrgsAcctAgt:
type: object
description: Agent that services a charges account.
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification4
CtrlSum:
maxLength: 18
type: string
description: >-
Total of all individual amounts included in the group, irrespective
of currencies. The number of fractional digits should not be more
than 17.
DrctDbtTxInf:
minItems: 1
type: array
description: >-
Set of elements used to provide information on the individual
transaction(s) included in the message.
items:
$ref: '#/components/schemas/DirectDebitTransactionInformation9'
Cdtr:
type: object
description: Party to which an amount of money is due.
allOf:
- $ref: '#/components/schemas/PartyIdentification32'
CdtrAcct:
type: object
description: >-
Unambiguous identification of the account of the creditor to which a
credit entry will be posted as a result of the payment transaction.
allOf:
- $ref: '#/components/schemas/CashAccount16'
CdtrAgt:
type: object
description: Financial institution servicing an account for the creditor.
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification4
CdtrAgtAcct:
type: object
description: >-
Unambiguous identification of the account of the creditor agent at
its servicing agent in the payment chain.
allOf:
- $ref: '#/components/schemas/CashAccount16'
NbOfTxs:
pattern: '[0-9]{1,15}'
type: string
description: >-
Number of individual transactions contained in the paymnet
information group.
PmtInfId:
type: object
description: >-
Unique identification, as assigned by a sending party, to
unambiguously identify the payment information group within the
message.
allOf:
- $ref: '#/components/schemas/Max35Text'
PmtMtd:
type: string
description: >-
Specifies the means of payment that will be used to move the amount
of money.
DD : Collection of an amount of money from
the debtor's bank account by the creditor. The amount of money and
dates of collections may vary.
enum:
- DD
PmtTpInf:
$ref: '#/components/schemas/PaymentTypeInformation20'
CdtrSchmeId:
type: object
description: Credit party that signs the mandate.
allOf:
- $ref: '#/components/schemas/PartyIdentification32'
ReqdColltnDt:
type: string
description: >-
Date and time at which the creditor requests that the amount of
money is to be collected from the debtor.
format: date
UltmtCdtr:
type: object
description: Ultimate party to which an amount of money is due.
allOf:
- $ref: '#/components/schemas/PartyIdentification32'
PaymentTypeInformation20:
type: object
properties:
CtgyPurp:
$ref: '#/components/schemas/CategoryPurpose1Choice'
InstrPrty:
$ref: '#/components/schemas/Priority2Code'
LclInstrm:
$ref: '#/components/schemas/LocalInstrument2Choice'
SvcLvl:
$ref: '#/components/schemas/ServiceLevel8Choice'
SeqTp:
$ref: '#/components/schemas/SequenceType1Code'
description: Set of elements used to further specify the type of transaction.
SequenceType1Code:
type: string
description: >-
Identifies the direct debit sequence, such as first, recurrent, final or
one-off.
FRST : First collection of a series of direct
debit instructions.
RCUR : Direct debit instruction where
the debtor's authorisation is used for regular direct debit transactions
initiated by the creditor.
FNAL : Final collection of a
series of direct debit instructions.
OOFF : Direct debit
instruction where the debtor's authorisation is used to initiate one
single direct debit transaction.
enum:
- FRST
- RCUR
- FNAL
- OOFF
AmountType3Choice:
type: object
properties:
EqvtAmt:
$ref: '#/components/schemas/EquivalentAmount2'
InstdAmt:
type: object
description: >-
Amount of money to be moved between the debtor and creditor, before
deduction of charges, expressed in the currency as ordered by the
initiating party.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
description: >-
Amount of money to be moved between the debtor and creditor, before
deduction of charges, expressed in the currency as ordered by the
initiating party. Either EqvtAmt or InstdAmt field value should be
passed on request.
BaseOneRate:
maxLength: 11
type: string
description: >-
The factor used for conversion of an amount from one currency to
another. This reflects the price at which one currency was bought with
another currency.
Cheque6:
type: object
properties:
ChqFr:
type: object
description: Identifies the party that ordered the issuance of the cheque.
allOf:
- $ref: '#/components/schemas/NameAndAddress10'
ChqMtrtyDt:
type: object
description: >-
Date when the draft becomes payable and the debtor's account is
debited.
allOf:
- $ref: '#/components/schemas/ISODate'
ChqNb:
type: object
description: >-
Unique and unambiguous identifier for a cheque as assigned by the
agent.
allOf:
- $ref: '#/components/schemas/Max35Text'
ChqTp:
$ref: '#/components/schemas/ChequeType2Code'
DlvrTo:
type: object
description: Party to whom the debtor's agent needs to send the cheque.
allOf:
- $ref: '#/components/schemas/NameAndAddress10'
DlvryMtd:
$ref: '#/components/schemas/ChequeDeliveryMethod1Choice'
FrmsCd:
type: object
description: >-
Identifies, in a coded form, the cheque layout, company logo and
digitised signature to be used to print the cheque, as agreed
between the initiating party and the debtor's agent.
allOf:
- $ref: '#/components/schemas/Max35Text'
InstrPrty:
type: object
description: >-
Urgency or order of importance that the originator would like the
recipient of the payment instruction to apply to the processing of
the payment instruction.
HIGH : Priority level is
high.
NORM : Priority level is normal.
allOf:
- $ref: '#/components/schemas/Priority2Code'
MemoFld:
maxItems: 2
type: array
description: >-
Information that needs to be printed on a cheque, used by the payer
to add miscellaneous information.
items:
$ref: '#/components/schemas/Max35Text'
PrtLctn:
type: object
description: Specifies the print location of the cheque.
allOf:
- $ref: '#/components/schemas/Max35Text'
RgnlClrZone:
type: object
description: >-
Regional area in which the cheque can be cleared, when a country has
no nation-wide cheque clearing organisation.
allOf:
- $ref: '#/components/schemas/Max35Text'
description: Set of elements needed to issue a cheque.
ChequeDelivery1Code:
type: string
description: >-
Specifies the delivery method of the cheque by the debtor's agent.
MLDB : Cheque is to be sent through mail services to
debtor.
MLCD : Cheque is to be sent through mail services
to creditor.
MLFA : Cheque is to be sent through mail
services to creditor agent.
CRDB : Cheque is to be sent
through courier services to debtor.
CRCD : Cheque is to
be sent through courier services to creditor.
CRFA :
Cheque is to be sent through courier services to creditor agent.
PUDB : Cheque will be picked up by the debtor.
PUCD : Cheque will be picked up by the creditor.
PUFA : Cheque will be picked up by the creditor agent.
RGDB : Cheque is to be sent through registered mail
services to debtor.
RGCD : Cheque is to be sent through
registered mail services to creditor.
RGFA : Cheque is to
be sent through registered mail services to creditor agent.
enum:
- MLDB
- MLCD
- MLFA
- CRDB
- CRCD
- CRFA
- PUDB
- PUCD
- PUFA
- RGDB
- RGCD
- RGFA
ChequeDeliveryMethod1Choice:
type: object
properties:
Cd:
$ref: '#/components/schemas/ChequeDelivery1Code'
Prtry:
type: object
description: >-
Specifies a proprietary delivery method of the cheque by the
debtor's agent.
allOf:
- $ref: '#/components/schemas/Max35Text'
description: Specifies the delivery method of the cheque by the debtor's agent.
ChequeType2Code:
type: string
description: >-
Specifies the type of cheque to be issued.
CCHQ : Cheque
drawn on the account of the debtor, and debited on the debtor's account
when the cheque is cashed. Synonym is 'corporate cheque'.
CCCH : Cheque drawn on the account of the debtor, and
debited on the debtor's account when the cheque is cashed. The financial
institution prints and certifies the cheque, guaranteeing the payment.
BCHQ : Cheque drawn on the account of the debtor's
financial institution, which is debited on the debtor's account when the
cheque is issued.These cheques are printed by the debtor's financial
institution and payment is guaranteed by the financial institution.
Synonym is 'cashier's cheque'.
DRFT : A guaranteed bank
cheque with a future value date (do not pay before], which in commercial
terms is a 'negotiatable instrument': the beneficiary can receive early
payment from any bank under subtraction of a discount. The ordering
customer's account is debited on value date.
ELDR : An
instrument with a future value date (do not pay before], which in
commercial terms is a 'negotiatable instrument': the beneficiary can
receive early payment from any bank under subtraction of a discount. The
ordering customer's account is debited on value date.
enum:
- CCHQ
- CCCH
- BCHQ
- DRFT
- ELDR
ContactDetails2:
type: object
properties:
EmailAdr:
type: object
description: Address for electronic mail (e-mail).
allOf:
- $ref: '#/components/schemas/Max2048Text'
FaxNb:
type: object
description: >-
Collection of information that identifies a FAX number, as defined
by telecom services.
allOf:
- $ref: '#/components/schemas/PhoneNumber'
MobNb:
type: object
description: >-
Collection of information that identifies a mobile phone number, as
defined by telecom services.
allOf:
- $ref: '#/components/schemas/PhoneNumber'
Nm:
type: object
description: >-
Name by which a party is known and which is usually used to identify
that party.
allOf:
- $ref: '#/components/schemas/Max140Text'
NmPrfx:
$ref: '#/components/schemas/NamePrefix1Code'
Othr:
type: object
description: Contact details in another form.
allOf:
- $ref: '#/components/schemas/Max35Text'
PhneNb:
type: object
description: >-
Collection of information that identifies a phone number, as defined
by telecom services.
allOf:
- $ref: '#/components/schemas/PhoneNumber'
description: Set of elements used to indicate how to contact the party.
CreditTransferTransactionInformation10:
required:
- Amt
- PmtId
type: object
properties:
Amt:
$ref: '#/components/schemas/AmountType3Choice'
ChrgBr:
$ref: '#/components/schemas/ChargeBearerType1Code'
ChqInstr:
$ref: '#/components/schemas/Cheque6'
Cdtr:
type: object
description: Party to which an amount of money is due.
allOf:
- $ref: '#/components/schemas/PartyIdentification32'
CdtrAcct:
type: object
description: >-
Unambiguous identification of the account of the creditor to which a
credit entry will be posted as a result of the payment transaction.
allOf:
- $ref: '#/components/schemas/CashAccount16'
CdtrAgt:
type: object
description: Financial institution servicing an account for the creditor.
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification4
CdtrAgtAcct:
type: object
description: >-
Unambiguous identification of the account of the creditor agent at
its servicing agent to which a credit entry will be made as a result
of the payment transaction.
allOf:
- $ref: '#/components/schemas/CashAccount16'
XchgRateInf:
$ref: '#/components/schemas/ExchangeRateInformation1'
InstrForCdtrAgt:
type: array
description: >-
Further information related to the processing of the payment
instruction, provided by the initiating party, and intended for the
creditor agent.
items:
$ref: '#/components/schemas/InstructionForCreditorAgent1'
InstrForDbtrAgt:
type: object
description: >-
Further information related to the processing of the payment
instruction, that may need to be acted upon by the debtor agent,
depending on agreement between debtor and the debtor agent.
allOf:
- $ref: '#/components/schemas/Max140Text'
IntrmyAgt1:
type: object
description: Agent between the debtor's agent and the creditor's agent.
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification4
IntrmyAgt1Acct:
type: object
description: >-
Unambiguous identification of the account of the intermediary agent
1 at its servicing agent in the payment chain.
allOf:
- $ref: '#/components/schemas/CashAccount16'
IntrmyAgt2:
type: object
description: Agent between the debtor's agent and the creditor's agent.
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification4
IntrmyAgt2Acct:
type: object
description: >-
Unambiguous identification of the account of the intermediary agent
2 at its servicing agent in the payment chain.
allOf:
- $ref: '#/components/schemas/CashAccount16'
IntrmyAgt3:
type: object
description: Agent between the debtor's agent and the creditor's agent.
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification4
IntrmyAgt3Acct:
type: object
description: >-
Unambiguous identification of the account of the intermediary agent
3 at its servicing agent in the payment chain.
allOf:
- $ref: '#/components/schemas/CashAccount16'
PmtId:
$ref: '#/components/schemas/PaymentIdentification1'
PmtTpInf:
$ref: '#/components/schemas/PaymentTypeInformation19'
Purp:
$ref: '#/components/schemas/Purpose2Choice'
RgltryRptg:
maxItems: 10
type: array
description: Information needed due to regulatory and statutory requirements.
items:
$ref: '#/components/schemas/RegulatoryReporting3'
RltdRmtInf:
maxItems: 10
type: array
description: >-
Set of elements used to provide information related to the handling
of the remittance information by any of the agents in the
transaction processing chain.
items:
$ref: '#/components/schemas/RemittanceLocation2'
RmtInf:
type: object
description: >-
Information supplied to enable the matching of an entry with the
items that the transfer is intended to settle, such as commercial
invoices in an accounts' receivable system.
allOf:
- $ref: '#/components/schemas/RemittanceInformation5'
Tax:
$ref: '#/components/schemas/TaxInformation3'
UltmtCdtr:
type: object
description: Ultimate party to which an amount of money is due.
allOf:
- $ref: '#/components/schemas/PartyIdentification32'
UltmtDbtr:
type: object
description: >-
Ultimate party that owes an amount of money to the (ultimate)
creditor.
allOf:
- $ref: '#/components/schemas/PartyIdentification32'
CustomerCreditTransferInitiationV03:
required:
- GrpHdr
- PmtInf
type: object
properties:
GrpHdr:
$ref: '#/components/schemas/GroupHeader32'
PmtInf:
minItems: 1
type: array
description: >-
Set of characteristics that apply to the debit side of the payment
transactions included in the credit transfer initiation.
items:
$ref: '#/components/schemas/PaymentInstructionInformation3'
description: >-
The CustomerCreditTransferInitiation message is sent by the initiating
party to the forwarding agent or debtor agent. It is used to request
movement of funds from the debtor account to a creditor.
CustomerPaymentStatusReportV03:
required:
- GrpHdr
- OrgnlGrpInfAndSts
type: object
properties:
GrpHdr:
$ref: '#/components/schemas/GroupHeader36'
OrgnlGrpInfAndSts:
$ref: '#/components/schemas/OriginalGroupInformation20'
OrgnlPmtInfAndSts:
type: array
description: >-
Information concerning the original payment information, to which
the status report message refers.
items:
$ref: '#/components/schemas/OriginalPaymentInformation1'
OriginalGroupInformation20:
required:
- OrgnlMsgId
- OrgnlMsgNmId
type: object
properties:
OrgnlMsgId:
type: object
description: >-
Point to point reference, as assigned by the original instructing
party, to unambiguously identify the original message.
allOf:
- $ref: '#/components/schemas/Max35Text'
OrgnlMsgNmId:
type: object
description: >-
Specifies the original message name identifier to which the message
refers.
allOf:
- $ref: '#/components/schemas/Max35Text'
OrgnlCreDtTm:
type: string
description: Date and time at which the original message was created.
format: date-time
OrgnlNbOfTxs:
type: object
description: Number of individual transactions contained in the original message.
allOf:
- $ref: '#/components/schemas/Max15NumericText'
OrgnlCtrlSum:
maxLength: 18
type: string
description: >-
Total of all individual amounts included in the original message,
irrespective of currencies. The number of fractional digits should
not be more than 17.
GrpSts:
$ref: '#/components/schemas/TransactionGroupStatus3Code'
StsRsnInf:
type: array
description: >-
Set of elements used to provide detailed information on the status
reason.
items:
$ref: '#/components/schemas/StatusReasonInformation8'
NbOfTxsPerSts:
type: array
description: >-
Detailed information on the number of transactions for each
identical transaction status.
items:
$ref: '#/components/schemas/NumberOfTransactionsPerStatus3'
description: >-
Original group information concerning the group of transactions, to
which the status report message refers to.
OriginalPaymentInformation1:
required:
- OrgnlPmtInfId
type: object
properties:
OrgnlPmtInfId:
type: object
description: >-
Unique identification, as assigned by the original sending party, to
unambiguously identify the original payment information group.
allOf:
- $ref: '#/components/schemas/Max35Text'
OrgnlNbOfTxs:
type: object
description: >-
Number of individual transactions contained in the original payment
information group.
allOf:
- $ref: '#/components/schemas/Max15NumericText'
OrgnlCtrlSum:
maxLength: 18
type: string
description: >-
Total of all individual amounts included in the original payment
information group, irrespective of currencies. The number of
fractional digits should not be more than 17.
PmtInfSts:
type: object
description: >-
Specifies the status of the payment information
group.
ACTC : Authentication and syntactical and
semantical validation are successful.
RCVD : Payment
initiation has been received by the receiving agent.
PART : A number of transactions have been accepted,
whereas another number of transactions have not yet achieved
'accepted' status.
RJCT : Payment initiation or
individual transaction included in the payment initiation has been
rejected.
PDNG : Payment initiation or individual
transaction included in the payment initiation is pending. Further
checks and status update will be performed.
ACCP :
Preceding check of technical validation was successful. Customer
profile check was also successful.
ACSP : All
preceding checks such as technical validation and customer profile
were successful and therefore the payment initiation has been
accepted for execution.
ACSC : Settlement on the
debtor's account has been completed. Usage : this can be used by the
first agent to report to the debtor that the transaction has been
completed. Warning : this status is provided for transaction status
reasons, not for financial information. It can only be used after
bilateral agreement
ACWC : Instruction is accepted but
a change will be made, such as date or remittance not sent.
allOf:
- $ref: '#/components/schemas/TransactionGroupStatus3Code'
StsRsnInf:
type: array
description: >-
Set of elements used to provide detailed information on the status
reason.
items:
$ref: '#/components/schemas/StatusReasonInformation8'
NbOfTxsPerSts:
type: array
description: >-
Detailed information on the number of transactions for each
identical transaction status.
items:
$ref: '#/components/schemas/NumberOfTransactionsPerStatus3'
TxInfAndSts:
type: array
description: Payment transaction information and status.
items:
$ref: '#/components/schemas/PaymentTransactionInformation25'
StatusReasonInformation8:
type: object
properties:
Orgtr:
type: object
description: Party that issues the status.
allOf:
- $ref: '#/components/schemas/PartyIdentification32'
Rsn:
$ref: '#/components/schemas/StatusReason6Choice'
AddtlInf:
type: array
description: Further details on the status reason.
items:
$ref: '#/components/schemas/Max105Text'
StatusReason6Choice:
type: object
properties:
Cd:
maxLength: 4
minLength: 1
type: string
description: Reason for the status, as published in an external reason code list.
Prtry:
type: object
description: Reason for the status, in a proprietary form.
allOf:
- $ref: '#/components/schemas/Max35Text'
description: >-
Specifies the reason for the status report. Either Code or Proprietary
field value should be passed on request.
NumberOfTransactionsPerStatus3:
required:
- DtldNbOfTxs
- DtldSts
type: object
properties:
DtldNbOfTxs:
type: object
description: >-
Number of individual transactions contained in the message, detailed
per status.
allOf:
- $ref: '#/components/schemas/Max15NumericText'
DtldCtrlSum:
maxLength: 18
type: string
description: >-
Total of all individual amounts included in the message,
irrespective of currencies, detailed per status. The number of
fractional digits should not be more than 17
DtldSts:
$ref: '#/components/schemas/TransactionIndividualStatus3Code'
TransactionIndividualStatus3Code:
type: string
description: >-
Common transaction status for all individual transactions
reported.
ACTC : Authentication and syntactical and
semantical validation are successful.
RJCT : Payment
initiation or individual transaction included in the payment initiation
has been rejected.
PDNG : Payment initiation or individual
transaction included in the payment initiation is pending. Further
checks and status update will be performed.
ACCP :
Preceding check of technical validation was successful. Customer profile
check was also successful.
ACSP : All preceding checks
such as technical validation and customer profile were successful and
therefore the payment initiation has been accepted for
execution.
ACSC : Settlement on the debtor's account has
been completed. Usage : this can be used by the first agent to report to
the debtor that the transaction has been completed. Warning : this
status is provided for transaction status reasons, not for financial
information. It can only be used after bilateral
agreement
ACWC : Instruction is accepted but a change will
be made, such as date or remittance not sent.
enum:
- ACTC
- RJCT
- PDNG
- ACCP
- ACSP
- ACSC
- ACWC
TransactionGroupStatus3Code:
type: string
description: >-
Specifies the status of a group of transactions.
ACTC :
Authentication and syntactical and semantical validation are successful.
RCVD : Payment initiation has been received by the
receiving agent.
PART : A number of transactions have
been accepted, whereas another number of transactions have not yet
achieved 'accepted' status.
RJCT : Payment initiation or
individual transaction included in the payment initiation has been
rejected.
PDNG : Payment initiation or individual
transaction included in the payment initiation is pending. Further
checks and status update will be performed.
ACCP :
Preceding check of technical validation was successful. Customer profile
check was also successful.
ACSP : All preceding checks
such as technical validation and customer profile were successful and
therefore the payment initiation has been accepted for
execution.
ACSC : Settlement on the debtor's account has
been completed. Usage : this can be used by the first agent to report to
the debtor that the transaction has been completed. Warning : this
status is provided for transaction status reasons, not for financial
information. It can only be used after bilateral
agreement
ACWC : Instruction is accepted but a change will
be made, such as date or remittance not sent.
enum:
- ACTC
- RCVD
- PART
- RJCT
- PDNG
- ACCP
- ACSP
- ACSC
- ACWC
PaymentTransactionInformation25:
type: object
properties:
StsId:
type: object
description: >-
Unique identification, as assigned by an instructing party for an
instructed party, to unambiguously identify the reported status.
allOf:
- $ref: '#/components/schemas/Max35Text'
OrgnlInstrId:
type: object
description: >-
Unique identification, as assigned by the original instructing party
for the original instructed party, to unambiguously identify the
original instruction.
allOf:
- $ref: '#/components/schemas/Max35Text'
OrgnlEndToEndId:
type: object
description: >-
Unique identification, as assigned by the original initiating party,
to unambiguously identify the original transaction.
allOf:
- $ref: '#/components/schemas/Max35Text'
TxSts:
$ref: '#/components/schemas/TransactionIndividualStatus3Code'
StsRsnInf:
type: array
description: >-
Set of elements used to provide detailed information on the status
reason.
items:
$ref: '#/components/schemas/StatusReasonInformation8'
ChrgsInf:
type: array
description: >-
Provides information on the charges related to the processing of the
rejection of the instruction.
items:
$ref: '#/components/schemas/ChargesInformation5'
AccptncDtTm:
type: string
description: >-
Point in time when the payment order from the initiating party meets
the processing conditions of the account servicing agent. This means
that the account servicing agent has received the payment order and
has applied checks such as authorisation, availability of funds.
format: date-time
AcctSvcrRef:
type: object
description: >-
Unique reference, as assigned by the account servicing institution,
to unambiguously identify the instruction.
allOf:
- $ref: '#/components/schemas/Max35Text'
ClrSysRef:
type: object
description: >-
Unique reference, as assigned by a clearing system, to unambiguously
identify the instruction.
allOf:
- $ref: '#/components/schemas/Max35Text'
OrgnlTxRef:
$ref: '#/components/schemas/OriginalTransactionReference13'
ChargesInformation5:
required:
- Amt
- Pty
type: object
properties:
Amt:
type: object
description: Transaction charges to be paid by the charge bearer.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
Pty:
type: object
description: >-
Party that takes the transaction charges or to which the transaction
charges are due.
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification4
OriginalTransactionReference13:
type: object
properties:
IntrBkSttlmAmt:
type: object
description: >-
Amount of money moved between the instructing agent and the
instructed agent.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
Amt:
$ref: '#/components/schemas/AmountType3Choice'
IntrBkSttlmDt:
type: string
description: >-
Date on which the amount of money ceases to be available to the
agent that owes it and when the amount of money becomes available to
the agent to which it is due.
format: date
ReqdColltnDt:
type: string
description: >-
Date on which the creditor requests that the amount of money is to
be collected from the debtor.
format: date
ReqdExctnDt:
type: string
description: >-
Date at which the initiating party requests the clearing agent to
process the payment.
format: date
CdtrSchmeId:
type: object
description: Credit party that signs the mandate.
allOf:
- $ref: '#/components/schemas/PartyIdentification32'
SttlmInf:
$ref: '#/components/schemas/SettlementInformation13'
PmtTpInf:
$ref: '#/components/schemas/PaymentTypeInformation22'
PmtMtd:
$ref: '#/components/schemas/PaymentMethod4Code'
MndtRltdInf:
$ref: '#/components/schemas/MandateRelatedInformation6'
RmtInf:
$ref: '#/components/schemas/RemittanceInformation5'
UltmtDbtr:
type: object
description: >-
Ultimate party that owes an amount of money to the (ultimate)
creditor.
allOf:
- $ref: '#/components/schemas/PartyIdentification32'
Dbtr:
type: object
description: Party that owes an amount of money to the (ultimate) creditor.
allOf:
- $ref: '#/components/schemas/PartyIdentification32'
DbtrAcct:
type: object
description: >-
Unambiguous identification of the account of the debtor to which a
debit entry will be made as a result of the transaction.
allOf:
- $ref: '#/components/schemas/CashAccount16'
DbtrAgt:
type: object
description: Financial institution servicing an account for the debtor.
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification4
DbtrAgtAcct:
type: object
description: >-
Unambiguous identification of the account of the debtor agent at its
servicing agent in the payment chain.
allOf:
- $ref: '#/components/schemas/CashAccount16'
CdtrAgt:
type: object
description: Financial institution servicing an account for the creditor.
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification4
CdtrAgtAcct:
type: object
description: >-
Unambiguous identification of the account of the creditor agent at
its servicing agent to which a credit entry will be made as a result
of the payment transaction.
allOf:
- $ref: '#/components/schemas/CashAccount16'
Cdtr:
type: object
description: Party to which an amount of money is due.
allOf:
- $ref: '#/components/schemas/PartyIdentification32'
CdtrAcct:
type: object
description: >-
Unambiguous identification of the account of the creditor to which a
credit entry will be posted as a result of the payment transaction.
allOf:
- $ref: '#/components/schemas/CashAccount16'
UltmtCdtr:
type: object
description: Ultimate party to which an amount of money is due.
allOf:
- $ref: '#/components/schemas/PartyIdentification32'
description: >-
Set of key elements used to identify the original transaction that is
being referred to.
SettlementInformation13:
required:
- SttlmMtd
type: object
properties:
SttlmMtd:
$ref: '#/components/schemas/SettlementMethod1Code'
SttlmAcct:
type: object
description: >-
A specific purpose account used to post debit and credit entries as
a result of the transaction.
allOf:
- $ref: '#/components/schemas/CashAccount16'
InstgRmbrsmntAgtAcct:
type: object
description: >-
Unambiguous identification of the account of the instructing
reimbursement agent account at its servicing agent in the payment
chain.
allOf:
- $ref: '#/components/schemas/CashAccount16'
InstdRmbrsmntAgtAcct:
type: object
description: >-
Unambiguous identification of the account of the instructed
reimbursement agent account at its servicing agent in the payment
chain.
allOf:
- $ref: '#/components/schemas/CashAccount16'
ThrdRmbrsmntAgtAcct:
type: object
description: >-
Unambiguous identification of the account of the third reimbursement
agent account at its servicing agent in the payment chain.
allOf:
- $ref: '#/components/schemas/CashAccount16'
InstgRmbrsmntAgt:
type: object
description: >-
Agent through which the instructing agent will reimburse the
instructed agent.
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification4
InstdRmbrsmntAgt:
type: object
description: Agent at which the instructed agent will be reimbursed.
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification4
ThrdRmbrsmntAgt:
type: object
description: Agent at which the instructed agent will be reimbursed.
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification4
ClrSys:
$ref: '#/components/schemas/ClearingSystemIdentification3Choice'
description: >-
Specifies the details on how the settlement of the original
transaction(s) between the instructing agent and the instructed agent
was completed.
PaymentTypeInformation22:
type: object
properties:
InstrPrty:
$ref: '#/components/schemas/Priority2Code'
ClrChanl:
type: string
description: >-
Specifies the clearing channel to be used to process the payment
instruction.
RTGS : Clearing channel is a real-time
gross settlement system.
RTNS : Clearing channel is a
real-time net settlement system.
MPNS : Clearing
channel is a mass payment net settlement system.
BOOK
: Payment through internal book transfer.
enum:
- RTGS
- RTNS
- MPNS
- BOOK
SvcLvl:
$ref: '#/components/schemas/ServiceLevel8Choice'
LclInstrm:
$ref: '#/components/schemas/LocalInstrument2Choice'
SeqTp:
type: string
description: >-
Identifies the direct debit sequence, such as first, recurrent,
final or one-off.
FRST : First collection of a series
of direct debit instructions.
RCUR : Direct debit
instruction where the debtor's authorisation is used for regular
direct debit transactions initiated by the creditor.
FNAL : Final collection of a series of direct debit
instructions.
OOFF : Direct debit instruction where
the debtor's authorisation is used to initiate one single direct
debit transaction.
enum:
- FRST
- RCUR
- FNAL
- OOFF
CtgyPurp:
$ref: '#/components/schemas/CategoryPurpose1Choice'
description: Set of elements used to further specify the type of transaction.
MandateRelatedInformation6:
type: object
properties:
MndtId:
type: object
description: >-
Unique identification, as assigned by the creditor, to unambiguously
identify the mandate.
allOf:
- $ref: '#/components/schemas/Max35Text'
AmdmntInd:
type: boolean
description: >-
Indicator notifying whether the underlying mandate is amended or
not.
AmdmntInfDtls:
$ref: '#/components/schemas/AmendmentInformationDetails6'
ElctrncSgntr:
maxLength: 1025
minLength: 1
type: string
description: >-
Additional security provisions, such as a digital signature, as
provided by the debtor.
DtOfSgntr:
type: string
description: >-
Date on which the direct debit mandate has been signed by the
debtor.
format: date
FrstColltnDt:
type: string
description: Date of the first collection of a direct debit as per the mandate.
format: date
FnlColltnDt:
type: string
description: Date of the final collection of a direct debit as per the mandate.
format: date
Frqcy:
$ref: '#/components/schemas/Frequency1Code'
description: >-
Set of elements used to provide further details of the mandate signed
between the creditor and the debtor.
AmendmentInformationDetails6:
type: object
properties:
OrgnlMndtId:
type: object
description: >-
Unique identification, as assigned by the creditor, to unambiguously
identify the original mandate.
allOf:
- $ref: '#/components/schemas/Max35Text'
OrgnlCdtrSchmeId:
type: object
description: Original creditor scheme identification that has been modified.
allOf:
- $ref: '#/components/schemas/PartyIdentification32'
OrgnlDbtr:
type: object
description: Original debtor that has been modified.
allOf:
- $ref: '#/components/schemas/PartyIdentification32'
OrgnlDbtrAcct:
type: object
description: Original debtor account that has been modified.
allOf:
- $ref: '#/components/schemas/CashAccount16'
OrgnlDbtrAgt:
type: object
description: Original debtor agent that has been modified.
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification4
OrgnlDbtrAgtAcct:
type: object
description: Original debtor agent account that has been modified.
allOf:
- $ref: '#/components/schemas/CashAccount16'
OrgnlCdtrAgt:
type: object
description: Original creditor agent that has been modified.
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification4
OrgnlCdtrAgtAcct:
type: object
description: Original creditor agent acount that has been modified.
allOf:
- $ref: '#/components/schemas/CashAccount16'
OrgnlFnlColltnDt:
type: string
description: Original final collection date that has been modified.
format: date
OrgnlFrqcy:
$ref: '#/components/schemas/Frequency1Code'
description: List of mandate elements that have been modified.
Frequency1Code:
type: string
description: >-
Original frequency that has been modified.
YEAR : Event
takes place every year or once a year.
MNTH : Event takes
place every month or once a month.
QURT : Event takes
place every three months or four times a year.
MIAN :
Event takes place every six months or two times a
year.
WEEK : Event takes place once a week.
DAIL : Event takes place every day.
ADHO :
Event takes place on request or as necessary.
INDA :
Event takes place several times a day.
enum:
- YEAR
- MNTH
- QURT
- MIAN
- WEEK
- DAIL
- ADHO
- INDA
DateAndPlaceOfBirth:
required:
- BirthDt
- CityOfBirth
- CtryOfBirth
type: object
properties:
BirthDt:
type: object
description: Date on which a person is born.
allOf:
- $ref: '#/components/schemas/ISODate'
PrvcOfBirth:
type: object
description: Province where a person was born.
allOf:
- $ref: '#/components/schemas/Max35Text'
CityOfBirth:
type: object
description: City where a person was born.
allOf:
- $ref: '#/components/schemas/Max35Text'
CtryOfBirth:
type: object
description: Country where a person was born.
allOf:
- $ref: '#/components/schemas/CountryCode'
description: Date and place of birth of a person.
DatePeriodDetails:
required:
- FrDt
- ToDt
type: object
properties:
FrDt:
type: object
description: Start date of the range.
allOf:
- $ref: '#/components/schemas/ISODate'
ToDt:
type: object
description: End date of the range.
allOf:
- $ref: '#/components/schemas/ISODate'
DocumentType5Code:
type: string
description: >-
Document type in a coded form.
MSIN : Document is an
invoice claiming payment for the supply of metered services, for example
gas or electricity supplied to a fixed meter.
CNFA :
Document is a credit note for the final amount settled for a commercial
transaction.
DNFA : Document is a debit note for the
final amount settled for a commercial transaction.
CINV
: Document is an invoice.
CREN : Document is a credit
note.
DEBN : Document is a debit note.
HIRI : Document is an invoice for the hiring of human
resources or renting goods or equipment.
SBIN : Document
is an invoice issued by the debtor.
SVGS : Account used
for savings.
CMCN : Document is an agreement between the
parties, stipulating the terms and conditions of the delivery of goods
or services.
SOAC : Document is a statement of the
transactions posted to the debtor's account at the supplier.
DISP : Document is a dispatch advice.
BOLD
: Document is a shipping notice.
VCHR : Document is an
electronic payment document.
AROI : Document is a payment
that applies to a specific source document.
TSUT :
Document is a transaction identifier as assigned by the Trade Services
Utility.
enum:
- MSIN
- CNFA
- DNFA
- CINV
- CREN
- DEBN
- HIRI
- SBIN
- CMCN
- SOAC
- DISP
- BOLD
- VCHR
- AROI
- TSUT
ExchangeRateInformation1:
type: object
properties:
CtrctId:
type: object
description: >-
Unique and unambiguous reference to the foreign exchange contract
agreed between the initiating party/creditor and the debtor agent.
allOf:
- $ref: '#/components/schemas/Max35Text'
XchgRate:
$ref: '#/components/schemas/BaseOneRate'
RateTp:
type: string
description: >-
Specifies the type used to complete the currency exchange.
SPOT : Exchange rate applied is the spot rate.
SALE : Exchange rate applied is the market rate at
the time of the sale.
AGRD : Exchange rate applied is
the rate agreed between the parties.
enum:
- SPOT
- SALE
- AGRD
description: >-
Set of elements used to provide details on the currency exchange rate
and contract.
FinancialInstitutionIdentification7:
type: object
properties:
BIC:
pattern: '[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}'
type: string
description: >-
Code allocated to a financial institution by the ISO 9362
Registration Authority as described in ISO 9362 "Banking - Banking
telecommunication messages - Business identifier code (BIC)".
ClrSysMmbId:
$ref: '#/components/schemas/ClearingSystemMemberIdentification2'
Nm:
type: object
description: >-
Name by which an agent is known and which is usually used to
identify that agent.
allOf:
- $ref: '#/components/schemas/Max140Text'
Othr:
$ref: '#/components/schemas/GenericFinancialIdentification1'
PstlAdr:
$ref: '#/components/schemas/PostalAddress6'
description: >-
Unique and unambiguous identification of a financial institution, as
assigned under an internationally recognised or proprietary
identification scheme.
GroupHeader32:
required:
- CreDtTm
- InitgPty
- MsgId
- NbOfTxs
type: object
properties:
CtrlSum:
maxLength: 18
type: string
description: >-
Total of all individual amounts included in the message,
irrespective of currencies. The number of fractional digits should
not be more than 17.
CreDtTm:
type: string
description: Date and time at which the message was created.
format: date-time
FwdgAgt:
type: object
description: >-
Financial institution that receives the instruction from the
initiating party and forwards it to the next agent in the payment
chain for execution.
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification4
InitgPty:
type: object
description: >-
Party that initiates the payment. This can either be the debtor or
the party that initiates the credit transfer on behalf of the
debtor.
allOf:
- $ref: '#/components/schemas/PartyIdentification32'
MsgId:
maxLength: 35
minLength: 1
type: string
description: >-
Message id. Point to point reference, as assigned by the instructing
party, and sent to the next party in the chain to unambiguously
identify the message.
NbOfTxs:
type: object
description: Number of individual transactions contained in the message.
allOf:
- $ref: '#/components/schemas/Max15NumericText'
Authstn:
maxItems: 2
type: array
description: >-
User identification or any user key to be used to check whether the
initiating party is allowed to initiate transactions from the
account specified in the message.
items:
$ref: '#/components/schemas/Authorisation1Choice'
description: >-
Group header details. Set of characteristics shared by all individual
transactions included in the message.
GroupHeader36:
required:
- CreDtTm
- MsgId
type: object
properties:
CreDtTm:
type: string
description: Date and time at which the message was created.
format: date-time
FwdgAgt:
type: object
description: >-
Financial institution that receives the instruction from the
initiating party and forwards it to the next agent in the payment
chain.
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification4
DbtrAgt:
type: object
description: Financial institution servicing an account for the debtor.
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification4
CdtrAgt:
type: object
description: Financial institution servicing an account for the creditor.
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification4
InitgPty:
type: object
description: Party that initiates the status message.
allOf:
- $ref: '#/components/schemas/PartyIdentification32'
MsgId:
maxLength: 35
minLength: 1
type: string
description: >-
Point to point reference, as assigned by the instructing party, and
sent to the next party in the chain to unambiguously identify the
message.
description: >-
Set of characteristics shared by all individual transactions included in
the message.
Instruction3Code:
type: string
description: >-
Coded information related to the processing of the payment instruction,
provided by the initiating party, and intended for the creditor's
agent.
CHQB : (Ultimate) creditor must be paid by cheque.
HOLD : Amount of money must be held for the (ultimate)
creditor, who will call. Pay on identification.
PHOB :
Please advise/contact (ultimate) creditor/claimant by phone.
TELB : Please advise/contact (ultimate) creditor/claimant
by the most efficient means of telecommunication.
enum:
- CHQB
- HOLD
- PHOB
- TELB
InstructionForCreditorAgent1:
type: object
properties:
Cd:
$ref: '#/components/schemas/Instruction3Code'
InstrInf:
type: object
description: >-
Further information complementing the coded instruction or
instruction to the creditor's agent that is bilaterally agreed or
specific to a user community.
allOf:
- $ref: '#/components/schemas/Max140Text'
Max10Text:
maxLength: 10
minLength: 1
type: string
Max15NumericText:
pattern: '[0-9]{1,15}'
type: string
Max34Text:
maxLength: 34
minLength: 1
type: string
Max105Text:
maxLength: 105
minLength: 1
type: string
NameAndAddress10:
required:
- Adr
- Nm
type: object
properties:
Adr:
$ref: '#/components/schemas/PostalAddress6'
Nm:
type: object
description: >-
Name by which a party is known and is usually used to identify that
party.
allOf:
- $ref: '#/components/schemas/Max140Text'
NamePrefix1Code:
type: string
description: >-
Specifies the terms used to formally address a person.
DOCT : Title of the person is Doctor or Dr.
MIST : Title of the person is Mister or Mr.
MISS : Title of the person is Miss.
MADM :
Title of the person is Madam.
enum:
- DOCT
- MIST
- MISS
- MADM
Number:
maxLength: 18
type: number
OrganisationIdentification4:
type: object
properties:
BICOrBEI:
pattern: '[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}'
type: string
description: >-
Code allocated to a financial institution or non financial
institution by the ISO 9362 Registration Authority as described in
ISO 9362 "Banking - Banking telecommunication messages - Business
identifier code (BIC)".
Othr:
type: array
description: >-
Unique identification of an organisation, as assigned by an
institution, using an identification scheme.
items:
$ref: '#/components/schemas/GenericOrganisationIdentification1'
description: Unique and unambiguous way to identify an organisation.
IdentificationSchemeName1Choice:
required:
- Cd
- Prtry
type: object
properties:
Cd:
maxLength: 4
minLength: 1
type: string
description: >-
Name of the identification scheme, in a coded form as published in
an external list.
Prtry:
type: object
description: Name of the identification scheme, in a free text form.
allOf:
- $ref: '#/components/schemas/Max35Text'
PartyIdentification32:
type: object
properties:
Nm:
type: object
description: >-
Name by which a party is known and which is usually used to identify
that party.
allOf:
- $ref: '#/components/schemas/Max140Text'
PstlAdr:
$ref: '#/components/schemas/PostalAddress6'
Id:
type: object
properties:
OrgId:
$ref: '#/components/schemas/OrganisationIdentification4'
PrvtId:
$ref: '#/components/schemas/PersonIdentification5'
description: >-
Unique and unambiguous identification of a party. Should pass either
OrgId or PrvtId for organisation and private respectively.
CtryOfRes:
type: object
description: >-
Country in which a person resides (the place of a person's home). In
the case of a company, it is the country from which the affairs of
that company are directed.
allOf:
- $ref: '#/components/schemas/CountryCode'
CtctDtls:
$ref: '#/components/schemas/ContactDetails2'
PaymentIdentification1:
required:
- EndToEndId
type: object
properties:
EndToEndId:
type: object
description: >-
Unique identification assigned by the initiating party to
unambiguously identify the transaction. This identification is
passed on, unchanged, throughout the entire end-to-end chain.
allOf:
- $ref: '#/components/schemas/Max35Text'
InstrId:
type: object
description: >-
Unique identification as assigned by an instructing party for an
instructed party to unambiguously identify the instruction.
allOf:
- $ref: '#/components/schemas/Max35Text'
description: Set of elements used to reference a payment instruction.
PaymentInstructionInformation3:
required:
- CdtTrfTxInf
- Dbtr
- DbtrAcct
- DbtrAgt
- PmtInfId
- PmtMtd
- ReqdExctnDt
type: object
properties:
BtchBookg:
type: boolean
description: >-
Identifies whether a single entry per individual transaction or a
batch entry for the sum of the amounts of all transactions within
the group of a message is requested.
ChrgBr:
$ref: '#/components/schemas/ChargeBearerType1Code'
ChrgsAcct:
type: object
description: Account used to process charges associated with a transaction.
allOf:
- $ref: '#/components/schemas/CashAccount16'
ChrgsAcctAgt:
type: object
description: Agent that services a charges account.
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification4
CtrlSum:
maxLength: 18
type: string
description: >-
Total of all individual amounts included in the group, irrespective
of currencies. The number of fractional digits should not be more
than 17.
CdtTrfTxInf:
minItems: 1
type: array
description: >-
Set of elements used to provide information on the individual
transaction(s) included in the message.
items:
$ref: '#/components/schemas/CreditTransferTransactionInformation10'
Dbtr:
type: object
description: Party that owes an amount of money to the (ultimate) creditor.
allOf:
- $ref: '#/components/schemas/PartyIdentification32'
DbtrAcct:
type: object
description: >-
Unambiguous identification of the account of the debtor to which a
debit entry will be made as a result of the transaction.
allOf:
- $ref: '#/components/schemas/CashAccount16'
DbtrAgt:
type: object
description: Financial institution servicing an account for the debtor.
allOf:
- $ref: >-
#/components/schemas/BranchAndFinancialInstitutionIdentification4
DbtrAgtAcct:
type: object
description: >-
Unambiguous identification of the account of the debtor agent at its
servicing agent in the payment chain.
allOf:
- $ref: '#/components/schemas/CashAccount16'
NbOfTxs:
pattern: '[0-9]{1,15}'
type: string
description: >-
Number of individual transactions contained in the paymnet
information group.
PmtInfId:
type: object
description: >-
Unique identification, as assigned by a sending party, to
unambiguously identify the payment information group within the
message.
allOf:
- $ref: '#/components/schemas/Max35Text'
PmtMtd:
type: string
description: >-
Specifies the means of payment that will be used to move the amount
of money.
CHK : Written order to a bank to pay a
certain amount of money from one person to another person.
TRF : Transfer of an amount of money in the books of
the account servicer.
TRA : Transfer of an amount of
money in the books of the account servicer. An advice should be sent
back to the account owner.
enum:
- CHK
- TRF
- TRA
PmtTpInf:
$ref: '#/components/schemas/PaymentTypeInformation19'
PoolgAdjstmntDt:
type: object
description: >-
Date used for the correction of the value date of a cash pool
movement that has been posted with a different value date.
allOf:
- $ref: '#/components/schemas/ISODate'
ReqdExctnDt:
type: object
description: >-
Date at which the initiating party requests the clearing agent to
process the payment.
allOf:
- $ref: '#/components/schemas/ISODate'
UltmtDbtr:
type: object
description: >-
Ultimate party that owes an amount of money to the (ultimate)
creditor.
allOf:
- $ref: '#/components/schemas/PartyIdentification32'
PaymentTypeInformation19:
type: object
properties:
CtgyPurp:
$ref: '#/components/schemas/CategoryPurpose1Choice'
InstrPrty:
$ref: '#/components/schemas/Priority2Code'
LclInstrm:
$ref: '#/components/schemas/LocalInstrument2Choice'
SvcLvl:
$ref: '#/components/schemas/ServiceLevel8Choice'
description: Set of elements used to further specify the type of transaction.
PersonIdentification5:
type: object
properties:
DtAndPlcOfBirth:
$ref: '#/components/schemas/DateAndPlaceOfBirth'
Othr:
type: array
description: >-
Unique identification of a person, as assigned by an institution,
using an identification scheme.
items:
$ref: '#/components/schemas/GenericPersonIdentification1'
description: >-
Unique and unambiguous identification of a person, for example a
passport.
PostalAddress6:
type: object
properties:
AdrLine:
maxItems: 7
type: array
description: >-
Information that locates and identifies a specific address, as
defined by postal services, presented in free format text.
items:
$ref: '#/components/schemas/Max70Text'
AdrTp:
type: string
description: >-
Identifies the nature of the postal address.
ADDR :
Address is the complete postal address.
PBOX :
Address is a postal office (PO) box.
HOME : Address
is the home address.
BIZZ : Address is the business
address.
MLTO : Address is the address to which mail
is sent.
DLVY : Address is the address to which
delivery is to take place.
enum:
- ADDR
- PBOX
- HOME
- BIZZ
- MLTO
- DLVY
BldgNb:
type: object
description: Number that identifies the position of a building on a street.
allOf:
- $ref: '#/components/schemas/Max16Text'
Ctry:
$ref: '#/components/schemas/CountryCode'
CtrySubDvsn:
type: object
description: Identifies a subdivision of a country such as state, region, county.
allOf:
- $ref: '#/components/schemas/Max35Text'
Dept:
type: object
description: Identification of a division of a large organisation or building.
allOf:
- $ref: '#/components/schemas/Max70Text'
PstCd:
type: object
description: >-
Identifier consisting of a group of letters and/or numbers that is
added to a postal address to assist the sorting of mail.
allOf:
- $ref: '#/components/schemas/Max16Text'
StrtNm:
type: object
description: Name of a street or thoroughfare.
allOf:
- $ref: '#/components/schemas/Max70Text'
SubDept:
type: object
description: >-
Identification of a sub-division of a large organisation or
building.
allOf:
- $ref: '#/components/schemas/Max70Text'
TwnNm:
type: object
description: >-
Name of a built-up area, with defined boundaries, and a local
government.
allOf:
- $ref: '#/components/schemas/Max35Text'
description: >-
Information that locates and identifies a specific address, as defined
by postal services.
ReferredDocumentInformation3:
type: object
properties:
Nb:
type: object
description: Unique and unambiguous identification of the referred document.
allOf:
- $ref: '#/components/schemas/Max35Text'
RltdDt:
type: object
description: Date associated with the referred document.
allOf:
- $ref: '#/components/schemas/ISODate'
Tp:
$ref: '#/components/schemas/ReferredDocumentType2'
ReferredDocumentType1Choice:
type: object
properties:
Cd:
$ref: '#/components/schemas/DocumentType5Code'
Prtry:
type: object
description: Proprietary identification of the type of the remittance document.
allOf:
- $ref: '#/components/schemas/Max35Text'
description: >-
Provides the type details of the referred document. Either Code or
Proprietary field value should be passed on request.
ReferredDocumentType2:
required:
- CdOrPrtry
type: object
properties:
CdOrPrtry:
$ref: '#/components/schemas/ReferredDocumentType1Choice'
Issr:
type: object
description: Identification of the issuer of the reference document type.
allOf:
- $ref: '#/components/schemas/Max35Text'
description: Specifies the type of referred document.
RegulatoryReporting3:
type: object
properties:
Authrty:
type: object
properties:
Ctry:
type: object
description: >-
Country of the entity that requires the regulatory reporting
information.
allOf:
- $ref: '#/components/schemas/CountryCode'
Nm:
type: object
description: >-
Name of the entity requiring the regulatory reporting
information.
allOf:
- $ref: '#/components/schemas/Max140Text'
description: Entity requiring the regulatory reporting information.
DbtCdtRptgInd:
type: string
description: >-
Identifies whether the regulatory reporting information applies to
the debit side, to the credit side or to both debit and credit sides
of the transaction.
CRED : Regulatory information
applies to the credit side.
DEBT : Regulatory
information applies to the debit side.
BOTH :
Regulatory information applies to both credit and debit sides.
enum:
- CRED
- DEBT
- BOTH
Dtls:
type: array
description: >-
Set of elements used to provide details on the regulatory reporting
information.
items:
$ref: '#/components/schemas/StructuredRegulatoryReporting3'
RemittanceAmount1:
type: object
properties:
AdjstmntAmtAndRsn:
type: array
description: >-
Set of elements used to provide information on the amount and reason
of the document adjustment.
items:
$ref: '#/components/schemas/DocumentAdjustment1'
CdtNoteAmt:
type: object
description: >-
Amount specified for the referred document is the amount of a credit
note.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
DscntApldAmt:
type: object
description: >-
Amount of money that results from the application of an agreed
discount to the amount due and payable to the creditor.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
DuePyblAmt:
type: object
description: >-
Amount specified is the exact amount due and payable to the
creditor.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
RmtdAmt:
type: object
description: Amount of money remitted for the referred document.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
TaxAmt:
type: object
description: Quantity of cash resulting from the calculation of the tax.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
description: >-
Set of elements used to provide details on the amounts of the referred
document.
RemittanceInformation5:
type: object
properties:
Strd:
type: array
description: >-
Information supplied to enable the matching/reconciliation of an
entry with the items that the payment is intended to settle, such as
commercial invoices in an accounts' receivable system, in a
structured form.
items:
$ref: '#/components/schemas/StructuredRemittanceInformation7'
Ustrd:
type: array
description: >-
Information supplied to enable the matching/reconciliation of an
entry with the items that the payment is intended to settle, such as
commercial invoices in an accounts' receivable system, in an
unstructured form.
items:
$ref: '#/components/schemas/Max140Text'
RemittanceLocation2:
type: object
properties:
RmtId:
type: object
description: >-
Unique identification, as assigned by the initiating party, to
unambiguously identify the remittance information sent separately
from the payment instruction, such as a remittance advice.
allOf:
- $ref: '#/components/schemas/Max35Text'
RmtLctnElctrncAdr:
type: object
description: >-
Electronic address to which an agent is to send the remittance
information.
allOf:
- $ref: '#/components/schemas/Max2048Text'
RmtLctnMtd:
type: string
description: >-
Method used to deliver the remittance advice
information.
FAXI : Remittance advice information must
be faxed.
EDIC : Remittance advice information must
be sent through Electronic Data Interchange (EDI).
URID : Remittance advice information needs to be sent
to a Uniform Resource Identifier (URI). URI is a compact string of
characters that uniquely identify an abstract or physical resource.
URI's are the super-set of identifiers, such as URLs, email
addresses, ftp sites, etc, and as such, provide the syntax for all
of the identification schemes.
EMAL : Remittance
advice information must be sent through e-mail.
POST
: Remittance advice information must be sent through postal
services.
SMSM : Remittance advice information must
be sent through by phone as a short message service (SMS).
enum:
- FAXI
- EDIC
- URID
- EMAL
- POST
- SMSM
RmtLctnPstlAdr:
type: object
description: >-
Postal address to which an agent is to send the remittance
information.
allOf:
- $ref: '#/components/schemas/NameAndAddress10'
StructuredRegulatoryReporting3:
type: object
properties:
Amt:
type: object
description: >-
Amount of money to be reported for regulatory and statutory
requirements.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
Cd:
type: object
description: >-
Specifies the nature, purpose, and reason for the transaction to be
reported for regulatory and statutory requirements in a coded form.
allOf:
- $ref: '#/components/schemas/Max10Text'
Ctry:
type: object
description: >-
Country related to the specified type of regulatory reporting
details.
allOf:
- $ref: '#/components/schemas/CountryCode'
Dt:
type: object
description: Date related to the specified type of regulatory reporting details.
allOf:
- $ref: '#/components/schemas/ISODate'
Inf:
type: array
description: >-
Additional details that cater for specific domestic regulatory
requirements.
items:
$ref: '#/components/schemas/Max35Text'
Tp:
type: object
description: >-
Specifies the type of the information supplied in the regulatory
reporting details.
allOf:
- $ref: '#/components/schemas/Max35Text'
StructuredRemittanceInformation7:
type: object
properties:
AddtlRmtInf:
maxItems: 3
type: array
description: >-
Additional information, in free text form, to complement the
structured remittance information.
items:
$ref: '#/components/schemas/Max140Text'
CdtrRefInf:
$ref: '#/components/schemas/CreditorReferenceInformation2'
Invcee:
type: object
description: >-
Identification of the party to whom an invoice is issued, when it is
different from the debtor or ultimate debtor.
allOf:
- $ref: '#/components/schemas/PartyIdentification32'
Invcr:
type: object
description: >-
Identification of the organisation issuing the invoice, when it is
different from the creditor or ultimate creditor.
allOf:
- $ref: '#/components/schemas/PartyIdentification32'
RfrdDocAmt:
$ref: '#/components/schemas/RemittanceAmount1'
RfrdDocInf:
type: array
description: >-
Set of elements used to identify the documents referred to in the
remittance information.
items:
$ref: '#/components/schemas/ReferredDocumentInformation3'
TaxAmount1:
type: object
properties:
Dtls:
type: array
description: >-
Set of elements used to provide details on the tax period and
amount.
items:
$ref: '#/components/schemas/TaxRecordDetails1'
Rate:
maxLength: 11
type: string
description: Rate used to calculate the tax.
TaxblBaseAmt:
type: object
description: Amount of money on which the tax is based.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
TtlAmt:
type: object
description: >-
Total amount that is the result of the calculation of the tax for
the record.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
description: >-
Set of elements used to provide information on the amount of the tax
record.
TaxInformation3:
type: object
properties:
AdmstnZn:
type: object
description: Territorial part of a country to which the tax payment is related.
allOf:
- $ref: '#/components/schemas/Max35Text'
Cdtr:
$ref: '#/components/schemas/TaxParty1'
Dt:
type: object
description: Date by which tax is due.
allOf:
- $ref: '#/components/schemas/ISODate'
Dbtr:
$ref: '#/components/schemas/TaxParty2'
Mtd:
type: object
description: >-
Method used to indicate the underlying business or how the tax is
paid.
allOf:
- $ref: '#/components/schemas/Max35Text'
Rcrd:
type: array
description: Record of tax details.
items:
$ref: '#/components/schemas/TaxRecord1'
RefNb:
type: object
description: Tax reference information that is specific to a taxing agency.
allOf:
- $ref: '#/components/schemas/Max140Text'
SeqNb:
type: object
description: Sequential number of the tax report.
allOf:
- $ref: '#/components/schemas/Number'
TtlTaxAmt:
type: object
description: Total amount of money as result of the calculation of the tax.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
TtlTaxblBaseAmt:
type: object
description: Total amount of money on which the tax is based.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
description: Set of elements used to provide details on the tax.
TaxPeriod1:
type: object
properties:
FrToDt:
type: object
description: >-
Range of time between a start date and an end date for which the tax
report is provided.
allOf:
- $ref: '#/components/schemas/DatePeriodDetails'
Tp:
$ref: '#/components/schemas/TaxRecordPeriod1Code'
Yr:
type: object
description: Year related to the tax payment.
allOf:
- $ref: '#/components/schemas/ISODate'
description: >-
Set of elements used to provide details on the period of time related to
the tax payment.
TaxRecord1:
type: object
properties:
AddtlInf:
type: object
description: Further details of the tax record.
allOf:
- $ref: '#/components/schemas/Max140Text'
Ctgy:
type: object
description: Specifies the tax code as published by the tax authority.
allOf:
- $ref: '#/components/schemas/Max35Text'
CtgyDtls:
type: object
description: Provides further details of the category tax code.
allOf:
- $ref: '#/components/schemas/Max35Text'
CertId:
type: object
description: >-
Identification number of the tax report as assigned by the taxing
authority.
allOf:
- $ref: '#/components/schemas/Max35Text'
DbtrSts:
type: object
description: >-
Code provided by local authority to identify the status of the party
that has drawn up the settlement document.
allOf:
- $ref: '#/components/schemas/Max35Text'
FrmsCd:
type: object
description: >-
Identifies, in a coded form, on which template the tax report is to
be provided.
allOf:
- $ref: '#/components/schemas/Max35Text'
Prd:
$ref: '#/components/schemas/TaxPeriod1'
TaxAmt:
$ref: '#/components/schemas/TaxAmount1'
Tp:
type: object
description: High level code to identify the type of tax details.
allOf:
- $ref: '#/components/schemas/Max35Text'
TaxRecordDetails1:
required:
- Amt
type: object
properties:
Amt:
type: object
description: Underlying tax amount related to the specified period.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
Prd:
$ref: '#/components/schemas/TaxPeriod1'
ActiveOrHistoricCurrencyAndAmountStatusInquiry:
required:
- Amt
- Ccy
type: object
properties:
Ccy:
type: object
description: Currency code.
allOf:
- $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
Amt:
$ref: >-
#/components/schemas/ActiveOrHistoricCurrencyAndAmount_SimpleTypeStatusInquiry
ActiveOrHistoricCurrencyAndAmount_SimpleTypeStatusInquiry:
type: string
description: Upto 3 fraction digits allowed
Request:
required:
- paymentBase64
type: object
properties:
paymentBase64:
type: string
description: >
Base64 encoded string of ISO XML payment initiation input xml. Based
on the use case, you should use one of the ISO schema. Use PACS
schema for financial institutions and PAIN format for non-financial
clients. ISO schema can be refered from below URL
pain.001.001.03 - https://www.iso20022.org/message/14316/download or
#/definitions/Pain001
example: >-
PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjxEb2N1bWVudCB4bWxuczp4c2k9Imh0dHA6Ly93d3cudzMub3JnLzIwMDEvWE1MU2NoZW1hLWluc3RhbmNlIiB4bWxucz0idXJuOmlzbzpzdGQ6aXNvOjIwMDIyOnRlY2g6eHNkOnBhaW4uMDAxLjAwMS4wMyI+DQogIDxDc3RtckNkdFRyZkluaXRuPg0KICAgIDxHcnBIZHI+DQogICAgICA8TXNnSWQ+R0JQMTYxMTE0Njk0ODY5PC9Nc2dJZD4NCiAgICAgIDxDcmVEdFRtPjIwMTctMDYtMDJUMTA6MTc6NTU8L0NyZUR0VG0+DQogICAgICA8TmJPZlR4cz4xPC9OYk9mVHhzPg0KICAgICAgPEN0cmxTdW0+MS4wMDwvQ3RybFN1bT4NCiAgICAgIDxJbml0Z1B0eT4NCiAgICAgICAgPE5tPkh1ZHNvbiBBZHZpc29ycyBFdXJvcGUgTHRkPC9ObT4NCiAgICAgIDwvSW5pdGdQdHk+DQogICAgPC9HcnBIZHI+DQogICAgPFBtdEluZj4NCiAgICAgIDxQbXRJbmZJZD4xNDAxNzQ5OCBGdW5kIFRyYW5zZmVyIERvbWVzdGljPC9QbXRJbmZJZD4NCiAgICAgIDxQbXRNdGQ+VFJGPC9QbXRNdGQ+DQogICAgICA8TmJPZlR4cz4xPC9OYk9mVHhzPg0KICAgICAgPEN0cmxTdW0+MS4wMDwvQ3RybFN1bT4NCiAgICAgIDxQbXRUcEluZj4NCiAgICAgICAgPFN2Y0x2bD4NCiAgICAgICAgICA8Q2Q+VVJHUDwvQ2Q+DQogICAgICAgIDwvU3ZjTHZsPg0KICAgICAgPC9QbXRUcEluZj4NCiAgICAgIDxSZXFkRXhjdG5EdD4yMDE5LTA4LTIwPC9SZXFkRXhjdG5EdD4NCiAgICAgIDxEYnRyPg0KICAgICAgICA8Tm0+Q0lUSUJBTksgRS1CVVNJTkVTUyBFVVIgRFVNIERFTU88L05tPg0KICAgICAgICA8UHN0bEFkcj4NCiAgICAgICAgICA8Q3RyeT5HQjwvQ3RyeT4NCiAgICAgICAgPC9Qc3RsQWRyPg0KICAgICAgICA8SWQ+DQogICAgICAgICAgPE9yZ0lkPg0KICAgICAgICAgICAgPEJJQ09yQkVJPkNJVElHQjJMPC9CSUNPckJFST4NCiAgICAgICAgICA8L09yZ0lkPg0KICAgICAgICA8L0lkPg0KICAgICAgPC9EYnRyPg0KICAgICAgPERidHJBY2N0Pg0KICAgICAgICA8SWQ+DQogICAgICAgICAgPE90aHI+DQogICAgICAgICAgICA8SWQ+MTAwMTIyNjI8L0lkPg0KICAgICAgICAgIDwvT3Rocj4NCiAgICAgICAgPC9JZD4NCiAgICAgICAgPENjeT5VU0Q8L0NjeT4NCiAgICAgIDwvRGJ0ckFjY3Q+DQogICAgICA8RGJ0ckFndD4NCiAgICAgICAgPEZpbkluc3RuSWQ+DQogICAgICAgICAgPEJJQz5DSVRJR0IyTDwvQklDPg0KICAgICAgICAgIDxQc3RsQWRyPg0KICAgICAgICAgICAgPEN0cnk+R0I8L0N0cnk+DQogICAgICAgICAgPC9Qc3RsQWRyPg0KICAgICAgICA8L0Zpbkluc3RuSWQ+DQogICAgICA8L0RidHJBZ3Q+DQogICAgICA8Q2hyZ0JyPkRFQlQ8L0NocmdCcj4NCiAgICAgIDxDZHRUcmZUeEluZj4NCiAgICAgICAgPFBtdElkPg0KICAgICAgICAgIDxFbmRUb0VuZElkPlBBMjAxODIwMTkxMjwvRW5kVG9FbmRJZD4NCiAgICAgICAgPC9QbXRJZD4NCiAgICAgICAgPEFtdD4NCiAgICAgICAgICA8SW5zdGRBbXQgQ2N5PSJVU0QiPjEuMDA8L0luc3RkQW10Pg0KICAgICAgICA8L0FtdD4NCiAgICAgICAgPFVsdG10RGJ0cj4NCiAgICAgICAgICA8SWQ+DQogICAgICAgICAgICA8UHJ2dElkPg0KICAgICAgICAgICAgICA8T3Rocj4NCiAgICAgICAgICAgICAgICA8SWQ+UEFSVElDSVBBTlQgSUQgUE9CTyBVSyBCUjYwMCAwMTIzNDU8L0lkPg0KICAgICAgICAgICAgICAgIDxTY2htZU5tPg0KICAgICAgICAgICAgICAgICAgPFBydHJ5PklOU1Q8L1BydHJ5Pg0KICAgICAgICAgICAgICAgIDwvU2NobWVObT4NCiAgICAgICAgICAgICAgPC9PdGhyPg0KICAgICAgICAgICAgPC9QcnZ0SWQ+DQogICAgICAgICAgPC9JZD4NCiAgICAgICAgPC9VbHRtdERidHI+DQogICAgICAgIDxDZHRyQWd0Pg0KICAgICAgICAgIDxGaW5JbnN0bklkPg0KICAgICAgICAgICAgPEJJQz5DSVRJR0IyTDwvQklDPg0KICAgICAgICAgICAgPENsclN5c01tYklkPg0KICAgICAgICAgICAgICA8TW1iSWQ+MTg1MDA4PC9NbWJJZD4NCiAgICAgICAgICAgIDwvQ2xyU3lzTW1iSWQ+DQogICAgICAgICAgICA8Tm0+Q0lUSUJBTksoSVNPKTwvTm0+DQogICAgICAgICAgICA8UHN0bEFkcj4NCiAgICAgICAgICAgICAgPEN0cnk+R0I8L0N0cnk+DQogICAgICAgICAgICA8L1BzdGxBZHI+DQogICAgICAgICAgPC9GaW5JbnN0bklkPg0KICAgICAgICA8L0NkdHJBZ3Q+DQogICAgICAgIDxDZHRyPg0KICAgICAgICAgIDxObT44MDEwNjQzMTIyWCBYWFhYWFhYWFhYWFhYIFhYWDwvTm0+DQogICAgICAgICAgPFBzdGxBZHI+DQogICAgICAgICAgICA8Q3RyeT5HQjwvQ3RyeT4NCiAgICAgICAgICA8L1BzdGxBZHI+DQogICAgICAgICAgPEN0Y3REdGxzPg0KICAgICAgICAgICAgPE5tPldEVyAzIElOVkVTVE1FTlRTIExJTUlURUQ8L05tPg0KICAgICAgICAgIDwvQ3RjdER0bHM+DQogICAgICAgIDwvQ2R0cj4NCiAgICAgICAgPENkdHJBY2N0Pg0KICAgICAgICAgIDxJZD4NCiAgICAgICAgICA8T3Rocj4NCiAgICAgICAgICAgICAgICAgICA8SWQ+MTAwMTIyNjI8L0lkPg0KICAgICAgICAgICAgICAgICAgPC9PdGhyPg0KICAgICAgICAgIDwvSWQ+DQogICAgICAgIDwvQ2R0ckFjY3Q+DQogICAgICAgIDxSbXRJbmY+DQogICAgICAgICAgPFVzdHJkPlRSMDAyNjM4PC9Vc3RyZD4NCiAgICAgICAgPC9SbXRJbmY+DQogICAgICA8L0NkdFRyZlR4SW5mPg0KICAgIDwvUG10SW5mPg0KICA8L0NzdG1yQ2R0VHJmSW5pdG4+DQo8L0RvY3VtZW50Pg==
description: >-
Object representing payment initiation request. ISO schema can be found
at
https://www.iso20022.org/catalogue-messages/iso-20022-messages-archive?page=4
and select Payments Initiation V03 and Payments Clearing and Settlement
V09 then select more and download mdr file for detailed information on
schema and xsd schema definitions.
xml:
name: Request
Document:
type: object
properties:
CstmrPmtStsRpt:
$ref: '#/components/schemas/CustomerPaymentStatusReportV03'
examples:
Payment-Initiation-Request-Json:
value:
'@xmlns': urn:iso:std:iso:20022:tech:xsd:pain.001.001.03
customer_credit_transfer_initiation:
group_header:
message_identification: Wire_SZD_API_1401
creation_date_time: '2020-02-20T09:30:47'
number_of_transactions: '1'
control_sum: '200'
initiating_party:
name: MSA ILE DE FRANCE
identification:
organisation_identification:
other:
- identification: '583700001'
payment_information:
- payment_information_identification: Batch_211
payment_method: TRF
requested_execution_date: '2022-09-22'
debtor:
name: SPVA - Veterans Agency
postal_address:
address_type: ADDR
country: FR
debtor_account:
identification:
other:
identification: '1187390001'
currency: USD
debtor_agent:
financial_institution_identification:
bic: CITIGB2L
name: ABCD
other:
identification: '583700001'
credit_transfer_transaction_information:
- payment_identification:
instruction_identification: MMSA27DECX028LUSEPA
end_to_end_identification: SRWL2022092201
payment_type_information:
service_level:
code: SEPA
category_purpose:
code: OTHR
amount:
equivalent_amount:
amount:
currency: EUR
$: '100'
currency_of_transfer: EUR
charge_bearer: SHAR
creditor_agent:
financial_institution_identification:
bic: CITILULX
creditor:
name: Beneficiaryname011231234567890123455
postal_address:
address_type: DLVY
department: Dept00001
sub_department: Subdept001
street_name: Streetname001
building_number: buildngno12
post_code: pstlcode01
town_name: town001
country_sub_division: ctrysub001
country: LU
country_of_residence: FR
contact_details:
name_prefix: MIST
name: dhgdfh
creditor_account:
identification:
iban: LU820340000201472001
type:
code: SVGS
name: BB
remittance_information:
unstructured:
- '12796190145799300'
Fx-Rate-Request-Json:
value:
SignonRq:
ClientDt: '2020-02-25T05:21:02'
CustLangPref: ENGLISH
ClientApp:
Name: CTSI INTERFACE
Org: ABCDBANK
Version: '1.0'
BankSvcRq:
- RqUID: 99dc17a3-6bbf-4310-973a-a369e5
ForExRateInqRq:
- RqUID: 99dc17a3-6bbf-4310-973a-a369e50
CustId:
CustPermId: '085370001'
SPName: CTSI
DepAcctId:
AcctId: '9999999999'
AcctType: SD
BankInfo: {}
RemitAmt: '3.00'
RemitCurCode: USD
IssueCurCode: INR
ForExRateType: Indicated
ForExRateDealType: Sell
ForExValDtType: SPOT
Book-Fx-Request-Json:
value:
'@xmlns': http://com.citi.citiconnect/services/types/worldlinkservices/bookfx/v1
SignonRq:
ClientDt: '2025-12-17T05:21:02'
CustLangPref: ENGLISH
ClientApp:
Org: KIWIBANK
Name: CTSI INTERFACE
Version: '1.0'
BankSvcRq:
- RqUID: 99dc17a3-6bbf-4310-973a-a369e5
PrefPrice: 'N'
WLFlag: W
DealType: O
ForExRateDealAddRq:
- RqUID: 99dc17a3-6bbf-4310-973a-a369e50
CustId:
SPName: CTSI
CustPermId: '085370001'
ForExDealInfo:
ForExRateDealType: Sell
CurConvertRule: Direct
IssueCurCode: INR
RemitAmt: '3'
RemitCurCode: USD
SPRefId: XML56EQB
Payment-Initiation-Response-Json:
value:
'@xmlns': urn:iso:std:iso:20022:tech:xsd:pain.002.001.03
customer_payment_status_report:
group_header:
message_identification: msg1018-DR011
creation_date_time: '2019-12-27T09:30:47'
initiating_party:
name: Vaibhav
identification:
organisation_identification:
other:
- identification: '583700001'
original_group_information_and_status:
original_message_identification: msg1018-DR011
original_message_name_identification: Pain.001.001.03
original_creation_date_time: '2019-12-27T09:30:47'
original_number_of_transactions: '1'
original_control_sum: '100'
original_payment_information_and_status:
- original_payment_information_identification: Batch_211
transaction_information_and_status:
- original_instruction_identification: MMSA27DECX028LUSEPA
original_end_to_end_identification: SRWL2022092901
transaction_status: ACCP
original_transaction_reference:
amount:
equivalent_amount:
amount:
currency: EUR
$: '100'
currency_of_transfer: EUR
requested_execution_date: '2022-09-30'
payment_type_information:
service_level:
code: SEPA
category_purpose:
code: OTHR
payment_method: TRF
remittance_information:
unstructured:
- FID 2345678909123456
- PMT Detail 212312345678901234567890
- PMT Detail 312312345678901234567890
- PMT Detail 412312345678901234567890
debtor:
name: SPVA - Veterans Agency
postal_address:
address_type: ADDR
country: FR
debtor_account:
identification:
other:
identification: '1187390001'
currency: USD
debtor_agent:
financial_institution_identification:
bic: CITIGB2L
name: ABCD
other:
identification: '583700001'
creditor_agent:
financial_institution_identification:
bic: CITILULX
creditor:
name: Beneficiaryname011231234567890123455
postal_address:
address_type: DLVY
department: Dept00001
sub_department: Subdept001
street_name: Streetname001
building_number: buildngno12
post_code: pstlcode01
town_name: town001
country_sub_division: ctrysub001
country: LU
country_of_residence: FR
contact_details:
name_prefix: MIST
name: dhgdfh
creditor_account:
identification:
iban: LU820340000201472001
type:
code: SVGS
name: BB
Fx-Rate-Response-Json:
value:
IFX:
xsi:noNamespaceSchemaLocation: CTSI.xsd
BankSvcRs:
Status:
StatusDesc: '000 : Rate returned'
Severity: NONE
StatusCode: PROCESSED
ForExRateInqRs:
Status:
StatusDesc: '000 : Rate returned'
Severity: NONE
StatusCode: PROCESSED
RemitAmt: 3
ForExRateRec:
ForExValDt: '2025-12-19'
ForExRateInfo:
RemitAmt: 3
IssueAmt: 267.81
CurRate: 89.27
RemitCurCode: USD
CurConvertRule: Direct
ExpDt: '2025-12-17T04:36:22'
IssueCurCode: INR
SPRefId: XML56EQB
RemitCurCode: USD
DepAcctId:
AcctId: 9999999999
AcctType: SD
BankInfo: ''
RqUID: 99dc17a3-6bbf-4310-973a-a369e50
IssueCurCode: INR
RqUID: 99dc17a3-6bbf-4310-973a-a369e5
xmlns:xsi: http://www.w3.org/2001/XMLSchema-instance
Book-Fx-Response-Json:
value:
IFX:
xmlns:xsi: http://www.w3.org/2001/XMLSchema-instance
xsi:noNamespaceSchemaLocation: CTSI.xsd
BankSvcRs:
Status:
StatusDesc: '000 : Rate returned'
Severity: NONE
StatusCode: PROCESSED
RqUID: 99dc17a3-6bbf-4310-973a-a369e5
PrefPrice: 'N'
WLFlag: W
DealType: O
ForExRateDealAddRs:
Status:
StatusDesc: '000 : Rate returned'
Severity: NONE
StatusCode: PROCESSED
RqUID: 99dc17a3-6bbf-4310-973a-a369e50
ForExDealInfo:
RemitAmt: 3
ForExRateDealType: Sell
RemitCurCode: USD
CurConvertRule: Direct
IssueCurCode: INR
SPRefId: XML5CNYP
ForExDealRec:
ForExDealInfo:
IssueAmt: 285.54
RemitAmt: 3
ForExUnw: 2026-05-08-08.50.01
CurRate: 95.18
RemitCurCode: USD
CurConvertRule: Direct
IssueCurCode: INR
SPRefId: XML5CNYP
ForExDealId: AA5663101573228
securitySchemes:
clientCredentials:
description: >+
All CitiConnect APIs use the oAuth2 authentication scheme, which
requires a bearer token to authenticate your API call. The Token URL
includes the version of authentication used by this API. See the Citi Authentication API reference for
information on requesting a token.
type: oauth2
flows:
clientCredentials:
tokenUrl: /authenticationservices/v3/oauth/token
scopes: {}
x-original-swagger-version: '2.0'