openapi: 3.0.1
servers:
- url: https://localhost:8080/OB-API-REST/v2
info:
description: Public API of Diebold Nixdorf for Banking Core Systems integration
version: 4.3.0
title: DN Open Backend API
contact:
name: Thorsten Brinkmann
email: Thorsten.Brinkmann@dieboldnixdorf.com
termsOfService: /terms-of-use
externalDocs:
url: /docs
description: Find more information here
tags:
- name: Authentication API
description: Authentication request for a transaction.
- name: Account Information API
description: Fetches account information.
- name: Consumer Information API
description: Fetches consumer information.
- name: Account Processing API
description: Performs a transaction.
paths:
/getToken:
get:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/tokenAuthorization'
summary: Get Token for API requests
security:
- basic: []
- jweBearer: []
tags:
- Authentication API
operationId: getToken
description: Retrieves a token which can be used for subsequent API requests. A new token is retrieved when expired.
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/tokenResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
ServiceResponseFundsExample:
$ref: '#/components/examples/ServiceResponseFundsExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/exchangeKey:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Exchange Key with the Backend Host
tags:
- Authentication API
operationId: exchangeKey
description: This API is used to exchange the keys with the backend. The key received in the response will be used to
encrypt the request payload for subsequent requests. The key sent in the request is used to encrypt the response payload
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/exchangeKeyRequest'
description: "TM Key and its Metadata information is send in the request as Signed JWT .
\n\n \n Signed\
\ JWT Token structure:\n \n Header:\n alg: Signing algorithm\n typ: JWT\n kid: Key\
\ Id of the key used for signing\n Payload:\n iss: Token Issuer URL\n iat: Absolute Token issue\
\ time (unix epoch time in seconds)\n exp: Absolute Token expiry time (unix epoch time in seconds)\n \
\ sub: TM Server name \n key: pem formatted Key to be used for payload encryption\n keyId: Key\
\ Identifier of the TM key\n keyType: Type of key i.e EC or RSA\n keyIssueTime: Absolute Issue time\
\ (unix epoch time in seconds)\n keyExpiryTime: Absolute Expiry time (unix epoch time in seconds)\n \
\ \n Signature:\n base64 signature with TM RSA private key\n \n Signed JWT Example Value:\n \n\
\ Header:\n {\n \"alg\": \"RS256\",\n \"typ\": \"JWT\",\n \"kid\": \"9Bj6hg8-h3vveksiZQr9S33OYMJXelOy31U7faOkHrU\"\
\n }\n \n Payload:\n {\n \"iss\": \"http://10.177.76.114:8080\",\n \"iat\": 1625723983,\n\
\ \"exp\": 1625724643,\n \"sub\": \"Alpha.Farm.Cluster.TXMServer01\",\n \"key\": \"-----BEGIN\
\ PUBLIC KEY-----\\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEt7SjiGcIrtepZGwO4Y6AiikhXfMm\\nQlDJMc/DIjpgnCU0Agnpv0UtpbXJqNlo7rOtlmJ1IKalwyxR8ZanavK4kw==\\\
n-----END PUBLIC KEY----\\n\",\n \"keyId\": \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"\
keyType\": \"EC\",\n \"keyIssueTime\": 1625723983,\n \"keyExpiryTime\": 1625725771\n }\n \
\ \n Signature: oB5BFasR_LOr_blUBaOD0p8Y5JuK0IO__HSD8A5DvUzhzvpccw1kwJj_5Eqab51QY06OPSLbvMIDGFhb1GGknCuVYSU9n5Y2G8ugIVvaG53TpmcF9bCxT3EzcLN1UhNL_yLYpJJLVPZfqE8Pb2zuvhjnUTg1NOUlbWxlMAYUFreWL3I74t7OdVY-7-xKjl2YkoiluQ03QOA4_8hHqn5Z2bxJ-SGxmVokcKpW49fSDNHnDe1c15PdzrkSjo70SHc2CEj6h7GiHrRaF_zqGP5aM6bMW5ztncf9Dp7h387gbck188Mwt9RqnSsJJ37wEGOYtKqEYCE4Vs7fkCg2HsbYlA\n\
\ \n Note: \n All Header and Payload parameters in SignedJWT are mandatory in request\n \n \
\ kid: It is kid from JWK thumbprint computed from the key used for\n signing. Their computation is specified\
\ in RFC 7638. Default hash\n algorithm SHA-256 used for computation.\n \n Signing algorithm: RS256\
\ (RSASSA-PKCS1-v1_5 using SHA-256)\n Key size: RSA Key Pair used for signing is of size 2048 bit. EC publicKey\
\ size is 256 bit\n \n "
responses:
'200':
description: "\nBackend Key and its Metadata information is received in response as Signed JWT
\n \n \
\ Signed JWT Token structure:\n \n Header:\n alg: Signing algorithm\n typ: JWT\n kid: Key\
\ Id of the key used for signing\n Payload:\n iss: Token Issuer URL\n iat: Absolute Token issue time\
\ (unix epoch time in seconds)\n exp: Absolute Token expiry time (unix epoch time in seconds)\n sub:\
\ Backend Server name \n key: pem formatted Key to be used for payload encryption\n keyId: Key Identifier\
\ of the Backend key\n keyType: Type of key i.e EC or RSA\n keyIssueTime: Absolute Issue time (unix\
\ epoch time in seconds)\n keyExpiryTime: Absolute Expiry time (unix epoch time in seconds)\n \n Signature:\n\
\ base64 signature with Backend RSA Private Key\n \n Signed JWT Example Value:\n \n Header:\n {\n\
\ \"alg\": \"RS256\",\n \"typ\": \"JWT\",\n \"kid\": \"LxvenwMisHToXaDUvios__oHeuR-iR-7dkYq-GSPUE4\"\
\n }\n \n Payload:\n {\n \"iss\": \"http://10.184.12.233:8080\",\n \"iat\": 1625723983,\n\
\ \"exp\": 1625724643,\n \"sub\": \"BackendHost01\",\n \"key\": \"-----BEGIN PUBLIC KEY-----\\\
nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEqIQhwENy4XuLP9VgkYKHpALWo3lE\\n5YqZfKW4bdmaXdgMiq2HCiixj/mpQnMZ4pk6sT3JNEhim9oUbpEvyd/vCA==\\\
n-----END PUBLIC KEY-----\\n\",\n \"keyId\": \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"keyType\"\
: \"EC\",\n \"keyIssueTime\": 1625723983,\n \"keyExpiryTime\": 1625725771\n }\n \n Signature:\n\
\ qA4CDvsN_LOr_blUBaOD0p8Y5JuK0IO__HSD8A5DvUzhzvpccw1kwJj_5Eqab51QY06OPSLbvMIDGFhb1GGknCuVYSU9n5Y2G8ugIVvaG53TpmcF9bCxT3EzcLN1UhNL_yLYpJJLVPZfqE8Pb2zuvhjnUTg1NOUlbWxlMAYUFreWL3I74t7OdVY-7-xKjl2YkoiluQ03QOA4_8hHqn5Z2bxJ-SGxmVokcKpW49fSDNHnDe1c15PdzrkSjo70SHc2CEj6h7GiHrRaF_zqGP5aM6bMW5ztncf9Dp7h387gbck188Mwt9RqnSsJJ37wEGOYtKqEYCE4Vs7asdvasdwQ34\n\
\ \n Note:\n Except iss and sub in Payload, all other Header and Payload parameters in SignedJWT are mandatory\
\ in response\n \n kid: It is kid from JWK thumbprint computed from the key used for\n signing. Their\
\ computation is specified in RFC 7638. Default hash\n algorithm SHA-256 used for computation.\n \n \
\ Signing algorithm: RS256 (RSASSA-PKCS1-v1_5 using SHA-256)\n Key size: RSA Key Pair used for signing is\
\ of size 2048 bit. EC publicKey size is 256 bit\n "
content:
application/json:
schema:
$ref: '#/components/schemas/exchangeKeyResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/accountList:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Get the account list of a consumer
tags:
- Account Information API
operationId: accountList
description: Retrieves a list of all accounts of a consumer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/accountListRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/accountListResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/accountInquiry:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Returns detail information of an account
tags:
- Account Information API
operationId: accountInquiry
description: Returns detail information of an account.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/accountInquiryRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/accountInquiryResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/consumerIdentify:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Returns detailed information of a consumer
tags:
- Consumer Information API
operationId: consumerIdentify
description: Returns detailed information of a consumer.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/consumerIdentifyRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/consumerIdentifyResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/getAccountMovement:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Returns the list of all the transactions processed in an account.
tags:
- Account Information API
operationId: getAccountMovement
description: Returns the list of all the transactions processed in an account.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/getAccountMovementRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/getAccountMovementResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/getAccountStopHold:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Returns list of holds and stop payments on an account
tags:
- Account Information API
operationId: getAccountStopHold
description: Returns list of holds and stop payments on an account
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/getAccountStopHoldRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/getAccountStopHoldResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/getAccountWarnings:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Returns list of Account Warnings on an account.
tags:
- Account Information API
operationId: getAccountWarnings
description: Returns list of Account Warnings on an account.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/getAccountWarningsRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/getAccountWarningsResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/getAccountListWarnings:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Returns list of Account Warnings on every account.
tags:
- Account Information API
operationId: getAccountListWarnings
description: Returns list of Account Warnings on every account.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/getAccountListWarningsRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/getAccountListWarningsResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/getBusinessDate:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Returns the Business Date.
tags:
- Account Information API
operationId: getBusinessDate
description: Returns the Business Date.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/getBusinessDateRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/getBusinessDateResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/getCardList:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Returns list of Cards of an account.
tags:
- Account Information API
operationId: getCardList
description: Returns list of Cards of an account.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/getCardListRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/getCardListResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/getCheckIssuerDetails:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Returns details of a check.
tags:
- Account Information API
operationId: getCheckIssuerDetails
description: Returns details of a check.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/getCheckIssuerDetailsRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/getCheckIssuerDetailsResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/getConsumerWarnings:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Returns a list of consumer warnings on an account.
tags:
- Consumer Information API
operationId: getConsumerWarnings
description: Returns a list of consumer warnings on an account.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/getConsumerWarningsRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/getConsumerWarningsResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/getScheduledTransactions:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Returns the list of all the transactions that are yet to be in an account.
tags:
- Account Information API
operationId: getScheduledTransactions
description: Returns the list of all the transactions that are yet to be in an account.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/getScheduledTransactionsRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/getScheduledTransactionsResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/ofacSearch:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Returns the list of all ofac accounts.
tags:
- Consumer Information API
operationId: ofacSearch
description: Returns the list of all ofac accounts.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/getOfacSearchRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/getOfacSearchResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/accountHold:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Creates a hold on an account
tags:
- Account Information API
operationId: accountHold
description: Creates a hold on an account
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/accountHoldRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/AccountHoldResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/cancelAccountHold:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Cancels the hold on an account
tags:
- Account Information API
operationId: cancelAccountHold
description: Cancels the hold on an account
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/cancelAccountHoldRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/transactionConfirmationResponseUpdatedBalance'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/credit:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: performs credit operation
tags:
- Account Processing API
operationId: credit
description: performs credit operation
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/creditRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/transactionConfirmationResponseUpdatedBalance'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/debit:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: performs debit operation
tags:
- Account Processing API
operationId: debit
description: performs debit operation
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/debitRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/transactionConfirmationResponseUpdatedBalance'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/pinCheck:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Verify pin.
tags:
- Account Processing API
operationId: pinCheck
description: Verify pin.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/pinCheckRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/transactionConfirmationResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/transfer:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: performs transfer operation
tags:
- Account Processing API
operationId: transfer
description: performs transfer operation
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/transferRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/transferConfirmationResponseUpdatedBalance'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/updateAccountNickName:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: update the account nickname
tags:
- Account Information API
operationId: updateAccountNickName
description: update the account nickname
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/updateAccountNickNameRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/transactionConfirmationResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/updateCardState:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Updates the card state
tags:
- Consumer Information API
operationId: updateCardState
description: Updates the card state
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/updateCardStateRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/transactionConfirmationResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/getPreferences:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Retrieves the list of customer preferences
tags:
- Consumer Information API
operationId: getPreferences
description: Retrieves the list of customer preferences
requestBody:
required: true
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
content:
application/json:
schema:
$ref: '#/components/schemas/getPreferencesRequest'
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/getPreferencesResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/setPreferences:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Saves the list of customer preferences
tags:
- Consumer Information API
operationId: setPreferences
description: Saves the list of customer preferences
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/setPreferencesRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/setPreferencesResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/getMemberBankList:
get:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Retrieves the list of member banks
tags:
- Consumer Information API
operationId: getMemberBankList
description: Retrieves the list of member banks
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/getMemberBankListResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/reversal:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Performs reversal for a transaction.
tags:
- Account Processing API
operationId: reversal
description: Performs reversal for a transaction.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/reversalRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/transactionConfirmationResponseUpdatedBalance'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/transferReversal:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Performs reversal for a transfer transaction.
tags:
- Account Processing API
operationId: transferReversal
description: Performs reversal for a transfer transaction.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/transferReversalRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/transferReversalResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/currencyTransactionReporting:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: performs transactions that consists of cash deposits, check deposits, cash withdrawals and cash checks
tags:
- Account Processing API
operationId: currencyTransactionReporting
description: Allows consumers to create teller transactions that consist of cash deposits, check deposits, cash withdrawals,
and cash checks. It also allow consumers to add teller currency transactions.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/currencyTransactionReportingRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/currencyTransactionReportingResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing currency transaction reporting operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/zpkExchange:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Zone PIN Key Exchange
tags:
- Authentication API
operationId: zpkExchange
description: Fetches the new Zone Pin Key from backend host
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/zpk.exchange.request'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below "
content:
application/json:
schema:
$ref: '#/components/schemas/zpk.exchange.response'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/keepAlive:
get:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Checks availability of OB-API backends
tags:
- Authentication API
operationId: keepAlive
description: Checks the availability of backends connected by OB-API by sending a keep-alive message.
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/keepAliveResponse'
example:
responseCode: OK
extendedResponse:
code: OK
message: OK
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/login:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Performs a login
tags:
- Authorization Processing API
operationId: login
description: "Posts details of the login step of an ATM transaction.\n\nThis indicates the start of consumer session\
\ at the ATM.\nThe host needs to note the login of a consumer and provide the following information\n - list of enabled\
\ transactions\n - information on accounts linked to the card\n"
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/login.request'
examples:
LoginRequest:
$ref: '#/components/examples/LoginRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/login.response'
examples:
LoginResponse:
$ref: '#/components/examples/LoginResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/logout:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Performs a logout
tags:
- Authorization Processing API
operationId: logout
description: 'Posts details of the logout step of an ATM transaction.
Host needs to note the logoff of current consumer session at the ATM.
'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/logout.request'
examples:
LogoutRequest:
$ref: '#/components/examples/LogoutRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below\n "
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/logout.response'
examples:
LogoutResponse:
$ref: '#/components/examples/LogoutResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/cassCounterChanged:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Lists changes to cassette counters
tags:
- Authorization Processing API
operationId: cassCounterChanged
description: "Posts details of the changes in different cassette counter devices. \nIncludes information like the reason\
\ for the change, the type of change, the devices that have changed with their changed values.\n"
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/cassCounterChanged.request'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below\n "
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/cassCounterChanged.response'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/pinChangeAuthorize:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Authorizes a pin change operation
tags:
- Authorization Processing API
operationId: pinChangeAuthorize
description: 'Posts details of the authorization of a pinchange operation
'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/pinChange.authorize.Request'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below\n "
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below\n "
content:
application/json:
schema:
$ref: '#/components/schemas/pinChange.authorize.response'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/pinChangeFinalize:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Finalizes a pin change operation
tags:
- Authorization Processing API
operationId: pinChangeFinalize
description: "Posts details of the finalization of a pinchange operation as per the accountingState.\n\nIf the accountingState\
\ is OK, the transaction is successful. Else, a reversal is triggered. \n\nThe host must perform reversal of the pin\
\ change operation in case of failure and ensure that the previous pin is recoverable.\nThe previous pin must be restored.\n"
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/pinChange.finalize.request'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below\n "
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/pinchange.finalize.response'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/withdrawalAuthorize:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Authorizes a withdrawal transaction
tags:
- Authorization Processing API
operationId: withdrawalAuthorize
description: "Posts details of the authorization of a withdrawal transaction. The host must authenticate and authorize\
\ the transaction and do necessary operation on the presented amount. \nNote: All amounts present in the request must\
\ be treated individually and they are exclusive of transaction fees. Fees, if present have to be additionally added\
\ to transaction amount while operating on account.\n \nKey scenarios associated with a withdrawal authorize\
\ transaction:\n\n- withdrawal without fee/FCC/DCC - There is no fee, FCC or DCC involved. The host must debit the\
\ specified amount from the specified account\n\n- withdrawal with fee - If fee is applicable and if confirmation\
\ is required (fees.type - DIRECT_ACQUIRER_FEE) from the consumer, a resubmit response is sent by the host in the\
\ first withdrawalAuthorize response. The consumer accepts/declines the fee in the subsequent withdrawalAuthorize\
\ request and the host processes the request considering the fee with the requested amount. If a fee is applicable\
\ but consumer confirmation is not required (fees.type - INDIRECT_ACQUIRER_FEE), the host must debit the fee and the\
\ specified amount without sending resubmit response.\n\n- withdrawal with FCC (Foreign Currency Conversion) - If\
\ FCC is available and a confirmation is required (foreignCurrencyConversion.fccState - CONFIRM_REQUIRED ) from the\
\ consumer, a resubmit response is sent by the host in the first withdrawalAuthorize response. The consumer accepts/declines\
\ the FCC in the subsequent withdrawalAuthorize request and the host processes the request. If FCC is available but\
\ consumer confirmation is not required (fccState - CONF_NOT_REQUIRED ) , the host must debit the specified amount\
\ in base currency without sending resubmit response.\n\n- withdrawal with DCC (Dynamic Currency Conversion) - If\
\ DCC is available, a confirmation is required (dynamicCurrencyConversion.mode - DCC_CURRENCY_AVAILABLE) from the\
\ consumer and, a resubmit response is sent by the host in the first withdrawalAuthorize response. The consumer accepts/declines\
\ the DCC in the subsequent withdrawalAuthorize request and the host processes the request as per the consumers response\
\ \n\n- withdrawal with a combination of fee/FCC/DCC - If fee, FCC and DCC are available in a combination (extendedResponse.code\
\ - MULTI_CONFIRM_REQUIRED), a resubmit response is sent by the host in the first withdrawalAuthorize response. The\
\ consumer accepts/declines the fee, FCC and/or DCC in the subsequent withdrawalAuthorize request and the host processes\
\ the request\n"
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/withdrawal.authorize.request'
examples:
WithdrawalAuthorizeRequestWithoutFee:
$ref: '#/components/examples/WithdrawalAuthorizeRequestWithoutFee'
WithdrawalAuthorizeRequestWithFeeConfirmed:
$ref: '#/components/examples/WithdrawalAuthorizeRequestWithFeeConfirmed'
WithdrawalAuthorizeRequestWithFCC:
$ref: '#/components/examples/WithdrawalAuthorizeRequestWithFCC'
WithdrawalAuthorizeRequestWithFCCAccepted:
$ref: '#/components/examples/WithdrawalAuthorizeRequestWithFCCAccepted'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/withdrawal.authorize.response'
examples:
WithdrawalAuthorizeResponseWithoutFee:
$ref: '#/components/examples/WithdrawalAuthorizeResponseWithoutFee'
WithdrawalAuthorizeResponseWithFee:
$ref: '#/components/examples/WithdrawalAuthorizeResponseWithFee'
WithdrawalAuthorizeResponseWithFCCConfirmRequired:
$ref: '#/components/examples/WithdrawalAuthorizeResponseWithFCCConfirmRequired'
WithdrawalAuthorizeResponseWithFCCConfirmNotRequired:
$ref: '#/components/examples/WithdrawalAuthorizeResponseWithFCCConfirmNotRequired'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/withdrawalFinalize:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Finalizes a withdrawal transaction
tags:
- Authorization Processing API
operationId: withdrawalFinalize
description: "Posts details of the finalization of a withdrawal transaction as per the accountingState.\n\nIf the accountingState\
\ is OK, the transaction is successful. Else, a reversal is triggered. \n\nThe host must perform reversal operations\
\ on all the accounts where operations were performed in the authorize step.\n\nThe 'amount' attribute represents\
\ the dispensed amount. In case of a partial dispense, the host must perform a reversal of the undispensed amount.\n"
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/withdrawal.finalize.request'
examples:
WithdrawalFinalizeRequest:
$ref: '#/components/examples/WithdrawalFinalizeRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/withdrawal.finalize.response'
examples:
WithdrawalFinalizeResponse:
$ref: '#/components/examples/WithdrawalFinalizeResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/transferAuthorize:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Authorizes a transfer transaction
tags:
- Authorization Processing API
operationId: transferAuthorize
description: "Posts details of the authorization of a transfer transaction. The host must authenticate and authorize\
\ the transaction and do necessary operation on the presented amount.\n\nKey scenarios associated with a transfer\
\ authorize transaction:\n\n- transfer without fee/FCC - There is no fee or FCC involved. The host must transfer the\
\ specified amount from the source account to the target account\n\n- transfer with fee - If fee is applicable and\
\ a confirmation is required from the consumer, a resubmit response is sent by the host in the first transferAuthorize\
\ response. The consumer accepts/declines the fee in the subsequent transferAuthorize request and the host processes\
\ the request considering the fee with the requested amount. If a fee is applicable but consumer confirmation is not\
\ required, the host must debit the fee and the specified amount from the source account \n\n- transfer with FCC (Foreign\
\ Currency Conversion) - If FCC is available and a confirmation is required from the consumer, a resubmit response\
\ is sent by the host in the first transferAuthorize response. The consumer accepts/declines the FCC in the subsequent\
\ transferAuthorize request and the host processes the request. If FCC is available but consumer confirmation is not\
\ required, the host must transfer the specified amount in base currency\n\n- transfer with a combination of fee/FCC\
\ - If fee and FCC are available in a combination, a resubmit response is sent by the host in the first transferAuthorize\
\ response. The consumer accepts/declines the fee, FCC in the subsequent transferAuthorize request and the host processes\
\ the request\n \n"
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/transfer.authorize.request'
examples:
TransferAuthorizeRequestWithoutFee:
$ref: '#/components/examples/TransferAuthorizeRequestWithoutFee'
TransferAuthorizeRequestWithFee:
$ref: '#/components/examples/TransferAuthorizeRequestWithFee'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below\n "
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/transfer.authorize.response'
examples:
TransferAuthorizeResponseWithoutFee:
$ref: '#/components/examples/TransferAuthorizeResponseWithoutFee'
TransferAuthorizeResponseWithFee:
$ref: '#/components/examples/TransferAuthorizeResponseWithFee'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/transferFinalize:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Finalizes a transfer transaction
tags:
- Authorization Processing API
operationId: transferFinalize
description: "Posts details of the finalization of a transfer transaction as per the accountingState.\n\nIf the accountingState\
\ is OK, the transaction is successful. Else, a reversal is triggered. \n\nThe host must perform reversal operations\
\ on all the accounts where operations were performed in the authorize step.\n"
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/transfer.finalize.request'
examples:
TransferFinalizeRequest:
$ref: '#/components/examples/TransferFinalizeRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below\n "
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/transfer.finalize.response'
examples:
TransferFinalizeResponse:
$ref: '#/components/examples/TransferFinalizeResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/depositAuthorize:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Authorizes a deposit transaction
tags:
- Authorization Processing API
operationId: depositAuthorize
description: "Posts details of the authorization of a deposit transaction. The host must authenticate the transaction\
\ and do necessary operation on the presented amount.\n\nKey scenarios associated with a deposit authorize transaction:\n\
\n- deposit - the specified amount is deposited only into the single account specified in the targetAccount property.\
\ \n\n- split deposit - the overall amount is split and deposited into multiple accounts as specified in the splitDeposit\
\ property.\n\nThe host must specify the cash and check limits (limits per transaction, if any) in the response. \n"
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/deposit.authorize.request'
examples:
DepositAuthorizeRequest:
$ref: '#/components/examples/DepositAuthorizeRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/deposit.authorize.response'
examples:
DepositAuthorizeResponse:
$ref: '#/components/examples/DepositAuthorizeResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/depositValidate:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Validates a deposit transaction
tags:
- Authorization Processing API
operationId: depositValidate
description: 'Posts details of the validations of a deposit transaction.
The host must validate the details of the check/s and proceess valid check/s.
'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/deposit.validate.request'
examples:
DepositValidateRequestWithFCCCurrency:
$ref: '#/components/examples/DepositValidateRequestWithFCCCurrency'
DepositValidateRequest:
$ref: '#/components/examples/DepositValidateRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/deposit.validate.response'
examples:
DepositValidateResponseWithFCCConfirmNotRequired:
$ref: '#/components/examples/DepositValidateResponseWithFCCConfirmNotRequired'
DepositValidateResponseWithFCCConfirmRequired:
$ref: '#/components/examples/DepositValidateResponseWithFCCConfirmRequired'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/depositFinishValidation:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Finishes the validation of a deposit transaction
tags:
- Authorization Processing API
operationId: depositFinishValidation
description: "Posts details of the finished validations of a deposit transaction.\n\nThe host must validate that there\
\ are sufficient funds to perform the transaction by considering the validated amount and the fees. \nIf the validated\
\ amount is less than the fee amount, the host must fail the transaction with INSUFFICIENT_FUNDS.\nIf the validated\
\ amount is missing, the host must fail the transaction with REQUEST_DATA_INVALID.\n"
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/deposit.finishValidation.request'
examples:
DepositFinishValidationRequestWithFeeAccepted:
$ref: '#/components/examples/DepositFinishValidationRequestWithFeeAccepted'
DepositFinishValidationRequestWithoutFee:
$ref: '#/components/examples/DepositFinishValidationRequestWithoutFee'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below\n "
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/deposit.finishValidation.response'
examples:
DepositFinishValidationResponseWithFee:
$ref: '#/components/examples/DepositFinishValidationResponseWithFee'
DepositFinishValidationResponseWithoutFee:
$ref: '#/components/examples/DepositFinishValidationResponseWithoutFee'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/depositProcessClearing:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Processes the clearing of a deposit transaction
tags:
- Authorization Processing API
operationId: depositProcessClearing
description: "Posts details of the clearings processed in a deposit transaction. The host must authorize the transaction\
\ and do necessary operation on the presented amount.\n\nThe host must operate on the accounts involved. \n- The fee\
\ (if applicable) must be credited in to the fee account.\n- For a deposit transaction : \n - the remaining validatedAmount\
\ must be credited into the specified account. \n - the check amounts must be debited from the check accounts and\
\ credited into the specified account.\n- For a split deposit transaction : \n - the specified amounts must be credited\
\ into the specified accounts.\n\nIn case of a check deposit transaction, the check amount must be held till the checks\
\ are cleared by the clearing house.\n"
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/deposit.processClearing.request'
examples:
DepositProcessClearingRequest:
$ref: '#/components/examples/DepositProcessClearingRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below "
content:
application/json:
schema:
$ref: '#/components/schemas/deposit.processClearing.response'
examples:
DepositProcessClearingResponse:
$ref: '#/components/examples/DepositProcessClearingResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/depositFinalize:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Finalizes a deposit transaction
tags:
- Authorization Processing API
operationId: depositFinalize
description: "Posts details of the finalization of a deposit transaction as per the accountingState\n\nIf the accountingState\
\ is OK, the transaction is successful. Else, a reversal is triggered. \n\nThe host must perform reversal operations\
\ on all the accounts where operations were performed in the processClearing step.\n"
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/deposit.finalize.request'
examples:
DepositFinalizeRequest:
$ref: '#/components/examples/DepositFinalizeRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/deposit.finalize.response'
examples:
DepositFinalizeResponse:
$ref: '#/components/examples/DepositFinalizeResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/mixedMediaPaymentAuthorize:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Authorizes a mixed media payment transaction
tags:
- Authorization Processing API
operationId: mixedMediaPaymentAuthorize
description: "Posts details of the authorization of a mixed media payment transaction. The host must authenticate the\
\ transaction and do necessary operation on the presented amount.\n\nKey scenarios associated with a mixed media payment\
\ authorize transaction revolve around payments of different types. Below fields specify the details.\n\n- paymentType\
\ - the type of payment being performed e.g. loan, credit-card, bill etc.\n- paymentSubType - the subtype of the payment\
\ e.g. principal payment, payoff etc. \n\nThe host must specify the cash and check limits (as applicable) in the response\n"
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/mmp.authorize.request'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below\n\n "
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/mmp.authorize.response'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/mixedMediaPaymentValidate:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Validates a mixed media payment transaction
tags:
- Authorization Processing API
operationId: mixedMediaPaymentValidate
description: 'Posts details of the validations of a mixed media payment transaction.
The host must validate that:
- for a check-only transaction, the inserted check is valid. If not, fail the transaction with REQUEST_DATA_INVALID.
- for a cash-only transaction, the inserted cash is greater than zero. If not, fail the transaction with REQUEST_DATA_INVALID.
- for a cash-and-check transaction, the inserted check is valid and the inserted cash is greater than zero. If not,
fail the transaction with REQUEST_DATA_INVALID.
'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/mmp.validate.request'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/mmp.validate.response'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/mixedMediaPaymentFinishValidation:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Finishes the validation a mixed media payment transaction
tags:
- Authorization Processing API
operationId: mixedMediaPaymentFinishValidation
description: 'Posts details of the finished validations of a mixed media payment transaction.
The host must validate that there are sufficient funds to perform the payment by considering the validatedAmount and
the fee amount. If not, the host must fail the transaction with INSUFFICIENT_FUNDS.
If the validatedAmount is missing, the host must fail the transaction with REQUEST_DATA_INVALID.
'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/mmp.finishvalidation.request'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below\n "
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/mmp.finishvalidation.response'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/mixedMediaPaymentProcessClearing:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Processes the clearing of a mixed media payment transaction
tags:
- Authorization Processing API
operationId: mixedMediaPaymentProcessClearing
description: "Posts details of the clearings processed in a mixed media payment transaction. The host must authorize\
\ the transaction and do necessary operation on the presented amount.\n\nThe host must operate on the accounts involved.\
\ \n- The fee (if applicable) must be credited in to the fee account. \n- The check amounts must be debited from the\
\ check accounts and credited into the 'targetAccount'. \n- The cash amount must be credited into the payment account\
\ specified in the 'targetAccount'. \n- The creditAmount/ debitAmount (if available) must be credited/debited into/from\
\ the 'account'. \n"
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/mmp.processclearing.request'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/mmp.processclearing.response'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/mixedMediaPaymentFinalizeCashOut:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Finalizes the cashout of a mixed media payment transaction
tags:
- Authorization Processing API
operationId: mixedMediaPaymentFinalizeCashOut
description: 'Posts details of the cashout finalized in a mixed media payment transaction
**This API is invoked only if the dispensedAmount is non-zero**
'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/mmp.finalizecashout.request'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/mmp.finalizecashout.response'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/mixedMediaPaymentFinalize:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Finalizes a mixed media payment transaction
tags:
- Authorization Processing API
operationId: mixedMediaPaymentFinalize
description: "Posts details of the finalization of a mixed media payment transaction.\n\nIf the accountingState is OK,\
\ the transaction is successful. Else, a reversal is triggered. \n\nThe host must perform reversal operations on all\
\ the accounts where operations were performed in the processClearing step.\n"
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/mmp.finalize.request'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/mmp.finalize.response'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/checkCashingAuthorize:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Authorizes a check cashing transaction
tags:
- Authorization Processing API
operationId: checkCashingAuthorize
description: 'Posts details of the authorization of a check cashing transaction. The host must authenticate the transaction
and do necessary operation on the presented amount.
'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/checkcashing.authorize.request'
examples:
CheckCashingAuthorizeRequest:
$ref: '#/components/examples/CheckCashingAuthorizeRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below\n "
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/checkcashing.authorize.response'
examples:
CheckCashingAuthorizeResponse:
$ref: '#/components/examples/CheckCashingAuthorizeResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/checkCashingValidate:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Validates a check cashing transaction
tags:
- Authorization Processing API
operationId: checkCashingValidate
description: 'Posts details of the validations of a check cashing transaction.
The host must validate the details of the check/s and proceess valid check/s.
'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/checkcashing.validate.request'
examples:
CheckCashingValidateChecksRequest:
$ref: '#/components/examples/CheckCashingValidateChecksRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/checkcashing.validate.response'
examples:
CheckCashingValidateChecksResponse:
$ref: '#/components/examples/CheckCashingValidateChecksResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/checkCashingFinishValidation:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Finishes the validation of a check cashing transaction
tags:
- Authorization Processing API
operationId: checkCashingFinishValidation
description: 'Posts details of the finished validations of a check cashing transaction.
The host must validate that there are sufficient funds to perform the transaction by considering the validated amount
and the fees. If the validated amount is less than the fee amount, the host must fail the transaction with INSUFFICIENT_FUNDS.
If the validated amount is missing, the host must fail the transaction with REQUEST_DATA_INVALID.
'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/checkcashing.finishvalidation.request'
examples:
CheckCashingFinishValidationRequest:
$ref: '#/components/examples/CheckCashingFinishValidationRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/checkcashing.finishvalidation.response'
examples:
CheckCashingFinishValidationResponse:
$ref: '#/components/examples/CheckCashingFinishValidationResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/checkCashingProcessClearing:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Processes the clearing of a check cashing transaction
tags:
- Authorization Processing API
operationId: checkCashingProcessClearing
description: 'Posts details of the clearings processed in a check cashing transaction. The host must authorize the transaction
and do necessary operation on the presented amount.
The host must operate on the accounts involved.
The check amounts must be debited from the check accounts.
'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/checkcashing.processclearing.request'
examples:
CheckCashingProcessClearingRequest:
$ref: '#/components/examples/CheckCashingProcessClearingRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/checkcashing.processclearing.response'
examples:
CheckCashingProcessClearingResponse:
$ref: '#/components/examples/CheckCashingProcessClearingResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/checkCashingAuthorizeCashOut:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Authorizes the cashout of a check cashing transaction
tags:
- Authorization Processing API
operationId: checkCashingAuthorizeCashOut
description: 'Posts details of the cashout authorized in a check cashing transaction.
The host must perform the following operations.
- Credit the fee amount into the fee account
- Calculate the ''creditAmount'' as ''check amount - requestedAmount - fee amount'' and credit it into ''account''
'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/checkcashing.authorizecashout.request'
examples:
CheckCashingAuthorizeCashOutRequest:
$ref: '#/components/examples/CheckCashingAuthorizeCashOutRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/checkcashing.authorizecashout.response'
examples:
CheckCashingAuthorizeCashOutResponse:
$ref: '#/components/examples/CheckCashingAuthorizeCashOutResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/checkCashingFinalizeCashOut:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Finalizes the cashout of a check cashing transaction
tags:
- Authorization Processing API
operationId: checkCashingFinalizeCashOut
description: 'Posts details of the cashout finalized in a check cashing transaction.
If a reversal is triggered, the host must perform reversal operations on all the accounts where operations were performed
in the processClearing and authorizeCashOut steps.
'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/checkcashing.finalizecashout.request'
examples:
CheckCashingFinalizeCashOutRequest:
$ref: '#/components/examples/CheckCashingFinalizeCashOutRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/checkcashing.finalizecashout.response'
examples:
CheckCashingFinalizeCashOutResponse:
$ref: '#/components/examples/CheckCashingFinalizeCashOutResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/checkCashingFinalize:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Finalizes a check cashing transaction
tags:
- Authorization Processing API
operationId: checkCashingFinalize
description: 'Posts details of the finalization of a check cashing transaction
'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/checkcashing.finalize.request'
examples:
CheckCashingFinalizeRequest:
$ref: '#/components/examples/CheckCashingFinalizeRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/checkcashing.finalize.response'
examples:
CheckCashingFinalizeResponse:
$ref: '#/components/examples/CheckCashingFinalizeResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/currencyExchangeRates:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Retrieves the exchange rates for a given pair of currencies
tags:
- Authorization Processing API
operationId: currencyExchangeRates
description: 'Posts details of the exchange rates retrieved for the given pair of currencies.
The host responds with:
- ''exchangeRateDefs'' if exchange rates are available for the requested currencies
- ''notSupportedCurrencyExchangeRates'' if exchange rates are not available for the requested currencies
'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/currencyExchangeRates.request'
examples:
CurrencyExchangeRatesRequestSupportedCurrencies:
$ref: '#/components/examples/CurrencyExchangeRatesRequestSupportedCurrencies'
CurrencyExchangeRatesRequestNotSupportedCurrencies:
$ref: '#/components/examples/CurrencyExchangeRatesRequestNotSupportedCurrencies'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/currencyExchangeRates.response'
examples:
CurrencyExchangeRatesResponseSupportedCurrencies:
$ref: '#/components/examples/CurrencyExchangeRatesResponseSupportedCurrencies'
CurrencyExchangeRatesResponseNotSupportedCurrencies:
$ref: '#/components/examples/CurrencyExchangeRatesResponseNotSupportedCurrencies'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/addCash:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Adds details of cash added to the transaction
tags:
- Authorization Processing API
operationId: addCash
description: 'Posts details of the cash added to the transaction.
This is applicable to deposit, mixedMediaPayent or checkCashing transactions.
'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/addCash.request'
examples:
AddCashRequest:
$ref: '#/components/examples/AddCashRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below\n "
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/addCash.response'
examples:
AddCashResponse:
$ref: '#/components/examples/AddCashResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/addCheck:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Adds details of the check added to the transaction
tags:
- Authorization Processing API
operationId: addCheck
description: 'Posts details of the check added to the transaction.
The host must validate if the inserted check is valid and fit for further processing.
This is applicable to deposit, mixedMediaPayent or checkCashing transactions.
'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/addCheck.request'
examples:
AddCheckRequest:
$ref: '#/components/examples/AddCheckRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/addCheck.response'
examples:
AddCheckResponse:
$ref: '#/components/examples/AddCheckResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
/updateChecks:
post:
parameters:
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/initiatingPartyId'
- $ref: '#/components/parameters/productName'
- $ref: '#/components/parameters/initiatingPartyName'
- $ref: '#/components/parameters/timestamp'
- $ref: '#/components/parameters/referenceId'
- $ref: '#/components/parameters/authorization'
summary: Updates details of the check added to the transaction
tags:
- Authorization Processing API
operationId: updateChecks
description: 'Posts details of updates made to the check added previously to the transaction.
This is applicable to deposit, mixedMediaPayent or checkCashing transactions.
'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/updateChecks.request'
examples:
UpdateChecksRequest:
$ref: '#/components/examples/UpdateChecksRequest'
description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \"\
keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\"\
,\n \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n }\n }\n\nIf payload encryption\
\ scheme is not used, Request body will follow schema as mentioned below"
responses:
'200':
description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.
Encryption\
\ algorithm: ECIES as in IEEE P 1363a
__Example Value:__
\n\n {\n \"envelope\": {\n \
\ \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\
\n }\n } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned\
\ below"
content:
application/json:
schema:
$ref: '#/components/schemas/updateChecks.response'
examples:
UpdateChecksResponse:
$ref: '#/components/examples/UpdateChecksResponse'
'400':
description: Invalid input fields, object invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'500':
description: Error while performing operation
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'401':
description: Unauthorized access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
'403':
description: Forbidden access
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
ServiceResponseFailExample:
$ref: '#/components/examples/ServiceResponseFailExample'
components:
parameters:
version:
name: version
in: header
description: Version of DN Open Backend API being used.
required: true
schema:
type: string
minLength: 1
example: 4.3.0
operation:
name: operation
in: header
description: Name of the operation that is requested. eg. credit
required: true
schema:
type: string
minLength: 1
example: transfer
initiatingPartyId:
name: initiatingPartyId
in: header
description: Identifier of the party that has initiated this transaction, in this case Diebold Nixdorf's ID.
required: true
schema:
type: string
minLength: 1
example: DieboldNixdorf
productName:
name: productName
in: header
description: The name of the product which is consuming the service (business product name).
required: true
schema:
type: string
minLength: 1
example: Transaction Middleware
initiatingPartyName:
name: initiatingPartyName
in: header
description: The name of the initiating party.
required: true
schema:
type: string
minLength: 1
example: DieboldNixdorf
timestamp:
name: timestamp
in: header
description: timestamp of the transaction
required: true
schema:
type: string
format: yyyy-MM-dd'T'HH:mm:ssZ
description: Timestamp
example: 2020-09-01T16:40:52+0000
referenceId:
name: referenceId
in: header
description: Unique identifier for the transaction request.
required: true
schema:
type: string
example: A123F34
token:
name: token
in: header
description: Token requested via getToken API
schema:
type: string
example: T2131241
authType:
name: authType
in: header
description: Authentication mechanisam being used. BASIC_AUTH, TOKEN, JWE, NONE
required: true
schema:
type: string
example: BASIC_AUTH
tokenAuthorization:
name: Authorization
in: header
description: "In case the Authentication Type is TOKEN, Authorization will contain base 64 encoded userName:password\
\ string using HTTP Basic Authentication.
In case the Authentication Type is JWE, Authorization will contain Bearer\
\ encryptedJWT. JWT will be encrypted with backend endpoint public key.
\n\n__Signed JWT Structure:__ \n\n \
\ Header:\n alg: Signing algorithm\n typ: JWT\n kid: Key Id of the key used for signing\n\
\ Payload:\n iss: Token Issuer URL\n iat: Absolute Token issue time (Unix epoch time in seconds)\n\
\ exp: Absolute Token expiry time (Unix epoch time in seconds)\n sub: TM Server name\n Signature:\n\
\ base64 signature with TM RSA private key\n\n__JWE Structure:__\n\n Header:\n kid: Key Id\
\ of the Backend RSA public key used to encrypt signed token \n cty: JWT\n enc: Content encryption\
\ algorithm\n alg: Key encryption algorithm\n Payload:\n signedJWT\n \n __JWT and JWE Example\
\ Value:__\n \n signedJWT: \n \n Header:\n {\n \"alg\": \"RS256\",\n \
\ \"typ\": \"JWT\",\n \"kid\": \"vJ_GkZgf1ApAXRICFscTxeUKu1oBqgjstTgNwhdyjBo\"\n }\n Payload:\n\
\ { \n \"iss\": \"http://10.177.76.114:8080\",\n \"iat\": 1620727194,\n \"exp\"\
: 1620727794,\n \"sub\": \"Alpha.Farm.Cluster.TXMServer01\"\n }\n Signature: oB5BFasR_LOr_blUBaOD0p8Y5JuK0IO__HSD8A5DvUzhzvpccw1kwJj_5Eqab51QY06OPSLbvMIDGFhb1GGknCuVYSU9n5Y2G8ugIVvaG53TpmcF9bCxT3EzcLN1UhNL_yLYpJJLVPZfqE8Pb2zuvhjnUTg1NOUlbWxlMAYUFreWL3I74t7OdVY-7-xKjl2YkoiluQ03QOA4_8hHqn5Z2bxJ-SGxmVokcKpW49fSDNHnDe1c15PdzrkSjo70SHc2CEj6h7GiHrRaF_zqGP5aM6bMW5ztncf9Dp7h387gbck188Mwt9RqnSsJJ37wEGOYtKqEYCE4Vs7fkCg2HsbYlA\n\
\ \n JWE:\n \n Header:\n {\n \"kid\": \"sTToJZb0bEq5p216E7S3yBB2S6Ci-13uD6mGNhNZaT4\"\
,\n \"cty\": \"JWT\",\n \"enc\": \"A256GCM\",\n \"alg\": \"RSA-OAEP-256\"\n }\n\
\ Payload:\n signedJWT\n \n Note:\n \n kid: It is kid from JWK thumbprint computed\
\ from the key used for\n signing or encryption. Their computation is specified in RFC 7638.\n Default hash\
\ algorithm SHA-256 used for computation.\n \n Algorithms used are as mentioned below:\n Signing\
\ algorithm: RS256 (RSASSA-PKCS1-v1_5 using SHA-256)\n Content encryption algorithm: A256GCM (AES GCM 256)\n\
\ Key encryption algorithm: RSA-OAEP-256 (RSAES OAEP using SHA-256)\n \n Key size: RSA Key Pair\
\ used for signing and encrypting the token is of size 2048 bit"
required: true
schema:
type: string
example: Basic afae1wad213da OR Bearer RA6ICaWwLPLDEcdefg+
authorization:
name: Authorization
in: header
description: 'In case the Authentication type is BASIC_AUTH, Authorization will contain base 64 encoded userName:password
string using HTTP Basic Authentication.
In case the Authentication Type is JWE/TOKEN, Authorization will contain
token received using getToken request as Bearer Token. '
schema:
type: string
example: Basic afae1wad213da OR Bearer T2131241
examples:
ServiceResponseFailExample:
value:
responseCode: FAIL
extendedResponse:
code: SERVER_FAILURE
message: SERVER_FAILURE
ServiceResponseFundsExample:
value:
responseCode: FAIL
extendedResponse:
code: INSUFFICIENT_FUNDS
message: SERVER_FAILURE
LoginResponse:
value:
responseCode: OK
payload:
enabledTransactions:
- sbLogin
- sbLogout
- sbOpenConsumer
- sbRelogin
- sbCardlessLogin
- sbAccountMovement
- sbAccountOverview
- sbCheckCashing
- sbDeposit
- sbMixedMediaPayment
- sbTransfer
- sbWithdrawal
- sbPinChange
- sbPrestagedCashOut
- sbPrestagedCashIn
- sbEReceipt
- sbLoadCustomerPreferences
- sbSaveCustomerPreferences
- sbAssistedWithdrawal
- sbAssistedDeposit
- sbLimitApproval
- sbRequestSupport
- sbCreditorSelection
- sbPaymentData
- sbPrestagedDeposit
accounts:
- accountNumber: A0123456789
accountCurrency: USD
accountType: SAVINGS
accountSubType: Savings account
accountName: Your Savings account
instituteName: Bank
amounts:
- amountType: LEDGER_BALANCE
currency: USD
value: '100.20'
- amountType: AVAILABLE_BALANCE
currency: USD
value: '100.20'
accountOwnership: PRIMARY
accountStatus: ACTIVE
branchCode: '1234'
openDate: '2024-01-01'
confirmationNumber: 998a87999
hostResponseData:
hostResponseCode: '000'
hostTransactionTime: 2024-04-15T10:00:32+0000
hostMessage: OK
cardHandlingIndicator: CHAINING_ALLOWED
consumerId: '123456'
LogoutResponse:
value:
responseCode: OK
payload:
confirmationNumber: 998a87999
hostResponseData:
hostResponseCode: '000'
hostTransactionTime: 2024-04-15T10:00:32+0000
hostMessage: OK
CheckCashingAuthorizeResponse:
value:
payload:
confirmationNumber: '998087999'
hostResponseData:
hostResponseCode: '00000'
hostTransactionTime: 2024-03-15T11:00:00+0530
hostMessage: Success
cardHandlingIndicator: CHAINING_ALLOWED
businessDate: '2024-04-15'
emvResponse:
- tag: ISSUER_DATA
value: 72629F18040*****0000005
responseCode: OK
CheckCashingValidateChecksResponse:
value:
payload:
confirmationNumber: '998087999'
hostResponseData:
hostResponseCode: '00000'
hostTransactionTime: 2024-03-15T11:00:00+0530
hostMessage: Success
cardHandlingIndicator: CHAINING_ALLOWED
hostCheckAmount:
value: '100.50'
currency: USD
hostCashBackAmount:
value: '100.50'
currency: USD
accountInformation:
accountNumber: A0123456789
accountCurrency: USD
accountType: SAVINGS
accountName: Your Savings account
accountSubType: Savings account
amounts:
- amountType: LEDGER_BALANCE
value: '52.20'
currency: USD
- amountType: AVAILABLE_BALANCE
value: '52.20'
currency: USD
checkValidationTransactionId: '808123458'
checks:
- id: A90A87312EE34C8CAE77BB0AEAB826F7
hostId: 442347823ebfad58676644aaaa432323
checkActionCode: NONE
suspectedFraud: false
deleted: false
printData: Dated March 23rd, 2024
responseCode: OK
CheckCashingFinishValidationResponse:
value:
payload:
confirmationNumber: '998087999'
hostResponseData:
hostResponseCode: '00000'
hostTransactionTime: 2024-03-15T11:00:00+0530
hostMessage: Success
cardHandlingIndicator: CHAINING_ALLOWED
responseCode: OK
CheckCashingProcessClearingResponse:
value:
payload:
confirmationNumber: '998087999'
hostResponseData:
hostResponseCode: '00000'
hostTransactionTime: 2024-03-15T11:00:00+0530
hostMessage: Success
cardHandlingIndicator: CHAINING_ALLOWED
emvResponse:
- tag: ISSUER_DATA
value: 72629F18040*****0000005
checks:
- id: A90A87312EE34C8CAE77BB0AEAB826F7
hostId: '1449501664206'
printData: Dated March 23rd, 2024
checkState: PROCESSED_OK
responseCode: OK
CheckCashingAuthorizeCashOutResponse:
value:
payload:
confirmationNumber: '998087999'
hostResponseData:
hostResponseCode: '00000'
hostTransactionTime: 2024-03-15T11:00:00+0530
hostMessage: Success
cardHandlingIndicator: CHAINING_ALLOWED
businessDate: '2019-09-23'
emvResponse:
- tag: ISSUER_DATA
value: 72629F18040*****0000005
responseCode: OK
CheckCashingFinalizeCashOutResponse:
value:
payload:
confirmationNumber: '998087999'
hostResponseData:
hostResponseCode: '00000'
hostTransactionTime: 2024-03-15T11:00:00+0530
hostMessage: Success
cardHandlingIndicator: OUT
accountInformation:
accountNumber: A0123456789
accountCurrency: USD
accountType: SAVINGS
accountName: Your Savings account
accountSubType: Savings account
amounts:
- amountType: AVAILABLE_BALANCE
value: '100.50'
currency: USD
responseCode: OK
CheckCashingFinalizeResponse:
value:
payload:
confirmationNumber: '998087999'
hostResponseData:
hostResponseCode: '00000'
hostTransactionTime: 2024-03-15T11:00:00+0530
hostMessage: Success
cardHandlingIndicator: CHAINING_ALLOWED
responseCode: OK
TransferAuthorizeResponseWithoutFee:
value:
responseCode: OK
payload:
confirmationNumber: '99887999'
hostResponseData:
hostResponseCode: '000'
hostTransactionTime: 2024-03-15T11:00:00+0530
hostMessage: OK
cardHandlingIndicator: CHAINING_ALLOWED
businessDate: '2024-04-15'
emvResponse:
- tag: ISSUER_DATA
value: 72629F18040*****0000005
accountRefFrom:
accountNumber: A0123456789
accountCurrency: USD
accountType: CHECKING
accountName: Your checking account
accountSubType: Checking account
instituteName: Bank
amounts:
- amountType: LEDGER_BALANCE
value: '52.20'
currency: USD
- amountType: AVAILABLE_BALANCE
value: '52.20'
currency: USD
accountRefTo:
accountNumber: B0123456789
accountCurrency: USD
accountType: SAVINGS
accountName: Your Savings account
accountSubType: Savings account
instituteName: Bank
amounts:
- amountType: LEDGER_BALANCE
value: '52.20'
currency: USD
- amountType: AVAILABLE_BALANCE
value: '52.20'
currency: USD
amount:
value: '100.50'
currency: USD
remark: Some remark.
senderName: ABC Corp.
receiverName: XYZ Ltd.
referenceNumber: AF249934
TransferAuthorizeResponseWithFee:
value:
responseCode: OK
payload:
confirmationNumber: '99887999'
hostResponseData:
hostResponseCode: '000'
hostTransactionTime: 2024-03-15T11:00:00+0530
hostMessage: OK
cardHandlingIndicator: CHAINING_ALLOWED
businessDate: '2020-05-23'
fees:
- name: Acquirer fee
type: DIRECT_ACQUIRER_FEE
amount:
value: '1.00'
currency: USD
accountRef:
accountNumber: C0123456789
accountType: FEE_COLLECTION_ACCOUNT
accountName: Fee account
accountSubType: Fee account
state: CONF_REQUIRED
emvResponse:
- tag: ISSUER_DATA
value: 72629F18040*****0000005
accountRefFrom:
accountNumber: A0123456789
accountCurrency: USD
accountType: CHECKING
accountName: CHECKING account
accountSubType: Checking account
instituteName: Bank
amounts:
- amountType: LEDGER_BALANCE
value: '52.20'
currency: USD
- amountType: AVAILABLE_BALANCE
value: '52.20'
currency: USD
accountRefTo:
accountNumber: B0123456789
accountCurrency: USD
accountType: LOAN
accountName: Mortgage Loan
accountSubType: Loan account
instituteName: Bank
amounts:
- amountType: LEDGER_BALANCE
value: '52.20'
currency: USD
- amountType: AVAILABLE_BALANCE
value: '52.20'
currency: USD
amount:
value: '20.00'
currency: USD
remark: Some remark.
senderName: AC Corp.
receiverName: XYZ Ltd.
orderId: order Id
changeId: change Id
scheduledDate: '2019-09-23'
creationDate: '2024-03-01'
referenceNumber: AF249934
TransferFinalizeResponse:
value:
responseCode: OK
payload:
confirmationNumber: '99887999'
hostResponseData:
hostResponseCode: '000'
hostTransactionTime: 2024-03-15T11:00:00+0530
hostMessage: OK
cardHandlingIndicator: CHAINING_ALLOWED
AddCashResponse:
value:
responseCode: OK
extendedResponse:
code: OK
message: OK
payload:
accountRef:
accountNumber: A0123456789
accountType: SAVINGS
accountName: Your Savings account
accountSubType: Business Savings
AddCheckResponse:
value:
responseCode: OK
extendedResponse:
code: OK
message: OK
payload:
check:
id: 7892480d0a1948099c71beffa823ed0e
hostId: 442347823ebfad58676644aaaa432323
transactionId: e025d7ee74db4ddcbfe4af45ca42327a
checkActionCode: NONE
deleted: false
suspectedFraud: false
micrReadIntegrity: GOOD
micr: T123*****1390
routingTransitNumber: '063100277'
mediaState: OK
printData: Dated March 23rd, 2024
date: '2024-03-23'
score: 0
accountNumber: A0123456789
checkNumber: '123456'
courtesyAmount:
value: '100.00'
currency: USD
micrAmount:
value: '100.00'
currency: USD
userAmount:
value: '100.00'
currency: USD
documentSequenceNumber: 1
externalProcessingCode: '4'
checkType: ON_US
checkState: ENDORSED
checkImageFront:
image: SUkqAN*******AAAA
imageType: JPEG
checkImageBack:
image: SUkqAN*******AAAA
imageType: JPEG
UpdateChecksResponse:
value:
responseCode: OK
extendedResponse:
code: OK
message: OK
DepositAuthorizeResponse:
value:
responseCode: OK
payload:
confirmationNumber: 998a87999
hostResponseData:
hostResponseCode: '000'
hostTransactionTime: 2024-04-15T10:00:32+0000
hostMessage: ''
cardHandlingIndicator: CHAINING_ALLOWED
businessDate: '2024-04-15'
emvResponse:
tag: ISSUER_DATA
value: 72629F18040*****0000005
accountInformation:
accountNumber: A0123456789
accountCurrency: USD
accountType: SAVINGS
accountName: Your Savings account
accountSubType: Savings account
amounts:
- amountType: LEDGER_BALANCE
value: '52.20'
currency: USD
- amountType: AVAILABLE_BALANCE
value: '52.20'
currency: USD
checkLimit:
value: '1000.00'
currency: USD
cashInLimit:
value: '1000.00'
currency: USD
DepositValidateResponseWithFCCConfirmNotRequired:
value:
responseCode: OK
payload:
confirmationNumber: 998a87999
hostResponseData:
hostResponseCode: '000'
hostTransactionTime: 2024-04-15T10:00:32+0000
hostMessage: ''
cardHandlingIndicator: CHAINING_ALLOWED
hostCashBackAmount:
currency: USD
value: '4000.00'
emvResponse:
tag: ISSUER_DATA
value: 72629F18040*****0000005
accountInformation:
accountNumber: A0123456789
accountCurrency: USD
accountType: SAVINGS
accountName: Your Savings account
accountSubType: Savings account
amounts:
- amountType: LEDGER_BALANCE
value: '52.20'
currency: USD
- amountType: AVAILABLE_BALANCE
value: '52.20'
currency: USD
foreignCurrencyConversion:
fccState: CONF_NOT_REQUIRED
amount:
value: '20.00'
currency: EUR
amountInBaseCurrency:
value: '25.00'
currency: USD
exchangeRate:
baseCurrency: USD
foreignCurrency: EUR
directQuotation: false
sell: true
cash: true
rate: 80
decimals: 2
DepositValidateResponseWithFCCConfirmRequired:
value:
responseCode: OK
payload:
confirmationNumber: 998a87999
hostResponseData:
hostResponseCode: '000'
hostTransactionTime: 2024-04-15T10:00:32+0000
hostMessage: ''
cardHandlingIndicator: CHAINING_ALLOWED
hostCashBackAmount:
currency: USD
value: '4000.00'
emvResponse:
tag: ISSUER_DATA
value: 72629F18040*****0000005
accountInformation:
accountNumber: A0123456789
accountCurrency: USD
accountType: SAVINGS
accountName: Your Savings account
accountSubType: Savings account
amounts:
- amountType: LEDGER_BALANCE
value: '52.20'
currency: USD
- amountType: AVAILABLE_BALANCE
value: '52.20'
currency: USD
foreignCurrencyConversion:
fccState: CONFIRM_REQUIRED
amount:
value: '20.00'
currency: EUR
amountInBaseCurrency:
value: '25.00'
currency: USD
exchangeRate:
baseCurrency: USD
foreignCurrency: EUR
directQuotation: false
sell: true
cash: true
rate: 80
decimals: 2
DepositFinishValidationResponseWithFee:
value:
responseCode: OK
payload:
confirmationNumber: 998a87999
hostResponseData:
hostResponseCode: '000'
hostTransactionTime: 2024-04-15T10:00:32+0000
hostMessage: ''
cardHandlingIndicator: CHAINING_ALLOWED
fees:
- name: Acquirer fee
type: DIRECT_ACQUIRER_FEE
amount:
value: '1.00'
currency: USD
accountRef:
accountNumber: C0123456789
accountType: FEE_COLLECTION_ACCOUNT
accountName: Fee account
accountSubType: Fee account
state: CONF_REQUIRED
DepositFinishValidationResponseWithoutFee:
value:
responseCode: OK
payload:
confirmationNumber: 998a87999
hostResponseData:
hostResponseCode: '000'
hostTransactionTime: 2024-04-15T10:00:32+0000
hostMessage: ''
cardHandlingIndicator: CHAINING_ALLOWED
DepositProcessClearingResponse:
value:
responseCode: OK
payload:
confirmationNumber: 998a87999
hostResponseData:
hostResponseCode: '000'
hostTransactionTime: 2024-04-15T10:00:32+0000
hostMessage: ''
cardHandlingIndicator: CHAINING_ALLOWED
emvResponse:
tag: ISSUER_DATA
value: 72629F18040*****0000005
cashInClearingState: OK
checkClearingState: OK
accounts:
- accountNumber: A0123456789
accountCurrency: USD
accountType: SAVINGS
accountName: Your Savings account
accountSubType: Savings account
amounts:
- amountType: LEDGER_BALANCE
value: '100.50'
currency: USD
- amountType: AVAILABLE_BALANCE
value: '100.50'
currency: USD
DepositFinalizeResponse:
value:
responseCode: OK
payload:
confirmationNumber: 998a87999
hostResponseData:
hostResponseCode: '000'
hostTransactionTime: 2024-04-15T10:00:32+0000
hostMessage: ''
cardHandlingIndicator: CHAINING_ALLOWED
emvResponse:
tag: ISSUER_DATA
value: 72629F18040*****0000005
deleteChecks: false
WithdrawalAuthorizeResponseWithoutFee:
value:
responseCode: OK
payload:
confirmationNumber: 998a87999
hostResponseData:
hostResponseCode: '000'
hostTransactionTime: 2024-04-15T10:00:32+0000
hostMessage: ''
cardHandlingIndicator: CHAINING_ALLOWED
businessDate: '2024-04-15'
emvResponse:
tag: ISSUER_DATA
value: 72629F18040*****0000005
accountInformation:
accountNumber: A0123456789
accountCurrency: USD
accountType: SAVINGS
accountName: Your Savings account
accountSubType: Savings account
amounts:
- amountType: LEDGER_BALANCE
value: '52.20'
currency: USD
- amountType: AVAILABLE_BALANCE
value: '52.20'
currency: USD
WithdrawalAuthorizeResponseWithFee:
value:
responseCode: OK
payload:
confirmationNumber: 998a87999
hostResponseData:
hostResponseCode: '000'
hostTransactionTime: 2024-04-15T10:00:32+0000
hostMessage: ''
cardHandlingIndicator: CHAINING_ALLOWED
businessDate: '2024-04-15'
emvResponse:
tag: ISSUER_DATA
value: 72629F18040*****0000005
accountInformation:
accountNumber: A0123456789
accountCurrency: USD
accountType: SAVINGS
accountName: Your Savings account
accountSubType: Savings account
amounts:
- amountType: LEDGER_BALANCE
value: '52.20'
currency: USD
- amountType: AVAILABLE_BALANCE
value: '52.20'
currency: USD
fees:
- name: Acquirer fee
type: DIRECT_ACQUIRER_FEE
amount:
value: '1.00'
currency: USD
accountRef:
accountNumber: C0123456789
accountType: FEE_COLLECTION_ACCOUNT
accountName: Fee account
accountSubType: Fee account
state: CONF_REQUIRED
WithdrawalAuthorizeResponseWithFCCConfirmRequired:
value:
responseCode: OK
payload:
confirmationNumber: 998a87999
hostResponseData:
hostResponseCode: '000'
hostTransactionTime: 2024-04-15T10:00:32+0000
hostMessage: ''
cardHandlingIndicator: CHAINING_ALLOWED
businessDate: '2024-04-15'
emvResponse:
tag: ISSUER_DATA
value: 72629F18040*****0000005
accountInformation:
accountNumber: A0123456789
accountCurrency: USD
accountType: SAVINGS
accountName: Your Savings account
accountSubType: Savings account
amounts:
- amountType: LEDGER_BALANCE
value: '52.20'
currency: USD
- amountType: AVAILABLE_BALANCE
value: '52.20'
currency: USD
foreignCurrencyConversion:
fccState: CONFIRM_REQUIRED
amount:
value: '20.00'
currency: EUR
amountInBaseCurrency:
value: '25.00'
currency: USD
exchangeRate:
baseCurrency: USD
foreignCurrency: EUR
directQuotation: false
sell: true
cash: true
rate: 80
decimals: 2
WithdrawalAuthorizeResponseWithFCCConfirmNotRequired:
value:
responseCode: OK
payload:
confirmationNumber: 998a87999
hostResponseData:
hostResponseCode: '000'
hostTransactionTime: 2024-04-15T10:00:32+0000
hostMessage: ''
cardHandlingIndicator: CHAINING_ALLOWED
businessDate: '2024-04-15'
emvResponse:
tag: ISSUER_DATA
value: 72629F18040*****0000005
accountInformation:
accountNumber: A0123456789
accountCurrency: USD
accountType: SAVINGS
accountName: Your Savings account
accountSubType: Savings account
amounts:
- amountType: LEDGER_BALANCE
value: '52.20'
currency: USD
- amountType: AVAILABLE_BALANCE
value: '52.20'
currency: USD
foreignCurrencyConversion:
fccState: CONF_NOT_REQUIRED
amount:
value: '20.00'
currency: EUR
amountInBaseCurrency:
value: '25.00'
currency: USD
exchangeRate:
baseCurrency: USD
foreignCurrency: EUR
directQuotation: false
sell: true
cash: true
rate: 80
decimals: 2
DepositAuthorizeRequest:
value:
pointOfInteraction:
clientId: '123'
institutionId: '1234'
branchCode: ''
tellerId: ''
clientTransactionDate: '0415'
clientTransactionTime: '074133'
channel: selfService
address:
street: Mainstreet
streetno: '119'
city: New York City
zipcode: N5467
countrycode: USA
state: New York
longitude: 0
latitude: 0
transaction:
id: '212423521525'
transactionTime: 2024-04-15T10:00:32+0000
poiSettlementDate: '0415'
businessCorrelationId: 0394757d955e4a6890bcc1f559936474
type: sbDeposit
operation: authorize
payload:
consumerId: '123456'
card:
bestMatchedElement: TRACK_2
pan: '4490739000000895'
track2: 4490739000000895D161222366
emvData:
- tag: EMV_57
value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
cardSequenceNumber: '05'
expiryDate: '2407'
consumerGroup: OnUsCard
targetAccount:
accountNumber: A0123456789
accountType: SAVINGS
accountName: Your Savings account
accountSubType: Savings account
DepositValidateRequestWithFCCCurrency:
value:
pointOfInteraction:
clientId: '123'
institutionId: '1234'
branchCode: ''
tellerId: ''
clientTransactionDate: '0415'
clientTransactionTime: '074133'
channel: selfService
address:
street: Mainstreet
streetno: '119'
city: New York City
zipcode: N5467
countrycode: USA
state: New York
longitude: 0
latitude: 0
transaction:
id: '212423521525'
transactionTime: 2024-04-15T10:00:32+0000
poiSettlementDate: '0415'
businessCorrelationId: 0394757d955e4a6890bcc1f559936474
type: sbDeposit
operation: validateDeposit
payload:
consumerId: '123456'
card:
bestMatchedElement: TRACK_2
pan: '4490739000000895'
track2: 4490739000000895D161222366
emvData:
- tag: EMV_57
value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
cardSequenceNumber: '05'
expiryDate: '2407'
consumerGroup: OnUsCard
targetAccount:
accountNumber: A0123456789
accountType: SAVINGS
accountName: Your Savings account
accountSubType: Savings account
checkAmount:
currency: EUR
value: '20.00'
cashInAmounts:
- currency: EUR
value: '20.00'
foreignCurrencyConversionList:
- amount:
currency: EUR
value: '20.00'
amountInBaseCurrency:
currency: USD
value: '22.22'
exchangeRate:
baseCurrency: USD
cash: true
decimals: 2
directQuotation: false
foreignCurrency: EUR
rate: 90
sell: false
fccState: CONFIRMED
itemMixUsed:
- changeType: NO_SOP_OPERATED_CHANGE
denomCounter:
- currency: EUR
denomination: '2000'
level4Count: 1
physicalType: NOTE
remainingTotalCounter: 1005
device:
device: CASH_RECYCLING_CASSETTE_1_3
deviceState: OPERATIONAL
DepositValidateRequest:
value:
pointOfInteraction:
clientId: '123'
institutionId: '1234'
branchCode: ''
tellerId: ''
clientTransactionDate: '0415'
clientTransactionTime: '074133'
channel: selfService
address:
street: Mainstreet
streetno: '119'
city: New York City
zipcode: N5467
countrycode: USA
state: New York
longitude: 0
latitude: 0
transaction:
id: '212423521525'
transactionTime: 2024-04-15T10:00:32+0000
poiSettlementDate: '0415'
businessCorrelationId: 0394757d955e4a6890bcc1f559936474
type: sbDeposit
operation: validateDeposit
payload:
consumerId: '123456'
card:
bestMatchedElement: TRACK_2
pan: '4490739000000895'
track2: 4490739000000895D161222366
emvData:
- tag: EMV_57
value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
cardSequenceNumber: '05'
expiryDate: '2407'
consumerGroup: OnUsCard
targetAccount:
accountNumber: A0123456789
accountType: SAVINGS
accountName: Your Savings account
accountSubType: Savings account
checkAmount:
currency: EUR
value: '20.00'
cashInAmounts:
- currency: EUR
value: '20.00'
DepositFinishValidationRequestWithFeeAccepted:
value:
pointOfInteraction:
clientId: '123'
institutionId: '1234'
branchCode: ''
tellerId: ''
clientTransactionDate: '0415'
clientTransactionTime: '074133'
channel: selfService
address:
street: Mainstreet
streetno: '119'
city: New York City
zipcode: N5467
countrycode: USA
state: New York
longitude: 0
latitude: 0
transaction:
id: '212423521525'
transactionTime: 2024-04-15T10:00:32+0000
poiSettlementDate: '0415'
businessCorrelationId: 0394757d955e4a6890bcc1f559936474
type: sbDeposit
operation: finishValidation
payload:
consumerId: '123456'
card:
bestMatchedElement: TRACK_2
pan: '4490739000000895'
track2: 4490739000000895D161222366
emvData:
- tag: EMV_57
value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
cardSequenceNumber: '05'
expiryDate: '2407'
consumerGroup: OnUsCard
validatedAmount:
value: '20.00'
currency: USD
fees:
- name: Acquirer fee
type: DIRECT_ACQUIRER_FEE
amount:
value: '1.00'
currency: USD
accountRef:
accountNumber: C0123456789
accountType: FEE_COLLECTION_ACCOUNT
accountName: Fee account
accountSubType: Fee account
state: CONFIRMED
accountingState: OK
mediaStates:
- state: OK
media: NOTE
DepositFinishValidationRequestWithoutFee:
value:
pointOfInteraction:
clientId: '123'
institutionId: '1234'
branchCode: ''
tellerId: ''
clientTransactionDate: '0415'
clientTransactionTime: '074133'
channel: selfService
address:
street: Mainstreet
streetno: '119'
city: New York City
zipcode: N5467
countrycode: USA
state: New York
longitude: 0
latitude: 0
transaction:
id: '212423521525'
transactionTime: 2024-04-15T10:00:32+0000
poiSettlementDate: '0415'
businessCorrelationId: 0394757d955e4a6890bcc1f559936474
type: sbDeposit
operation: finishValidation
payload:
consumerId: '123456'
card:
bestMatchedElement: TRACK_2
pan: '4490739000000895'
track2: 4490739000000895D161222366
emvData:
- tag: EMV_57
value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
cardSequenceNumber: '05'
expiryDate: '2407'
consumerGroup: OnUsCard
checkValidationTransactionId: '808123458'
validatedAmount:
value: '20.00'
currency: USD
accountingState: OK
DepositProcessClearingRequest:
value:
pointOfInteraction:
clientId: '123'
institutionId: '1234'
branchCode: ''
tellerId: ''
clientTransactionDate: '0415'
clientTransactionTime: '074133'
channel: selfService
address:
street: Mainstreet
streetno: '119'
city: New York City
zipcode: N5467
countrycode: USA
state: New York
longitude: 0
latitude: 0
transaction:
id: '212423521525'
transactionTime: 2024-04-15T10:00:32+0000
poiSettlementDate: '0415'
businessCorrelationId: 0394757d955e4a6890bcc1f559936474
type: sbDeposit
operation: finishValidation
payload:
consumerId: '123456'
card:
bestMatchedElement: TRACK_2
pan: '4490739000000895'
track2: 4490739000000895D161222366
emvData:
- tag: EMV_57
value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
cardSequenceNumber: '05'
expiryDate: '2407'
consumerGroup: OnUsCard
targetAccount:
accountNumber: A0123456789
accountType: SAVINGS
accountName: Your Savings account
accountSubType: Savings account
cashInAmount:
value: '20.00'
currency: USD
checkAmount:
value: '20.00'
currency: USD
clearingType: CASH_AND_CHECK
DepositFinalizeRequest:
value:
pointOfInteraction:
clientId: '123'
institutionId: '1234'
branchCode: ''
tellerId: ''
clientTransactionDate: '0415'
clientTransactionTime: '074133'
channel: selfService
address:
street: Mainstreet
streetno: '119'
city: New York City
zipcode: N5467
countrycode: USA
state: New York
longitude: 0
latitude: 0
transaction:
id: '212423521525'
transactionTime: 2024-04-15T10:00:32+0000
poiSettlementDate: '0415'
businessCorrelationId: 0394757d955e4a6890bcc1f559936474
type: sbDeposit
operation: confirm
payload:
consumerId: '123456'
card:
bestMatchedElement: TRACK_2
pan: '4490739000000895'
track2: 4490739000000895D161222366
emvData:
- tag: EMV_57
value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
cardSequenceNumber: '05'
expiryDate: '2407'
consumerGroup: OnUsCard
checkAmount:
value: '20.00'
currency: USD
cashInAmount:
value: '20.00'
currency: USD
accountingState: OK
mediaStates:
- state: OK
media: NOTE
itemMixUsed:
- device:
device: CASHIN_CASSETTE_1_1
deviceState: OPERATIONAL
changeType: CASH_ADDED
denomCounter:
- currency: USD
denomination: '2000'
physicalType: NOTE
level4Count: 1
itemMixTotal:
- device:
device: CHECKIN_CASSETTE_1
deviceState: OPERATIONAL
changeType: ''
denomCounter:
- retainCount: 2
- device:
device: CHECKIN_RETRACT_1
deviceState: OPERATIONAL
changeType: ''
denomCounter: []
- device:
device: CASHIN_CASSETTE_1_1
deviceState: OPERATIONAL
changeType: CASH_ADDED
denomCounter:
- currency: USD
denomination: '100'
physicalType: NOTE
level4Count: 5
- currency: USD
denomination: '2000'
physicalType: NOTE
level4Count: 2
- currency: USD
denomination: '10000'
physicalType: NOTE
level4Count: 1
- currency: USD
denomination: '5000'
physicalType: NOTE
level4Count: 1
- device:
device: CASHIN_RETRACT_1
deviceState: OPERATIONAL
changeType: NO_SOP_OPERATED_CHANGE
denomCounter:
- retractCounter: 1
- device:
device: CASHIN_CASSETTE_LEVEL2_1
deviceState: OPERATIONAL
changeType: NO_SOP_OPERATED_CHANGE
- device:
device: CASHIN_CASSETTE_LEVEL3_1
deviceState: OPERATIONAL
changeType: NO_SOP_OPERATED_CHANGE
CheckCashingAuthorizeRequest:
value:
pointOfInteraction:
clientId: '123'
institutionId: '1234'
branchCode: ''
tellerId: ''
clientTransactionDate: '0415'
clientTransactionTime: '074133'
channel: selfService
address:
street: Mainstreet
streetno: '119'
city: New York City
zipcode: N5467
countrycode: USA
state: New York
longitude: 0
latitude: 0
transaction:
id: '212423521525'
transactionTime: 2024-04-15T10:00:32+0000
poiSettlementDate: '0415'
businessCorrelationId: 0394757d955e4a6890bcc1f559936474
type: sbCheckCashing
operation: authorize
payload:
consumerId: '7745'
card:
bestMatchedElement: TRACK_2
pan: '4490739000000895'
track2: 4490739000000895D161222366
emvData:
- tag: EMV_57
value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
cardSequenceNumber: '05'
expiryDate: '2407'
consumerGroup: OnUsCard
pin:
encryptedPin: B1D2AC6236D99348
format: VISA_1
CheckCashingValidateChecksRequest:
value:
pointOfInteraction:
clientId: '123'
institutionId: '1234'
branchCode: ''
tellerId: ''
clientTransactionDate: '0415'
clientTransactionTime: '074133'
channel: selfService
address:
street: Mainstreet
streetno: '119'
city: New York City
zipcode: N5467
countrycode: USA
state: New York
longitude: 0
latitude: 0
transaction:
id: '212423521525'
transactionTime: 2024-04-15T10:00:32+0000
poiSettlementDate: '0415'
businessCorrelationId: 0394757d955e4a6890bcc1f559936474
type: sbCheckCashing
operation: validateChecks
payload:
consumerId: '7745'
card:
bestMatchedElement: TRACK_2
pan: '4490739000000895'
track2: 4490739000000895D161222366
emvData:
- tag: EMV_57
value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
cardSequenceNumber: '05'
expiryDate: '2407'
consumerGroup: OnUsCard
transactionId: DN200VPFS01110840011151162741
targetAccount:
accountNumber: A0123456789
accountType: SAVINGS
accountName: Your Savings account
accountSubType: Savings account
cashBackAmount:
value: '150.00'
currency: EUR
checkAmount:
value: '150.00'
currency: EUR
checks:
- id: A90A87312EE34C8CAE77BB0AEAB826F7
transactionId: DN200VPFS01110840011151162741
checkActionCode: NONE
deleted: false
suspectedFraud: false
micrReadIntegrity: GOOD
micr: T123*****1390
mediaState: OK
date: '2024-04-17'
score: 987
checkNumber: '0'
courtesyAmount:
value: '150.00'
currency: EUR
checkState: OPEN
CheckCashingFinishValidationRequest:
value:
pointOfInteraction:
clientId: '123'
institutionId: '1234'
branchCode: ''
tellerId: ''
clientTransactionDate: '0415'
clientTransactionTime: '074133'
channel: selfService
address:
street: Mainstreet
streetno: '119'
city: New York City
zipcode: N5467
countrycode: USA
state: New York
longitude: 0
latitude: 0
transaction:
id: '212423521525'
transactionTime: 2024-04-15T10:00:32+0000
poiSettlementDate: '0415'
businessCorrelationId: 0394757d955e4a6890bcc1f559936474
type: sbCheckCashing
operation: finishValidation
payload:
consumerId: '7745'
card:
bestMatchedElement: TRACK_2
pan: '4490739000000895'
track2: 4490739000000895D161222366
emvData:
- tag: EMV_57
value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
cardSequenceNumber: '05'
expiryDate: '2407'
consumerGroup: OnUsCard
validatedAmount:
value: '150.00'
currency: EUR
checks:
- id: A90A87312EE34C8CAE77BB0AEAB826F7
hostId: 442347823ebfad58676644aaaa432323
transactionId: DN200VPFS01110840011151162741
checkActionCode: NONE
deleted: false
suspectedFraud: false
micrReadIntegrity: GOOD
micr: T123*****1390
mediaState: OK
printData: Dated March 23rd, 2024
date: '2024-03-23'
score: 987
checkNumber: '0'
courtesyAmount:
value: '150.00'
currency: EUR
checkState: OPEN
accountingState: OK
mediaStates:
- state: NO_MEDIA
media: CHECK
CheckCashingProcessClearingRequest:
value:
pointOfInteraction:
clientId: '123'
institutionId: '1234'
branchCode: ''
tellerId: ''
clientTransactionDate: '0415'
clientTransactionTime: '074133'
channel: selfService
address:
street: Mainstreet
streetno: '119'
city: New York City
zipcode: N5467
countrycode: USA
state: New York
longitude: 0
latitude: 0
transaction:
id: '212423521525'
transactionTime: 2024-04-15T10:00:32+0000
poiSettlementDate: '0415'
businessCorrelationId: 0394757d955e4a6890bcc1f559936474
type: sbCheckCashing
operation: processClearing
payload:
consumerId: '7745'
card:
bestMatchedElement: TRACK_2
pan: '4490739000000895'
track2: 4490739000000895D161222366
emvData:
- tag: EMV_57
value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
cardSequenceNumber: '05'
expiryDate: '2407'
consumerGroup: OnUsCard
checkAmount:
value: '150.00'
currency: EUR
checks:
- id: A90A87312EE34C8CAE77BB0AEAB826F7
hostId: 442347823ebfad58676644aaaa432323
transactionId: DN200VPFS01110840011151162741
checkActionCode: NONE
deleted: false
suspectedFraud: false
micrReadIntegrity: GOOD
micr: T123*****1390
mediaState: OK
printData: Dated March 23rd, 2024
date: '2024-03-23'
score: 987
checkNumber: '0'
courtesyAmount:
value: '150.00'
currency: EUR
checkState: OPEN
CheckCashingAuthorizeCashOutRequest:
value:
pointOfInteraction:
clientId: '123'
institutionId: '1234'
branchCode: ''
tellerId: ''
clientTransactionDate: '0415'
clientTransactionTime: '074133'
channel: selfService
address:
street: Mainstreet
streetno: '119'
city: New York City
zipcode: N5467
countrycode: USA
state: New York
longitude: 0
latitude: 0
transaction:
id: '212423521525'
transactionTime: 2024-04-15T10:00:32+0000
poiSettlementDate: '0415'
businessCorrelationId: 0394757d955e4a6890bcc1f559936474
type: sbCheckCashing
operation: authorizeCashOut
payload:
consumerId: '7745'
card:
bestMatchedElement: TRACK_2
pan: '4490739000000895'
track2: 4490739000000895D161222366
emvData:
- tag: EMV_57
value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
cardSequenceNumber: '05'
expiryDate: '2407'
consumerGroup: OnUsCard
requestedAmount:
value: '150.00'
currency: EUR
account:
accountNumber: A0123456789
accountType: SAVINGS
accountName: Your Savings account
accountSubType: Savings account
CheckCashingFinalizeCashOutRequest:
value:
pointOfInteraction:
clientId: '123'
institutionId: '1234'
branchCode: ''
tellerId: ''
clientTransactionDate: '0415'
clientTransactionTime: '074133'
channel: selfService
address:
street: Mainstreet
streetno: '119'
city: New York City
zipcode: N5467
countrycode: USA
state: New York
longitude: 0
latitude: 0
transaction:
id: '212423521525'
transactionTime: 2024-04-15T10:00:32+0000
poiSettlementDate: '0415'
businessCorrelationId: 0394757d955e4a6890bcc1f559936474
type: sbCheckCashing
operation: finalizeCashOut
payload:
consumerId: '7745'
card:
bestMatchedElement: TRACK_2
pan: '4490739000000895'
track2: 4490739000000895D161222366
emvData:
- tag: EMV_57
value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
cardSequenceNumber: '05'
expiryDate: '2407'
consumerGroup: OnUsCard
dispensedAmount:
value: '150.00'
currency: EUR
requestedAmount:
value: '150.00'
currency: EUR
account:
accountNumber: A0123456789
accountType: SAVINGS
accountName: Your Savings account
accountSubType: Savings account
cashOutItemMixUsed:
- device:
device: CASH_RECYCLING_CASSETTE_1_1
deviceState: OPERATIONAL
changeType: CASH_REMOVED
denomCounter:
- currency: EUR
denomination: '1000'
physicalType: NOTE
dispensedCounter: 2
dispensedToConsumerCount: 2
remainingTotalCounter: 1013
- device:
device: CASH_RECYCLING_CASSETTE_1_2
deviceState: OPERATIONAL
changeType: CASH_REMOVED
denomCounter:
- currency: EUR
denomination: '1000'
physicalType: NOTE
dispensedCounter: 1
dispensedToConsumerCount: 1
remainingTotalCounter: 999
- device:
device: CASH_RECYCLING_CASSETTE_1_3
deviceState: OPERATIONAL
changeType: CASH_REMOVED
denomCounter:
- currency: EUR
denomination: '2000'
physicalType: NOTE
dispensedCounter: 1
dispensedToConsumerCount: 1
remainingTotalCounter: 1006
- device:
device: CASH_RECYCLING_CASSETTE_1_4
deviceState: OPERATIONAL
changeType: CASH_REMOVED
denomCounter:
- currency: EUR
denomination: '5000'
physicalType: NOTE
dispensedCounter: 2
dispensedToConsumerCount: 2
remainingTotalCounter: 1004
cashOutItemMixTotal:
- device:
device: CASHIN_CASSETTE_LEVEL2_1
deviceState: OPERATIONAL
changeType: NO_SOP_OPERATED_CHANGE
- device:
device: CASHOUT_RETRACT_1
deviceState: OPERATIONAL
changeType: ''
denomCounter: []
- device:
device: CASHIN_RETRACT_1
deviceState: OPERATIONAL
changeType: NO_SOP_OPERATED_CHANGE
denomCounter: []
- device:
device: CASHOUT_REJECT_1
deviceState: OPERATIONAL
changeType: ''
denomCounter:
- rejectCounter: 1
- device:
device: CASH_RECYCLING_CASSETTE_1_1
deviceState: OPERATIONAL
changeType: CASH_REMOVED
denomCounter:
- currency: EUR
denomination: '1000'
physicalType: NOTE
dispensedCounter: 14
dispensedToConsumerCount: 14
remainingTotalCounter: 1011
level4Count: 1011
- device:
device: CASH_RECYCLING_CASSETTE_1_2
deviceState: OPERATIONAL
changeType: CASH_REMOVED
denomCounter:
- currency: EUR
denomination: '1000'
physicalType: NOTE
dispensedCounter: 2
dispensedToConsumerCount: 2
remainingTotalCounter: 998
level4Count: 998
- device:
device: CASH_RECYCLING_CASSETTE_1_3
deviceState: OPERATIONAL
changeType: CASH_REMOVED
denomCounter:
- currency: EUR
denomination: '2000'
physicalType: NOTE
dispensedCounter: 7
dispensedToConsumerCount: 6
remainingTotalCounter: 1005
level4Count: 1005
- device:
device: CASH_RECYCLING_CASSETTE_1_4
deviceState: OPERATIONAL
changeType: CASH_REMOVED
denomCounter:
- currency: EUR
denomination: '5000'
physicalType: NOTE
dispensedCounter: 3
dispensedToConsumerCount: 3
remainingTotalCounter: 1002
level4Count: 1002
accountingState: OK
mediaStates:
- state: OK
media: NOTE
CheckCashingFinalizeRequest:
value:
payload:
pointOfInteraction: null
clientId: '123'
institutionId: '1234'
branchCode: ''
tellerId: ''
clientTransactionDate: '0415'
clientTransactionTime: '074133'
channel: selfService
address:
street: Mainstreet
streetno: '119'
city: New York City
zipcode: N5467
countrycode: USA
state: New York
longitude: 0
latitude: 0
transaction:
id: '212423521525'
transactionTime: 2024-04-15T10:00:32+0000
poiSettlementDate: '0415'
businessCorrelationId: 0394757d955e4a6890bcc1f559936474
type: sbCheckCashing
operation: confirm
consumerId: '7745'
card:
bestMatchedElement: TRACK_2
pan: '4490739000000895'
track2: 4490739000000895D161222366
emvData:
- tag: EMV_57
value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
cardSequenceNumber: '05'
expiryDate: '2407'
consumerGroup: OnUsCard
checkAmount:
value: '150.00'
currency: EUR
itemMixUsed:
- device:
device: CASH_RECYCLING_CASSETTE_1_1
deviceState: OPERATIONAL
changeType: CASH_REMOVED
denomCounter:
- currency: EUR
denomination: '1000'
physicalType: NOTE
dispensedCounter: 2
dispensedToConsumerCount: 2
remainingTotalCounter: 1013
- device:
device: CASH_RECYCLING_CASSETTE_1_2
deviceState: OPERATIONAL
changeType: CASH_REMOVED
denomCounter:
- currency: EUR
denomination: '1000'
physicalType: NOTE
dispensedCounter: 1
dispensedToConsumerCount: 1
remainingTotalCounter: 999
- device:
device: CASH_RECYCLING_CASSETTE_1_3
deviceState: OPERATIONAL
changeType: CASH_REMOVED
denomCounter:
- currency: EUR
denomination: '2000'
physicalType: NOTE
dispensedCounter: 1
dispensedToConsumerCount: 1
remainingTotalCounter: 1006
- device:
device: CASH_RECYCLING_CASSETTE_1_4
deviceState: OPERATIONAL
changeType: CASH_REMOVED
denomCounter:
- currency: EUR
denomination: '5000'
physicalType: NOTE
dispensedCounter: 2
dispensedToConsumerCount: 2
remainingTotalCounter: 1004
- device:
device: CHECKIN_CASSETTE_1
deviceState: OPERATIONAL
changeType: ''
denomCounter:
- retainCount: 1
itemMixTotal:
- device:
device: CASHIN_CASSETTE_LEVEL2_1
deviceState: OPERATIONAL
changeType: NO_SOP_OPERATED_CHANGE
- device:
device: CASHOUT_RETRACT_1
deviceState: OPERATIONAL
changeType: ''
denomCounter: []
- device:
device: CASHIN_RETRACT_1
deviceState: OPERATIONAL
changeType: NO_SOP_OPERATED_CHANGE
denomCounter: []
- device:
device: CASHOUT_REJECT_1
deviceState: OPERATIONAL
changeType: ''
denomCounter:
- rejectCounter: 1
- device:
device: CASH_RECYCLING_CASSETTE_1_1
deviceState: OPERATIONAL
changeType: CASH_REMOVED
denomCounter:
- currency: EUR
denomination: '1000'
physicalType: NOTE
dispensedCounter: 14
dispensedToConsumerCount: 14
remainingTotalCounter: 1011
level4Count: 1011
- device:
device: CASH_RECYCLING_CASSETTE_1_2
deviceState: OPERATIONAL
changeType: CASH_REMOVED
denomCounter:
- currency: EUR
denomination: '1000'
physicalType: NOTE
dispensedCounter: 2
dispensedToConsumerCount: 2
remainingTotalCounter: 998
level4Count: 998
- device:
device: CASH_RECYCLING_CASSETTE_1_3
deviceState: OPERATIONAL
changeType: CASH_REMOVED
denomCounter:
- currency: EUR
denomination: '2000'
physicalType: NOTE
dispensedCounter: 7
dispensedToConsumerCount: 6
remainingTotalCounter: 1005
level4Count: 1005
- device:
device: CASH_RECYCLING_CASSETTE_1_4
deviceState: OPERATIONAL
changeType: CASH_REMOVED
denomCounter:
- currency: EUR
denomination: '5000'
physicalType: NOTE
dispensedCounter: 3
dispensedToConsumerCount: 3
remainingTotalCounter: 1002
level4Count: 1002
- device:
device: CHECKIN_CASSETTE_1
deviceState: OPERATIONAL
changeType: ''
denomCounter:
- retainCount: 5
- device:
device: CHECKIN_RETRACT_1
deviceState: OPERATIONAL
changeType: ''
denomCounter: []
accountingState: OK
mediaStates:
- state: OK
media: CHECK
TransferAuthorizeRequestWithoutFee:
value:
pointOfInteraction:
clientId: '123'
institutionId: '1234'
branchCode: ''
tellerId: ''
clientTransactionDate: '0415'
clientTransactionTime: '074133'
channel: selfService
address:
street: Mainstreet
streetno: '119'
city: New York City
zipcode: N5467
countrycode: USA
state: New York
longitude: 0
latitude: 0
transaction:
id: '212423521525'
transactionTime: 2024-04-15T10:00:32+0000
poiSettlementDate: '0415'
businessCorrelationId: 0394757d955e4a6890bcc1f559936474
type: sbTransfer
operation: authorize
payload:
consumerId: '123456'
card:
bestMatchedElement: TRACK_2
pan: '4490739000000895'
track2: 4490739000000895D161222366
emvData:
- tag: EMV_57
value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
cardSequenceNumber: '05'
expiryDate: '2407'
consumerGroup: OnUsCard
amount:
value: '20.00'
currency: USD
accountRefFrom:
accountNumber: A0123456789
accountType: CHECKING
accountName: CHECKING account
accountSubType: Checking account
accountRefTo:
accountNumber: B0123456789
accountType: SAVINGS
accountName: SAVING account
accountSubType: SAVING account
TransferAuthorizeRequestWithFee:
value:
pointOfInteraction:
clientId: '123'
institutionId: '1234'
branchCode: ''
tellerId: ''
clientTransactionDate: '0415'
clientTransactionTime: '074133'
channel: selfService
address:
street: Mainstreet
streetno: '119'
city: New York City
zipcode: N5467
countrycode: USA
state: New York
longitude: 0
latitude: 0
transaction:
id: '212423521525'
transactionTime: 2024-04-15T10:00:32+0000
poiSettlementDate: '0415'
businessCorrelationId: 0394757d955e4a6890bcc1f559936474
type: sbTransfer
operation: authorize
payload:
consumerId: '123456'
card:
bestMatchedElement: TRACK_2
pan: '4490739000000895'
track2: 4490739000000895D161222366
emvData:
- tag: EMV_57
value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
cardSequenceNumber: '05'
expiryDate: '2407'
consumerGroup: OnUsCard
amount:
value: '20.00'
currency: USD
accountRefFrom:
accountNumber: A0123456789
accountType: CHECKING
accountName: CHECKING account
accountSubType: Checking account
accountRefTo:
accountNumber: B0123456789
accountType: LOAN
accountName: Mortgage Loan
accountSubType: Loan account
scheduledDate: '2019-09-23'
fees:
- name: Acquirer fee
type: DIRECT_ACQUIRER_FEE
amount:
value: '1.00'
currency: USD
accountRef:
accountNumber: C0123456789
accountType: FEE_COLLECTION_ACCOUNT
accountName: Fee account
accountSubType: Fee account
state: CONFIRMED
TransferFinalizeRequest:
value:
pointOfInteraction:
clientId: '123'
institutionId: '1234'
branchCode: ''
tellerId: ''
clientTransactionDate: '0415'
clientTransactionTime: '074133'
channel: selfService
address:
street: Mainstreet
streetno: '119'
city: New York City
zipcode: N5467
countrycode: USA
state: New York
longitude: 0
latitude: 0
transaction:
id: '212423521525'
transactionTime: 2024-04-15T10:00:32+0000
poiSettlementDate: '0415'
businessCorrelationId: 0394757d955e4a6890bcc1f559936474
type: sbTransfer
operation: confirm
payload:
consumerId: '123456'
card:
bestMatchedElement: TRACK_2
pan: '4490739000000895'
track2: 4490739000000895D161222366
emvData:
- tag: EMV_57
value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
cardSequenceNumber: '05'
expiryDate: '2407'
consumerGroup: OnUsCard
accountingState: OK
AddCashRequest:
value:
pointOfInteraction:
clientId: '123'
institutionId: '1234'
branchCode: ''
tellerId: ''
clientTransactionDate: '0415'
clientTransactionTime: '074133'
channel: selfService
address:
street: Mainstreet
streetno: '119'
city: New York City
zipcode: N5467
countrycode: USA
state: New York
longitude: 0
latitude: 0
transaction:
id: '212423521525'
transactionTime: 2024-04-15T10:00:32+0000
poiSettlementDate: '0415'
businessCorrelationId: 0394757d955e4a6890bcc1f559936474
type: sbDeposit
operation: addCash
payload:
consumerId: '123456'
card:
bestMatchedElement: TRACK_2
pan: '4490739000000895'
track2: 4490739000000895D161222366
emvData:
- tag: EMV_57
value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
cardSequenceNumber: '05'
expiryDate: '2407'
consumerGroup: OnUsCard
accountRef:
accountNumber: A0123456789
accountType: SAVINGS
accountName: Your Savings account
accountSubType: Business Savings
level3AmountList:
- value: '0.00'
currency: USD
level4AmountList:
- value: '20.00'
currency: USD
totalAmount:
value: '20.00'
currency: USD
itemMixUsed:
- device:
device: CASHIN_CASSETTE_1_1
deviceState: OPERATIONAL
changeType: CASH_ADDED
denomCounter:
- currency: USD
denomination: '2000'
physicalType: NOTE
level4Count: 1
AddCheckRequest:
value:
pointOfInteraction:
clientId: '123'
institutionId: '1234'
branchCode: ''
tellerId: ''
clientTransactionDate: '0415'
clientTransactionTime: '074133'
channel: selfService
address:
street: Mainstreet
streetno: '119'
city: New York City
zipcode: N5467
countrycode: USA
state: New York
longitude: 0
latitude: 0
transaction:
id: '212423521525'
transactionTime: 2024-04-15T10:00:32+0000
poiSettlementDate: '0415'
businessCorrelationId: 0394757d955e4a6890bcc1f559936474
type: sbDeposit
operation: addCheck
payload:
consumerId: '123456'
card:
bestMatchedElement: TRACK_2
pan: '4490739000000895'
track2: 4490739000000895D161222366
emvData:
- tag: EMV_57
value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
cardSequenceNumber: '05'
expiryDate: '2407'
consumerGroup: OnUsCard
check:
id: 6b836323d16c44a5b1dea08947d7d1e1
transactionId: 110a0f87a53e466ebf40f5f470cb4121
checkActionCode: NONE
deleted: false
suspectedFraud: false
micrReadIntegrity: GOOD
micr: T123*****1390
mediaState: OK
date: '2024-03-23'
documentSequenceNumber: 1
accountNumber: A0123456789
checkNumber: '123456'
courtesyAmount:
value: '100.00'
currency: USD
micrAmount:
value: '100.00'
currency: USD
userAmount:
value: '100.00'
currency: USD
externalProcessingCode: '4'
checkType: ON_US
checkState: OPEN
checkImageFront:
image: SUkqAN*******AAAA
imageType: TIFF
checkImageBack:
image: SUkqAN*******AAAA
imageType: TIFF
UpdateChecksRequest:
value:
pointOfInteraction:
clientId: '123'
institutionId: '1234'
branchCode: ''
tellerId: ''
clientTransactionDate: '0415'
clientTransactionTime: '074133'
channel: selfService
address:
street: Mainstreet
streetno: '119'
city: New York City
zipcode: N5467
countrycode: USA
state: New York
longitude: 0
latitude: 0
transaction:
id: '212423521525'
transactionTime: 2024-04-15T10:00:32+0000
poiSettlementDate: '0415'
businessCorrelationId: 0394757d955e4a6890bcc1f559936474
type: sbDeposit
operation: updateChecks
payload:
consumerId: '123456'
card:
bestMatchedElement: TRACK_2
pan: '4490739000000895'
track2: 4490739000000895D161222366
emvData:
- tag: EMV_57
value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
cardSequenceNumber: '05'
expiryDate: '2407'
consumerGroup: OnUsCard
checks:
- id: 6b836323d16c44a5b1dea08947d7d1e1
transactionId: 110a0f87a53e466ebf40f5f470cb4121
checkActionCode: NONE
deleted: false
suspectedFraud: false
micrReadIntegrity: GOOD
micr: T123*****1390
mediaState: OK
date: '2024-04-15'
documentSequenceNumber: 1
accountNumber: A0123456789
checkNumber: '123456'
courtesyAmount:
value: '100.00'
currency: USD
micrAmount:
value: '100.00'
currency: USD
userAmount:
value: '100.00'
currency: USD
externalProcessingCode: '4'
checkType: ON_US
checkState: OPEN
WithdrawalAuthorizeRequestWithoutFee:
value:
pointOfInteraction:
clientId: '123'
institutionId: '1234'
branchCode: ''
tellerId: ''
clientTransactionDate: '0415'
clientTransactionTime: '074133'
channel: selfService
address:
street: Mainstreet
streetno: '119'
city: New York City
zipcode: N5467
countrycode: USA
state: New York
longitude: 0
latitude: 0
transaction:
id: '212423521525'
transactionTime: 2024-04-15T10:00:32+0000
poiSettlementDate: '0415'
businessCorrelationId: 0394757d955e4a6890bcc1f559936474
type: sbWithdrawal
operation: authorize
payload:
consumerId: '123456'
card:
bestMatchedElement: TRACK_2
pan: '4490739000000895'
track2: 4490739000000895D161222366
emvData:
- tag: EMV_57
value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
cardSequenceNumber: '05'
expiryDate: '2407'
consumerGroup: OnUsCard
accountRef:
accountNumber: A0123456789
accountType: SAVINGS
accountName: Your Savings account
accountSubType: Savings account
amount:
value: '20.00'
currency: USD
WithdrawalAuthorizeRequestWithFeeConfirmed:
value:
pointOfInteraction:
clientId: '123'
institutionId: '1234'
branchCode: ''
tellerId: ''
clientTransactionDate: '0415'
clientTransactionTime: '074133'
channel: selfService
address:
street: Mainstreet
streetno: '119'
city: New York City
zipcode: N5467
countrycode: USA
state: New York
longitude: 0
latitude: 0
transaction:
id: '212423521525'
transactionTime: 2024-04-15T10:00:32+0000
poiSettlementDate: '0415'
businessCorrelationId: 0394757d955e4a6890bcc1f559936474
type: sbWithdrawal
operation: authorize
payload:
consumerId: '123456'
card:
bestMatchedElement: TRACK_2
pan: '4490739000000895'
track2: 4490739000000895D161222366
emvData:
- tag: EMV_57
value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
cardSequenceNumber: '05'
expiryDate: '2407'
consumerGroup: OnUsCard
accountRef:
accountNumber: A0123456789
accountType: SAVINGS
accountName: Your Savings account
accountSubType: Savings account
amount:
value: '20.00'
currency: USD
fees:
- name: Acquirer fee
type: DIRECT_ACQUIRER_FEE
amount:
value: '1.00'
currency: USD
accountRef:
accountNumber: C0123456789
accountType: FEE_COLLECTION_ACCOUNT
accountName: Fee account
accountSubType: Fee account
state: CONFIRMED
WithdrawalAuthorizeRequestWithFCC:
value:
payload:
consumerId: '123456'
card:
bestMatchedElement: TRACK_2
pan: '4490739000000895'
track2: 4490739000000895D161222366
emvData:
- tag: EMV_57
value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
cardSequenceNumber: '05'
expiryDate: '2407'
consumerGroup: OnUsCard
accountRef:
accountNumber: A0123456789
accountType: SAVINGS
accountName: Your Savings account
accountSubType: Savings account
amount:
value: '20.00'
currency: EUR
WithdrawalAuthorizeRequestWithFCCAccepted:
value:
pointOfInteraction:
clientId: '123'
institutionId: '1234'
branchCode: ''
tellerId: ''
clientTransactionDate: '0415'
clientTransactionTime: '074133'
channel: selfService
address:
street: Mainstreet
streetno: '119'
city: New York City
zipcode: N5467
countrycode: USA
state: New York
longitude: 0
latitude: 0
transaction:
id: '212423521525'
transactionTime: 2024-04-15T10:00:32+0000
poiSettlementDate: '0415'
businessCorrelationId: 0394757d955e4a6890bcc1f559936474
type: sbWithdrawal
operation: authorize
payload:
consumerId: '123456'
card:
bestMatchedElement: TRACK_2
pan: '4490739000000895'
track2: 4490739000000895D161222366
emvData:
- tag: EMV_57
value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
cardSequenceNumber: '05'
expiryDate: '2407'
consumerGroup: OnUsCard
accountRef:
accountNumber: A0123456789
accountType: SAVINGS
accountName: Your Savings account
accountSubType: Savings account
amount:
value: '20.00'
currency: EUR
foreignCurrencyConversion:
fccState: CONFIRMED
amount:
value: '20.00'
currency: EUR
amountInBaseCurrency:
value: '25.00'
currency: USD
exchangeRate:
baseCurrency: USD
foreignCurrency: EUR
directQuotation: false
sell: true
cash: true
rate: 80
decimals: 2
WithdrawalFinalizeRequest:
value:
pointOfInteraction:
clientId: '123'
institutionId: '1234'
branchCode: ''
tellerId: ''
clientTransactionDate: '0415'
clientTransactionTime: '074133'
channel: selfService
address:
street: Mainstreet
streetno: '119'
city: New York City
zipcode: N5467
countrycode: USA
state: New York
longitude: 0
latitude: 0
transaction:
id: '270'
transactionTime: 2024-04-15T10:00:32+0000
poiSettlementDate: '0415'
businessCorrelationId: 0394757d955e4a6890bcc1f559936474
type: sbWithdrawal
operation: confirm
payload:
consumerId: '123456'
card:
bestMatchedElement: TRACK_2
pan: '4490739000000895'
track2: 4490739000000895D161222366
emvData:
- tag: EMV_57
value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
cardSequenceNumber: '05'
expiryDate: '2407'
consumerGroup: OnUsCard
accountingState: OK
accountRef:
accountNumber: A0123456789
accountType: CHECKING
accountName: Your Checking Account
accountSubType: Checking account
amount:
value: '20.00'
currency: USD
mediaStates:
- state: OK
media: NOTE
itemMixUsed:
- device:
device: CASHOUT_CASSETTE_1_3
deviceState: OPERATIONAL
changeType: CASH_REMOVED
denomCounter:
- currency: USD
denomination: '1000'
physicalType: NOTE
dispensedCounter: 2
dispensedToConsumerCount: 2
remainingTotalCounter: 169
itemMixTotal:
- device:
device: CASHOUT_CASSETTE_1_1
deviceState: OPERATIONAL
changeType: NO_SOP_OPERATED_CHANGE
denomCounter:
- currency: USD
denomination: '100'
physicalType: NOTE
dispensedCounter: 11
dispensedToConsumerCount: 4
remainingTotalCounter: 189
- device:
device: CASHOUT_CASSETTE_1_2
deviceState: NOT_OPERATIONAL
changeType: NO_SOP_OPERATED_CHANGE
denomCounter:
- currency: EUR
denomination: '500'
physicalType: NOTE
dispensedCounter: 3
remainingTotalCounter: 197
- device:
device: CASHOUT_CASSETTE_1_3
deviceState: OPERATIONAL
changeType: CASH_REMOVED
denomCounter:
- currency: USD
denomination: '1000'
physicalType: NOTE
dispensedCounter: 31
dispensedToConsumerCount: 26
remainingTotalCounter: 169
- device:
device: CASHOUT_CASSETTE_1_5
deviceState: NOT_OPERATIONAL
changeType: NO_SOP_OPERATED_CHANGE
denomCounter:
- currency: USD
denomination: '1'
physicalType: NOTE
- device:
device: CASHOUT_CASSETTE_1_6
deviceState: NOT_OPERATIONAL
changeType: NO_SOP_OPERATED_CHANGE
denomCounter:
- currency: USD
denomination: '5'
physicalType: NOTE
- device:
device: CASHOUT_CASSETTE_1_7
deviceState: NOT_OPERATIONAL
changeType: NO_SOP_OPERATED_CHANGE
denomCounter:
- currency: USD
denomination: '10'
physicalType: NOTE
- device:
device: CASHOUT_CASSETTE_1_8
deviceState: NOT_OPERATIONAL
changeType: NO_SOP_OPERATED_CHANGE
denomCounter:
- currency: USD
denomination: '25'
physicalType: NOTE
- device:
device: CASHOUT_REJECT_1
deviceState: OPERATIONAL
changeType: ''
denomCounter:
- rejectCounter: 15
- device:
device: CASHOUT_RETRACT_1
deviceState: OPERATIONAL
changeType: ''
denomCounter: []
WithdrawalFinalizeResponse:
value:
responseCode: OK
payload:
confirmationNumber: 998a87999
hostResponseData:
hostResponseCode: '000'
hostTransactionTime: 2024-04-15T10:00:32+0000
hostMessage: OK
cardHandlingIndicator: OUT
LoginRequest:
value:
pointOfInteraction:
clientId: '123'
institutionId: '1234'
branchCode: ''
tellerId: ''
clientTransactionDate: '0415'
clientTransactionTime: '074133'
channel: selfService
address:
street: Mainstreet
streetno: '119'
city: New York City
zipcode: N5467
countrycode: USA
state: New York
longitude: 0
latitude: 0
transaction:
id: '212423521525'
transactionTime: 2024-04-15T10:00:32+0000
businessCorrelationId: 0394757d955e4a6890bcc1f559936474
type: sbLogin
operation: process
payload:
consumerId: '123456'
card:
bestMatchedElement: TRACK_2
pan: '4490739000000895'
track2: 4490739000000895D161222366
emvData:
- tag: EMV_57
value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
cardSequenceNumber: '05'
expiryDate: '2407'
consumerGroup: OnUsCard
LogoutRequest:
value:
pointOfInteraction:
clientId: '123'
institutionId: '1234'
branchCode: ''
tellerId: ''
clientTransactionDate: '0415'
clientTransactionTime: '074133'
channel: selfService
address:
street: Mainstreet
streetno: '119'
city: New York City
zipcode: N5467
countrycode: USA
state: New York
longitude: 0
latitude: 0
transaction:
id: '212423521525'
transactionTime: 2024-04-15T10:00:32+0000
businessCorrelationId: 0394757d955e4a6890bcc1f559936474
type: sbLogout
operation: process
payload:
consumerId: '123456'
card:
bestMatchedElement: TRACK_2
pan: '4490739000000895'
track2: 4490739000000895D161222366
emvData:
- tag: EMV_57
value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
cardSequenceNumber: '05'
expiryDate: '2407'
consumerGroup: OnUsCard
CurrencyExchangeRatesRequestSupportedCurrencies:
value:
pointOfInteraction:
clientId: '123'
institutionId: '1234'
branchCode: ''
tellerId: ''
clientTransactionDate: '0415'
clientTransactionTime: '074133'
channel: selfService
address:
street: Mainstreet
streetno: '119'
city: New York City
zipcode: N5467
countrycode: USA
state: New York
longitude: 0
latitude: 0
transaction:
id: '212423521525'
transactionTime: 2024-04-15T10:00:32+0000
businessCorrelationId: 0394757d955e4a6890bcc1f559936474
type: sbLogout
operation: process
payload:
consumerId: '123456'
card:
bestMatchedElement: TRACK_2
pan: '4490739000000895'
track2: 4490739000000895D161222366
emvData:
- tag: EMV_57
value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
cardSequenceNumber: '05'
expiryDate: '2407'
consumerGroup: OnUsCard
currencyExchangeRatePairs:
- sourceCurrency: USD
targetCurrency: EUR
currencyExchangeRateCategory: CASH
CurrencyExchangeRatesRequestNotSupportedCurrencies:
value:
pointOfInteraction:
clientId: '123'
institutionId: '1234'
branchCode: ''
tellerId: ''
clientTransactionDate: '0415'
clientTransactionTime: '074133'
channel: selfService
address:
street: Mainstreet
streetno: '119'
city: New York City
zipcode: N5467
countrycode: USA
state: New York
longitude: 0
latitude: 0
transaction:
id: '212423521525'
transactionTime: 2024-04-15T10:00:32+0000
businessCorrelationId: 0394757d955e4a6890bcc1f559936474
type: sbLogout
operation: process
payload:
consumerId: '123456'
card:
bestMatchedElement: TRACK_2
pan: '4490739000000895'
track2: 4490739000000895D161222366
emvData:
- tag: EMV_57
value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
cardSequenceNumber: '05'
expiryDate: '2407'
consumerGroup: OnUsCard
currencyExchangeRatePairs:
- sourceCurrency: USD
targetCurrency: CAD
currencyExchangeRateCategory: CASH
CurrencyExchangeRatesResponseSupportedCurrencies:
value:
responseCode: OK
payload:
exchangeRateDefs:
- directQuotation: false
baseCurrency: USD
foreignCurrency: EUR
rateSell: 84
rateBuy: 82
decimals: 2
currencyExchangeRateCategory: CASH
CurrencyExchangeRatesResponseNotSupportedCurrencies:
value:
responseCode: OK
payload:
notSupportedCurrencyExchangeRates:
- sourceCurrency: USD
targetCurrency: CAD
currencyExchangeRateCategory: CASH
schemas:
ServiceResponse:
type: object
required:
- responseCode
properties:
responseCode:
$ref: '#/components/schemas/ResponseCode'
extendedResponse:
$ref: '#/components/schemas/ExtendedResponse'
tokenResponse:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
required:
- token
- validity
properties:
token:
type: string
example: '123456789'
expirationDate:
type: string
format: yyyy-MM-dd'T'HH:mm:ssZ
description: Expiry timestamp of the generated token.
example: 2030-09-23T16:40:52+0530
getMemberBankListResponse:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
operation:
type: string
description: Defines the operation to be performed on the list of 'memberBanks'. ADD - adds the
listed 'memberBanks' to existing list of member banks if not present. REMOVE - removes the listed
'memberBanks' from existing list of member banks if present. If unspecified, the entire list
of member banks is refreshed with the new list of 'memberBanks'
enum:
- ADD
- REMOVE
memberBanks:
type: array
items:
$ref: '#/components/schemas/MemberBanks'
keepAliveResponse:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
accountInquiryRequest:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
required:
- accountRef
properties:
accountRef:
$ref: '#/components/schemas/AccountRef'
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
emvRequest:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
pin:
$ref: '#/components/schemas/Pin'
scope:
$ref: '#/components/schemas/AccountScopeInformation'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
consumerIdentifyRequest:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
pin:
$ref: '#/components/schemas/Pin'
memberBankId:
$ref: '#/components/schemas/MemberBankId'
accountRef:
$ref: '#/components/schemas/AccountRefConsumerIdentify'
consumerSearchForm:
type: object
properties:
firstName:
type: string
description: The first name of the account holder.
example: Betty
lastName:
type: string
description: The last name of the account holder.
example: Adams
name:
type: string
description: The full name of the account holder. Represents the full name of the individual or name of
the business entity if the holder is a business organisation.
example: Betty Adams
phoneNumber:
type: string
description: The phone number of the entity holding the account.
example: 91-1234567890
taxId:
type: string
description: The Tax Identification Number
example: '123456789'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
accountInquiryResponse:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
required:
- accountDetails
properties:
accountDetails:
$ref: '#/components/schemas/AccountInfo'
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
cardHandlingIndicator:
$ref: '#/components/schemas/CardHandlingIndicator'
emvResponse:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
creditRequest:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionWithStandin'
payload:
type: object
required:
- accountRef
- amount
properties:
amount:
$ref: '#/components/schemas/Amount'
consumerId:
type: string
example: '123456'
check:
$ref: '#/components/schemas/CheckWithAmount'
card:
$ref: '#/components/schemas/CardPan'
pin:
$ref: '#/components/schemas/Pin'
remark:
type: string
description: Transaction comments
example: Transaction remark
clearingCategoryCode:
$ref: '#/components/schemas/ClearingCategoryCode'
type:
$ref: '#/components/schemas/PaymentSubType'
valueDate:
$ref: '#/components/schemas/ValueDate'
fundTypeCode:
$ref: '#/components/schemas/FundTypeCode'
cashBoxNumber:
type: string
description: Cash Box Number
example: '1234'
accountRef:
$ref: '#/components/schemas/AccountRef'
fee:
$ref: '#/components/schemas/TransactionFeeAmountOnly'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
debitRequest:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionWithStandin'
payload:
type: object
required:
- accountRef
- amount
properties:
amount:
$ref: '#/components/schemas/Amount'
consumerId:
$ref: '#/components/schemas/ConsumerId'
check:
$ref: '#/components/schemas/CheckWithAmount'
card:
$ref: '#/components/schemas/CardPan'
pin:
$ref: '#/components/schemas/Pin'
remark:
type: string
description: Transaction comments
example: Transaction remark
clearingCategoryCode:
$ref: '#/components/schemas/ClearingCategoryCode'
type:
type: string
example: PAYOFF
valueDate:
$ref: '#/components/schemas/ValueDate'
fundTypeCode:
$ref: '#/components/schemas/FundTypeCode'
cashBoxNumber:
type: string
description: Cash Box Number
example: '1234'
accountRef:
$ref: '#/components/schemas/AccountRef'
fee:
$ref: '#/components/schemas/TransactionFeeAmountOnly'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
transferRequest:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionWithStandin'
payload:
type: object
required:
- accountRefTo
- accountRefFrom
- amount
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
pin:
$ref: '#/components/schemas/Pin'
remark:
type: string
description: Transaction comments
example: Transaction remark
type:
$ref: '#/components/schemas/PaymentSubType'
clearingCategoryCode:
$ref: '#/components/schemas/ClearingCategoryCode'
valueDate:
$ref: '#/components/schemas/ValueDate'
fundTypeCode:
$ref: '#/components/schemas/FundTypeCode'
accountRefTo:
$ref: '#/components/schemas/AccountRef'
accountRefFrom:
$ref: '#/components/schemas/AccountRef'
amount:
$ref: '#/components/schemas/Amount'
fee:
$ref: '#/components/schemas/TransactionFeeAmountOnly'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
currencyTransactionReportingRequest:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
properties:
remark:
type: string
description: Currency transaction reporting comments
example: CTR request in process
conductorConsumerId:
type: string
example: A000013
conductorNonConsumerId:
type: string
example: '243234'
conductorType:
type: string
example: NonConsumer
transactionMetaData:
type: array
items:
$ref: '#/components/schemas/TransactionMetaData'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
currencyTransactionReportingResponse:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
receiptId:
type: string
description: Receipt identification number of the transaction
example: 998a87999
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
updateCardStateRequest:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
required:
- card
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/Card'
pin:
$ref: '#/components/schemas/Pin'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
accountHoldRequest:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionWithStandin'
payload:
type: object
required:
- amount
- expiryDate
- accountRef
properties:
card:
$ref: '#/components/schemas/CardPan'
pin:
$ref: '#/components/schemas/Pin'
accountRef:
$ref: '#/components/schemas/AccountRef'
amount:
$ref: '#/components/schemas/Amount'
fee:
$ref: '#/components/schemas/TransactionFeeAmountOnly'
expiryDate:
$ref: '#/components/schemas/Date'
expiryDateTime:
$ref: '#/components/schemas/DateTime'
effectiveDate:
$ref: '#/components/schemas/Date'
holdType:
$ref: '#/components/schemas/HoldType'
remark:
type: string
description: Transaction comments
example: Hold for this account
payeeName:
type: string
description: The name of the payee when the holdType is CHECK_HOLD
example: Betty
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
getAccountStopHoldRequest:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
required:
- accountRef
properties:
accountRef:
$ref: '#/components/schemas/AccountRef'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
getAccountStopHoldResponse:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
required:
- accountHoldList
properties:
accountHoldList:
type: array
items:
$ref: '#/components/schemas/AccountHold'
accountStopPaymentList:
type: array
items:
$ref: '#/components/schemas/AccountStop'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
cancelAccountHoldRequest:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionWithStandin'
payload:
type: object
required:
- holdId
- accountRef
properties:
card:
$ref: '#/components/schemas/CardPan'
pin:
$ref: '#/components/schemas/Pin'
holdId:
type: string
description: The unique identifier used to identify the hold to be cancelled. This is the identifier received
in accountHold API response as the confirmationNumber
example: '998087999'
cancelEffectiveDate:
$ref: '#/components/schemas/Date'
amount:
$ref: '#/components/schemas/Amount'
fee:
$ref: '#/components/schemas/TransactionFeeAmountOnly'
accountRef:
$ref: '#/components/schemas/AccountRef'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
getAccountWarningsRequest:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
required:
- accountRef
properties:
accountRef:
$ref: '#/components/schemas/AccountRef'
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
pin:
$ref: '#/components/schemas/Pin'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
getAccountWarningsResponse:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
required:
- accountWarnings
- isBankEmployee
properties:
accountWarnings:
type: array
items:
$ref: '#/components/schemas/Warning'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
getAccountListWarningsRequest:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
required:
- accounts
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
pin:
$ref: '#/components/schemas/Pin'
accounts:
type: array
items:
$ref: '#/components/schemas/AccountRef'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
getAccountListWarningsResponse:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
required:
- accountWarnings
properties:
accountInformationList:
type: array
items:
$ref: '#/components/schemas/AccountListWarning'
transaction:
$ref: '#/components/schemas/TransactionResponse'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
getConsumerWarningsRequest:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
pin:
$ref: '#/components/schemas/Pin'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
getConsumerWarningsResponse:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
required:
- consumerWarnings
- isBankEmployee
properties:
isBankEmployee:
type: boolean
description: Is Bank Employee.
consumerWarnings:
type: array
items:
$ref: '#/components/schemas/Warning'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
getCardListRequest:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
accountRef:
$ref: '#/components/schemas/AccountRef'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
getCardListResponse:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
required:
- cards
properties:
cards:
type: array
items:
$ref: '#/components/schemas/Cards'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
updateAccountNickNameRequest:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
required:
- accountRef
- accountName
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
pin:
$ref: '#/components/schemas/Pin'
accountRef:
$ref: '#/components/schemas/AccountRef'
accountName:
type: string
minLength: 1
example: SAVINGS
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
getBusinessDateRequest:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
properties:
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
getBusinessDateResponse:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
required:
- businessDate
properties:
businessDate:
$ref: '#/components/schemas/Date'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
getAccountMovementRequest:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
required:
- accountRef
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
pin:
$ref: '#/components/schemas/Pin'
emvRequest:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
startDate:
$ref: '#/components/schemas/Date'
endDate:
$ref: '#/components/schemas/Date'
maxRecords:
$ref: '#/components/schemas/MaxRecords'
accountRef:
$ref: '#/components/schemas/AccountRef'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
getAccountMovementResponse:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
required:
- accountMovements
properties:
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
accountMovements:
type: array
items:
$ref: '#/components/schemas/AccountMovements'
cardHandlingIndicator:
$ref: '#/components/schemas/CardHandlingIndicator'
emvResponse:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
getOfacSearchRequest:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
consumerSearchForm:
type: object
properties:
name:
type: string
description: The name of the account owner
example: Betty Adams
consumerType:
$ref: '#/components/schemas/ConsumerType'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
getOfacSearchResponse:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
required:
- ofacSearchDetails
properties:
ofacSearchDetails:
type: array
items:
$ref: '#/components/schemas/OfacSearch'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
getScheduledTransactionsRequest:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
required:
- accountRef
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
pin:
$ref: '#/components/schemas/Pin'
accountRef:
$ref: '#/components/schemas/AccountRef'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
getScheduledTransactionsResponse:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
required:
- accountMovements
properties:
accountMovements:
type: array
items:
$ref: '#/components/schemas/AccountMovements'
transaction:
$ref: '#/components/schemas/TransactionResponse'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
getCheckIssuerDetailsRequest:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
required:
- check
properties:
check:
$ref: '#/components/schemas/Check'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
getCheckIssuerDetailsResponse:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
required:
- checkIssuerDetails
properties:
checkIssuerDetails:
$ref: '#/components/schemas/CheckIssuerDetails'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
reversalRequest:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionWithStandin'
payload:
type: object
required:
- confirmationNumber
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
pin:
$ref: '#/components/schemas/Pin'
accountRef:
$ref: '#/components/schemas/AccountRef'
amount:
$ref: '#/components/schemas/Amount'
fee:
$ref: '#/components/schemas/TransactionFeeAmountOnly'
confirmationNumber:
allOf:
- $ref: '#/components/schemas/ConfirmationNumber'
description: the transaction confirmation number for the transaction to be reversed.
remarks:
type: string
description: Remarks for the transaction
example: Reversal for ACCT XXXX 4567
cancelReason:
$ref: '#/components/schemas/CancelReason'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
transferReversalRequest:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionWithStandin'
payload:
type: object
required:
- confirmationNumber
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
pin:
$ref: '#/components/schemas/Pin'
accountRefFrom:
$ref: '#/components/schemas/AccountRef'
accountRefTo:
$ref: '#/components/schemas/AccountRef'
amount:
$ref: '#/components/schemas/Amount'
fee:
$ref: '#/components/schemas/TransactionFeeAmountOnly'
confirmationNumber:
allOf:
- $ref: '#/components/schemas/ConfirmationNumber'
description: the transaction confirmation number for the transaction to be reversed.
remarks:
type: string
description: Remarks for the transaction
example: Reversal for ACCT XXXX 4567
cancelReason:
$ref: '#/components/schemas/CancelReason'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
transferReversalResponse:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
fromAccountDetails:
$ref: '#/components/schemas/AccountInformationBase'
toAccountDetails:
$ref: '#/components/schemas/AccountInformationBase'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
pinCheckRequest:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
required:
- card
- pin
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
pin:
$ref: '#/components/schemas/Pin'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
login.request:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
login.response:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
enabledTransactions:
type: array
items:
$ref: '#/components/schemas/TransactionTypes'
consumerId:
$ref: '#/components/schemas/ConsumerId'
accounts:
type: array
items:
$ref: '#/components/schemas/AccountInfo'
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
cardHandlingIndicator:
$ref: '#/components/schemas/CardHandlingIndicator'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
logout.request:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
logout.response:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
cardHandlingIndicator:
$ref: '#/components/schemas/CardHandlingIndicator'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
cassCounterChanged.request:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
properties:
reason:
$ref: '#/components/schemas/CassCounterChangeReason'
newCassCounterList:
type: array
items:
$ref: '#/components/schemas/CassCounter'
oldCassCounterList:
type: array
items:
$ref: '#/components/schemas/CassCounter'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
cassCounterChanged.response:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
pinChange.authorize.Request:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
required:
- card
- oldPin
- newPin
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
emvRequest:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
oldPin:
$ref: '#/components/schemas/Pin'
newPin:
$ref: '#/components/schemas/Pin'
verifiedNewPin:
$ref: '#/components/schemas/Pin'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
pinChange.authorize.response:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
cardHandlingIndicator:
$ref: '#/components/schemas/CardHandlingIndicator'
businessDate:
$ref: '#/components/schemas/Date'
emvResponse:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
pinChange.finalize.request:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
emvRequest:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
accountingState:
$ref: '#/components/schemas/AccountingState'
cancelReason:
$ref: '#/components/schemas/CancelReason'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
pinchange.finalize.response:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
cardHandlingIndicator:
$ref: '#/components/schemas/CardHandlingIndicator'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
withdrawal.authorize.request:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
required:
- accountRef
- amount
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
emvRequest:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
pin:
$ref: '#/components/schemas/Pin'
accountRef:
$ref: '#/components/schemas/AccountRef'
amount:
$ref: '#/components/schemas/Amount'
fees:
type: array
items:
$ref: '#/components/schemas/TransactionFee'
dynamicCurrencyConversion:
$ref: '#/components/schemas/DynamicCurrencyConversion'
foreignCurrencyConversion:
$ref: '#/components/schemas/ForeignCurrencyConversion'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
withdrawal.authorize.response:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
cardHandlingIndicator:
$ref: '#/components/schemas/CardHandlingIndicator'
businessDate:
$ref: '#/components/schemas/Date'
fees:
type: array
items:
$ref: '#/components/schemas/TransactionFee'
emvResponse:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
accountInformation:
$ref: '#/components/schemas/AccountInformationBase'
alternateAmounts:
$ref: '#/components/schemas/AlternateAmounts'
dynamicCurrencyConversion:
$ref: '#/components/schemas/DynamicCurrencyConversion'
foreignCurrencyConversion:
$ref: '#/components/schemas/ForeignCurrencyConversion'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
withdrawal.finalize.request:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
emvRequest:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
accountRef:
$ref: '#/components/schemas/AccountRef'
amount:
$ref: '#/components/schemas/Amount'
accountingState:
$ref: '#/components/schemas/AccountingState'
mediaStates:
$ref: '#/components/schemas/MediaStates'
fees:
type: array
items:
$ref: '#/components/schemas/TransactionFee'
itemMixUsed:
type: array
description: List of dispensed notes and coins
items:
$ref: '#/components/schemas/CassCounter'
itemMixTotal:
type: array
description: list of dispensed notes and coins since last settlement
items:
$ref: '#/components/schemas/CassCounter'
cancelReason:
$ref: '#/components/schemas/CancelReason'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
withdrawal.finalize.response:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
cardHandlingIndicator:
$ref: '#/components/schemas/CardHandlingIndicator'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
transfer.authorize.request:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
required:
- accountRefTo
- accountRefFrom
- amount
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
pin:
$ref: '#/components/schemas/Pin'
emvRequest:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
accountRefFrom:
$ref: '#/components/schemas/AccountRef'
accountRefTo:
$ref: '#/components/schemas/AccountRef'
amount:
$ref: '#/components/schemas/Amount'
textKey:
type: string
description: Text key (typically used for accounting references and defined by the central bank of the state)
example: textKey
textKeyExtension:
type: string
description: Text key extension (used for accounting references)
example: textKeyExtension
remark:
type: string
description: Transaction remark
example: Transaction Remark
senderName:
type: string
description: Sender Name
example: ABC Corp.
receiverName:
type: string
description: Receiver Name
example: XYZ Ltd.
orderId:
type: string
description: Order Id
example: order Id
changeId:
type: string
description: Change Id
example: change Id
scheduledDate:
$ref: '#/components/schemas/Date'
creationDate:
$ref: '#/components/schemas/Date'
referenceNumber:
type: string
description: Reference number to identify a particular consumer/account for which payment is made
example: ''
paymentType:
$ref: '#/components/schemas/PaymentType'
paymentSubType:
$ref: '#/components/schemas/PaymentSubType'
foreignCurrencyConversion:
$ref: '#/components/schemas/ForeignCurrencyConversion'
fees:
type: array
items:
$ref: '#/components/schemas/TransactionFee'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
transfer.authorize.response:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
cardHandlingIndicator:
$ref: '#/components/schemas/CardHandlingIndicator'
businessDate:
$ref: '#/components/schemas/Date'
fees:
type: array
items:
$ref: '#/components/schemas/TransactionFee'
emvResponse:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
accountRefFrom:
$ref: '#/components/schemas/AccountInformationBase'
accountRefTo:
$ref: '#/components/schemas/AccountInformationBase'
amount:
$ref: '#/components/schemas/Amount'
textKey:
type: string
description: Text key (typically used for accounting references and defined by the central bank of the state)
example: textKey
textKeyExtension:
type: string
description: Text key extension (used for accounting references)
example: textKeyExtension
remark:
type: string
description: Transaction remark
example: Some remark
senderName:
type: string
description: Sender Name
example: ABC Corp.
receiverName:
type: string
description: Receiver Name
example: XYZ Ltd.
orderId:
type: string
description: Order Id
example: order Id
changeId:
type: string
description: Change Id
example: change Id
scheduledDate:
$ref: '#/components/schemas/Date'
creationDate:
$ref: '#/components/schemas/Date'
referenceNumber:
type: string
description: Reference number to identify a particular consumer/account for which payment is made
example: ''
paymentType:
$ref: '#/components/schemas/PaymentType'
paymentSubType:
$ref: '#/components/schemas/PaymentSubType'
foreignCurrencyConversion:
$ref: '#/components/schemas/ForeignCurrencyConversion'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
transfer.finalize.request:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
emvRequest:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
fees:
type: array
items:
$ref: '#/components/schemas/TransactionFee'
accountingState:
$ref: '#/components/schemas/AccountingState'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
transfer.finalize.response:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
cardHandlingIndicator:
$ref: '#/components/schemas/CardHandlingIndicator'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
deposit.authorize.request:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
pin:
$ref: '#/components/schemas/Pin'
emvRequest:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
targetAccount:
$ref: '#/components/schemas/TargetAccount'
splitDeposit:
type: array
items:
$ref: '#/components/schemas/SplitDeposit'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
deposit.authorize.response:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
cardHandlingIndicator:
$ref: '#/components/schemas/CardHandlingIndicator'
businessDate:
$ref: '#/components/schemas/Date'
emvResponse:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
checkLimit:
$ref: '#/components/schemas/CheckLimit'
cashInLimit:
$ref: '#/components/schemas/CashInLimit'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
addCash.request:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
accountRef:
$ref: '#/components/schemas/AccountRef'
level4AmountList:
type: array
description: A list of level 4 amounts
items:
$ref: '#/components/schemas/Amount'
level3AmountList:
type: array
description: A list of level 3 amounts
items:
$ref: '#/components/schemas/Amount'
totalAmount:
$ref: '#/components/schemas/AddCashTotalAmount'
description: The total of all level3 and level4 amounts
itemMixUsed:
type: array
description: List of used check and/or cash items
items:
$ref: '#/components/schemas/CassCounter'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
addCash.response:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
accountRef:
$ref: '#/components/schemas/AccountRef'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
addCheck.request:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
required:
- check
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
check:
$ref: '#/components/schemas/CheckDetailsWithImage'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
addCheck.response:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
check:
$ref: '#/components/schemas/CheckDetailsWithImage'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
updateChecks.request:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
required:
- checks
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
checks:
type: array
items:
$ref: '#/components/schemas/CheckDetailsWithImage'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
updateChecks.response:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
deposit.validate.request:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
transactionId:
$ref: '#/components/schemas/TransactionId'
targetAccount:
$ref: '#/components/schemas/TargetAccount'
checkAmount:
$ref: '#/components/schemas/CheckAmount'
cashInAmounts:
type: array
items:
$ref: '#/components/schemas/Amount'
checks:
type: array
items:
$ref: '#/components/schemas/CheckDetails'
foreignCurrencyConversionList:
type: array
items:
$ref: '#/components/schemas/ForeignCurrencyConversion'
itemMixUsed:
type: array
description: List of used check and/or cash items
items:
$ref: '#/components/schemas/CassCounter'
splitDeposit:
type: array
items:
$ref: '#/components/schemas/SplitDeposit'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
deposit.validate.response:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
cardHandlingIndicator:
$ref: '#/components/schemas/CardHandlingIndicator'
hostSumAmount:
$ref: '#/components/schemas/HostSumAmount'
hostCashBackAmount:
$ref: '#/components/schemas/HostCashBackAmount'
accountInformation:
$ref: '#/components/schemas/AccountInformationBase'
checkValidationTransactionId:
$ref: '#/components/schemas/CheckValidationTransactionId'
checks:
type: array
items:
$ref: '#/components/schemas/ValidateResponseCheck'
foreignCurrencyConversionList:
type: array
items:
$ref: '#/components/schemas/ForeignCurrencyConversion'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
deposit.finishValidation.request:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
validatedAmount:
$ref: '#/components/schemas/ValidatedAmount'
checks:
type: array
items:
$ref: '#/components/schemas/CheckDetails'
checkValidationTransactionId:
$ref: '#/components/schemas/CheckValidationTransactionId'
fees:
type: array
items:
$ref: '#/components/schemas/TransactionFee'
accountingState:
$ref: '#/components/schemas/AccountingState'
mediaStates:
$ref: '#/components/schemas/MediaStates'
cancelReason:
$ref: '#/components/schemas/CancelReason'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
deposit.finishValidation.response:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
cardHandlingIndicator:
$ref: '#/components/schemas/CardHandlingIndicator'
fees:
type: array
items:
$ref: '#/components/schemas/TransactionFee'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
deposit.processClearing.request:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
emvRequest:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
targetAccount:
$ref: '#/components/schemas/TargetAccount'
checkAmount:
$ref: '#/components/schemas/CheckAmount'
cashInAmount:
$ref: '#/components/schemas/CashInAmount'
checks:
type: array
items:
$ref: '#/components/schemas/CheckDetails'
fees:
type: array
items:
$ref: '#/components/schemas/TransactionFee'
clearingType:
$ref: '#/components/schemas/ClearingType'
splitDeposit:
type: array
items:
$ref: '#/components/schemas/SplitDeposit'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
deposit.processClearing.response:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
cardHandlingIndicator:
$ref: '#/components/schemas/CardHandlingIndicator'
emvResponse:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
checks:
type: array
items:
$ref: '#/components/schemas/ProcessClearingResponseCheck'
cashInClearingState:
$ref: '#/components/schemas/ClearingState'
checkClearingState:
$ref: '#/components/schemas/ClearingState'
accounts:
type: array
items:
$ref: '#/components/schemas/AccountInformationBase'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
deposit.finalize.request:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
emvRequest:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
checkAmount:
$ref: '#/components/schemas/CheckAmount'
cashInAmount:
$ref: '#/components/schemas/CashInAmount'
fees:
type: array
items:
$ref: '#/components/schemas/TransactionFee'
splitDeposit:
type: array
items:
$ref: '#/components/schemas/SplitDeposit'
itemMixUsed:
type: array
description: List of used check and/or cash items
items:
$ref: '#/components/schemas/CassCounter'
itemMixTotal:
type: array
description: List of total check and/or cash items
items:
$ref: '#/components/schemas/CassCounter'
accountingState:
$ref: '#/components/schemas/AccountingState'
mediaStates:
$ref: '#/components/schemas/MediaStates'
cancelReason:
$ref: '#/components/schemas/CancelReason'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
deposit.finalize.response:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
cardHandlingIndicator:
$ref: '#/components/schemas/CardHandlingIndicator'
deleteChecks:
type: boolean
description: Whether the check data must be deleted by the Client
example: false
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
mmp.authorize.request:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
pin:
$ref: '#/components/schemas/Pin'
emvRequest:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
targetAccount:
$ref: '#/components/schemas/TargetAccount'
sourceAccount:
$ref: '#/components/schemas/SourceAccount'
requestedAmount:
$ref: '#/components/schemas/RequestedAmount'
textKey:
type: string
description: Text key (typically used for accounting references and defined by the central bank of the state)
example: textKey
textKeyExtension:
type: string
description: Text key extension (used for accounting references)
example: textKeyExtension
remark:
type: string
description: Transaction remark
example: Transaction remark
senderName:
type: string
description: Sender's Name
receiverName:
type: string
description: Receiver's Name
orderId:
type: string
description: Order identifier
example: A4323
changeId:
type: string
description: Change Id
example: change Id
scheduledDate:
$ref: '#/components/schemas/ScheduledDate'
creationDate:
$ref: '#/components/schemas/Date'
referenceNumber:
type: string
description: Reference number to identify a particular consumer/account for which payment is made
example: ''
paymentType:
$ref: '#/components/schemas/PaymentType'
paymentSubType:
$ref: '#/components/schemas/PaymentSubType'
invoicingParty:
type: string
description: Invoicing party
externalPaymentId:
type: string
example: '4711'
description: External payment identifier
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
mmp.authorize.response:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
transaction:
$ref: '#/components/schemas/TransactionResponse'
cardHandlingIndicator:
$ref: '#/components/schemas/CardHandlingIndicator'
businessDate:
$ref: '#/components/schemas/Date'
emvResponse:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
checkLimit:
$ref: '#/components/schemas/CheckLimit'
cashInLimit:
$ref: '#/components/schemas/CashInLimit'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
mmp.finalize.request:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
emvRequest:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
checkAmount:
$ref: '#/components/schemas/CheckAmount'
cashInAmount:
$ref: '#/components/schemas/CashInAmount'
debitAmount:
$ref: '#/components/schemas/DebitAmount'
creditAmount:
$ref: '#/components/schemas/CreditAmount'
fees:
type: array
items:
$ref: '#/components/schemas/TransactionFee'
itemMixUsed:
type: array
description: List of used check and/or cash items
items:
$ref: '#/components/schemas/CassCounter'
itemMixTotal:
type: array
description: List of total check and/or cash items
items:
$ref: '#/components/schemas/CassCounter'
accountingState:
$ref: '#/components/schemas/AccountingState'
mediaStates:
$ref: '#/components/schemas/MediaStates'
cancelReason:
$ref: '#/components/schemas/CancelReason'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
mmp.finalize.response:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
cardHandlingIndicator:
$ref: '#/components/schemas/CardHandlingIndicator'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
mmp.processclearing.request:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
emvRequest:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
targetAccount:
$ref: '#/components/schemas/TargetAccount'
checkAmount:
$ref: '#/components/schemas/CheckAmount'
cashInAmount:
$ref: '#/components/schemas/CashInAmount'
checks:
type: array
items:
$ref: '#/components/schemas/CheckDetails'
debitAmount:
$ref: '#/components/schemas/DebitAmount'
creditAmount:
$ref: '#/components/schemas/CreditAmount'
account:
$ref: '#/components/schemas/AccountMMP'
fees:
type: array
items:
$ref: '#/components/schemas/TransactionFee'
clearingType:
$ref: '#/components/schemas/ClearingType'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
mmp.processclearing.response:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
cardHandlingIndicator:
$ref: '#/components/schemas/CardHandlingIndicator'
emvResponse:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
checks:
type: array
items:
$ref: '#/components/schemas/ProcessClearingResponseCheck'
cashInClearingState:
$ref: '#/components/schemas/ClearingState'
checkClearingState:
$ref: '#/components/schemas/ClearingState'
accounts:
type: array
items:
$ref: '#/components/schemas/AccountInformationBase'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
mmp.finishvalidation.request:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
validatedAmount:
$ref: '#/components/schemas/ValidatedAmount'
checks:
type: array
items:
$ref: '#/components/schemas/CheckDetails'
fees:
type: array
items:
$ref: '#/components/schemas/TransactionFee'
accountingState:
$ref: '#/components/schemas/AccountingState'
mediaStates:
$ref: '#/components/schemas/MediaStates'
cancelReason:
$ref: '#/components/schemas/CancelReason'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
mmp.finishvalidation.response:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
cardHandlingIndicator:
$ref: '#/components/schemas/CardHandlingIndicator'
fees:
type: array
items:
$ref: '#/components/schemas/TransactionFee'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
mmp.finalizecashout.request:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
emvRequest:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
dispensedAmount:
$ref: '#/components/schemas/DispensedAmount'
requestedAmount:
$ref: '#/components/schemas/RequestedAmountFinalizeCashOut'
account:
$ref: '#/components/schemas/AccountForUndispensedAmount'
fees:
type: array
items:
$ref: '#/components/schemas/TransactionFee'
cashOutItemMixUsed:
type: array
description: List of dispensed notes and coins
items:
$ref: '#/components/schemas/CassCounter'
cashOutItemMixTotal:
type: array
description: List of dispensed notes and coins since last settlement
items:
$ref: '#/components/schemas/CassCounter'
accountingState:
$ref: '#/components/schemas/AccountingState'
mediaStates:
$ref: '#/components/schemas/MediaStates'
cancelReason:
$ref: '#/components/schemas/CancelReason'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
mmp.finalizecashout.response:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
cardHandlingIndicator:
$ref: '#/components/schemas/CardHandlingIndicator'
accountInformation:
$ref: '#/components/schemas/AccountInformationBase'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
mmp.validate.request:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
transactionId:
$ref: '#/components/schemas/TransactionId'
targetAccount:
$ref: '#/components/schemas/TargetAccount'
checkAmount:
$ref: '#/components/schemas/CheckAmount'
cashInAmount:
$ref: '#/components/schemas/CashInAmount'
checks:
type: array
items:
$ref: '#/components/schemas/CheckDetails'
itemMixUsed:
type: array
description: List of used check and/or cash items
items:
$ref: '#/components/schemas/CassCounter'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
mmp.validate.response:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
cardHandlingIndicator:
$ref: '#/components/schemas/CardHandlingIndicator'
hostSumAmount:
$ref: '#/components/schemas/HostSumAmount'
hostCashBackAmount:
$ref: '#/components/schemas/HostCashBackAmount'
accountInformation:
$ref: '#/components/schemas/AccountInformationBase'
checkValidationTransactionId:
$ref: '#/components/schemas/CheckValidationTransactionId'
checkModificationAllowed:
description: Flag to indicate if check modification is allowed
type: boolean
example: false
checks:
type: array
items:
$ref: '#/components/schemas/ValidateResponseCheck'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
checkcashing.authorize.request:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
pin:
$ref: '#/components/schemas/Pin'
emvRequest:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
checkcashing.authorize.response:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
cardHandlingIndicator:
$ref: '#/components/schemas/CardHandlingIndicator'
businessDate:
$ref: '#/components/schemas/Date'
emvResponse:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
checkcashing.validate.request:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
transactionId:
$ref: '#/components/schemas/TransactionId'
targetAccount:
$ref: '#/components/schemas/TargetAccount'
cashBackAmount:
$ref: '#/components/schemas/CashBackAmount'
checkAmount:
$ref: '#/components/schemas/CheckAmount'
checks:
type: array
items:
$ref: '#/components/schemas/CheckDetails'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
checkcashing.validate.response:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
cardHandlingIndicator:
$ref: '#/components/schemas/CardHandlingIndicator'
hostCheckAmount:
$ref: '#/components/schemas/HostCheckAmount'
hostCashBackAmount:
$ref: '#/components/schemas/HostCashBackAmount'
accountInformation:
$ref: '#/components/schemas/AccountInformationBase'
checkValidationTransactionId:
$ref: '#/components/schemas/CheckValidationTransactionId'
checks:
type: array
items:
$ref: '#/components/schemas/ValidateResponseCheck'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
checkcashing.finishvalidation.request:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
validatedAmount:
$ref: '#/components/schemas/ValidatedAmount'
checkValidationTransactionId:
$ref: '#/components/schemas/CheckValidationTransactionId'
checks:
type: array
items:
$ref: '#/components/schemas/CheckDetails'
fees:
type: array
items:
$ref: '#/components/schemas/TransactionFee'
accountingState:
$ref: '#/components/schemas/AccountingState'
mediaStates:
$ref: '#/components/schemas/MediaStates'
cancelReason:
$ref: '#/components/schemas/CancelReason'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
checkcashing.finishvalidation.response:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
cardHandlingIndicator:
$ref: '#/components/schemas/CardHandlingIndicator'
fees:
type: array
items:
$ref: '#/components/schemas/TransactionFee'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
checkcashing.processclearing.request:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
emvRequest:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
checkAmount:
$ref: '#/components/schemas/CheckAmount'
checks:
type: array
items:
$ref: '#/components/schemas/CheckDetails'
fees:
type: array
items:
$ref: '#/components/schemas/TransactionFee'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
checkcashing.processclearing.response:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
cardHandlingIndicator:
$ref: '#/components/schemas/CardHandlingIndicator'
emvResponse:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
checks:
type: array
items:
$ref: '#/components/schemas/ProcessClearingResponseCheck'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
checkcashing.authorizecashout.request:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
emvRequest:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
requestedAmount:
$ref: '#/components/schemas/RequestedAmount'
creditAmount:
$ref: '#/components/schemas/CreditAmountCC'
account:
$ref: '#/components/schemas/AccountCC'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
checkcashing.authorizecashout.response:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
cardHandlingIndicator:
$ref: '#/components/schemas/CardHandlingIndicator'
businessDate:
$ref: '#/components/schemas/Date'
emvResponse:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
checkcashing.finalizecashout.request:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
emvRequest:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
dispensedAmount:
$ref: '#/components/schemas/DispensedAmount'
requestedAmount:
$ref: '#/components/schemas/RequestedAmountFinalizeCashOut'
account:
$ref: '#/components/schemas/AccountForUndispensedAmount'
fees:
type: array
items:
$ref: '#/components/schemas/TransactionFee'
cashOutItemMixUsed:
type: array
description: List of dispensed notes and coins
items:
$ref: '#/components/schemas/CassCounter'
cashOutItemMixTotal:
type: array
description: List of dispensed notes and coins since last settlement
items:
$ref: '#/components/schemas/CassCounter'
accountingState:
$ref: '#/components/schemas/AccountingState'
mediaStates:
$ref: '#/components/schemas/MediaStates'
cancelReason:
$ref: '#/components/schemas/CancelReason'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
checkcashing.finalizecashout.response:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
cardHandlingIndicator:
$ref: '#/components/schemas/CardHandlingIndicator'
accountInformation:
$ref: '#/components/schemas/AccountInformationBase'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
checkcashing.finalize.request:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
emvRequest:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
checkAmount:
$ref: '#/components/schemas/CheckAmount'
fees:
type: array
items:
$ref: '#/components/schemas/TransactionFee'
itemMixUsed:
type: array
description: List of used check and/or cash items
items:
$ref: '#/components/schemas/CassCounter'
itemMixTotal:
type: array
description: List of total check and/or cash items
items:
$ref: '#/components/schemas/CassCounter'
accountingState:
$ref: '#/components/schemas/AccountingState'
mediaStates:
$ref: '#/components/schemas/MediaStates'
cancelReason:
$ref: '#/components/schemas/CancelReason'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
checkcashing.finalize.response:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
cardHandlingIndicator:
$ref: '#/components/schemas/CardHandlingIndicator'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
zpk.exchange.request:
type: object
required:
- payload
- transaction
properties:
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
required:
- zoneId
- keyType
- keyName
properties:
zoneId:
$ref: '#/components/schemas/KeyZoneId'
keyType:
$ref: '#/components/schemas/KeyType'
keyName:
$ref: '#/components/schemas/KeyName'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
zpk.exchange.response:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
required:
- keyCheckValue
- keyGenerationIndex
- key
properties:
keyCheckValue:
$ref: '#/components/schemas/KeyCheckValue'
keyGenerationIndex:
$ref: '#/components/schemas/KeyGenerationIndex'
key:
$ref: '#/components/schemas/KeyData'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
getPreferencesRequest:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
required:
- scopes
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
scopes:
type: array
items:
$ref: '#/components/schemas/PreferenceScope'
preferences:
type: array
items:
$ref: '#/components/schemas/ConsumerPreferencesLoad'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
getPreferencesResponse:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
required:
- preferences
properties:
preferences:
type: array
items:
$ref: '#/components/schemas/ConsumerPreferences'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
setPreferencesRequest:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
required:
- preferences
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
preferences:
type: array
items:
$ref: '#/components/schemas/ConsumerPreferences'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
setPreferencesResponse:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
currencyExchangeRates.request:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
required:
- currencyExchangeRatePairs
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
currencyExchangeRatePairs:
type: array
items:
$ref: '#/components/schemas/CurrencyExchangeRatePairs'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
currencyExchangeRates.response:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
exchangeRateDefs:
type: array
items:
$ref: '#/components/schemas/CurrencyExchangeRateDefs'
notSupportedCurrencyExchangeRates:
type: array
items:
$ref: '#/components/schemas/NotSupportedCurrencyExchangeRatePairs'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
ExtendedResponse:
type: object
required:
- code
properties:
code:
$ref: '#/components/schemas/ExtendedResponseCode'
message:
$ref: '#/components/schemas/ExtendedResponseMessage'
ResponseCode:
type: string
enum:
- OK
- FAIL
- RESUBMIT
example: OK
ExtendedResponseCode:
type: string
enum:
- OK
- SERVER_FAILURE
- NO_RESULT
- ACCOUNT_NOT_FOUND
- ACCOUNT_CLOSED
- ACCOUNT_TYPE_INVALID
- LIMIT_EXCEEDED
- INSUFFICIENT_FUNDS
- REQUEST_DATA_INVALID
- TRX_NOT_PERMITTED_TO_ACCOUNT
- TRANSACTION_NOT_POSSIBLE
- HOST_OFFLINE
- HOST_CANCEL
- HOST_BUSINESS_ERROR
- RESPONSE_FEE_CONFIRM_REQUIRED
- OVERDRAFT_CONFIRM_REQUIRED
- PIN_VALIDATION_FAILED
- FCC_CONFIRM_REQUIRED
- DIRECT_CURRENCY_CONVERSION_CONFIRM_REQUIRED
- MULTI_CONFIRM_REQUIRED
- CARD_NOT_FOUND
- CARD_NOT_FOUND_FOR_EXPIRY_DATE
- CARD_BLOCKED
- CARD_EXPIRED
- CARD_MANIPULATED
- PIN_INACTIVE
- PIN_TRY_LIMIT_EXCEEDED
- PINS_DIFFER
- OFFLINE_OKAY
- SERVER_NOT_READY
example: OK
description: Extended Response Code Mapping
ExtendedResponseMessage:
type: string
description: Extended Response Message
example: OK
PointOfInteraction:
properties:
clientId:
type: string
description: Client Id
example: '123'
clientType:
$ref: '#/components/schemas/ClientType'
institutionId:
type: string
description: The id of the institute
example: '1234'
tellerId:
type: string
description: The id of the teller
example: ''
branchCode:
type: string
description: Branch code
example: ''
clientTransactionDate:
$ref: '#/components/schemas/ClientTransactionDate'
clientTransactionTime:
$ref: '#/components/schemas/ClientTransactionTime'
channel:
$ref: '#/components/schemas/Channel'
address:
$ref: '#/components/schemas/AddressPOI'
networkId:
$ref: '#/components/schemas/NetworkId'
merchantCategory:
$ref: '#/components/schemas/MerchantCategory'
Card:
type: object
required:
- pan
properties:
pan:
type: string
minLength: 1
description: Card number of the consumer
example: '4512665599887762'
cardState:
type: string
description: Defines the state of the card (Active, Blocked etc)
enum:
- ACTIVE
- CLOSED
- EXPIRED
- BLOCKED
- ISSUED
- HOTCARD
cardStateReasonCode:
type: string
description: Card State Reason Code
enum:
- LOST
- STOLEN
- EXPIRED
- DAMAGED
- SUSPECTED_FRAUD
- FRAUD
- CLOSED_BY_CUSTOMER
- AUTOMATIC_AGREEMENT_COPY
- DO_NOT_HONOUR
cardStateReasonDescription:
type: string
description: Card State Reason Description
example: Activate Card
CardPan:
type: object
required:
- pan
properties:
bestMatchedElement:
$ref: '#/components/schemas/BestMatchedElement'
pan:
type: string
minLength: 1
description: Primary Account Number (PAN) of the card
example: '4490739000000895'
track2:
type: string
example: 4490739000000895D161222366
description: ISO track 2 issued from the magnetic stripe card or from the ICC
emvData:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
cardSequenceNumber:
type: string
example: '05'
description: Identify a card or a payment token inside a set of cards with the same PAN
expiryDate:
type: string
description: Expiry date of the card expressed in YYMM format
example: '2107'
consumerGroup:
type: string
description: Consumer Group Name
example: CG_ON_US_DEBIT
BestMatchedElement:
type: string
example: TRACK_2
description: Best matched element for Consumer Identification
enum:
- TRACK_2
- NFC
- EMV
- CUSTOM
EMVTagData:
type: object
properties:
tag:
$ref: '#/components/schemas/EMVTags'
value:
type: string
description: Hex Encoded value of EMVTag
example: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
EMVTags:
type: string
example: EMV_57
enum:
- ISSUER_SCRIPTS
- ISSUER_SCRIPTS_RESULT
- EMV_42
- EMV_4F
- EMV_50
- EMV_57
- EMV_5A
- EMV_5F28
- EMV_5F55
- EMV_5F56
- EMV_5F57
- EMV_61
- EMV_6F
- EMV_70
- EMV_73
- EMV_77
- EMV_80
- EMV_81
- EMV_82
- EMV_83
- EMV_84
- EMV_86
- EMV_87
- EMV_88
- EMV_89
- EMV_8A
- EMV_8B
- EMV_8C
- EMV_8D
- EMV_8E
- EMV_8F
- EMV_90
- EMV_91
- EMV_92
- EMV_93
- EMV_94
- EMV_95
- EMV_97
- EMV_98
- EMV_99
- EMV_9A
- EMV_9B
- EMV_9C
- EMV_9D
- EMV_5F20
- EMV_5F24
- EMV_5F25
- EMV_5F2A
- EMV_5F2D
- EMV_5F30
- EMV_5F34
- EMV_5F36
- EMV_5F50
- EMV_5F53
- EMV_5F54
- EMV_9F01
- EMV_9F02
- EMV_9F03
- EMV_9F04
- EMV_9F05
- EMV_9F06
- EMV_9F07
- EMV_9F08
- EMV_9F09
- EMV_9F0B
- EMV_9F0D
- EMV_9F0E
- EMV_9F0F
- EMV_9F10
- EMV_9F11
- EMV_9F12
- EMV_9F13
- EMV_9F14
- EMV_9F15
- EMV_9F16
- EMV_9F17
- EMV_9F18
- EMV_9F19
- EMV_9F1A
- EMV_9F1B
- EMV_9F1C
- EMV_9F1D
- EMV_9F1E
- EMV_9F1F
- EMV_9F20
- EMV_9F21
- EMV_9F22
- EMV_9F23
- EMV_9F24
- EMV_9F26
- EMV_9F27
- EMV_9F2D
- EMV_9F2E
- EMV_9F2F
- EMV_9F32
- EMV_9F33
- EMV_9F34
- EMV_9F35
- EMV_9F36
- EMV_9F37
- EMV_9F38
- EMV_9F39
- EMV_9F3A
- EMV_9F3B
- EMV_9F3C
- EMV_9F3D
- EMV_9F40
- EMV_9F41
- EMV_9F42
- EMV_9F43
- EMV_9F44
- EMV_9F45
- EMV_9F46
- EMV_9F47
- EMV_9F48
- EMV_9F49
- EMV_9F4A
- EMV_9F4B
- EMV_9F4C
- EMV_9F4D
- EMV_9F4E
- EMV_9F4F
- EMV_9F53
- EMV_9F5B
- EMV_A5
- EMV_BF0C
- EMV_C0
- EMV_6E
- EMV_E7
- EMV_DF01
- EMV_DF02
- EMV_DF03
- EMV_DF04
Check:
type: object
required:
- checkNumber
properties:
checkNumber:
type: string
example: '214214'
micr:
type: string
example: 09879078
checkType:
$ref: '#/components/schemas/CheckType'
bankRoutingId:
type: string
description: Contains the BIC (bank identifier code)
example: '335668810'
accountNumber:
type: string
description: Account Number
example: '1248131234'
Pin:
type: object
required:
- encryptedPin
properties:
encryptedPin:
type: string
description: Hex encoded value of PIN block
example: B1D2AC6236D99348
format:
type: string
description: Encryption format for provided PIN
example: VISA_1
zpkGeneration:
type: string
description: Generation of Zone PIN Key used to encrypt the PIN
example: '2'
CheckIssuerDetails:
type: object
properties:
id:
type: string
description: Unqiue identifier for the check
example: edc856895cee42b5a859acec7f332ca3
transactionNumber:
type: string
description: Transaction number
example: '12489891247987'
score:
type: integer
description: Check score
state:
type: string
description: Check state
example: OPEN
suspectedFraud:
type: boolean
description: True if check is suspected as fraud.
checkNumber:
type: string
example: '214214'
micr:
type: string
example: 09879078
checkType:
$ref: '#/components/schemas/CheckType'
bankRoutingId:
type: string
description: Contains the BIC (bank identifier code)
example: '335668810'
accountNumber:
type: string
description: Account Number
example: 913131234"
accountType:
$ref: '#/components/schemas/AccountType'
rejectedBy:
type: string
description: check rejected by.
example: UNDEFINED
rejectedReason:
type: integer
description: reason for check rejection.
OfacSearch:
type: object
required:
- ofacMatchType
properties:
ofacMatchType:
type: string
description: OFAC Match Type.
example: OFACAlias
ofacMatchRef:
type: string
description: OFAC Match Reference ID.
example: L0305
id:
type: string
description: OFAC ID.
example: '6366'
aliasID:
type: string
description: OFAC alias ID.
example: '4349'
aliasName:
type: string
description: OFAC alias name.
example: A.C.L.
name:
type: string
description: Full Name.
example: 'Alliance Corporation Limited '
type:
type: string
description: OFAC Type.
example: Unknown
program:
type: string
description: OFAC Program.
example: FTO] [SDGT] [SDT
street:
type: string
description: OFAC Street.
example: A.B. street
city:
type: string
description: OFAC City.
example: New York
country:
type: string
description: OFAC Country.
example: USA
remarks:
type: string
description: Remarks for the transaction.
example: Search for ACCT XXXX 4567
AccountMovements:
type: object
required:
- transactionDate
- amount
- accountRef
properties:
effectiveDate:
$ref: '#/components/schemas/Date'
transactionId:
type: string
description: Transaction Id
example: '212423521525'
type:
type: string
description: transaction Type
example: credit
transactionDate:
$ref: '#/components/schemas/Date'
primanota:
type: string
description: Primanota for this account movement
example: '87536789'
amount:
$ref: '#/components/schemas/Amount'
accountRef:
$ref: '#/components/schemas/AccountRef'
remarks:
type: string
description: information on the transaction.
example: Misc Debit with description.
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
Cards:
type: array
items:
$ref: '#/components/schemas/Card'
AccountHold:
type: object
required:
- id
- effectiveDate
- expiryDate
- type
- code
- amount
properties:
id:
type: string
description: The unique identifier for the hold
minLength: 1
example: 123
expiryDate:
$ref: '#/components/schemas/Date'
effectiveDate:
$ref: '#/components/schemas/Date'
type:
$ref: '#/components/schemas/StopHoldType'
code:
type: string
description: The code for this hold
example: '1'
amount:
$ref: '#/components/schemas/Amount'
description:
type: string
description: The description for the hold
example: Hold for this account
AccountStop:
type: object
required:
- id
- effectiveDate
- expiryDate
- type
- code
- checkNumberStart
- checkNumberEnd
properties:
id:
type: string
description: The unique identifier for the stop payment
minLength: 1
example: 123
expiryDate:
$ref: '#/components/schemas/Date'
effectiveDate:
$ref: '#/components/schemas/Date'
type:
$ref: '#/components/schemas/StopHoldType'
code:
type: string
description: The code for this stop payment
example: STOL
description:
type: string
description: The description for the stop payment
example: Stop for this account
checkNumberStart:
type: string
description: The beginning check number for stop payment
example: '123'
checkNumberEnd:
type: string
description: The ending check number for stop payment
example: '789'
AccountRef:
type: object
description: "The account on which the transaction is to be performed. \n"
required:
- accountNumber
- accountType
properties:
accountNumber:
description: Account number
type: string
minLength: 1
example: A0123456789
accountType:
$ref: '#/components/schemas/AccountType'
accountName:
$ref: '#/components/schemas/AccountName'
accountSubType:
$ref: '#/components/schemas/AccountSubType'
AccountRefFee:
type: object
description: "The account in which fee transactions are to be performed. \n"
required:
- accountType
properties:
accountNumber:
description: Fee account number
type: string
minLength: 1
example: A0123456789
accountType:
$ref: '#/components/schemas/AccountType'
accountName:
$ref: '#/components/schemas/AccountName'
accountSubType:
$ref: '#/components/schemas/AccountSubType'
AccountRefConsumerIdentify:
type: object
properties:
accountNumber:
description: Account number
type: string
example: A0123456789
accountType:
$ref: '#/components/schemas/AccountType'
accountName:
$ref: '#/components/schemas/AccountName'
accountSubType:
$ref: '#/components/schemas/AccountSubType'
Amount:
description: "The basic type of an amount. \nAlways an unsigned value. \nThe host must perform operations on this value\
\ as per the context of the transaction.\n\ne.g. \nFor a withdrawal transaction, the value must be debited, whereas\
\ for a deposit transaction, the value must be credited.\n"
type: object
required:
- value
- currency
properties:
value:
description: The amount value of the given currency.
type: string
pattern: '[0-9]{1,13}\.[0-9]{1,3}'
minimum: 0
example: '100.00'
currency:
description: Currency code
type: string
minLength: 3
pattern: '[A-Z]{3,3}'
example: USD
AmountForeign:
description: The basic type of an amount.
type: object
required:
- value
- currency
properties:
value:
type: string
example: '82.00'
currency:
type: string
example: EUR
ConsumerId:
type: string
description: A unique identifier of a consumer
example: '123456'
accountListRequest:
type: object
required:
- pointOfInteraction
- payload
- transaction
properties:
pointOfInteraction:
$ref: '#/components/schemas/PointOfInteraction'
transaction:
$ref: '#/components/schemas/TransactionBase'
payload:
type: object
properties:
consumerId:
$ref: '#/components/schemas/ConsumerId'
card:
$ref: '#/components/schemas/CardPan'
emvRequest:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
pin:
$ref: '#/components/schemas/Pin'
scope:
$ref: '#/components/schemas/AccountScopeInformation'
maxRecords:
$ref: '#/components/schemas/MaxRecords'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
transactionConfirmationResponse:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
transactionConfirmationResponseUpdatedBalance:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
accountDetails:
$ref: '#/components/schemas/AccountInformationBase'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
transferConfirmationResponseUpdatedBalance:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
properties:
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
fromAccountDetails:
$ref: '#/components/schemas/AccountInformationBase'
toAccountDetails:
$ref: '#/components/schemas/AccountInformationBase'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
accountListResponse:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
required:
- accounts
properties:
accounts:
type: array
items:
$ref: '#/components/schemas/AccountInfo'
confirmationNumber:
$ref: '#/components/schemas/ConfirmationNumber'
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
cardHandlingIndicator:
$ref: '#/components/schemas/CardHandlingIndicator'
emvResponse:
type: array
items:
$ref: '#/components/schemas/EMVTagData'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
consumerIdentifyResponse:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
required:
- consumerDetails
properties:
consumerDetails:
type: array
items:
$ref: '#/components/schemas/ConsumerProfile'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
ConsumerLevel:
type: string
enum:
- NORMAL
- SENSITIVE
- HIGHLY_SENSITIVE
description: The consumer level
example: NORMAL
PhoneNumber:
type: object
required:
- number
- phoneType
properties:
number:
type: string
example: '+919123456789'
phoneType:
type: string
enum:
- BUSINESS
- HOME
- WORK
- MOBILE
example: HOME
ConsumerType:
type: string
enum:
- INDIVIDUAL
- BUSINESS
- UNKNOWN
description: Type of the consumer
example: INDIVIDUAL
ConsumerProfile:
type: object
required:
- consumerId
- firstname
- taxId
properties:
consumerId:
type: string
minLength: 1
description: A unique identifier of a consumer
example: '123456'
consumerLevel:
$ref: '#/components/schemas/ConsumerLevel'
firstName:
type: string
example: Betty
lastName:
type: string
example: Adams
name:
type: string
example: Betty Adams
email:
type: string
format: email
example: betty.adams123456@cmail.com
phoneNumbers:
type: array
items:
$ref: '#/components/schemas/PhoneNumber'
taxId:
type: string
description: The Tax Id of the account.
example: '123'
address:
$ref: '#/components/schemas/Address'
isBankEmployee:
type: boolean
consumerType:
$ref: '#/components/schemas/ConsumerType'
consumerWarnings:
type: array
items:
$ref: '#/components/schemas/Warning'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
AccountType:
type: string
enum:
- UNSPECIFIED
- GIRO
- SAVINGS
- SECURITIES_DEPOSIT
- SAVINGS_SECURITIES_DEPOSIT
- GIRO_SECURITIES_DEPOSIT
- FIXED_TERM_DEPOSIT
- CREDIT_CARD
- LOAN
- MORTGAGE
- FOREIGN_CURRENCY
- EXTERNAL
- CHECKING
- UNIVERSAL
- SPENDING_POWER
- FEE_COLLECTION_ACCOUNT
- ATM
- VENDOR
- SHAREHOLDER
- GENERAL_LEDGER
- CASH_RESERVE
- LOAN_DENIAL
- LEASE
- CONSUMER_LOAN
- COMMERCIAL_LOAN
- RETIREMENT_LOAN
- EXTERNAL_LOAN
- SHARE
- INDIVIDUAL_RETIREMENT
- CARD_PAN
- HEALTH_SAVINGS
- CREDIT
- CREDIT_LINE
- CERTIFIED_DEPOSIT
- INSTALLMENT
- OTHER
- DEFAULT_INVESTMENT_ACCOUNT
- CASH_BENEFIT
- OTHER_LOAN
- DEBIT_CARD
- DEFERRED_DEBIT_CARD
- CHARGE_ACCOUNT
- PREPAID
- EMPLOYEE_BENEFIT
example: SAVINGS
description: '| Symbolic name | Comment | |----------------------------|----------------------------------------------------------------|
| UNSPECIFIED | Default value for unknown accounts. | | GIRO |
Giro account. | | SAVINGS | Savings account. |
SECURITIES_DEPOSIT | Depot of securities (shares and so on). | | SAVINGS_SECURITIES_DEPOSIT
| Savings securities. | | GIRO_SECURITIES_DEPOSIT | Giro securities. |
| FIXED_TERM_DEPOSIT | Fixed term deposit. | | CREDIT_CARD |
Credit card account. (ISO 8583; MC DE.54->30 / VISA DE.54->30).| | LOAN | An account that covers
a credit and its balance and movements. | | MORTGAGE | Security for a loan. |
| FOREIGN_CURRENCY | An account that holds money in a foreign curreny. | | EXTERNAL |
An account that represents an account of a foreign institution.| | CHECKING | Checking account.
(ISO 8583; MC DE.54->20 / VISA DE.54->20) | | UNIVERSAL | ISO 8583; VISA DE.54->40) | |
SPENDING_POWER | ISO 8583; VISA DE.54->64) | | FEE_COLLECTION_ACCOUNT |
used to collect fees | | ATM | ATM |
| VENDOR | Vendor | | SHAREHOLDER |
Shareholder | | GENERAL_LEDGER | General ledger |
| CASH_RESERVE | Cash Reserve Line of Credit | | LOAN_DENIAL |
Load denial | | LEASE | Lease |
| CONSUMER_LOAN | Consumer loan | | COMMERCIAL_LOAN |
Cemercial loan | | RETIREMENT_LOAN | Retirement loan |
| EXTERNAL_LOAN | External loan | | SHARE |
Share | | INDIVIDUAL_RETIREMENT | Individual Retirement
Account(IRA) |'
AccountSubType:
description: Represents the SubType of an account for AccountType
type: string
example: Savings account
AccountScopeInformation:
type: string
description: The scope from where the the account list has to be returned in response
enum:
- INTERNAL
- EXTERNAL
example: INTERNAL
AccountOwnership:
type: string
enum:
- PRIMARY
- JOINT
- NOT_SPECIFIED
- CUSTODIAN
- TRUSTEE
- POWER_OF_ATTORNEY
- AUTHORIZED_SIGNER
- TRUSTOR
- CO_BORROWER
- CO_SIGNER
- CO_OWNER
- CO_MAKER
- CORPORATION
- BORROWER
- CORPORATE_OWNER
- JOINT_PRIMARY
- JOINT_SECONDARY
- JOINT_AND
- JOINT_OR
- ENDORSER
- GUARANTOR
- GRANTOR
- LANDLORD
- SECONDARY
- TENANT
- SOLE_PROPRIETOR
- GUARDIAN
- EXECUTOR
example: PRIMARY
AccountStatus:
type: string
description: The status of the account
enum:
- ACTIVE
- APPROVED
- CLOSED
- DORMANT
- PENDING_CLOSED
- CHARGEOFF
- INACTIVE
- NON_ACCRUAL
- MATURED
- ESCHEAT
- ASSUMED
- LOAN_DENIED
- ORIGINATING
- REDEEMED
- MATURED_NOT_REDEEMED
- NO_DEBIT
- NO_CREDIT
- NO_POST
- FROZEN_NON_ACCRUAL
- CHARGEDOFF_NON_ACCRUAL
- OCCUPIED
- NOT_AVAILABLE
- UNOCCUPIED
- ACTIVE_NO_POD
- DO_NOT_CLOSE_ON_ZERO_BALANCE
- FROZEN_ACCRUAL
- OPEN_PRIMARY_ACCOUNT
- RESTRICTED_PRIMARY_ACCOUNT
- RESTRICTED_TO_DEPOSIT
- NOT_SPECIFIED
example: ACTIVE
AccountName:
type: string
description: The account name which is displayed to the user
example: Your Savings account
CheckType:
type: string
enum:
- ON_US
- OFF_US
- GOVERNMENT
- NOT_SPECIFIED
example: ON_US
description: The Check Type value of the check
AccessPermission:
type: string
enum:
- NO_PERMISSION
- FULL_PERMISSION
- DEPOSIT_ONLY_PERMISSION
- WITHDRAWAL_ONLY_PERMISSION
example: FULL_PERMISSION
description: The Access permission of the Account
AccountPermissions:
type: object
properties:
accessPermission:
$ref: '#/components/schemas/AccessPermission'
markedForDepositOnly:
type: boolean
example: false
description: Flag to identify if the account is for Deposit only
Conductor:
type: object
required:
- conductorId
- firstName
properties:
conductorId:
type: string
example: '4562893742'
firstName:
type: string
example: Betty
lastName:
type: string
example: Adams
role:
type: string
example: PRIMARY
primaryIdentifier:
type: integer
example: 1
accountPermissions:
type: array
items:
$ref: '#/components/schemas/AccountPermissions'
Amounts:
type: array
items:
$ref: '#/components/schemas/AccountAmount'
AccountAmount:
type: object
properties:
amountType:
$ref: '#/components/schemas/AccountAmountType'
value:
description: The amount value of the given currency
type: string
pattern: '[0-9]{1,13}\.[0-9]{1,3}'
minimum: 0
example: '100.50'
currency:
description: Currency code
type: string
pattern: '[A-Z]{3,3}'
example: USD
AccountAmountType:
type: string
enum:
- LEDGER_BALANCE
- AVAILABLE_BALANCE
- AVAILABLE_CREDIT
- CREDIT_LIMIT
- OVERDRAFT_LIMIT
- LOAN_BALANCE
- INTEREST_AMOUNT
- REGULAR_PAYMENT_AMOUNT
- REGULAR_PAYMENT_DUE
- PRINCIPLE_BALANCE
- CURRENT_AMOUNT_DUE
- LAST_PAYMENT_AMOUNT
- LAST_CHARGE_DUE
- INTEREST_PAID_YEAR_TO_DATE
- INTEREST_PAID_PREVIOUS_YEAR_TO_DATE
- OFF_HOST_DEBIT_AMOUNT
- OFF_HOST_CREDIT_AMOUNT
- TOTAL_DEBIT_AMOUNT
- TOTAL_CREDIT_AMOUNT
- PAYOFF_AMOUNT
- OWING_AMOUNT
- AMOUNT_ALREADY_DRAWN_ON
- MEMBER_PROVIDED_FEE_AMOUNT
- REMAINING_PREAUTHORIZED_AMOUNT
- HEALTHCARE_ELIGIBILITY_AMOUNT
- PRESCRIPTION_ELIGIBILITY_AMOUNT
- PREPAID_ONLINE_BILL_PAY_FEE_AMOUNT
- CASH_BACK
- ORIGINAL_AMOUNT
- POI_AMOUNT
- CO_PAY_AMOUNT
- MINIMUM_AMOUNT_DUE
- REWARD_BALANCE
- LAST_STATEMENT_BALANCE
example: AVAILABLE_BALANCE
description: Amount types for account
PaymentType:
type: string
description: Payment type
enum:
- LOAN
- CREDIT_CARD
- BILL
- NOT_SPECIFIED
PaymentSubType:
type: string
description: Payment subtype
enum:
- PRINCIPAL
- REGULAR
- PAYOFF
- INTEREST_ONLY
- MINIMUM
- NOT_SPECIFIED
LoanType:
type: string
enum:
- LOAN
- CONSUMER_LOAN
- COMMERCIAL_LOAN
- MORTGAGE_LOAN
- EXTERNAL_LOAN
- LOAN_DENIAL
example: MORTGAGE_LOAN
description: All the possible account types for LOAN Accounts
Loan:
type: object
description: Loan balance to be represented in amounts as LOAN_BALANCE, INTEREST_AMOUNT, REGULAR_PAYMENT_AMOUNT, REGULAR_PAYMENT_DUE,
PRINCIPLE_BALANCE, MINIMUM_AMOUNT_DUE, LAST_PAYMENT_AMOUNT, LAST_CHARGE_DUE, INTEREST_PAID_YEAR_TO_DATE, INTEREST_PAID_PREVIOUS_YEAR_TO_DATE
properties:
loanType:
$ref: '#/components/schemas/LoanType'
loanMaturityDate:
$ref: '#/components/schemas/Date'
Credit:
type: object
description: Credit amounts to be represnted in amounts as CREDIT_LIMIT, AVAILABLE_CREDIT, LAST_CHARGE_DUE, INTEREST_PAID_YEAR_TO_DATE,
INTEREST_PAID_PREVIOUS_YEAR_TO_DATE, INTEREST_AMOUNT, MINIMUM_AMOUNT_DUE, REWARD_BALANCE, LAST_STATEMENT_BALANCE
properties:
interestRate:
type: number
format: double
description: Interest rate for this account
example: 2.34
Payment:
type: object
description: Payment amounts to be represnted in amounts as REGULAR_PAYMENT_AMOUNT, REGULAR_PAYMENT_DUE, PRINCIPAL_BALANCE,
PAYOFF_AMOUNT, LAST_PAYMENT_AMOUNT
properties:
regularPaymentDueDate:
$ref: '#/components/schemas/Date'
regularPaymentFrequency:
type: string
description: Regular payment frequency. This can be DAILY| MONTHLY|WEEKLY|YEARLY
example: MONTHLY
lastPaymentDate:
$ref: '#/components/schemas/Date'
paymentMethod:
type: string
description: The payment method of this account.
AccountListWarning:
type: object
required:
- accountRef
- isBankEmployee
- accountWarnings
properties:
accountRef:
$ref: '#/components/schemas/AccountRef'
isBankEmployee:
type: boolean
description: Is Bank Employee.
accountWarnings:
type: array
items:
$ref: '#/components/schemas/Warning'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
Warning:
type: object
required:
- warningCode
- effectiveDate
properties:
effectiveDate:
$ref: '#/components/schemas/Date'
expirationDate:
$ref: '#/components/schemas/Date'
warningCode:
type: string
example: 94
description: The warning code for warning.
description:
type: string
description: The description for this warning.
category:
type: string
description: The category for this warning.
AccountInfo:
type: object
allOf:
- $ref: '#/components/schemas/AccountInformationBase'
- type: object
properties:
accountOwnerName:
type: string
description: 'The owner of the account. '
example: JOHN DOE
accountOwnership:
$ref: '#/components/schemas/AccountOwnership'
accountStatus:
$ref: '#/components/schemas/AccountStatus'
cardNumber:
type: string
description: Card number
example: 3999821321
branchCode:
description: The branch code of the bank
type: string
example: 1234
bankCode:
description: Contains the BIC (bank identifier code)
type: string
example: '11133444'
nickName:
type: string
description: NickName
example: Nick
openDate:
$ref: '#/components/schemas/Date'
accountMaturityDate:
$ref: '#/components/schemas/Date'
conductors:
type: array
items:
$ref: '#/components/schemas/Conductor'
possibleTransactionsAsSourceAccount:
type: array
items:
$ref: '#/components/schemas/TransactionTypes'
possibleTransactionsAsTargetAccount:
type: array
items:
$ref: '#/components/schemas/TransactionTypes'
loan:
$ref: '#/components/schemas/Loan'
credit:
$ref: '#/components/schemas/Credit'
payment:
$ref: '#/components/schemas/Payment'
accountWarnings:
type: array
items:
$ref: '#/components/schemas/Warning'
AccountInformationBase:
type: object
required:
- accountType
- accountNumber
- amounts
properties:
accountNumber:
description: Account number
type: string
minLength: 5
example: '19023456789'
accountCurrency:
description: Currency code
type: string
pattern: '[A-Z]{3,3}'
example: USD
accountType:
$ref: '#/components/schemas/AccountType'
accountSubType:
$ref: '#/components/schemas/AccountSubType'
accountName:
$ref: '#/components/schemas/AccountName'
instituteName:
description: The name or identifier of the institute
type: string
example: Deutsche Bank
effectiveDateTime:
type: string
description: The date and time stamp in UTC from which the balances specified in the 'amounts' property are effective
format: yyyy-MM-dd'T'HH:mm:ssZ
example: 2024-06-01T00:00:00+0000
amounts:
$ref: '#/components/schemas/Amounts'
PreferencesMap:
type: object
properties:
accountNumber:
description: Account number
type: string
accountName:
$ref: '#/components/schemas/AccountName'
address:
type: object
properties:
street:
type: string
description: The name of the street.
city:
type: string
description: The name of the city.
zipcode:
type: string
description: The zip code of this city.
example:
street: Mainstreet
city: New York City
zipcode: N5467
AdditionalProperties:
type: object
additionalProperties:
type: string
description: Additional properties can be provided within this object
SupplementaryData:
type: object
description: 'Additional information incorporated as an extension to the message by mixins based on the transaction
type '
Date:
type: string
format: yyyy-MM-dd
description: The date pattern is defined 'yyyy-MM-dd', with yyyy as 4-digit year, MM as 2-digit month and dd as 2-digit
date of month
example: '2020-07-23'
ValueDate:
type: string
description: Refers to some future point in time at which the value of an account or transaction becomes effective
example: '2020-07-23'
MaxRecords:
type: integer
description: Maximum number of records to fetch
example: 50
Address:
type: object
properties:
street:
type: string
description: The name of the street.
example: Mainstreet
streetno:
type: string
description: The street number of this address.
example: '119'
city:
type: string
description: The name of the city.
example: New York City
zipcode:
type: string
description: The zip code of this city.
example: N5467
countrycode:
type: string
description: Country code
example: USA
TransactionMetaData:
type: object
required:
- amount
properties:
settlementType:
type: string
description: The type of settlement.
example: CASH
operationType:
type: string
description: The type of operation.
example: Credit
accountRef:
$ref: '#/components/schemas/AccountRef'
amount:
$ref: '#/components/schemas/Amount'
transactionRef:
type: string
description: Transaction reference.
example: A12345
transactionDescCode:
type: string
description: Transaction description code
example: Deposit
beneficiaryConsumerId:
type: string
description: Id of the beneficiary who is a consumer
example: A000013
beneficiaryNonConsumerId:
type: string
description: Id of the beneficiary who is a non-consumer
example: '22343'
beneficiaryType:
type: string
description: Type of the beneficiary
example: Consumer
TransactionTypes:
type: string
enum:
- sbLogin
- sbLogout
- sbRelogin
- sbOpenConsumer
- sbCardlessLogin
- sbAccountMovement
- sbAccountOverview
- sbCheckCashing
- sbDeposit
- sbMixedMediaPayment
- sbTransfer
- sbWithdrawal
- sbPinChange
- sbPrestagedCashOut
- sbPrestagedCashIn
- sbEReceipt
- sbLoadCustomerPreferences
- sbSaveCustomerPreferences
- sbAssistedWithdrawal
- sbAssistedDeposit
- sbLimitApproval
- sbRequestSupport
- sbCreditorSelection
- withdrawal
- balanceInquiry
- transfer
- purchase
- deposit
- payment
- refund
- purchaseCashback
- cashDisbursement
- consumerProfile
- moneyTransferDebit
- moneyTransferCredit
- paymentDebit
- paymentCredit
- adjustmentDebit
- adjustmentCredit
- financialProfile
- quasiCash
- requestCurrencyExchangeRates
description: Type of Transaction or BusinessCase performed
TransactionFee:
type: object
required:
- name
- type
- state
- amount
properties:
name:
type: string
description: Fee name
example: TRANSACTION_FEE
type:
$ref: '#/components/schemas/FeeType'
amount:
$ref: '#/components/schemas/Amount'
accountRef:
$ref: '#/components/schemas/AccountRefFee'
state:
$ref: '#/components/schemas/FeeState'
TransactionFeeAmountOnly:
type: object
required:
- amount
properties:
amount:
type: object
description: "The fee amount for this transaction. Always an unsigned value. \n\nThe value in this field is just\
\ for information purpose. It is already included in calculations for the 'amount' field.\n"
required:
- value
- currency
properties:
value:
description: The amount value of the given currency.
type: string
pattern: '[0-9]{1,13}\.[0-9]{1,3}'
minimum: 0
example: '2.00'
currency:
description: Currency code
type: string
minLength: 3
pattern: '[A-Z]{3,3}'
example: USD
FeeType:
type: string
enum:
- DIRECT_ACQUIRER_FEE
- INDIRECT_ACQUIRER_FEE
- ISSUER_FEE
- SPECIAL_FEE
- SETTLEMENT_ACQUIRER_FEE
- TELLER_MODIFIABLE_FEE
- DCC_COMMISSION_FEE
example: DIRECT_ACQUIRER_FEE
FeeState:
type: string
enum:
- CONF_REQUIRED
- CONF_DECLINED
- CONFIRMED
- CONF_NOT_REQUIRED
example: CONF_NOT_REQUIRED
Channel:
type: string
enum:
- selfService
- network
- teller
- mobile
- undefined
description: Channel through which transaction is initiated.
Device:
type: object
description: ATM Device
required:
- device
properties:
device:
type: string
description: Device id. For a list of all 185 possible devices please refer to - http://[xxx.xxx.xxx.xxx]/pce-manuals/ruegen/pdf25/KnowledgeBase/doc/content.html?url=content/html/KnowledgeBase_SRV/SEC_possible_devices.html&search=PCEDeviceConstant
example: DOCUMENT_FEED
deviceState:
type: string
description: State of Device OPERATIONAL or NON_OPERATIONAL
example: OPERATIONAL
AccountingState:
description: Outcome of the transaction at the acceptor
type: string
enum:
- OK
- ABORT
- CRITICAL
- NOT_AUTHORIZED
example: OK
MediaStates:
type: array
items:
properties:
media:
$ref: '#/components/schemas/MediaType'
state:
$ref: '#/components/schemas/MediaState'
MediaState:
description: The state of the media
type: string
enum:
- UNKNOWN
- RETAINED
- OK
- JAMMED
- NO_MEDIA
- REMAINED_IN_SLOT
- REJECTED
- RECYCLED
- RECYCLING_ERROR
example: OK
HoldType:
type: string
enum:
- GENERAL_PURPOSE_HOLD
- CHECK_HOLD
- NOT_SPECIFIED
- DEBIT_HOLD
- CREDIT_HOLD
example: GENERAL_PURPOSE_HOLD
description: Type of Hold on Account
StopHoldType:
type: string
enum:
- HOLD
- STOP_PAYMENT
example: HOLD
description: Specifies if this is a hold or a stop payment
MediaType:
description: The type of media
type: string
enum:
- NOTE
- NOTE_L2
- NOTE_L3
- NOTE_L4
- NOTE_UNFIT
- COIN
- PRINT_DOCUMENTS
- CHECK
- ENVELOPE
- CARD
- PASSBOOK
example: NOTE
CancelReason:
type: string
description: Reason for cancellation
example: HARDWARE_ERROR
enum:
- UNDEFINED
- TIME_OUT
- CONSUMER_CANCEL
- HARDWARE_ERROR
- COMMUNICATION_ERROR
- NOT_AUTHORIZED
- DOOR_OPENED
- LIMIT_EXCEEDED
- WORKSTATION_CLOSED
- CHIP_ERROR
- MESSAGE_INVALID
- HSM_STATE_INVALID
- CARD_READ_ERROR
- SERVER_ERROR
- CLIENT_ERROR
- APPLICATION_CANCEL
- COUNTERFEIT_LIMIT_EXCEEDED
DenomCounter:
type: object
description: Denomination Counter
properties:
currency:
description: Currency code
type: string
minLength: 3
pattern: '[A-Z]{3,3}'
example: USD
denomination:
type: string
description: Denomination
example: '500'
release:
type: integer
description: Release of document (e.g. newer edition of banknote)
example: 1
physicalType:
$ref: '#/components/schemas/PhysicalType'
dispensedCounter:
type: integer
description: counter
example: 2
dispensedToConsumerCount:
type: integer
description: counter
example: 4
remainingTotalCounter:
type: integer
description: counter
level4Count:
type: integer
description: counter
level3Count:
type: integer
description: counter
level2Count:
type: integer
description: counter
unfitCount:
type: integer
description: counter
retainCount:
type: integer
description: counter
rejectCounter:
type: integer
description: counter
retractCounter:
type: integer
description: counter
PhysicalType:
type: string
description: Type of documents
enum:
- COIN
- NOTE
example: NOTE
DeviceChangeType:
type: string
enum:
- UNKNOWN
- DEVICE_ADDED
- DEVICE_REMOVED
- CASH_ADDED
- CASH_REMOVED
- NO_SOP_OPERATED_CHANGE
- NEW_CHECK_PERIOD
example: UNKNOWN
description: Device Change type
CassCounter:
type: object
properties:
device:
$ref: '#/components/schemas/Device'
changeType:
$ref: '#/components/schemas/DeviceChangeType'
denomCounter:
type: array
items:
$ref: '#/components/schemas/DenomCounter'
CassCounterChangeReason:
type: string
enum:
- STARTUP
- CASS_COUNTER_CIT_REPLENISHMENT
- CASS_COUNTER_SOP_ENTRY
- CASS_COUNTER_BRANCH_REPLENISHMENT
- CASS_COUNTER_CHANGED_WITHOUT_TRANSACTION
example: CASS_COUNTER_CIT_REPLENISHMENT
CardHandlingIndicator:
type: string
enum:
- OUT
- RETAIN
- CHAINING_ALLOWED
- RETAIN_ON_SUCCESS
description: Card Handling Indicator
example: OUT
AlternateAmounts:
type: object
properties:
lowerAlternateAmount:
$ref: '#/components/schemas/Amount'
higherAlternateAmount:
$ref: '#/components/schemas/Amount'
ClearingType:
type: string
enum:
- CASH
- CHECK
- CASH_AND_CHECK
- PAYMENT
description: Clearing Type
example: CASH
ClearingState:
type: string
enum:
- OK
- NOT_SET
- FAILED
description: Clearing State of the inserted media
example: OK
HostResponseData:
type: object
description: Host Response details
properties:
hostResponseCode:
type: string
description: Host response code
example: '00000'
hostTransactionTime:
type: string
description: Host transaction datetime in milliseconds
format: yyyy-MM-dd'T'HH:mm:ssZ
example: 2020-09-01T16:40:52+0000
hostMessage:
type: string
description: Host response message
example: Success
TransactionId:
type: string
description: Unique transaction identifier
example: e025d7ee74db4ddcbfe4af45ca42327a
SplitDeposit:
type: object
required:
- account
- amount
description: Account and Amount data for Split Deposit processing
properties:
account:
$ref: '#/components/schemas/AccountRef'
amount:
$ref: '#/components/schemas/Amount'
CheckDetailsWithImage:
type: object
allOf:
- $ref: '#/components/schemas/CheckDetails'
- type: object
properties:
checkImageBack:
$ref: '#/components/schemas/CheckImage'
checkImageFront:
$ref: '#/components/schemas/CheckImage'
CheckImage:
type: object
required:
- image
description: Check Image
properties:
image:
type: string
description: Base 64 Image
imageType:
$ref: '#/components/schemas/ImageType'
ImageType:
type: string
enum:
- BMP
- JPEG
- PNG
- TIFF
description: ImageType of the check
example: JPEG
CheckDetails:
type: object
required:
- id
description: Details of checks
properties:
id:
type: string
description: Unique identifier of the check record maintained by the client. This value needs to be mirrored and
returned by the host while passing details for this same check in the response
example: 7892480d0a1948099c71beffa823ed0e
hostId:
type: string
description: Transaction identifier provided by the check processing system after validation
example: 442347823ebfad58676644aaaa432323
transactionId:
$ref: '#/components/schemas/TransactionId'
checkActionCode:
type: string
description: Action to be taken post the check recognition
enum:
- NONE
- CORRECT
- VERIFY_IMAGE
- SUSPECTED_DUPLICATE
- REMOVE
example: NONE
deleted:
$ref: '#/components/schemas/Deleted'
suspectedFraud:
type: boolean
description: Flag to indicate if the check is suspected to be a fraud
example: false
micrReadIntegrity:
type: string
enum:
- GOOD
- PARTIAL
- BAD
description: Defines the integrity of the MICR which is read
example: GOOD
micr:
type: string
description: Contains the MICR (Magnetic Ink Character Recognition) as raw string as scanned and recognized from
the check
example: '*192307*T06300277T41442*'
routingTransitNumber:
type: string
description: Identifies the bank on which the document is drawn. For instance, in the US this is the Routing and
Transit number, and in the UK it is the Sort Code
example: '063100277'
mediaState:
$ref: '#/components/schemas/MediaState'
printData:
type: string
description: The string that must be printed on the back of the check
example: Dated July 17th, 2020
date:
type: string
description: Creation date-time, or date-time of last update for this record
format: yyyy-MM-dd'T'HH:mm:ssZ
example: 2024-06-01T16:40:52+0000
score:
type: integer
description: Score of the Optical Character recognition (OCR)
example: 0
accountNumber:
type: string
description: Identifies the account on which the check is drawn
example: A0123456789
checkNumber:
type: string
description: Check number as provided by MICR line
example: '123456'
courtesyAmount:
$ref: '#/components/schemas/CourtesyAmount'
micrAmount:
$ref: '#/components/schemas/MICRAmount'
payableAmount:
$ref: '#/components/schemas/PayableAmount'
userAmount:
$ref: '#/components/schemas/UserAmount'
validatedAmount:
$ref: '#/components/schemas/ValidatedAmount'
documentSequenceNumber:
type: integer
description: The document sequence number. Order number of the entered checks
example: 1
rejectedBy:
$ref: '#/components/schemas/RejectedBy'
externalProcessingCode:
type: string
description: Processing Code read from the MICR line. (a.k.a. Transaction Code (UK), Trancode (AU))
example: '4'
checkType:
$ref: '#/components/schemas/CheckType'
checkState:
$ref: '#/components/schemas/CheckState'
HostSumAmount:
type: object
allOf:
- $ref: '#/components/schemas/Amount'
description: The amount set by the host system if some checks are denied and the total amount is decreased by this decision
HostCashBackAmount:
type: object
allOf:
- $ref: '#/components/schemas/Amount'
description: The amount set by the host system if some checks are denied and the cashback amount is decreased by this
decision
HostCheckAmount:
type: object
allOf:
- $ref: '#/components/schemas/HostCashBackAmount'
description: The amount set by the host system if some checks are denied and the total check amount is decreased by
this decision
CheckLimit:
type: object
allOf:
- $ref: '#/components/schemas/Amount'
description: Amount limit for check in the transaction
CashInLimit:
type: object
allOf:
- $ref: '#/components/schemas/Amount'
description: Amount limit for cash in the transaction
CheckAmount:
type: object
allOf:
- $ref: '#/components/schemas/Amount'
description: The check amount of the transaction
CashInAmount:
type: object
allOf:
- $ref: '#/components/schemas/Amount'
description: The cash amount of the transaction
PayableAmount:
type: object
allOf:
- $ref: '#/components/schemas/Amount'
description: The amount which may be payed on this check
UserAmount:
type: object
allOf:
- $ref: '#/components/schemas/Amount'
description: The amount which is entered by the User
ValidatedAmount:
type: object
allOf:
- $ref: '#/components/schemas/Amount'
description: Amount which has been validated
MICRAmount:
type: object
allOf:
- $ref: '#/components/schemas/Amount'
description: Amount read from the MICR line
CourtesyAmount:
type: object
allOf:
- $ref: '#/components/schemas/Amount'
description: Amount read by Optical Character Recognition (OCR) from the check image
CreditAmount:
type: object
allOf:
- $ref: '#/components/schemas/Amount'
description: The balance amount of the transaction to be credited to the consumer
CreditAmountCC:
type: object
allOf:
- $ref: '#/components/schemas/Amount'
description: 'The balance amount of the transaction to be credited to the consumer, calculated as (checkAmount - requestedAmount
- feeAmount) '
DebitAmount:
type: object
allOf:
- $ref: '#/components/schemas/Amount'
description: The amount of the transaction to be debited from the consumer's account when the amount being paid is less
than the payment amount being requested
DispensedAmount:
type: object
allOf:
- $ref: '#/components/schemas/Amount'
description: The total dispensed amount
CashBackAmount:
type: object
allOf:
- $ref: '#/components/schemas/Amount'
description: The amount to be encashed from the check
RequestedAmount:
type: object
allOf:
- $ref: '#/components/schemas/Amount'
description: The amount requested for this transaction
RequestedAmountFinalizeCashOut:
type: object
allOf:
- $ref: '#/components/schemas/Amount'
description: The amount that was authorized for cashout
CheckValidationTransactionId:
type: string
description: Identifier for check validation
example: '808123458'
RejectedBy:
type: string
enum:
- UNDEFINED
- CONSUMER
- SYSTEM
- TELLER
description: Indicates who has rejected the check
example: SYSTEM
Deleted:
type: boolean
description: Flag to indicate that the check is rejected or must be returned to the consumer
CheckState:
type: string
enum:
- OPEN
- RETURNED
- RETAINED
- ENDORSED
- CONFIRMED
- AMENDED
- REJECTED
- PROCESSED_OK
- PROCESSED_ERROR
description: State of the check
example: ENDORSED
ScheduledDate:
type: string
description: Date when the transaction is scheduled
ProcessClearingResponseCheck:
type: object
required:
- id
description: Details of checks
properties:
id:
type: string
description: Unique identifier of the check record maintained by the client. This value needs to be mirrored and
returned by the host while passing details for this same check in the response
example: 7892480d0a1948099c71beffa823ed0e
hostId:
type: string
description: Transaction identifier provided by the check processing system after validation
example: 442347823ebfad58676644aaaa432323
printData:
type: string
description: The string that must be printed on the back of the check
example: Dated July 17th, 2020
checkState:
$ref: '#/components/schemas/CheckState'
ValidateResponseCheck:
type: object
allOf:
- $ref: '#/components/schemas/ProcessClearingResponseCheck'
- type: object
properties:
checkActionCode:
type: string
description: Action to be taken post the check recognition
enum:
- NONE
- CORRECT
- VERIFY_IMAGE
- SUSPECTED_DUPLICATE
- REMOVE
example: NONE
suspectedFraud:
type: boolean
description: True if check is suspected as fraud.
payableAmount:
$ref: '#/components/schemas/PayableAmount'
validatedAmount:
$ref: '#/components/schemas/ValidatedAmount'
rejectedBy:
$ref: '#/components/schemas/RejectedBy'
deleted:
$ref: '#/components/schemas/Deleted'
TargetAccount:
type: object
allOf:
- $ref: '#/components/schemas/AccountRef'
description: The account to which the amount has to be credited
SourceAccount:
type: object
allOf:
- $ref: '#/components/schemas/AccountRef'
description: The account from which the payment amount has to be deducted
AccountForUndispensedAmount:
type: object
allOf:
- $ref: '#/components/schemas/AccountRef'
description: The account to which the undispensed amount has to be credited in case of a) Dispense failure (identified
through mediaStates) b) Partial dispense
AccountCC:
type: object
allOf:
- $ref: '#/components/schemas/AccountRef'
description: The account to which the creditAmount has to be credited
AccountMMP:
type: object
allOf:
- $ref: '#/components/schemas/AccountRef'
description: The account to which the creditAmount has to be credited or the debitAmount has to be debited
KeyZoneId:
type: string
description: Zone-id for which the key is requested
example: TARGET_ZONE
KeyType:
type: string
description: Type of the key requested
example: ZPK
KeyName:
type: string
description: Name of the key requested
example: ZPK
KeyCheckValue:
type: string
description: Key check value
example: ABCDE
KeyGenerationIndex:
type: string
description: Key generation Index
example: '1'
KeyData:
type: string
description: Hex Encoded value of key
example: 4C0EDDA0BC74008A16484FEEFF67EC5FF089826D94402111
Currency:
description: Currency code
type: string
minLength: 3
pattern: '[A-Z]{3,3}'
example: USD
BaseCurrency:
description: Currency code of the base currency
type: string
minLength: 3
pattern: '[A-Z]{3,3}'
example: USD
SourceCurrency:
description: Currency code of the source currency
type: string
minLength: 3
pattern: '[A-Z]{3,3}'
example: USD
CurrencyForeign:
description: Currency code of the foreign currency
type: string
minLength: 3
pattern: '[A-Z]{3,3}'
example: EUR
RequestedCurrency:
description: Currency code of the requested currency
type: string
minLength: 3
pattern: '[A-Z]{3,3}'
example: EUR
ConsumerAccountCurrency:
description: Currency code of the consumer account
type: string
minLength: 3
pattern: '[A-Z]{3,3}'
example: EUR
TargetCurrency:
description: Currency code of the target currency
type: string
minLength: 3
pattern: '[A-Z]{3,3}'
example: EUR
CurrencyExchangeRate:
type: object
required:
- baseCurrency
- foreignCurrency
- rate
- decimals
description: Currency exchange rate
properties:
directQuotation:
type: boolean
description: '
Flag to indicate whether a direct or an indirect quotation mode has to be used with this exchange rate.
A direct quote is a foreign exchange rate involving a quote in fixed units of foreign currency against variable
amounts of the domestic currency.
An indirect quote is a currency quotation in the foreign exchange market that expresses the amount of foreign
currency required to buy or sell one unit of the domestic currency
'
example: false
sell:
type: boolean
description: '
Flag to indicate whether it is a sell rate (true) or a buy rate (false).
For withdrawal and transfer transactions, it is true.
For a deposit transaction, it is false.
'
example: false
cash:
type: boolean
description: '
Flag to indicate whether it is a cash rate (true) or a non-cash rate (false).
For withdrawal and deposit transactions, it is true.
For a transfer transaction, it is false.
'
example: true
baseCurrency:
$ref: '#/components/schemas/Currency'
foreignCurrency:
$ref: '#/components/schemas/CurrencyForeign'
rate:
type: integer
description: The exchange rate as long value
example: 82
decimals:
type: integer
description: The decimal places of the exchange rate
example: 2
ForeignCurrencyConversion:
type: object
required:
- fccState
- amount
- amountInBaseCurrency
- exchangeRate
properties:
fccState:
$ref: '#/components/schemas/ForeignCurrencyConversionState'
amount:
allOf:
- $ref: '#/components/schemas/AmountForeign'
description: The amount converted to foreign currency
amountInBaseCurrency:
allOf:
- $ref: '#/components/schemas/Amount'
description: The amount in base currency of the Financial Institute
exchangeRate:
$ref: '#/components/schemas/CurrencyExchangeRate'
DynamicCurrencyConversion:
required:
- mode
- dccOverAllAmount
- notDccOverallAmount
- exchangeRate
type: object
properties:
mode:
$ref: '#/components/schemas/DynamicCurrencyConversionState'
requestedCurrency:
$ref: '#/components/schemas/RequestedCurrency'
consumerAccountCurrency:
$ref: '#/components/schemas/ConsumerAccountCurrency'
notDccOverallAmount:
allOf:
- $ref: '#/components/schemas/AmountForeign'
description: The overall amount without performing a currency conversion
dccOverAllAmount:
allOf:
- $ref: '#/components/schemas/Amount'
description: The overall amount post performing a currency conversion
exchangeRate:
$ref: '#/components/schemas/CurrencyExchangeRate'
DynamicCurrencyConversionState:
type: string
description: '
In the request, this field defines whether DCC has been confirmed or declined by the consumer.
In the response, this field defines whether dynamic currency conversion is available.
'
enum:
- DCC_CURRENCY_AVAILABLE
- DCC_CONSUMER_CONFIRMED
- DCC_CONSUMER_DECLINED
example: DCC_CURRENCY_AVAILABLE
ForeignCurrencyConversionState:
type: string
description: '
In the request, this field defines whether the consumer accepted or declined the FCC.
In the response, this field defines whether a confirmation is required or not from the consumer for FCC.
'
enum:
- CONFIRM_REQUIRED
- CONF_NOT_REQUIRED
- CONFIRMED
- DECLINED
example: CONFIRM_REQUIRED
IsStandin:
type: boolean
description: Standin request indicator
example: false
TransactionBase:
type: object
required:
- id
- type
- operation
properties:
id:
type: string
minLength: 1
example: '212423521525'
transactionTime:
type: string
description: Transaction time
format: yyyy-MM-dd'T'HH:mm:ssZ
example: 2020-09-01T16:40:52+0000
poiSettlementDate:
$ref: '#/components/schemas/PointOfInteractionSettlementDate'
businessCorrelationId:
type: string
description: Unique ID for a transaction business case
maxLength: 50
example: 7f2b9fcde28b42abbc10b0b9640f6ede
type:
$ref: '#/components/schemas/TransactionTypes'
operation:
type: string
minLength: 1
description: Operation performed for the given transaction type given by the 'type' property
retrievalReferenceNumber:
type: string
example: '827364775848'
description: 'A numeric value containing the unique transaction reference number '
authorizationIdentificationResponse:
type: string
example: '000123'
description: A numeric value containing the authorization code
TransactionWithStandin:
type: object
allOf:
- $ref: '#/components/schemas/TransactionBase'
- type: object
properties:
isStandin:
$ref: '#/components/schemas/IsStandin'
AddressPOI:
type: object
allOf:
- $ref: '#/components/schemas/Address'
- type: object
properties:
state:
type: string
description: The name of the state.
example: New York
longitude:
type: number
description: The longitude coordinate of this location.
latitude:
type: number
description: The latitude coordinate of this location
PreferenceScope:
type: string
description: The scope for the list of customer preferences
example: FastCash
ConsumerPreferences:
type: object
description: Consumer preferences containing preferences for a specific scope
required:
- scope
- entries
properties:
scope:
$ref: '#/components/schemas/PreferenceScope'
entries:
type: array
description: "\nList of preferences in the key-value-type format. \n\n**key** - mandatory field of *string* type\
\ that indicates the name of the preference\n\n**value** - mandatory field of any data type containing the value\
\ of this preference\n\n**type** - mandatory field of *string* type indicating the data type of 'value' field.\
\ It is an enum containing the below values.\n\n - Long\n - Boolean\n - String\n - Integer\n -\
\ Double\n - BigInteger\n - BigDecimal\n - HashMap\n - ArrayList\n \n"
items:
type: object
additionalProperties: true
example:
- key: Language
value: en-US
type: String
- key: Print receipt
value: true
type: Boolean
- key: FastCash amount
value: 1000
type: Integer
ConsumerPreferencesLoad:
type: object
description: Consumer preferences
required:
- entries
properties:
entries:
type: array
description: "\nList of preferences in the key-value-type format. \n\n**key** - mandatory field of *string* type\
\ that indicates the name of the prefernces\n\n**value** - mandatory field of any data type containing the value\
\ of this preference\n\n**type** - mandatory field of *string* type indicating the data type of 'value' field.\
\ It is an enum containing the below values.\n\n - Long\n - Boolean\n - String\n - Integer\n -\
\ Double\n - BigInteger\n - BigDecimal\n - HashMap\n - ArrayList\n"
items:
type: object
additionalProperties: true
example:
- key: Language
value: en-US
type: String
- key: Print receipt
value: true
type: Boolean
- key: FastCash amount
value: 1000
type: Integer
PreferenceKeyValueType:
type: object
description: Consumer preferences of simple-type stored in key-value-type format
required:
- key
- value
- type
properties:
key:
$ref: '#/components/schemas/PreferenceKey'
value:
type: object
description: The value of this preference
type:
$ref: '#/components/schemas/PreferenceTypeEnum'
example:
key: Currency
value: USD
type: String
PreferenceKeyValueMap:
type: object
description: Consumer preferences of complex type stored in key-value-type format. The type is HashMap and the value
is a complex object.
required:
- key
- value
- type
properties:
key:
$ref: '#/components/schemas/PreferenceKey'
value:
type: object
description: The value of this preference
type:
$ref: '#/components/schemas/PreferenceTypeEnum'
example:
key: Account
value:
accountNumber: '123456789'
accountName: Your Savings account
address:
street: Mainstreet
city: New York City
zipcode: N5467
type: HashMap
PreferenceKeyValueList:
type: object
description: Consumer preferences of list type stored in key-value-type format. The type is ArrayList and the value
is a list of objects
required:
- key
- value
- type
properties:
key:
$ref: '#/components/schemas/PreferenceKey'
value:
type: array
description: The value of this preference
items:
type: object
type:
$ref: '#/components/schemas/PreferenceTypeEnum'
example:
key: List
value:
- '123456789'
- false
- 123.22
- person:
firstname: Betty
lastname: Adams
type: ArrayList
PreferenceKey:
type: string
description: The name of this preference
example: Amount
PreferenceTypeEnum:
type: string
description: The type of this preference
enum:
- Long
- Boolean
- String
- Integer
- Double
- BigInteger
- BigDecimal
- HashMap
- ArrayList
example: Integer
ClientTransactionDate:
type: string
description: 'In Local Timezone
For ''selfService'' channel, the local month and day the transaction takes place.
For ''network'' channel, data element DE13 - the local month and day the transaction takes place at the card acceptor
location.'
format: MMDD
example: 0921
ClientTransactionTime:
type: string
description: 'In Local Timezone
For ''selfService'' channel, the local time the transaction takes place.
For ''network'' channel, data element DE12 - the local time the transaction takes place at the card acceptor location.'
example: '164052'
PointOfInteractionSettlementDate:
type: string
description: 'In Local Timezone
For ''selfService'' channel, ATM booking date for the transaction.
For ''network'' channel, data element DE15 - the month and day funds are transferred between the acquirer and issuer.'
format: MMDD
example: 0921
ClearingCategoryCode:
type: string
description: Defines type of transaction clearing IMED/MEMO
enum:
- IMED
- MEMO
example: IMED
CurrencyExchangeRatePairs:
type: object
required:
- sourceCurrency
- targetCurrency
properties:
sourceCurrency:
$ref: '#/components/schemas/SourceCurrency'
targetCurrency:
$ref: '#/components/schemas/TargetCurrency'
currencyExchangeRateCategory:
$ref: '#/components/schemas/CurrencyExchangeRateCategory'
NotSupportedCurrencyExchangeRatePairs:
type: object
allOf:
- $ref: '#/components/schemas/CurrencyExchangeRatePairs'
description: The currency pairs for which exchange rates are requested but not supported. This field is always populated
with requested currency pairs for which exchange rate details are not available.
CurrencyExchangeRateDefs:
type: object
required:
- directQuotation
- baseCurrency
- foreignCurrency
- rateSell
- rateBuy
- decimals
- currencyExchangeRateCategory
description: Currency exchange rate details for supported currencies
properties:
directQuotation:
type: boolean
description: Flag to indicate whether a direct or an indirect quotation mode has to be used with this exchange rate.
A direct quote is a foreign exchange rate involving a quote in fixed units of foreign currency against variable
amounts of the domestic currency. An indirect quote is a currency quotation in the foreign exchange market that
expresses the amount of foreign currency required to buy or sell one unit of the domestic currency
example: false
baseCurrency:
$ref: '#/components/schemas/BaseCurrency'
foreignCurrency:
$ref: '#/components/schemas/CurrencyForeign'
rateSell:
type: integer
description: The sell exchange rate as long value
example: 84
rateBuy:
type: integer
description: The buy exchange rate as long value
example: 82
decimals:
type: integer
description: The decimal places of the exchange rate
example: 2
currencyExchangeRateCategory:
$ref: '#/components/schemas/CurrencyExchangeRateCategory'
CurrencyExchangeRateCategory:
type: string
description: The category of this currency exchange
enum:
- CASH
- NON_CASH
example: CASH
exchangeKeyRequest:
type: object
required:
- signedJWT
description: '
signedJwt property represents the signed Jwt Token containing the TM public key'
properties:
signedJWT:
type: string
minLength: 1
example: eyJraWQiOiIyIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3Q6ODA4MCIsInN1YiI6IkFscGhhLkZhcm0uQ2x1c3Rlci5pbmlkYy1ha2FzaGMiLCJleHAiOjE2MjA3Mjc3OTQsImlhdCI6MTYyMDcyNzE5NH0.By0BQI9RjVNY5b0TSn6YIV2xjfTsGlWsGp5fDxsTh4npJ1SngQg37cqVPFc9Lepxp0VKi3zKm+fZHcvR6omG34JNUVDW+3pefLjYJxymixZdQTCjAL2FFIt1ei0JzyaSQGCOwpE+TUDkdMkbJ5x69ztAoa0tOSnLWPUJD0ELbV8wX2DhBTyS0sCDqEiht3wxk+3QoI04m+36Nt6zuLazigQzikJxLYllJB2QvM76oWLY3o3lNX77LdkZH6XkNF1w2acCXvbAdy11Bi+dAoSxPvCw5goFuh48I5yfQ/gzziY1RKXpMyxLkF+eMLixfjYx4WVDtZ4YIONdrSVdfQxPZs+A
exchangeKeyResponse:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- signedJWT
properties:
signedJWT:
type: string
minLength: 1
example: eyJraWQiOiIyIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3Q6ODA4MCIsInN1YiI6IkFscGhhLkZhcm0uQ2x1c3Rlci5pbmlkYy1ha2FzaGMiLCJleHAiOjE2MjA3Mjc3OTQsImlhdCI6MTYyMDcyNzE5NH0.By0BQI9RjVNY5b0TSn6YIV2xjfTsGlWsGp5fDxsTh4npJ1SngQg37cqVPFc9Lepxp0VKi3zKm+fZHcvR6omG34JNUVDW+3pefLjYJxymixZdQTCjAL2FFIt1ei0JzyaSQGCOwpE+TUDkdMkbJ5x69ztAoa0tOSnLWPUJD0ELbV8wX2DhBTyS0sCDqEiht3wxk+3QoI04m+36Nt6zuLazigQzikJxLYllJB2QvM76oWLY3o3lNX77LdkZH6XkNF1w2acCXvbAdy11Bi+dAoSxPvCw5goFuh48I5yfQ/gzziY1RKXpMyxLkF+eMLixfjYx4WVDtZ4YIONdrSVdfQxPZs+A
EnvelopeRequest:
type: object
required:
- envelope
description: '
The __Envelope__ has a __payload__ property which represents an encrypted JSON string of the actual request object.'
properties:
envelope:
$ref: '#/components/schemas/Envelope'
EnvelopeResponse:
type: object
required:
- envelope
description: The response data is contained in the __Envelope__'s property __payload__ as encrypted
properties:
envelope:
type: object
required:
- payload
- keyId
description: Object holding a cryptographically secured properties.
properties:
payload:
type: string
minLength: 1
example: BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+
keyId:
description: KeyId of the key used to encrypt the response
type: string
minLength: 1
example: 7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38
Envelope:
type: object
required:
- payload
- keyId
- requestor
description: Object holding a cryptographically secured properties.
properties:
payload:
type: string
minLength: 1
example: BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+
keyId:
description: KeyId of the key used to encrypt the request
type: string
minLength: 1
example: 6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0
requestor:
type: string
minLength: 1
example: Alpha.Cluster.Farm.TXMServer01
AccountHoldResponse:
type: object
allOf:
- $ref: '#/components/schemas/ServiceResponse'
- type: object
required:
- payload
properties:
payload:
type: object
required:
- confirmationNumber
properties:
confirmationNumber:
allOf:
- $ref: '#/components/schemas/ConfirmationNumber'
description: The unique identifier for the hold created
hostResponseData:
$ref: '#/components/schemas/HostResponseData'
accountDetails:
$ref: '#/components/schemas/AccountInformationBase'
transaction:
$ref: '#/components/schemas/TransactionResponse'
additionalProperties:
$ref: '#/components/schemas/AdditionalProperties'
supplementaryData:
$ref: '#/components/schemas/SupplementaryData'
FundTypeCode:
type: string
enum:
- CASH
- CHECK
example: CASH
CheckWithAmount:
type: object
allOf:
- $ref: '#/components/schemas/Check'
- type: object
properties:
checkAmount:
$ref: '#/components/schemas/Amount'
ConfirmationNumber:
type: string
description: The unique identifier for the transaction
example: '998087999'
MemberBanks:
type: object
required:
- memberBankName
- memberBankId
properties:
memberBankName:
type: string
example: Bank1
description: Name of the member bank
memberBankId:
$ref: '#/components/schemas/MemberBankId'
MemberBankId:
type: string
description: Id of the member bank
example: '1234'
ClientType:
type: string
description: The type of the hardware terminal device
enum:
- ADMINISTRATIVE_TERMINAL
- POS_TERMINAL
- ATM
- HOME_TERMINAL
- ECR
- DIAL_TERMINAL
- TRAVELERS_CHECK_MACHINE
- FUEL_MACHINE
- SCRIP_MACHINE
- COUPON_MACHINE
- TICKET_MACHINE
- POINT_OF_BANKING_TERMINAL
- TELLER
- FRANCHISE_TELLER
- PERSONAL_BANKING
- PUBLIC_UTILITY
- VENDING
- SELF_SERVICE
- AUTHORIZATION
- PAYMENT
- VRU
- SMART_PHONE
- INTERACTIVE_TELEVISION
- PERSONAL_DIGITAL_ASSISTANT
- SCREEN_PHONE
- INTERNET_TERMINAL
- MICR_TERMINAL
- MOBILE_ACCEPTANCE_SOLUTION
- UNKNOWN
- NOT_CARDHOLDER_ACTIVATED
- LEVEL_1_CAT_ATM_WITH_PIN
- LEVEL_2_CAT_SELF_SERVICE_TERMINAL
- LEVEL_3_CAT_LIMITED_AMOUNT_TERMINAL
- LEVEL_4_CAT_IN_FLIGHT_COMMERCE
- LEVEL_6_CAT_ECOMMERCE
- LEVEL_7_CAT_TRANSPONDER_TRANSACTION
- LEVEL_8_CAT_MOBILE_INITIATED
- LEVEL_9_CAT_MPOS_ACCEPTANCE_DEVICE
example: ATM
NetworkId:
type: string
description: Id of the acquiring network (scheme specific)
example: MAC
DateTime:
type: string
description: The date and time expressed in the pattern 'yyyy-MM-dd'T'HH:mm:ssZ', where yyyy is 4-digit year, MM is
2-digit month, dd is 2-digit date of month, HH is hours, mm is minutes and ss is seconds
format: yyyy-MM-dd'T'HH:mm:ssZ
example: 2020-07-23T12:00:00+0000
MerchantCategory:
type: string
description: Identifier representing the merchant's type of business product or service
example: '6011'
TransactionResponse:
type: object
allOf:
- $ref: '#/components/schemas/TransactionWithStandin'
description: Exact replica of the request 'transaction' object which must be returned by the host
AddCashTotalAmount:
type: object
allOf:
- $ref: '#/components/schemas/Amount'
description: A sum of all level 3 and level 4 amounts
securitySchemes:
basic:
type: http
description: Authorization will contain base 64 encoded userName:password string
scheme: basic
bearer:
type: http
description: Authorization will contain token received using getToken request as Bearer Token
scheme: bearer
bearerFormat: Any string
jweBearer:
type: http
description: Authorization will contain Bearer encryptedJWT. JWT will be encrypted with backend endpoint public key
scheme: bearer
bearerFormat: Any string
security:
- basic: []
- bearer: []