--- swagger: "2.0" info: title: Money Movement description: |- <P>The Money Movement API allow you to move money from Citi customers account. Transfers can be made to predefined payees by customer and individuals not included in the payee list</P> The segment of API will allow to perform below category of transfers:<br><br><b>Personal Transfer-</b> Allowing customer to initiate the money transfers within customer’s own Citi accounts.<br><br><b>Internal transfer-</b> Allowing customer to initiate the money transfer from customer Citi own accounts to other Citi accounts locally.<br><br><b>External transfer-</b> Allowing customer to initiate the money transfer from customer Citi own accounts to other bank accounts locally.<br><br><b>Bill Payment-</b> Allowing customer to initiate the bill payment from customer Citi own accounts to billing organization.<br><br><b>Citi Global Transfer-</b> Allowing customer to initiate the money transfer from customer Citi own accounts to other Citi bank accounts across various Countries.<br><br><b>SEPA Transfer-</b> Allowing customer to initiate money transfer to other European bank accounts within the SEPA territory.<br><br><b>Cross border transfer-</b> Allowing customer to initiate money transfer from customer own account to cross border bank accounts.<br> version: 1.0.0e x-ibm-name: moneymovement_100e name: "" schemes: - https basePath: /api produces: - application/json paths: /v1/moneyMovement/payees/{payeeId}/details: get: summary: Retrieve Payee Additional Details by Payee Id description: This API returns the additional payee details associated with a payee id. tags: - Money Movement parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: payeeId in: path description: Unique identifier associated with the payee. required: true type: string - name: clientDetails in: header description: This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId type: string required: false responses: 200: description: Successful operation. schema: $ref: '#/definitions/PayeeDetailsResponse' 204: description: No Content 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidPayeePayee is invalid
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/moneyMovement/payees/sourceAccounts: get: summary: Retrieve Destination Source Account description: This API returns the valid combinations of destination and source accounts of all payment types for an authenticated Citi Customer. This information can be used to prepare a valid source list for a selected destination, or vice versa. tags: [] parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: paymentType in: query description: Payment Type. This is a reference data field. Please use /v1/utilities/referenceData/{paymentType} resource to get valid value of this field with description. type: string - name: nextStartIndex in: query description: In some cases there is more data than what can be returned in a single response. If there is additional data available a nextStartIndex will be returned. Pass the nextStartIndex in your next request to retrieve the next set of data. type: string responses: 200: description: Successful operation. schema: $ref: '#/definitions/ValidSourceDestinationAccountsResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/moneyMovement/payees: get: summary: Retrieve Payee List description: This API is used to return a list of payees (active and inactive) or destination accounts for the customer who authorized your app. responses: 200: schema: $ref: '#/definitions/PayeeListResponse' description: Successful operation. 400: schema: $ref: '#/definitions/ErrorResponse' description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
401: schema: $ref: '#/definitions/ErrorResponse' description:
errorunAuthorizedAuthorization credentials are missing or invalid
403: schema: $ref: '#/definitions/ErrorResponse' description:
erroraccessNotConfiguredAccess is not configured for this resource
404: schema: $ref: '#/definitions/ErrorResponse' description:
errorresourceNotFoundEmpty resource/resource not found
500: schema: $ref: '#/definitions/ErrorResponse' description:
fatalserverUnavailableThe request failed due to an internal error
parameters: - in: header name: Authorization description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - in: header name: uuid description: 128 bit random UUID generated uniquely for every request. type: string required: true - in: header name: Accept description: Content-Type that are acceptable for the response. type: string required: true - in: header name: client_id description: client id generated during consumer on-boarding type: string required: true - in: query name: paymentType description: The payment type. This is a reference data field. Please use /v1/utilities//referenceData/{paymentType} resource to get valid value of this field with description. You can use paymentType as referenceCode parameter to retrieve the values. type: string - in: query name: nextStartIndex description: In some cases there is more data than what can be returned in a single response. If there is additional data available a nextStartIndex will be returned. Pass the nextStartIndex in your next request to retrieve the next set of data. type: string tags: [] /v1/moneyMovement/payees/{payeeId}: get: summary: Retrieve Payee Details by Payee Id description: This API returns the complete payee details associated with a payee id. tags: [] parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: payeeId in: path description: Unique identifier associated with the payee. required: true type: string responses: 200: description: Successful operation. schema: $ref: '#/definitions/PayeeDetailsResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidPayeePayee is invalid
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/moneyMovement/personalDomesticTransfers/destinationAccounts/sourceAccounts: get: summary: Retrieve Destination Source Account - Personal Transfers description: This API returns the valid combinations of personal domestic transfer destination and source accounts. This information may be used to prepare a valid source list for a selected destination, or vice versa. responses: 200: schema: $ref: '#/definitions/PersonalDomesticValidSrcDesAcctRes' description: Successful operation. 400: schema: $ref: '#/definitions/ErrorResponse' description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
401: schema: $ref: '#/definitions/ErrorResponse' description:
errorunAuthorizedAuthorization credential is missing or invalid
403: schema: $ref: '#/definitions/ErrorResponse' description:
erroraccessNotConfiguredAccess is not configured for this resource
404: schema: $ref: '#/definitions/ErrorResponse' description:
errorresourceNotFoundEmpty resource/resource not found
500: schema: $ref: '#/definitions/ErrorResponse' description:
fatalserverUnavailableThe request failed due to an internal error
parameters: - in: header name: Authorization description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - in: header name: uuid description: 128 bit random UUID generated uniquely for every request. type: string required: true - in: header name: Accept description: Content-Type that are acceptable for the response. type: string required: true - in: header name: client_id description: Client ID generated during application registration. type: string required: true tags: [] /v1/moneyMovement/personalDomesticTransfers/preprocess: post: summary: Create Personal Transfer description: This API is used to Create a new personal domestic transfer and verify that there are no errors. The response from this resource should be used to construct a pre-confirmation tpage so the customer can review the transaction before confirming. responses: 200: schema: $ref: '#/definitions/PreprocessForFundTransferResponse' description: Successful operation. 400: schema: $ref: '#/definitions/ErrorResponse' description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidPayeePayee is invalid
errorinvalidSourceAccountSource account is invalid
errorinvalidAccountCombinationInvalid source and destination account combination
errorinvalidTransactionAmountTransaction amount is invalid
errorinvalidFxDealReferenceNumberForex deal reference is invalid
errortransactionAmountBelowMinimumTransaction amount below minimum amount
errortransactionAmountExceedsMaximumAllowed transaction amount limit for this transaction exceeded
401: schema: $ref: '#/definitions/ErrorResponse' description:
errorunAuthorizedAuthorization credential is missing or invalid
403: schema: $ref: '#/definitions/ErrorResponse' description:
erroraccessNotConfiguredAccess is not configured for this resource
500: schema: $ref: '#/definitions/ErrorResponse' description:
fatalserverUnavailableThe request failed due to an internal error
parameters: - in: header name: Authorization description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - in: header name: uuid description: 128 bit random UUID generated uniquely for every request. type: string required: true - in: header name: Accept description: Content-Type that are acceptable for the response. type: string required: true - in: header name: client_id description: Client ID generated during application registration. type: string required: true - in: header name: Content-Type description: application/json type: string required: true - schema: $ref: '#/definitions/PreprocessFundTransferRequestPersonalTransfer' in: body name: PreprocessFundTransferRequest required: true tags: [] /v1/moneyMovement/personalDomesticTransfers: post: summary: Confirm Personal Transfer description: This API is used to Confirm the personal transfer. It should be called after successfully creating the personal transfer. If successful, it will return a confirmation number that should be displayed and stored. responses: 200: schema: $ref: '#/definitions/PersonalDomesticTransferResponse' description: Successful operation. 400: schema: $ref: '#/definitions/ErrorResponse' description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorpreprocessFxRateExpiredPre-process forex rate is expired
errorinvalidControlFlowIdControl flow ID is invalid
errorinvalidTransactionAmountTransaction amount is invalid
errorinsufficientFundInsufficient fund
errorinvalidAccountStatusAccount status is invalid
errortransactionDeniedTransaction Denied
401: schema: $ref: '#/definitions/ErrorResponse' description:
TypeCodeDetails
errorunAuthorizedAuthorization credential is missing or invalid
403: schema: $ref: '#/definitions/ErrorResponse' description:
error accessNotConfigured Access is not configured for this resource
error mfaRequired MFA is required
500: schema: $ref: '#/definitions/ErrorResponse' description:
TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error
parameters: - in: header name: Authorization description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - in: header name: uuid description: 128 bit random UUID generated uniquely for every request. type: string required: true - in: header name: Accept description: Content-Type that are acceptable for the response. type: string required: true - in: header name: client_id description: Client ID generated during application registration. type: string required: true - in: header name: Content-Type description: application/json type: string required: true - schema: $ref: '#/definitions/PersonalDomesticTransferRequest' in: body name: PersonalDomesticTransferRequest required: true tags: [] /v1/moneyMovement/internalDomesticTransfers/payees/sourceAccounts: get: summary: Retrieve Destination Source Account - Internal Transfers description: This API Returns the valid combinations of the internal domestic transfer destination and source accounts. This information may be used to prepare a valid source list for a selected destination, or vice versa. responses: 200: schema: $ref: '#/definitions/InternalDomesticValidSourceDestinationAcccountsResponse' description: Successful operation. 400: schema: $ref: '#/definitions/ErrorResponse' description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
401: schema: $ref: '#/definitions/ErrorResponse' description:
errorunAuthorizedAuthorization credential is missing or invalid
403: schema: $ref: '#/definitions/ErrorResponse' description:
erroraccessNotConfiguredAccess is not configured for this resource
404: schema: $ref: '#/definitions/ErrorResponse' description:
errorresourceNotFoundEmpty resource/resource not found
500: schema: $ref: '#/definitions/ErrorResponse' description:
fatalserverUnavailableThe request failed due to an internal error
parameters: - in: header name: Authorization description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - in: header name: uuid description: 128 bit random UUID generated uniquely for every request. type: string required: true - in: header name: Accept description: Content-Type that are acceptable for the response. type: string required: true - in: header name: client_id description: Client ID generated during application registration. type: string required: true - in: query name: nextStartIndex description: In some cases there is more data than what can be returned in a single response. If there is additional data available a nextStartIndex will be returned. Pass the nextStartIndex in your next request to retrieve the next set of data. type: string tags: [] /v1/moneyMovement/internalDomesticTransfers/preprocess: post: summary: Create Internal Transfer description: This API is used to create a new Internal domestic transfer and verify that there are no errors. The response from this resource should be used to construct a pre-confirmation page so the customer can review the transaction before confirming. responses: 200: schema: $ref: '#/definitions/PreprocessForFundTransferResponse' description: Successful operation. 400: schema: $ref: '#/definitions/ErrorResponse' description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidPayeePayee is invalid
errorinvalidSourceAccountSource account is invalid
errorinvalidAccountCombinationInvalid source and destination account combination
errorinvalidTransactionAmountTransaction amount is invalid
errorinvalidFxDealReferenceNumberForex deal reference is invalid
errortransactionAmountBelowMinimumTransaction amount below minimum amount
errortransactionAmountExceedsMaximumAllowed transaction amount limit for this transaction exceeded
401: schema: $ref: '#/definitions/ErrorResponse' description:
errorunAuthorizedAuthorization credential is missing or invalid
403: schema: $ref: '#/definitions/ErrorResponse' description:
erroraccessNotConfiguredAccess is not configured for this resource
500: schema: $ref: '#/definitions/ErrorResponse' description:
fatalserverUnavailableThe request failed due to an internal error
parameters: - in: header name: Authorization description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - in: header name: uuid description: 128 bit random UUID generated uniquely for every request. type: string required: true - in: header name: Accept description: Content-Type that are acceptable for the response. type: string required: true - in: header name: client_id description: Client ID generated during application registration. type: string required: true - in: header name: Content-Type description: application/json type: string required: true - schema: $ref: '#/definitions/PreprocessFundTransferRequestInternalTransfer' in: body name: PreprocessFundTransferRequest required: true tags: [] /v1/moneyMovement/internalDomesticTransfers: post: summary: Confirm Internal Transfer description: This API confirms the internal domestic transfer. It should be called after successfully creating the internal transfer. If successful, it will return a confirmation number that should be displayed and stored. responses: 200: schema: $ref: '#/definitions/InternalDomesticTransferResponse' description: Successful operation. 400: schema: $ref: '#/definitions/ErrorResponse' description:
Type Code Details
invalid invalidRequest Missing or invalid parameters
error preprocessFxRateExpired Pre-process forex rate is expired
error transactionAmountBelowLimit Transaction amount below minimum amount
error invalidControlFlowId Control flow ID is invalid
error invalidTransactionAmount Transaction amount is invalid
error insufficientFund Insufficient fund
error tempServiceSuspensionDueToNaturalCalamity Temporary service suspension due to natural calamities
error transactionPendingReview Transaction pending under review
error dailyTransactionAmountLimitReached Maximum daily transaction amount limit reached
error transactionAmountLimitExceeded Allowed transaction amount limit for this transaction exceeded
error invalidAccountStatus Account status is invalid
error invalidDateRange Date range is invalid
error transactionDenied Transaction Denied
401: schema: $ref: '#/definitions/ErrorResponse' description:
errorunAuthorizedAuthorization credential is missing or invalid
403: schema: $ref: '#/definitions/ErrorResponse' description:
error accessNotConfigured Access is not configured for this resource
error mfaRequired MFA is required
500: schema: $ref: '#/definitions/ErrorResponse' description:
fatalserverUnavailableThe request failed due to an internal error
parameters: - in: header name: Authorization description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - in: header name: uuid description: 128 bit random UUID generated uniquely for every request. type: string required: true - in: header name: Accept description: Content-Type that are acceptable for the response. type: string required: true - in: header name: client_id description: Client ID generated during application registration. type: string required: true - in: header name: Content-Type description: application/json type: string required: true - schema: $ref: '#/definitions/InternalDomesticTransferRequest' in: body name: InternalDomesticTransferRequest required: true tags: [] /v1/moneyMovement/internalDomesticTransfers/preprocess/adhoc: post: summary: Create Adhoc Internal Transfer description: This API is used to create a new Internal domestic transfer to an adhoc destination and verify there are no errors. The destination does not need to be in a payee list. The response from this resource should be used to construct a pre-confirmation page so the customer can review the transaction before confirming. tags: [] parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: AdhocInternalDmstcTransferPreprocessRequest in: body required: true schema: $ref: '#/definitions/AdhocInternalDmstcTransferPreprocessRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/AdhocInternalDmstcTransferPreprocessResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidAccountAccount is invalid
errorinvalidTransactionAmountTransaction amount is invalid
errorinvalidPayeePayee is invalid
errorinvalidSourceAccountSource account is invalid
errorinvalidAccountCombinationInvalid source and destination account combination
errortransactionAmountBelowMinimumTransaction amount below minimum amount
errortransactionAmountExceedsMaximumAllowed transaction amount limit for this transaction exceeded
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/moneyMovement/externalDomesticTransfers/payees/sourceAccounts: get: summary: Retrieve Destination Source Account - External Transfers description: This API returns the valid combinations of external domestic transfer destination and source accounts. This information may be used to prepare a valid source list for a selected destination, or vice versa. responses: 200: schema: $ref: '#/definitions/ExtDmstcValidPayeeDestAcctsResponse' description: Successful operation. 400: schema: $ref: '#/definitions/ErrorResponse' description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
401: schema: $ref: '#/definitions/ErrorResponse' description:
errorunAuthorizedAuthorization credential is missing or invalid
403: schema: $ref: '#/definitions/ErrorResponse' description:
erroraccessNotConfiguredAccess is not configured for this resource
404: schema: $ref: '#/definitions/ErrorResponse' description:
errorresourceNotFoundEmpty resource/resource not found
500: schema: $ref: '#/definitions/ErrorResponse' description:
fatalserverUnavailableThe request failed due to an internal error
parameters: - in: header name: Authorization description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - in: header name: uuid description: 128 bit random UUID generated uniquely for every request. type: string required: true - in: header name: Accept description: Content-Type that are acceptable for the response. type: string required: true - in: header name: client_id description: Client ID generated during application registration. type: string required: true - in: query name: nextStartIndex description: In some cases there is more data than what can be returned in a single response. If there is additional data available a nextStartIndex will be returned. Pass the nextStartIndex in your next request to retrieve the next set of data. type: string tags: [] /v1/moneyMovement/externalDomesticTransfer/preprocess: post: summary: Create External Transfer description: This API is used to Create a new external domestic transfer and verify that there are no errors. The response from this resource should be used to construct a pre-confirmation page so the customer can review the transaction before confirming. responses: 200: schema: $ref: '#/definitions/PreprocessForFundTransferResponse' description: Successful operation. 400: schema: $ref: '#/definitions/ErrorResponse' description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidPayeePayee is invalid
errorinvalidSourceAccountSource account is invalid
errorinvalidAccountCombinationInvalid source and destination account combination
errorinvalidTransactionAmountTransaction amount is invalid
errorinvalidFxDealReferenceNumberForex deal reference is invalid
errortransactionAmountBelowMinimumTransaction amount below minimum amount
errortransactionAmountExceedsMaximumAllowed transaction amount limit for this transaction exceeded
errorinvalidPaymentMethodPayment method is invalid
401: schema: $ref: '#/definitions/ErrorResponse' description:
errorunAuthorizedAuthorization credential is missing or invalid
403: schema: $ref: '#/definitions/ErrorResponse' description:
erroraccessNotConfiguredAccess is not configured for this resource
500: schema: $ref: '#/definitions/ErrorResponse' description:
fatalserverUnavailableThe request failed due to an internal error
parameters: - in: header name: Authorization description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - in: header name: uuid description: 128 bit random UUID generated uniquely for every request. type: string required: true - in: header name: Accept description: Content-Type that are acceptable for the response. type: string required: true - in: header name: client_id description: Client ID generated during application registration. type: string required: true - in: header name: Content-Type description: application/json type: string required: true - schema: $ref: '#/definitions/PreprocessFundTransferRequestExternalTransfer' in: body name: PreprocessFundTransferRequest required: true tags: [] /v1/moneyMovement/externalDomesticTransfers: post: summary: Confirm External Transfer description: This API confirms the external domestic transfer. It should be called after successfully creating the external domestic transfer. If successful, it will return a confirmation number that should be displayed and stored. responses: 200: schema: $ref: '#/definitions/ExternalDomesticTransferResponse' description: Successful operation. 400: schema: $ref: '#/definitions/ErrorResponse' description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorpreprocessFxRateExpiredPre-process forex rate is expired
errortransactionAmountBelowMinimumTransaction amount below minimum amount
errorinvalidControlFlowIdControl flow ID is invalid
errorinvalidBankCodeBank code is invalid
errorinvalidTransactionAmountTransaction amount is invalid
errorinsufficientFundInsufficient fund
errortempServiceSuspensionDueToNaturalCalamityTemporary service suspension due to natural calamities
errortransactionPendingReviewTransaction is pending under review
errordailyTransactionAmountLimitReachedMaximum daily transaction amount limit reached
errortransactionAmountExceedsMaximumAllowed transaction amount limit for this transaction exceeded
errorinvalidAccountStatusAccount status is invalid
errorinvalidDateRangeDate range is invalid
errortransactionDeniedTransaction Denied
401: schema: $ref: '#/definitions/ErrorResponse' description:
errorunAuthorizedAuthorization credential is missing or invalid
403: schema: $ref: '#/definitions/ErrorResponse' description:
erroraccessNotConfiguredAccess is not configured for this resource
errormfaRequiredMFA is required
500: schema: $ref: '#/definitions/ErrorResponse' description:
fatalserverUnavailableThe request failed due to an internal error
parameters: - in: header name: Authorization description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - in: header name: uuid description: 128 bit random UUID generated uniquely for every request. type: string required: true - in: header name: Accept description: Content-Type that are acceptable for the response. type: string required: true - in: header name: client_id description: Client ID generated during application registration. type: string required: true - in: header name: Content-Type description: application/json type: string required: true - schema: $ref: '#/definitions/ExternalDomesticTransferRequest' in: body name: ExternalDomesticTransferRequest required: true tags: [] /v1/moneyMovement/externalDomesticTransfers/preprocess/adhoc: post: summary: Create Adhoc External Transfer description: This API creates a new external domestic transfer to an adhoc destination and verifies there are no errors. The destination does not need to be in a payee list. The response from this resource should be used to construct a pre-confirmation page so the customer can review the transaction before confirming. tags: [] parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: AdhocExtDmstcTransferPreprocessRequest in: body required: true schema: $ref: '#/definitions/AdhocExtDmstcTransferPreprocessRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/AdhocExtDmstcTransferPreprocessResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidSourceAccountSource account is invalid
errorinvalidTransactionAmountTransaction amount is invalid
errorinvalidFxDealReferenceNumberForex deal reference is invalid
errortransactionAmountBelowMinimumTransaction amount below minimum amount
errortransactionAmountExceedsMaximumAllowed transaction amount limit for this transaction exceeded
errorinvalidPaymentMethodPayment method is invalid
errorinvalidTransferCurrencyIndicatorTransaction currency indicator is invalid
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/moneyMovement/billPayments/payees/sourceAccounts: get: summary: Retrieve Destination Source Account Bill Pay description: This API returns the valid combinations of domestic bill pay destination and source accounts. This information may be used to prepare a valid source list for a selected destination, or vice versa. responses: 200: schema: $ref: '#/definitions/BillPaymentAccountPayeeEligibilityResponse' description: Successful operation. 400: schema: $ref: '#/definitions/ErrorResponse' description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
401: schema: $ref: '#/definitions/ErrorResponse' description:
errorunAuthorizedAuthorization credential is missing or invalid
403: schema: $ref: '#/definitions/ErrorResponse' description:
erroraccessNotConfiguredAccess is not configured for this resource
404: schema: $ref: '#/definitions/ErrorResponse' description:
errorresourceNotFoundEmpty resource/resource not found
500: schema: $ref: '#/definitions/ErrorResponse' description:
fatalserverUnavailableThe request failed due to an internal error
parameters: - in: header name: Authorization description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - in: header name: uuid description: 128 bit random UUID generated uniquely for every request. type: string required: true - in: header name: Accept description: Content-Type that are acceptable for the response. type: string required: true - in: header name: client_id description: Client ID generated during application registration. type: string required: true - in: query name: nextStartIndex description: In some cases there is more data than what can be returned in a single response. If there is additional data available a nextStartIndex will be returned. Pass the nextStartIndex in your next request to retrieve the next set of data. type: string tags: [] /v1/moneyMovement/billPayments/preprocess: post: summary: Create Bill Payment description: This API is used to Create a new domestic bill payment and verify that there are no errors. The response from this resource should be used to construct a pre-confirmation page so the customer can review the transaction before confirming. responses: 200: schema: $ref: '#/definitions/BillPaymentsPreprocessResponse' description: Successful operation. 400: schema: $ref: '#/definitions/ErrorResponse' description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidPayeePayee is invalid
errorinvalidSourceAccountSource account is invalid
errorinvalidAccountCombinationInvalid source and destination account combination
errorinvalidTransactionAmountTransaction amount is invalid
errortransactionAmountBelowLimitTransaction amount below minimum amount
errorpaymentAmountExceedsMaximumPayment amount exceeded maximum
errorinvalidMerchantAndBillTypeCombinationMerchant Id and BillerTypecd combination is invalid
errorinvalidCustomerMerchantReferenceNumberCustomer Merchant reference id is not valid
401: schema: $ref: '#/definitions/ErrorResponse' description:
errorunAuthorizedAuthorization credential is missing or invalid
403: schema: $ref: '#/definitions/ErrorResponse' description:
erroraccessNotConfiguredAccess is not configured for this resource
500: schema: $ref: '#/definitions/ErrorResponse' description:
fatalserverUnavailableThe request failed due to an internal error
parameters: - in: header name: Authorization description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - in: header name: uuid description: 128 bit random UUID generated uniquely for every request. type: string required: true - in: header name: Accept description: Content-Type that are acceptable for the response. type: string required: true - in: header name: client_id description: Client ID generated during application registration. type: string required: true - in: header name: Content-Type description: application/json type: string required: true - schema: $ref: '#/definitions/BillPaymentsPreprocessRequest' in: body name: BillPaymentsPreprocessRequest required: true tags: [] /v1/moneyMovement/billPayments: post: summary: Confirm Bill Payment description: This API is used to Confirm the domestic bill payment. It should be called after successfully creating an domestic bill payment. If successful, it will return a confirmation number that should be displayed and stored. responses: 200: schema: $ref: '#/definitions/BillPaymentsResponse' description: Successful operation. 400: schema: $ref: '#/definitions/ErrorResponse' description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorpreprocessFxRateExpiredPre-process forex rate is expired
errorinvalidControlFlowIdControl flow ID is invalid
errorinvalidPayeeAccountPayee account number is invalid
errorinvalidMerchantMerchant number is invalid
errorinvalidSourceAccountSource account is invalid
errorpaymentCountLimitExceededExceeded maximum number of payments
errortransactionPendingReviewTransaction pending under review
errorinsufficientFundInsufficient fund
errordailyTransactionAmountLimitReachedMaximum daily transaction amount limit reached
errorinvalidAccountStatusAccount status is invalid
errormerchantNotAllowedForAdhocPaymentMerchant not allowed for ad-hoc bill payment
errortransactionAmountBelowMinimumTransaction amount below minimum amount
errortransactionAmountExceedsMaximumAllowed transaction amount limit for this transaction exceeded
errorinvalidPaymentDatePayment date is invalid
errorinvalidPaymentAmountPayment amount is invalid
errorinvalidDateRangeDate range is invalid
errorinvalidBillerTypeBiller type code is invalid
errortransactionDeniedTransaction Denied
401: schema: $ref: '#/definitions/ErrorResponse' description:
errorunAuthorizedAuthorization credential is missing or invalid
403: schema: $ref: '#/definitions/ErrorResponse' description:
erroraccessNotConfiguredAccess is not configured for this resource
errormfaRequiredMFA is required
500: schema: $ref: '#/definitions/ErrorResponse' description:
fatalserverUnavailableThe request failed due to an internal error
parameters: - in: header name: Authorization description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - in: header name: uuid description: 128 bit random UUID generated uniquely for every request. type: string required: true - in: header name: Accept description: Content-Type that are acceptable for the response. type: string required: true - in: header name: client_id description: Client ID generated during application registration. type: string required: true - in: header name: Content-Type description: application/json type: string required: true - schema: $ref: '#/definitions/BillPaymentsRequest' in: body name: BillPaymentsRequest required: true tags: [] /v1/moneyMovement/billPayments/preprocess/adhoc: post: summary: Create Adhoc Bill Payment description: This API creates a new domestic bill payment to an adhoc destination and verifies there are no errors. The destination does not need to be in a payee list. The response from this resource should be used to construct a pre-confirmation page so the customer can review the transaction before confirming. responses: 200: schema: $ref: '#/definitions/BillPaymentsPreprocessResponse' description: Successful operation. 400: schema: $ref: '#/definitions/ErrorResponse' description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid Parameters
errorinvalidSourceAccountSource account is invalid
errortransactionAmountBelowLimitTransaction amount below minimum amount
errortransactionAmountExceedsMaximumTransaction amount exceeded maximum
errorinvalidMerchantMerchant is invalid
errorinvalidTransactionCurrencyCodeTransaction currency code is invalid
401: schema: $ref: '#/definitions/ErrorResponse' description:
errorunAuthorizedAuthorization credential is missing or invalid
403: schema: $ref: '#/definitions/ErrorResponse' description:
erroraccessNotConfiguredAccess is not configured for this resource
500: schema: $ref: '#/definitions/ErrorResponse' description:
fatalserverUnavailableThe request failed due to an internal error
parameters: - in: header name: Authorization description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - in: header name: uuid description: 128 bit random UUID generated uniquely for every request. type: string required: true - in: header name: Accept description: Content-Type that are acceptable for the response. type: string required: true - in: header name: client_id description: Client ID generated during application registration. type: string required: true - in: header name: Content-Type description: application/json type: string required: true - schema: $ref: '#/definitions/BillPaymentsPreprocessRequest' in: body name: BillPaymentsPreprocessRequest required: true tags: [] /v1/moneyMovement/billPayments/merchants: get: summary: Retrieve Merchant List description: This API is used to retrieve list of merchants based on Biller category tags: [] parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: billerCategoryCode in: query description: Biller Category Code is a classification code that is assigned by a bank to a biller.This is a reference data field. Please use /v1/utilities/referenceData/{billerCategoryCode} resource to get valid value of this field with description type: string responses: 200: description: Successful operation. schema: $ref: '#/definitions/MerchantListResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidBillerCategoryCodeBiller category code is invalid
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/moneyMovement/billPayments/merchants/{merchantNumber}: get: summary: Retrieve Merchant Details description: This API is used to returns additional merchant information for a specific merchant during add payee or bill payment tags: [] parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: merchantNumber in: path description: A string that uniquely identifies a merchant. required: true type: string responses: 200: description: Successful operation. schema: $ref: '#/definitions/MerchantDetailsResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidMerchantNumberMerchant Number is invalid
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/moneyMovement/citiGlobalTransfers/payees/sourceAccounts: get: summary: Retrieve Destination Source Account Citi Global Transfer description: This API is used to return the valid combinations of Citi global transfer destination and source accounts. This information may be used to prepare a valid source list for a selected destination, or vice versa. tags: [] parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: nextStartIndex in: query description: In some cases there is more data than what can be returned in a single response. If there is additional data available a nextStartIndex will be returned. Pass the nextStartIndex in your next request to retrieve the next set of data. type: string responses: 200: description: Successful operation. schema: $ref: '#/definitions/CitiGlobalTransfersAccountPayeeEligibilityResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/moneyMovement/citiGlobalTransfers/preprocess: post: summary: Create Citi Global Transfer description: This API creates a new Citi global transfer and verifies that there are no errors. The response from this resource should be used to construct a pre-confirmation page so the customer can review the transaction before confirming. tags: [] parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: CitiGlobalTransfersPreprocessRequest in: body required: true schema: $ref: '#/definitions/CitiGlobalTransfersPreprocessRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/CitiGlobalTransfersPreprocessResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidPayeePayee is invalid
errorinvalidSourceAccountSource account is invalid
errorinvalidAccountCombinationInvalid source and destination account combination
errorinvalidTransactionAmountTransaction amount is invalid
errortransactionAmountBelowMinimumTransaction amount below minimum amount
errortransactionAmountExceedsMaximumAllowed transaction amount limit for this transaction exceeded
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/moneyMovement/citiGlobalTransfers: post: summary: Confirm Citi Global Transfer description: This API is used to Confirm the Citi global transfer. It should be called after successfully creating the Citi global transfer. If successful, it will return a confirmation number that should be displayed and stored. tags: [] parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: clientDetails in: header description: This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId type: string required: false - name: CitiGlobalTransfersRequest in: body required: true schema: $ref: '#/definitions/CitiGlobalTransfersRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/CitiGlobalTransfersResponse' 202: description: Accepted –The request has been accepted for processing , but has not been completed. schema: $ref: '#/definitions/CitiGlobalTransfersResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidControlFlowIdControl flow ID is invalid
errorpreprocessFxRateExpiredPre-process forex rate is expired
errortransactionAmountBelowLimitTransaction amount below minimum amount
errortransactionAmountLimitExceededAllowed transaction amount limit for this transaction exceeded
errorinvalidTransactionAmountTransaction amount is invalid
errorinsufficientFundInsufficient fund
errordailyTransactionAmountLimitReachedMaximum daily transaction amount limit reached
errorinvalidDateRangeDate range is invalid
errortransactionDeniedTransaction Denied
errorclientDetailsRequiredClient details is required in header
errorinvalidAccountStatusAccount status is invalid
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
errormfaRequiredMFA is required
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/moneyMovement/citiGlobalTransfers/preprocess/adhoc: post: summary: Create Adhoc Citi Global Transfer description: This API creates a new Citi global transfer to an adhoc destination and verifies there are no errors. The destination does not need to be in a payee list. The response from this resource should be used to construct a pre-confirmation page so the customer can review the transaction before confirming. tags: [] parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: AdhocCitiGlobalTransfersPreprocessRequest in: body required: true schema: $ref: '#/definitions/AdhocCitiGlobalTransfersPreprocessRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/AdhocCitiGlobalTransfersPreprocessResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidSourceAccountSource account is invalid
errorinvalidPayeeAccountPayee account is invalid
errorinvalidTransactionAmountTransaction amount is invalid
errortransactionAmountExceedsMaximumAllowed transaction amount limit for this transaction exceeded
errortransactionAmountBelowMinimumTransaction amount below minimum amount
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/moneyMovement/crossBorderWireTransfers/payees/sourceAccounts: get: summary: Retrieve Destination Source Account Cross Border Transfer description: This API returns the valid combinations of cross border transfer destination and source accounts. This information may be used to prepare a valid source list for a selected destination, or vice versa. tags: [] parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: nextStartIndex in: query description: In some cases there is more data than what can be returned in a single response. If there is additional data available a nextStartIndex will be returned. Pass the nextStartIndex in your next request to retrieve the next set of data. type: string responses: 200: description: Successful operation. schema: $ref: '#/definitions/CrossBorderWireTransfersAccountPayeeEligibilityResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/moneyMovement/crossBorderWireTransfers/preprocess: post: summary: Create Cross Border Transfer description: This API creates a new cross border transfer and verifies that there are no errors. The response from this resource should be used to construct a pre-confirmation page so the customer can review the transaction before confirming. tags: [] parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: CrossBorderWireTransfersPreprocessRequest in: body required: true schema: $ref: '#/definitions/CrossBorderWireTransfersPreprocessRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/CrossBorderWireTransfersPreprocessResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidPayeePayee is invalid
errorinvalidSourceAccountSource account is invalid
errorinvalidAccountCombinationInvalid source and destination account combination
errorinvalidTransactionAmountTransaction amount is invalid
errortransactionAmountBelowMinimumTransaction amount below minimum amount
errortransactionAmountExceedsMaximumAllowed transaction amount limit for this transaction exceeded
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/moneyMovement/crossBorderWireTransfers: post: summary: Confirm Cross Border Transfer description: This API is used to confirms the cross border transfer. It should be called after successfully creating the cross border transfer. If successful, it will return a confirmation number that should be displayed and stored. tags: [] parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: clientDetails in: header description: This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId type: string required: false - name: CrossBorderWireTransfersRequest in: body required: true schema: $ref: '#/definitions/CrossBorderWireTransfersRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/CrossBorderWireTransfersResponse' 202: description: Accepted –The request has been accepted for processing , but has not been completed. schema: $ref: '#/definitions/CrossBorderWireTransfersResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidControlFlowIdControl flow ID is invalid
errorpreprocessFxRateExpiredPre-process forex rate is expired
errortransactionAmountBelowLimitTransaction amount below minimum amount
errortransactionAmountLimitExceededAllowed transaction amount limit for this transaction exceeded
errorinvalidTransactionAmountTransaction amount is invalid
errorinsufficientFundInsufficient fund
errordailyTransactionAmountLimitReachedMaximum daily transaction amount limit reached
errorinvalidDateRangeDate range is invalid
errortransactionDeniedTransaction Denied
errorclientDetailsRequiredClient details is required in header
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
errormfaRequiredMFA is required
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/moneyMovement/crossBorderWireTransfers/preprocess/adhoc: post: summary: Create Adhoc Cross Border Transfer description: This API creates a new cross border transfer to an adhoc destination and verifies there are no errors. The destination does not need to be in a payee list. The response from this resource should be used to construct a pre-confirmation page so the customer can review the transaction before confirming. tags: [] parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: AdhocCrossBorderWireTransfersPreprocessRequest in: body required: true schema: $ref: '#/definitions/AdhocCrossBorderWireTransfersPreprocessRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/AdhocCrossBorderWireTransfersPreprocessResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidAccountAccount is invalid
errorinvalidTransactionAmountTransaction amount is invalid
errortransactionAmountExceedsMaximumAllowed transaction amount limit for this transaction exceeded
errortransactionAmountBelowMinimumTransaction amount below minimum amount
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/emea/moneyMovement/sepaTransfers/payees/sourceAccounts: get: summary: Retrieve Destination Source Account SEPA description: This API returns the valid combinations of SEPA transfer destination and source accounts. This information may be used to prepare a valid source list for a selected destination, or vice versa. tags: [] parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: nextStartIndex in: query description: In some cases there is more data than what can be returned in a single response. If there is additional data available a nextStartIndex will be returned. Pass the nextStartIndex in your next request to retrieve the next set of data. type: string responses: 200: description: Successful operation. schema: $ref: '#/definitions/SepaTransfersAccountPayeeEligibilityResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/emea/moneyMovement/sepaTransfers/preprocess: post: summary: Create SEPA Transfer description: This API creates a new SEPA transfer and verifies that there are no errors. The response from this resource should be used to construct a pre-confirmation page so the customer can review the transaction before confirming. tags: [] parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: SepaTransfersPreprocessRequest in: body required: true schema: $ref: '#/definitions/SepaTransfersPreprocessRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/SepaTransfersPreprocessResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidPayeePayee is invalid
errorinvalidSourceAccountSource account is invalid
errorinvalidAccountCombinationInvalid source and destination account combination
errorinvalidTransactionAmountTransaction amount is invalid
errortransactionAmountExceedsMaximumAllowed transaction amount limit for this transaction exceeded
errortransactionAmountBelowMinimumTransaction amount below minimum amount
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/moneyMovement/sepaTransfers: post: summary: Confirm SEPA transfer description: This API is used to confirm the SEPA transfer. It should be called after successfully creating the SEPA transfer. If successful, it will return a confirmation number that should be displayed and stored. tags: [] parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: clientDetails in: header description: This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId type: string required: false - name: SepaTransferRequest in: body required: true schema: $ref: '#/definitions/SepaTransferRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/SepaTransferResponse' 202: description: Accepted –The request has been accepted for processing , but has not been completed. schema: $ref: '#/definitions/SepaTransferResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidControlFlowIdControl Flow Id is invalid
errorpreprocessFxRateExpiredPre-process forex rate is expired
errortransactionAmountBelowLimitTransaction amount below minimum amount
errortransactionAmountLimitExceededAllowed transaction amount limit for this transaction exceeded
errorinvalidTransactionAmountTransaction amount is invalid
errorinsufficientFundInsufficient fund
errordailyTransactionAmountLimitReachedMaximum daily transaction amount limit reached
errortransactionDeniedTransaction Denied
errorclientDetailsRequiredClient details is required in header
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
errormfaRequiredMFA is required
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/emea/moneyMovement/sepaTransfers/preprocess/adhoc: post: summary: Create adhoc SEPA transfer description: This API creates a new SEPA transfer to an adhoc destination and verifies there are no errors. The destination does not need to be in a payee list. The response from this resource should be used to construct a pre-confirmation page so the customer can review the transaction before confirming. tags: [] parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: AdhocSepaTransfersPreprocessRequest in: body required: true schema: $ref: '#/definitions/AdhocSepaTransfersPreprocessRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/AdhocSepaTransfersPreprocessResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidAccountAccount is invalid
errorinvalidTransactionAmountTransaction amount is invalid
errortransactionAmountExceedsMaximumAllowed transaction amount limit for this transaction exceeded
errortransactionAmountBelowMinimumTransaction amount below minimum amount
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/moneyMovement/externalDomesticTransfers/confirmation: post: summary: This API is to confirm external domestic transfers post Multi Factor Authentication. description: This API is to confirm external domestic transfers post Multi Factor Authentication. tags: - Money Movement parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: clientDetails in: header description: This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId type: string required: false - name: ExternalDomesticTransferConfirmationRequest in: body required: true schema: $ref: '#/definitions/ExternalDomesticTransferConfirmationRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/ExternalDomesticTransferConfirmationResponse' 202: description: Accepted The request has been accepted for processing , but has not been completed. schema: $ref: '#/definitions/ExternalDomesticTransferConfirmationResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorpreprocessFxRateExpiredPre-process forex rate is expired
errortransactionAmountBelowMinimumTransaction amount below minimum amount
errorinvalidControlFlowIdControl flow ID is invalid
errorinvalidBankCodeBank code is invalid
errorinvalidTransactionAmountTransaction amount is invalid
errorinsufficientFundInsufficient fund
errortempServiceSuspensionDueToNaturalCalamityTemporary service suspension due to natural calamities
errortransactionPendingReviewTransaction is pending under review
errordailyTransactionAmountLimitReachedMaximum daily transaction amount limit reached
errortransactionAmountExceedsMaximumAllowed transaction amount limit for this transaction exceeded
errorinvalidAccountStatusAccount status is invalid
errorinvalidDateRangeDate range is invalid
errorinvalidPaymentDateInvalid payment date
schema: $ref: '#/definitions/ErrorResponse' 401: description:
TypeCodeDetails
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/moneyMovement/externalDomesticTransfers/preprocess: post: summary: Pre-process activities for transfer/payment that handle the exchange rate, fees and charges. description: This API allows you to pre process the External domestic transfer transaction for any errors and check the validity of all inputs. The result of this is shown in a pre-confirmation or review details type of page. tags: - Money Movement parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: clientDetails in: header description: This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId type: string required: false - name: PreprocessFundTransferRequest in: body required: true schema: $ref: '#/definitions/PreprocessFundTransferRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/PreprocessForFundTransferResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidPayeePayee is invalid
errorinvalidSourceAccountSource account is invalid
errorinvalidAccountCombinationInvalid source and destination account combination
errorinvalidTransactionAmountTransaction amount is invalid
errorinvalidFxDealReferenceNumberForex deal reference is invalid
errortransactionAmountBelowMinimumTransaction amount below minimum amount
errortransactionAmountExceedsMaximumAllowed transaction amount limit for this transaction exceeded
errorinvalidPaymentMethodPayment method is invalid
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/moneyMovement/externalDomesticTransfers/preprocess/adhocWithPayeeCreation: post: summary: This API is used to do preprocess activities for externalDomesticTransfer. This handle the exchange rate, fees and charges.This API also allows to send request to enroll the payee in registered list of payees, however registration of payee in payee list takes place in subsequent confirmation APIs. description: This API is used to do preprocess activities for externalDomesticTransfer. This handle the exchange rate, fees and charges.This API also allows to send request to enroll the payee in registered list of payees, however registration of payee in payee list takes place in subsequent confirmation APIs. tags: - Money Movement parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: clientDetails in: header description: This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId type: string required: false - name: AdhocExtDmstcTransferPreprocessWithAddPayeeRequest in: body required: true schema: $ref: '#/definitions/AdhocExtDmstcTransferPreprocessWithAddPayeeRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/AdhocExtDmstcTransferPreprocessWithAddPayeeResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidSourceAccountSource account is invalid
errorinvalidTransactionAmountTransaction amount is invalid
errorinvalidFxDealReferenceNumberForex deal reference is invalid
errortransactionAmountBelowMinimumTransaction amount below minimum amount
errortransactionAmountExceedsMaximumAllowed transaction amount limit for this transaction exceeded
errorinvalidPaymentMethodPayment method is invalid
errorinvalidTransferCurrencyIndicatorTransaction currency indicator is invalid
errorinvalidPaymentDateInvalid payment date
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/moneyMovement/internalDomesticTransfers/confirmation: post: summary: This API is to confirm internal domestic transfers post Multi Factor Authentication. description: This API is to confirm internal domestic transfers post Multi Factor Authentication. tags: - Money Movement parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: clientDetails in: header description: This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId type: string required: false - name: InternalDomesticTransferConfirmationRequest in: body required: true schema: $ref: '#/definitions/InternalDomesticTransferConfirmationRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/InternalDomesticTransferConfirmationResponse' 202: description: Accepted –The request has been accepted for processing , but has not been completed. schema: $ref: '#/definitions/InternalDomesticTransferConfirmationResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorpreprocessFxRateExpiredPre-process forex rate is expired
errortransactionAmountBelowLimitTransaction amount below minimum amount
errorinvalidControlFlowIdControl flow ID is invalid
errorinvalidTransactionAmountTransaction amount is invalid
errorinsufficientFundInsufficient fund
errortempServiceSuspensionDueToNaturalCalamityTemporary service suspension due to natural calamities
errortransactionPendingReviewTransaction pending under review
errordailyTransactionAmountLimitReachedMaximum daily transaction amount limit reached
errortransactionAmountLimitExceededAllowed transaction amount limit for this transaction exceeded
errorinvalidAccountStatusAccount status is invalid
errorinvalidDateRangeDate range is invalid
errorinvalidPaymentDateInvalid payment date
schema: $ref: '#/definitions/ErrorResponse' 401: description:
TypeCodeDetails
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/moneyMovement/internalDomesticTransfers/preprocess/adhocWithPayeeCreation: post: summary: This API allows customer to make adhoc transfers within CITIBANK for a same country.This handle the exchange rate, fees and charges. This API also allows to send request to enroll the payee in registered list of payees, however registration of payee in payee list takes place in subsequent confirmation APIs. description: 'This API allows customer to make adhoc transfers within CITIBANK for a same country.This handle the exchange rate, fees and charges. This API also allows to send request to enroll the payee in registered list of payees, however registration of payee in payee list takes place in subsequent confirmation APIs. ' tags: - Money Movement parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: clientDetails in: header description: This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId type: string required: false - name: AdhocInternalDmstcTransferPreprocessWithAddPayeeRequest in: body required: true schema: $ref: '#/definitions/AdhocInternalDmstcTransferPreprocessWithAddPayeeRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/AdhocInternalDmstcTransferPreprocessWithAddPayeeResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 422: description:
TypeCodeDetails
errorbusinessValidationsFailedBusiness validations failed
errorinvalidAccountAccount is invalid
errorinvalidTransactionAmountTransaction amount is invalid
errorinvalidPayeePayee is invalid
errorinvalidSourceAccountSource account is invalid
errortransactionAmountBelowMinimumTransaction amount below minimum amount
errortransactionAmountExceedsMaximumAllowed transaction amount limit for this transaction exceeded
errorinvalidDestinationAccountDestination account is invalid
errorpaymentScheduleNotAllowedSelected Payment Schedule cannot be supported for this payment
errorfutureDatedTransferRestrictedFuture Date transfers are not allowed for selected source account
errorsourceAccountOrCardInactiveOrNotFoundSource account is inactive or not found in records
errorcustomerIsLockedForVdaCustomer is locked due to invalid attempts
errorfailedToGetFXRateUnable to fetch FX Rate
errorcrossCurrencySpotLimitExceededThe transaction amount is higher than allowed spot limit for cross currency transfers
errortransactionFeeHigherThanTransactionAmountThe transaction fee is higher than transaction amount
errorfailedToGetFXRateUnable to fetch FX Rate
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/moneyMovement/accountProxyTransfers/preprocess/adhocWithPayeeCreation: post: summary: This API is used to do pre-process activities for adhoc proxy payments.This handle the exchange rate, fees and charges. description: This API is used to do pre-process activities for adhoc proxy payments.This handle the exchange rate, fees and charges. operationId: Adhoc-AccountProxyTransfersPreprocessWithAddPayee tags: - Money Movement parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: clientDetails in: header description: This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId type: string required: false - name: AdhocAccountProxyTransfersPreprocessWithAddPayeeRequest in: body required: true schema: $ref: '#/definitions/AdhocAccountProxyTransfersPreprocessWithAddPayeeRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/AdhocAccountProxyTransfersPreprocessWithAddPayeeResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidProxyAccountIdTypePayee is invalid
errorproxyNotRegisteredThis proxy account identifier is not registered or invalid
errorinsufficientFundInsufficient fund
errorinvalidSourceAccountSource account is invalid
errorinvalidTransactionAmountTransaction amount is invalid
errortransactionAmountBelowMinimumTransaction amount below minimum amount
errortransactionAmountExceedsMaximumAllowed transaction amount limit for this transaction exceeded
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/moneyMovement/accountProxyTransfers/sourceAccounts: get: summary: This API return eligible source accounts for account proxy transfers. description: This API return eligible source accounts for account proxy transfers. operationId: AccountProxyTransfersSourceAccountEligibility tags: - Money Movement parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: clientDetails in: header description: This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId type: string required: false - name: proxyPaymentType in: query description: The type of proxy payment.This is a reference data field. Please use /v1/utilities/referenceData/{proxyPaymentType} resource to get valid value of this field with description. type: string required: true - name: nextStartIndex in: query description: In some cases there is more data than what can be returned in a single response. If there is additional data available a nextStartIndex will be returned. Pass the nextStartIndex in your next request to retrieve the next set of data. type: string responses: 200: description: Successful operation. schema: $ref: '#/definitions/AccountProxyTransfersSourceAccountEligibilityResponse' 204: description: No Content 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
erroraccountsWithInsufficientFundsAccounts with insufficient funds
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/moneyMovement/personalDomesticTransfers/confirmation: post: summary: This API is to confirm personal domestic transfers post Multi Factor Authentication. description: This API is to confirm personal domestic transfers post Multi Factor Authentication. tags: - Money Movement parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: clientDetails in: header description: This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId type: string required: false - name: PersonalDomesticTransferConfirmationRequest in: body required: true schema: $ref: '#/definitions/PersonalDomesticTransferConfirmationRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/PersonalDomesticTransferConfirmationResponse' 202: description: Accepted The request has been accepted for processing , but has not been completed. schema: $ref: '#/definitions/PersonalDomesticTransferConfirmationResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
schema: $ref: '#/definitions/ErrorResponse' 401: description:
TypeCodeDetails
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 422: description:
errorbusinessValidationsFailedBusiness validations failed
errorpreprocessFxRateExpiredPre-process forex rate is expired
errorinvalidControlFlowIdControl flow ID is invalid
errorinvalidTransactionAmountTransaction amount is invalid
errorinsufficientFundInsufficient fund
errorinvalidAccountStatusAccount status is invalid
errorduplicateTransactionDuplicate transaction
errortransactionPendingReviewTransaction is under review
errorinvalidTransactionExecutionDateInvalid transaction execution date
errorinvalidDestinationAccountStatusThe destination account or card is inactive of not found
errortransactionMissedCutoffTimeThe transaction has missed cutoff time
errortransactionRejectedDueToSdnHitTransaction is rejected due to SDN hit
schema: $ref: '#/definitions/ErrorResponse' 500: description:
TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/moneyMovement/destinationCountries: get: summary: This API allows to inquire list of countries along with country code and country bank branch identifier. description: This API allows to inquire list of countries along with country code and country bank branch identifier. tags: - Money Movement parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: client id generated during consumer on-boarding type: string required: true - name: clientDetails in: header description: This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId type: string required: false - name: nextStartIndex in: query description: In some cases there is more data than what can be returned in a single response. If there is additional data available a nextStartIndex will be returned. Pass the nextStartIndex in your next request to retrieve the next set of data. type: string responses: 200: description: Successful operation. schema: $ref: '#/definitions/DestinationListResponse' 204: description: No Content 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/moneyMovement/billPayments/payees/{payeeId}/billDetails: get: summary: This API returns additional Bill details for an existing bill payments payee from Mpay. description: This API returns additional Bill details for an existing bill payments payee from Mpay. operationId: Bill Details Inquiry tags: - Money Movement parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: clientDetails in: header description: This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId type: string required: false - name: payeeId in: path description: Unique identifier associated with the payee. required: true type: string responses: 200: description: Successful operation. schema: $ref: '#/definitions/BillDetailsInquiryResponse' 204: description: No Content 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorpaymentOverduePayment is overdue. Please contact the provider
errorinvalidMerchantNumberMerchant Number is invalid
errorinvalidBillBill is invalid
errorinvalidPaymentDateInvalid payment date
errorinvalidPaymentAmountPayment amount is invalid
errorinvalidPayeePayee is invalid
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
error
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/moneyMovement/accountProxyTransfers: post: summary: Allows the customer to transfer fund from customer to proxy registered account. description: Allows the customer to transfer fund from customer to proxy registered account. operationId: AccountProxyTransfers tags: - Money Movement parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: clientDetails in: header description: This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId type: string required: false - name: AccountProxyTransfersRequest in: body required: true schema: $ref: '#/definitions/AccountProxyTransfersRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/AccountProxyTransfersResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
schema: $ref: '#/definitions/ErrorResponse' 401: description:
TypeCodeDetails
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
errormfaRequiredMFA is required
schema: $ref: '#/definitions/ErrorResponse' 422: description:
TypeCodeDetails
errorbusinessValidationsFailedBusiness validations failed
errorpreprocessFxRateExpiredPre-process forex rate is expired
errortransactionAmountBelowMinimumTransaction amount below minimum amount
errorinvalidControlFlowIdControl flow ID is invalid
errorinvalidTransactionAmountTransaction amount is invalid
errorinsufficientFundInsufficient fund
errortransactionPendingReviewTransaction is pending under review
errordailyTransactionAmountLimitReachedMaximum daily transaction amount limit reached
errortransactionAmountExceedsMaximumAllowed transaction amount limit for this transaction exceeded
errorinvalidAccountStatusAccount status is invalid
errorpayeeAlreadyExistsDuplicate payee found in records
errormaxNumOfPayeesDailyLimitExceededMaximum number of payees daily limit reached
errorinvalidDateRangeDate range is invalid
errortransactionDeniedTransaction Denied
errortransactionPendingConfirmationTransaction Settlement not received
errortransactionFailedFailure received from CentralBank
errortransactionHitTransaction caught in SDN Hit
schema: $ref: '#/definitions/ErrorResponse' 500: description:
TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/moneyMovement/accountProxyTransfers/preprocess: post: summary: This API is used to do pre-process activities for proxy payments.This handle the exchange rate, fees and charges. description: This API is used to do pre-process activities for proxy payments.This handle the exchange rate, fees and charges. operationId: AccountProxyTransfersPreprocess tags: - Money Movement parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: clientDetails in: header description: This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId type: string required: false - name: AccountProxyTransfersPreprocessRequest in: body required: true schema: $ref: '#/definitions/AccountProxyTransfersPreprocessRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/AccountProxyTransfersPreprocessResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidProxyAccountIdTypePayee is invalid
errorproxyNotRegisteredThis proxy account identifier is not registered or invalid
errorinsufficientFundInsufficient fund
errorinvalidSourceAccountSource account is invalid
errorinvalidTransactionAmountTransaction amount is invalid
errortransactionAmountBelowMinimumTransaction amount below minimum amount
errortransactionAmountExceedsMaximumAllowed transaction amount limit for this transaction exceeded
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/moneyMovement/accountProxyTransfers/confirmation: post: summary: This API allows the customer to transfer fund from customer to proxy registered account if MFA interdicts. description: This API allows the customer to transfer fund from customer to proxy registered account if MFA interdicts. operationId: AccountProxyTransfersConfirmation tags: - Money Movement parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: clientDetails in: header description: This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId type: string required: false - name: AccountProxyTransfersConfirmationRequest in: body required: true schema: $ref: '#/definitions/AccountProxyTransfersConfirmationRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/AccountProxyTransfersConfirmationResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorpreprocessFxRateExpiredPre-process forex rate is expired
errortransactionAmountBelowMinimumTransaction amount below minimum amount
errorinvalidControlFlowIdControl flow ID is invalid
errorinvalidBankCodeBank code is invalid
errorinvalidTransactionAmountTransaction amount is invalid
errorinsufficientFundInsufficient fund
errortransactionPendingReviewTransaction is pending under review
errordailyTransactionAmountLimitReachedMaximum daily transaction amount limit reached
errortransactionAmountExceedsMaximumAllowed transaction amount limit for this transaction exceeded
errorinvalidAccountStatusAccount status is invalid
errorpayeeAlreadyExistsDuplicate payee found in records
errormaxNumOfPayeesDailyLimitExceededMaximum number of payees daily limit reached
schema: $ref: '#/definitions/ErrorResponse' 401: description:
TypeCodeDetails
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' definitions: AdhocInternalDmstcTransferPreprocessWithAddPayeeRequest: properties: sourceAccountId: description: The source account identifier in encrypted format.Typically, this is not displayed to the customer. type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d payeeAccountDetails: $ref: '#/definitions/PayeeAccountDetails' transactionAmount: description: The transaction amount type: number format: double example: 4500.250000 transferCurrencyIndicator: description: Indicator to specify whether the transfer is in source account currency.The acceptable forms of remittance for a given payments and transfer transaction.This is a reference data field. Please use /v1/utilities/referenceData/{transferCurrencyIndicator} resource to get valid value of this field with description. type: string example: SOURCE_ACCOUNT_CURRENCY chargeBearer: description: Field to identify charge bearer.The acceptable forms of remittance for a given payments and transfer transaction.This is a reference data field. Please use /v1/utilities/referenceData/{chargeBearer} resource to get valid value of this field with description. type: string example: BENEFICIARY paymentScheduleType: type: string description: The payment schedule type. This is a reference data. Please use /v1/utilities/referenceData/{paymentScheduleType} resource to get valid value of this field. example: IMMEDIATE futureDatedTransaction: $ref: '#/definitions/FutureDatedTransaction' standingInstruction: $ref: '#/definitions/StandingInstruction' transferPurpose: description: This is to indicate the purpose of transfer. This is a reference data field.This is a reference data field. Please use /v1/utilities/referenceData/{transferPurpose} resource to get valid value of this field with description. type: string example: CASH_DISBURSEMENT transferSubPurpose: description: Sub-purpose of transfer. type: string example: REFERENCE remarks: description: Free text that usually describes purpose of payment. type: string example: Personal paymentPriority: description: Priority to the payment used to identify urgency. This is a reference data field. Please use /v1/utilities/referenceData/{paymentPriority} resource to get valid value of this field with description. type: string example: EXECUTIVE_PAYMENTS required: - sourceAccountId - transferCurrencyIndicator - payeeAccountDetails - transactionAmount PayeeAccountDetails: properties: payeeAccountNumber: description: The account number of the destination account type: string example: "251212582364" payeeName: description: Name of the payee. type: string example: Mark Jacobs payeeNickName: description: The nick name of the payee assigned by the customer. type: string example: MarkJ payeeBankDetails: $ref: '#/definitions/PayeeBankDetails' payeeAddress: $ref: '#/definitions/PayeeAddress' required: - payeeAccountNumber - payeeName FutureDatedTransaction: properties: scheduleDate: description: Date on which the future transaction is scheduled in ISO 8601 format YYYY-MM-DD. type: string format: date example: "2017-12-15" required: - scheduleDate StandingInstruction: properties: standingInstructionStartDate: description: Standing instruction start date in ISO 8601 format YYYY-MM-DD. type: string format: date example: "2017-12-12" paymentFrequency: type: string description: The frequency of payment. This is a reference data. Please use /v1/utilities/referenceData/{paymentFrequency} resource to get valid value of this field. example: MONTHLY perpetualFlag: description: Flag to indicate if the standing instruction will be continued until cancellation. type: boolean example: true standingInstructionEndDate: type: string format: date description: Standing instruction end date in ISO 8601 date format YYYY-MM-DD. example: "2018-10-15" required: - standingInstructionStartDate - paymentFrequency AdhocInternalDmstcTransferPreprocessWithAddPayeeResponse: properties: controlFlowId: description: Control flow Id type: string example: "12345678" debitDetails: $ref: '#/definitions/DebitDetails' creditDetails: $ref: '#/definitions/CreditDetails' foreignExchangeRate: description: Exchange rate type: number format: double example: 1.102100 forexType: description: This is an indicator if exchange rate received from host is Counter or Live. This is a reference data field. Please use /v1/apac/utilities/referenceData/{forexType} resource to get valid value of this field with description. type: string example: LIVE forexConversionIndicator: description: This is the indicator if FX rate sent in response is computed on one Unit of Source Currency to Destination currency or one Unit of Destination Currency to Source Currency.This is a reference data field. Please use /v1/apac/utilities/referenceData/{forexConversionIndicator} resource to get valid value of this field with description. type: string example: SOURCE_TO_DESTINATION transactionFee: description: Transaction fee type: number format: double example: 500.250000 feeCurrencyCode: description: Fee currency code in ISO 4217 format. type: string example: USD localCurrencyTransactionFee: description: This is the transactionFee in local currency type: number format: double example: 10.110000 localCurrencyCode: type: string description: Local currency code in ISO 4217 Format. example: SGD required: - controlFlowId DebitDetails: properties: transactionDebitAmount: description: The transaction debit amount. type: number format: double example: 4500.250000 currencyCode: description: The currency code for the debit amount in ISO 4217 format type: string example: EUR CreditDetails: properties: transactionCreditAmount: description: The transaction credit amount. type: number format: double example: 19178.720000 currencyCode: description: The currency code for the credit amount in ISO 4217 format type: string example: PLN InternalDomesticTransferConfirmationRequest: properties: controlFlowId: description: The control flow Id type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d required: - controlFlowId InternalDomesticTransferConfirmationResponse: properties: sourceAccount: $ref: '#/definitions/SourceAccount' payeeEnrollmentStatus: description: Status to indicate if the payee is added or not to customers registered list of billers. This is a reference data. Please use /v1/utilities/referenceData/{payeeEnrollmentStatus} resource to get valid value of this field. type: string example: SUCCESS transactionReferenceId: description: The unique transaction reference Id used to identify this transaction from all the other transactions type: string example: HBKFT160129X001373 required: - transactionReferenceId SourceAccount: properties: displaySourceAccountNumber: description: The display account number of the source account. type: string example: XXXXXX2364 sourceAccountAvailableBalance: format: double description: This is the amount after external domestic transfer completion. type: number example: 50000.250000 sourceCurrencyCode: description: Currency code of the source account in ISO 4217 format. type: string example: USD required: - displaySourceAccountNumber - sourceAccountAvailableBalance AdhocExtDmstcTransferPreprocessWithAddPayeeRequest: properties: sourceAccountId: description: The source account identifier in encrypted format.Typically, this is not displayed to the customer. type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d payeeAccountDetails: $ref: '#/definitions/PayeeAccountDetails' transactionAmount: description: The transaction amount type: number format: double example: 4500.250000 transferCurrencyIndicator: description: Indicator to specify whether the transfer is in source or destination account currency.The acceptable forms of remittance for a given payments and transfer transaction.This is a reference data field. Please use /v1/utilities/referenceData/{transferCurrencyIndicator} resource to get valid value of this field with description. type: string example: SOURCE_ACCOUNT_CURRENCY chargeBearer: description: Field to identify charge bearer.The acceptable forms of remittance for a given payments and transfer transaction.This is a reference data field. Please use /v1/utilities/referenceData/{chargeBearer} resource to get valid value of this field with description. type: string example: BENEFICIARY paymentMethod: description: The acceptable forms of remittance for a given payments and transfer transaction.This is a reference data field. Please use /v1/utilities/referenceData/{paymentMethod} resource to get valid value of this field with description. type: string example: GIRO paymentScheduleType: type: string description: The payment schedule type. This is a reference data. Please use /v1/utilities/referenceData/{paymentScheduleType} resource to get valid value of this field. example: IMMEDIATE futureDatedTransaction: $ref: '#/definitions/FutureDatedTransaction' standingInstruction: $ref: '#/definitions/StandingInstruction' remarks: description: Payment notes. Free text from screen type: string transferPurpose: description: Purpose of transfer. Applicable if paymentMethod is GIRO, FAST. This is a reference data field.This is a reference data field. Please use /v1/utilities/referenceData/{transferPurpose} resource to get valid value of this field with description. type: string example: CASH_DISBURSEMENT required: - sourceAccountId - transactionAmount - payeeAccountDetails - transferCurrencyIndicator BankDetails: properties: bankCode: description: Payee account bank code. Code assigned by a central bank, a bank supervisory body or a Bankers Association in a country to all its licensed member banks or financial institutions code type: string example: "101" bankName: description: Payee account bank name type: string example: HSBC Bank Address: properties: addressLine1: description: AddressLine1 type: string example: 29 Main St addressLine2: description: AddressLine2 type: string example: Kirkby Lonsdale addressLine3: description: AddressLine3 type: string example: London AdhocExtDmstcTransferPreprocessWithAddPayeeResponse: properties: controlFlowId: description: Control flow Id type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d debitDetails: $ref: '#/definitions/DebitDetails' creditDetails: $ref: '#/definitions/CreditDetails' foreignExchangeRate: description: Exchange rate type: number format: double example: 1.102100 forexType: description: This is an indicator if exchange rate received from host is Counter or Live. This is a reference data field. Please use /v1/apac/utilities/referenceData/{forexType} resource to get valid value of this field with description. type: string example: LIVE forexConversionIndicator: description: This is the indicator if FX rate sent in response is computed on one Unit of Source Currency to Destination currency or one Unit of Destination Currency to Source Currency.This is a reference data field. Please use /v1/apac/utilities/referenceData/{forexConversionIndicator} resource to get valid value of this field with description. type: string example: SOURCE_TO_DESTINATION transactionFee: description: Transaction fee type: number format: double example: 500.250000 feeCurrencyCode: description: Fee currency code in ISO 4217 format. type: string example: USD localCurrencyTransactionFee: description: This is the transactionFee in local currency type: number format: double example: 10.110000 localCurrencyCode: type: string description: Local currency code in ISO 4217 Format. example: SGD paymentPriority: description: Priority to the payment used to identify urgency. This is a reference data field. Please use /v1/utilities/referenceData/{paymentPriority} resource to get valid value of this field with description. type: string example: PRIORITY_ONE_FAST required: - controlFlowId - debitDetails - creditDetails ExternalDomesticTransferConfirmationRequest: properties: controlFlowId: description: The control flow Id type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d required: - controlFlowId ExternalDomesticTransferConfirmationResponse: properties: sourceAccount: $ref: '#/definitions/SourceAccount' payeeEnrollmentStatus: description: Status to indicate if the payee is added or not to customers registered list of billers. This is a reference data. Please use /v1/utilities/referenceData/{payeeEnrollmentStatus} resource to get valid value of this field. type: string example: SUCCESS transactionReferenceId: description: The unique transaction reference Id used to identify this transaction from all the other transactions type: string example: HBKFT160129X001373 required: - transactionReferenceId CitiGlobalTransferpayee: properties: payeeName: description: Name of the payee. type: string example: Mark Jacobs payeeNickName: description: The nick name of the payee assigned by the customer. type: string example: Mark payeeType: description: 'Identifies the type of payee based on the destination of the payee.This is a reference data field. Please use /v1/utilities/referenceData/{payeeType} resource to get valid value of this field with description. ' type: string example: CITI_GLOBAL_TRANSFERS payeeStatus: description: The payee status. This is a reference data field. Please use /v1/utilities/referenceData/{payeeStatus} resource to get valid value of this field with description. type: string example: ACTIVE currencyCode: description: The currency code of the payee account in ISO 4217 format type: string example: RUB payeeCountryCode: description: ISO country code. This is a reference data field. Please use /v1/utilities/referenceData/{country} resource to get valid value of this field with description. type: string example: AU accountId: type: string description: The payee account identifier in encrypted format. example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d displayAccountNumber: description: A masked account number that can be displayed to the customer. type: string example: XXXXXX2364 payeeAddress: $ref: '#/definitions/PayeeAddress' payeeNotes: description: Free text that usually describes purpose of payment. type: string example: Mobile bill payment required: - payeeType - payeeName - accountId - payeeNickName - displayAccountNumber - payeeNotes - payeeCountryCode CrossBorderWireTransferPayee: properties: payeeName: description: Name of the payee. type: string example: Adam Smith payeeNickName: description: The nick name of the payee assigned by the customer. type: string example: Adam payeeType: description: 'Identifies the type of payee based on the destination of the payee.This is a reference data field. Please use /v1/utilities/referenceData/{payeeType} resource to get valid value of this field with description. ' type: string example: SWIFT payeeStatus: description: The payee status. This is a reference data field. Please use /v1/utilities/referenceData/{payeeStatus} resource to get valid value of this field with description. type: string example: ACTIVE transferPurpose: description: This is to indicate the purpose of transfer. This is a reference data field.This is a reference data field. Please use /v1/utilities/referenceData/{transferPurpose} resource to get valid value of this field with description. type: string example: CASH_DISBURSEMENT currencyCode: description: The currency code of the payee account in ISO 4217 format type: string example: GBP localCurrencyCode: type: string description: This is the local currency code in ISO 4217 Format. example: SGD payeeCountryCode: description: ISO country code. This is a reference data field. Please use /v1/utilities/referenceData/{country} resource to get valid value of this field with description. type: string example: AU accountId: type: string description: The payee account identifier in encrypted format. example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d displayAccountNumber: description: A masked account number that can be displayed to the customer. type: string example: XXXXXX2364 beneficiaryBankName: description: Name of the bank. type: string example: Rabo Bank beneficiaryBankCode: description: The bank code of the external payee account. type: string example: "44525101" bankRoutingMethod: description: Bank rounting method.This is a reference data field. Please use /utilities/referenceData/{bankRoutingMethod} resource to get valid values of this field with descriptions type: string example: SWIFT payeeAddress: $ref: '#/definitions/PayeeAddress' bankAddress: $ref: '#/definitions/BankAddress' crossBorderBeneficiaryDetails: $ref: '#/definitions/CrossBorderBeneficiaryDetails' payeeNotes: description: Free text that usually describes purpose of payment. type: string example: University Fee payment required: - payeeType - payeeName - accountId - displayAccountNumber - payeeNotes - payeeNickName - payeeCountryCode - beneficiaryBankName - beneficiaryBankCode SepaTransferPayee: properties: payeeName: description: Name of the payee. type: string example: Tim Van Baker payeeNickName: description: The nick name of the payee assigned by the customer. type: string example: Tim payeeType: description: 'Identifies the type of payee based on the destination of the payee. ' type: string example: SEPA_PAYMENT payeeStatus: description: The payee status. This is a reference data field. Please use /v1/utilities/referenceData/{payeeStatus} resource to get valid value of this field with description. type: string example: ACTIVE currencyCode: description: The currency code of the payee account in ISO 4217 format type: string example: EUR payeeCountryCode: description: ISO country code. This is a reference data field. Please use /v1/utilities/referenceData/{country} resource to get valid value of this field with description. type: string example: NL accountId: type: string description: The payee account identifier in encrypted format. example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d displayAccountNumber: description: A masked account number that can be displayed to the customer. type: string example: XXXXXX2364 beneficiaryBankName: description: Name of the bank. type: string example: ABN Amro Bank beneficiaryBankCode: description: The bank code of the external payee account. type: string example: "44525101" payeeNotes: description: Free text that usually describes purpose of payment. type: string example: Family maintenance required: - payeeType - payeeNickName - payeeName - accountId - displayAccountNumber - payeeNotes - payeeCountryCode PayeeAddress: properties: addressLine1: description: Address line 1 type: string example: 40A Orchard Road addressLine2: description: Address line 2 type: string example: '#99-99 Macdonald House' addressLine3: description: Address line 3 type: string example: Singapore-510121 countryName: description: This field is to indicate the name of the country. This is a reference data field. Please use /v1/utilities/referenceData/{countryName} resource to get valid value of this field with description. type: string example: SINGAPORE required: - addressLine1 BankAddress: properties: addressLine1: description: Address line 1 type: string example: Road 11 Street addressLine2: description: Address line2 type: string example: Texas addressLine3: description: Address line 3 type: string example: US CrossBorderBeneficiaryDetails: properties: beneficiaryType: description: Type of beneficiary.This is a reference data field. Please use /v1/utilities/referenceData/{beneficiaryType} resource to get valid value of this field with description type: string example: INDIVIDUAL transactionCategory: description: Type of transaction.This is a reference data field. Please use /v1/utilities/referenceData/{transactionCategory} resource to get valid value of this field with description type: string example: TRANSFERS BETWEEN CUSTOMERS=50 beneficiaryTaxId: description: Tax Payer Identification Code type: string example: INN1234567890 legalTaxId: description: Tax Payer Identification Code for legal Entities assigned by the Tax Authorities type: string example: KPP1234567890 beneficiaryNationalIdNumber: description: Computerized National Identity Card/Smart National Identity Card Number type: string example: NTN0003456 beneficiaryNationalIdType: description: national Id type. This is a reference data field. Please use /v1/utilities/referenceData/{beneficiaryNationalIdType} resource to get valid value of this field with description type: string example: CNIC beneficiaryNationality: description: Beneficiary nationality type: string example: Indian beneficiaryDateOfBirth: description: Beneficiary date of birth in ISO 8601 date format YYYY-MM-DD. type: string example: "2016-07-08" PayeeDetailsResponse: properties: internalDomesticPayee: $ref: '#/definitions/InternalDomesticPayee' externalDomesticPayee: $ref: '#/definitions/ExternalDomesticPayee' billPaymentPayee: $ref: '#/definitions/BillPaymentPayee' ibbsPayee: $ref: '#/definitions/IbbsPayee' citiGlobalTransferpayee: $ref: '#/definitions/CitiGlobalTransferpayee' crossBorderWireTransfersPayee: $ref: '#/definitions/CrossBorderWireTransfersPayee' sepaTransferPayee: $ref: '#/definitions/SepaTransferPayee' InternalDomesticPayee: properties: payeeType: description: Identifies the type of payee based on the destination of the payee.This is a reference data field. Please use /v1/utilities/referenceData/{payeeType} resource to get valid value of this field with description. type: string example: INTERNAL_DOMESTIC payeeStatus: description: The payee status. This is a reference data field. Please use /v1/utilities/referenceData/{payeeStatus} resource to get valid value of this field with description. type: string example: ACTIVE currencyCode: description: The currency code of the payee account in ISO 4217 format type: string example: RUB payeeName: description: Name of the payee. type: string example: Mark Jacobs payeeNickName: description: The nick name of the payee assigned by the customer. type: string example: MarkJ paymentPriority: description: Priority to the payment used to identify urgency. This is a reference data field. Please use /v1/utilities/referenceData/{paymentPriority} resource to get valid value of this field with description. type: string example: EXECUTIVE_PAYMENTS payeeNotes: description: Free text that usually describes purpose of payment. type: string example: Personal displayAccountNumber: description: A masked account number that can be displayed to the customer. type: string example: XXXXXX2364 accountId: type: string description: The account identifier of the payee in encrypted format. example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d displayCardNumber: description: A masked card number that can be displayed to the customer. type: string example: XXXXXXXXXXXX4521 cardId: description: The card id in encrypted format type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d required: - payeeType - payeeName - payeeNickName - payeeNotes ExternalDomesticPayee: properties: payeeType: description: 'Identifies the type of payee based on the destination of the payee.This is a reference data field. Please use /v1/utilities/referenceData/{payeeType} resource to get valid value of this field with description. ' type: string example: EXTERNAL_DOMESTIC payeeStatus: description: The payee status. This is a reference data field. Please use /v1/utilities/referenceData/{payeeStatus} resource to get valid value of this field with description. type: string example: ACTIVE currencyCode: description: The currency code of the payee account in ISO 4217 format type: string example: AUD payeeName: description: Name of the payee. type: string example: Matt William payeeNickName: description: The nick name of the payee assigned by the customer. type: string example: Matt paymentPriority: description: Priority to the payment used to identify urgency. This is a reference data field. Please use /v1/utilities/referenceData/{paymentPriority} resource to get valid value of this field with description. type: string example: EXECUTIVE_PAYMENTS payeeNotes: description: Free text that usually describes purpose of payment. type: string example: Rent displayAccountNumber: description: A masked account number that can be displayed to the customer. type: string example: XXXXXX3475 accountId: type: string description: The account identifier of the payee in encrypted format. example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d beneficiaryBankName: description: Name of the bank. type: string example: HSBC Bank beneficiaryBankCode: description: The bank code of the external payee account. type: string example: "44525101" utilityBillPaymentIndicator: description: Indicator to identify if the transfer is Utility Bill Payment. Applicable only for Russia. This is a reference data field. Please use /v1/utilities/referenceData/{utilityBillPaymentIndicator} resource to get valid value of this field with description. type: string example: "Y" beneficiaryIndividualTaxNumber: description: Indicator to identify if the transfer is Utility Bill Payment. Applicable only for Russia. type: string example: "1234567890" beneficiaryTaxRegistrationCode: description: Beneficiary tax registration code assigned by Russia government. type: string example: "987654321" taxDeclarationype: description: The type of tax declaration filed by an individual type: string example: VAT taxYear: description: Year of the tax payment. type: string example: "2018" taxPeriod: description: The period of the tax payment. type: string example: YEARLY idType: description: Type of Identification document. This is a reference data field. Please use /v1/utilities/referenceData/{idType} resource to get valid values of this field with descriptions type: string example: PASSPORT idNumber: description: Unique identifier of identification document. type: string example: M0992136 required: - displayAccountNumber - accountId - payeeType - payeeName - payeeNickName - payeeNotes BillPaymentPayee: properties: payeeType: description: 'Identifies the type of payee based on the destination of the payee.This is a reference data field. Please use /v1/utilities/referenceData/{payeeType} resource to get valid value of this field with description. ' type: string example: BILL_PAYMENT payeeStatus: description: The payee status. This is a reference data field. Please use /v1/utilities/referenceData/{payeeStatus} resource to get valid value of this field with description. type: string example: ACTIVE currencyCode: description: The currency code of the payee account in ISO 4217 format type: string example: RUB payeeNickName: description: The nick name of the payee assigned by the customer. type: string example: Beeline paymentPriority: description: Priority to the payment used to identify urgency. This is a reference data field. Please use /v1/utilities/referenceData/{paymentPriority} resource to get valid value of this field with description. type: string example: EXECUTIVE_PAYMENTS payeeNotes: description: Free text that usually describes purpose of payment. type: string example: Mobile bill payment merchantName: description: ' The name of the merchant.' type: string example: Verizone Wireless merchantNameLocal: description: ' The name of the merchant in local language.' type: string example: БИЛÐ?ЙÐ? merchantNumber: description: ' A string that uniquely identifies a merchant.' type: string example: "123456789" merchantInformation: type: array items: $ref: '#/definitions/MerchantInformation' required: - payeeType - payeeNickName - payeeNotes IbbsPayee: properties: payeeType: description: 'Identifies the type of payee based on the destination of the payee.This is a reference data field. Please use /v1/utilities/referenceData/{payeeType} resource to get valid value of this field with description. ' type: string example: IBBS payeeStatus: description: The payee status. This is a reference data field. Please use /v1/utilities/referenceData/{payeeStatus} resource to get valid value of this field with description. type: string example: ACTIVE currencyCode: description: The currency code of the payee account in ISO 4217 format type: string example: RUB payeeName: description: Name of the payee. type: string example: Mark Jacobs payeeNickName: description: The nick name of the payee assigned by the customer. type: string example: MarkJ payeeNotes: description: Free text that usually describes purpose of payment. type: string example: Tax paymentPriority: description: Priority to the payment used to identify urgency. This is a reference data field. Please use /v1/utilities/referenceData/{paymentPriority} resource to get valid value of this field with description. type: string example: EXECUTIVE_PAYMENTS displayAccountNumber: description: A masked account number that can be displayed to the customer. type: string example: XXXXXX1278 accountId: type: string description: The account identifier of the payee in encrypted format. example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d beneficiaryBankName: description: Name of the bank type: string example: HSBC Bank beneficiaryBankCode: description: The bank code of the external payee account. type: string example: "44525101" utilityBillPaymentIndicator: description: Indicator to identify if the transfer is Utility Bill Payment. Applicable only for Russia. This is a reference data field. Please use /v1/utilities/referenceData/{utilityBillPaymentIndicator} resource to get valid value of this field with description. type: string example: "Y" beneficiaryIndividualTaxNumber: description: Indicator to identify if the transfer is Utility Bill Payment. Applicable only for Russia. type: string example: "1234567890" beneficiaryTaxRegistrationCode: description: Beneficiary Tax registration code assigned by RU Government type: string example: "987654321" required: - displayAccountNumber - accountId - payeeType - payeeName - payeeNickName - payeeNotes PreprocessFundTransferRequest: properties: sourceAccountId: description: The source account identifier in encrypted format.Typically, this is not displayed to the customer. type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d transactionAmount: description: The transaction amount type: number format: double example: 4500.250000 transferCurrencyIndicator: description: Indicator to specify whether the transfer is in source or destination account currency.The payment type.This is a reference data field. Please use /v1/utilities/referenceData/{transferCurrencyIndicator} resource to get valid value of this field with description. type: string example: SOURCE_ACCOUNT_CURRENCY destinationAccountId: description: The destination account identifier in encrypted format.Typically, this is not displayed to the customer. type: string example: 724f5141524b4d58576853766c786a45376e7637576e6d35695378515a726f494c36367763776775432f453d chargeBearer: description: Field to identify charge bearer.The payment type.This is a reference data field. Please use /v1/utilities/referenceData/{chargeBearer} resource to get valid value of this field with description. type: string example: BENEFICIARY fxDealReferenceNumber: description: Fx deal reference number type: string example: "12345678" paymentScheduleType: type: string description: The payment schedule type. This is a reference data. Please use /v1/utilities/referenceData/{paymentScheduleType} resource to get valid value of this field. example: IMMEDIATE futureDatedTransaction: $ref: '#/definitions/FutureDatedTransaction' standingInstruction: $ref: '#/definitions/StandingInstruction' remarks: description: Payment notes. Free text from screen type: string required: - sourceAccountId - transactionAmount - transferCurrencyIndicator - destinationAccountId - chargeBearer PreprocessForFundTransferResponse: properties: controlFlowId: description: Control flow Id type: string example: "12345678" debitDetails: $ref: '#/definitions/DebitDetails' creditDetails: $ref: '#/definitions/CreditDetails' foreignExchangeRate: description: Exchange rate type: number format: double example: 1.102100 transactionFee: description: Transaction fee type: number format: double example: 500.250000 feeCurrencyCode: description: Fee currency code in ISO 4217 format. type: string example: USD required: - controlFlowId - foreignExchangeRate - debitDetails - creditDetails TaxPaymentDetails: properties: idType: description: Type of Identification document. This is a reference data field. Please use /v1/utilities/referenceData/{idType} resource to get valid values of this field with descriptions type: string example: PASSPORT idNumber: description: Unique identifier of identification document. type: string example: M0992136 taxDeclarationType: description: This field is to indicate the type of tax declaration.This is a reference data field. Please use /v1/utilities/referenceData/{taxDeclarationType} resource to get valid values of this field with descriptions type: string example: PIT_37 taxPaymentYear: description: This field is to indicate the tax payment year. type: string example: "2018" taxPaymentMonth: description: This field is to indicate the tax payment month. Applicable when taxPaymentPeriod=DECADE or DATE. type: string example: JUNE taxPaymentDay: description: This field is to indicate the tax payment day. Applicable when taxPaymentPeriod=DATE. type: string example: "5" taxPaymentPeriod: description: This field is to indicate the period of the tax payment. This is a reference data field. Please use /v1/utilities/referenceData/{taxPaymentPeriod} resource to get valid values of this field with descriptions type: string example: YEARLY taxPaymentPeriodNumber: description: This field is to indicate the period number of the tax payment. type: string example: "5" required: - idType - idNumber - taxDeclarationType - taxPaymentYear InternalDomesticValidSourceDestinationAcccountsResponse: properties: sourceAccounts: type: array items: $ref: '#/definitions/InternalDomesticSourceAccounts' payeeSourceAccountCombinations: type: array items: $ref: '#/definitions/InternalDomesticPayeeSourceAccountCombinations' nextStartIndex: description: In some cases there is more data than what can be returned in a single response. If there is additional data available a nextStartIndex will be returned. Pass the nextStartIndex in your next request to retrieve the next set of data. type: string example: "11" required: - sourceAccounts - payeeSourceAccountCombinations PersonalDomesticValidSrcDesAcctRes: properties: sourceAccounts: type: array items: $ref: '#/definitions/PersonalDomesticSourceAccounts' destinationSourceAcctCombinations: type: array items: $ref: '#/definitions/PersonalDomesticDestinationSourceAcctCombinations' required: - sourceAccounts - destinationSourceAcctCombinations InternalDomesticSourceAccounts: properties: sourceAccountId: description: The source account identifier in encrypted format. Typically, this is not displayed to the customer,use displayAccountNumber instead. type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d displaySourceAccountNumber: description: A masked account number that can be displayed to the customer type: string example: XXXXXX2364 sourceAccountCurrencyCode: description: The currency code of the source account in ISO 4217 format type: string example: SGD accountGroup: description: Account Group associated with the source Account. This is a reference data field. Please use /v1/utilities//referenceData/{accountGroup} resource to get valid value of this field with description. You can use accountGroup as the referenceCode parameter to retrieve the values. type: string example: SAVINGS_AND_INVESTMENTS availableBalance: format: double description: The available balance including any pending or in progress deposits and withdrawals type: number example: 50000.250000 nextPaymentAmount: format: double description: The next payment amount due. type: number example: 4500.250000 accountNickName: description: Nick name of the source account. type: string example: James productName: description: The name of the product type: string example: Personal Checking Account required: - sourceAccountId - displaySourceAccountNumber - sourceAccountCurrencyCode - accountGroup ExternalDomesticTransferRequest: properties: controlFlowId: description: Control Flow Id type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d required: - controlFlowId BillPaymentSourceAccounts: properties: sourceAccountId: description: The source account identifier in encrypted format. Typically, this is not displayed to the customer,use displayAccountNumber instead. type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d displaySourceAccountNumber: description: A masked account number that can be displayed to the customer. type: string example: XXXXXX2364 sourceAccountCurrencyCode: description: The currency code of the source account in ISO 4217 format type: string example: SGD accountGroup: description: Account Group associated with the source Account. This is a reference data field. Please use /v1/utilities//referenceData/{accountGroup} resource to get valid value of this field with description. You can use accountGroup as the referenceCode parameter to retrieve the values. type: string example: SAVINGS_AND_INVESTMENTS availableBalance: format: double description: The available balance including any pending or in progress deposits and withdrawals. type: number example: 50000.250000 nextPaymentAmount: format: double description: The next payment amount due. type: number example: 4500.250000 accountNickName: description: The nick name of the account assigned by the customer type: string example: Singtel productName: description: The name of the product type: string example: Personal Checking Account required: - sourceAccountId - displaySourceAccountNumber - sourceAccountCurrencyCode - accountGroup ExternalDomesticPayeeSourceAccountCombinations: properties: payeeId: description: Unique identifier associated with the payee. Typically, this is not displayed to the customer. type: string example: C$0003019202$AU$XX$01000540000001 displayPayeeAccountNumber: description: The display account number of the destination account. type: string example: XXXXXX2364 payeeAccountCurrencyCode: description: The currency code of the payee account in ISO 4217 format type: string example: SGD payeeNickName: description: Payee account nick name type: string example: James bankDetails: $ref: '#/definitions/BankDetails' paymentMethods: type: array items: $ref: '#/definitions/PaymentMethod' sourceAccountIds: type: array items: $ref: '#/definitions/SourceAccountIds' required: - payeeId - displayPayeeAccountNumber - payeeAccountCurrencyCode - sourceAccountIds - payeeNickName - bankDetails - paymentMethods InternalDomesticPayeeSourceAccountCombinations: properties: payeeId: description: Unique identifier associated with the payee. Typically, this is not displayed to the customer. type: string example: C$0003019202$AU$XX$01000540000001 displayPayeeAccountNumber: description: A masked account number of the payee that can be displayed to the customer. type: string example: XXXXXX2364 payeeAccountCurrencyCode: description: The currency code of the payee account in ISO 4217 format type: string example: SGD payeeNickName: description: Payee account nick name type: string example: James sourceAccountIds: type: array items: $ref: '#/definitions/SourceAccountIds' required: - payeeId - displayPayeeAccountNumber - payeeAccountCurrencyCode - payeeNickName - sourceAccountIds ExternalDomesticTransferResponse: properties: sourceAccount: $ref: '#/definitions/SourceAccount' transactionReferenceId: description: The unique transaction reference Id used to identify this transaction from all the other transactions type: string example: HBKFT160129X001373 required: - transactionReferenceId - sourceAccount PersonalDomesticTransferResponse: properties: sourceAccount: $ref: '#/definitions/SourceAccount' destinationAccount: $ref: '#/definitions/DestinationAccount' transactionReferenceId: description: The unique transaction reference Id used to identify this transaction from all the other transactions type: string example: HBKFT160129X001373 required: - transactionReferenceId - destinationAccount PreprocessFundTransferRequestPersonalTransfer: properties: sourceAccountId: description: The source account identifier in encrypted format.Typically, this is not displayed to the customer. type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d transactionAmount: description: The transaction amount type: number format: double example: 4500.250000 transferCurrencyIndicator: description: Indicator to specify whether the transfer is in source or destination account currency.The payment type.This is a reference data field. Please use /v1/utilities/referenceData/{transferCurrencyIndicator} resource to get valid value of this field with description. type: string example: SOURCE_ACCOUNT_CURRENCY destinationAccountId: description: The destination account identifier in encrypted format.Typically, this is not displayed to the customer. type: string example: 724f5141524b4d58576853766c786a45376e7637576e6d35695378515a726f494c36367763776775432f453d fxDealReferenceNumber: description: Fx deal reference number type: string example: "12345678" paymentScheduleType: type: string description: The payment schedule type. This is a reference data. Please use /v1/utilities/referenceData/{paymentScheduleType} resource to get valid value of this field. example: IMMEDIATE futureDatedTransaction: $ref: '#/definitions/FutureDatedTransaction' standingInstruction: $ref: '#/definitions/StandingInstruction' remarks: description: Payment notes. Free text from screen type: string required: - sourceAccountId - transactionAmount - transferCurrencyIndicator - destinationAccountId PreprocessFundTransferRequestInternalTransfer: properties: sourceAccountId: description: The source account identifier in encrypted format.Typically, this is not displayed to the customer. type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d transactionAmount: description: The transaction amount. type: number format: double example: 4500.250000 transferCurrencyIndicator: description: Indicator to specify whether the transfer is in source or destination account currency.The acceptable forms of remittance for a given payments and transfer transaction.This is a reference data field. Please use /v1/utilities/referenceData/{transferCurrencyIndicator} resource to get valid value of this field with description. You can use transferCurrencyIndicator as the referenceCode parameter to retrieve the values type: string example: SOURCE_ACCOUNT_CURRENCY payeeId: description: The payee identifier in encrypted format.Typically, this is not displayed to the customer. type: string example: C$0003019202$AU$XX$01000540000001 fxDealReferenceNumber: description: Fx deal reference number type: string example: "12345678" remarks: description: Payment notes. Free text from screen type: string transferPurpose: description: Purpose of transfer. Applicable if paymentMethod is GIRO, FAST. This is a reference data field.This is a reference data field. Please use /v1/utilities/referenceData/{transferPurpose} resource to get valid value of this field with description. You can use transferPurpose as the referenceCode parameter to retrieve the values. type: string example: CASH_DISBURSEMENT paymentScheduleType: type: string description: The payment schedule type. This is a reference data. Please use /v1/utilities/referenceData/{paymentScheduleType} resource to get valid value of this field. example: IMMEDIATE futureDatedTransaction: $ref: '#/definitions/FutureDatedTransaction' standingInstruction: $ref: '#/definitions/StandingInstruction' required: - sourceAccountId - transferCurrencyIndicator - payeeId PreprocessFundTransferRequestExternalTransfer: properties: sourceAccountId: description: The source account identifier in encrypted format.Typically, this is not displayed to the customer. type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d transactionAmount: description: The transaction amount type: number format: double example: 4500.250000 transferCurrencyIndicator: description: Indicator to specify whether the transfer is in source or destination account currency.The acceptable forms of remittance for a given payments and transfer transaction.This is a reference data field. Please use /v1/utilities/referenceData/{transferCurrencyIndicator} resource to get valid value of this field with description. type: string example: SOURCE_ACCOUNT_CURRENCY payeeId: description: The payee identifier in encrypted format.Typically, this is not displayed to the customer. type: string example: C$0003019202$AU$XX$01000540000001 chargeBearer: description: Field to identify charge bearer.The acceptable forms of remittance for a given payments and transfer transaction.This is a reference data field. Please use /v1/utilities/referenceData/{chargeBearer} resource to get valid value of this field with description. type: string example: BENEFICIARY paymentMethod: description: The acceptable forms of remittance for a given payments and transfer transaction.This is a reference data field. Please use /v1/utilities/referenceData/{paymentMethod} resource to get valid value of this field with description. type: string example: GIRO fxDealReferenceNumber: description: Fx deal reference number type: string example: "12345678" remarks: description: Payment notes. Free text from screen type: string transferPurpose: description: Purpose of transfer. Applicable if paymentMethod is GIRO, FAST. This is a reference data field.This is a reference data field. Please use /v1/utilities/referenceData/{transferPurpose} resource to get valid value of this field with description. type: string example: CASH_DISBURSEMENT paymentScheduleType: type: string description: The payment schedule type. This is a reference data. Please use /v1/utilities/referenceData/{paymentScheduleType} resource to get valid value of this field. example: IMMEDIATE futureDatedTransaction: $ref: '#/definitions/FutureDatedTransaction' standingInstruction: $ref: '#/definitions/StandingInstruction' taxPaymentDetails: $ref: '#/definitions/TaxPaymentDetails' required: - sourceAccountId - paymentMethod - transactionAmount - transferCurrencyIndicator - payeeId - chargeBearer PayeeListResponse: properties: payeeList: type: array items: $ref: '#/definitions/Payee' nextStartIndex: description: In some cases there is more data than what can be returned in a single response. If there is additional data available a nextStartIndex will be returned. Pass the nextStartIndex in your next request to retrieve the next set of data. type: string example: "11" required: - payeeList DestinationAccount: properties: displayDestinationAccountNumber: description: A masked destination account number that can be displayed to the customer. type: string example: XXXXXX4085 destinationAccountAvailableBalance: format: double description: Available balance amount in destination account type: number example: 2500 destinationCurrencyCode: description: Currency code of the destination account in ISO 4217 format. type: string example: SGD required: - displayDestinationAccountNumber - destinationAccountAvailableBalance PersonalDomesticTransferRequest: properties: controlFlowId: description: The control flow Id type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d required: - controlFlowId InternalDomesticTransferRequest: properties: controlFlowId: description: Control flow Id type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d required: - controlFlowId ValidSourceDestinationAccountsResponse: properties: sourceAccounts: type: array items: $ref: '#/definitions/SourceAccounts' payeeSourceAccountCombinations: type: array items: $ref: '#/definitions/PayeeSourceAccountCombinations' destinationSourceAcctCombinations: type: array items: $ref: '#/definitions/DestinationSourceAcctCombinations' nextStartIndex: description: In some cases there is more data than what can be returned in a single response. If there is additional data available a nextStartIndex will be returned. Pass the nextStartIndex in your next request to retrieve the next set of data. type: string example: "11" PersonalDomesticSourceAccounts: properties: sourceAccountId: description: The source account ID in encrypted format. Typically, this is not displayed to the customer,use displayAccountNumber instead. type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d displaySourceAccountNumber: description: A masked account number that can be displayed to the customer. type: string example: XXXXXX2364 sourceAccountCurrencyCode: description: The currency code of the source account in ISO 4217 format type: string example: SGD accountGroup: description: Account Group associated with the source Account. This is a reference data field. Please use /v1/utilities//referenceData/{accountGroup} resource to get valid value of this field with description. You can use accountGroup as the referenceCode parameter to retrieve the values. type: string example: SAVINGS_AND_INVESTMENTS availableBalance: format: double description: The available balance including any pending or in progress deposits and withdrawals type: number example: 50000.250000 nextPaymentAmount: format: double description: The next payment amount due. type: number example: 4500.250000 productName: description: The name of the product type: string example: Personal Checking Account accountNickName: description: Nick name of the source account. type: string example: James required: - sourceAccountId - displaySourceAccountNumber - sourceAccountCurrencyCode - accountGroup BillPaymentPayeeSourceAccountCombinations: properties: payeeId: description: Unique identifier associated with the payee. Typically, this is not displayed to the customer. type: string example: C$0003019202$AU$XX$01000540000001 displayPayeeAccountNumber: description: The display account number of the destination account. type: string example: XXXXXX2364 payeeAccountCurrencyCode: description: The currency code of the payee account in ISO 4217 format. type: string example: SGD payeeName: description: Name of the payee. Applicable only for Australia. type: string example: Singtel payeeNickName: description: Payee account nick name. type: string example: Singtel merchantNumber: description: Unique identifier associated with the merchant. Applicable only for Australia. type: string example: "10000025142" billTypeCode: description: Bill Type Code is the sub category for the Merchant. Bill Payment Transaction can be uniquely identified by the combination of the merchant number & billTypeCode type: string example: "1" sourceAccountIds: type: array items: $ref: '#/definitions/SourceAccountIds' required: - payeeId - payeeAccountCurrencyCode - payeeNickName - sourceAccountIds PersonalDomesticDestinationSourceAcctCombinations: properties: destinationAccountId: description: The destination account identifier in encrypted format. Typically, this is not displayed to the customer,use displayDestinationAccountNumber instead. type: string example: 724f5141524b4d58576853766c786a45376e7637576e6d35695378515a726f494c36367763776775432f453d displayDestinationAccountNumber: description: A masked account number that can be displayed to the customer type: string example: XXXXXX4085 destinationAccountCurrencyCode: description: The currency code of the payee account in ISO 4217 format type: string example: SGD availableBalance: format: double description: The amount available to withdraw or transfer immediately. type: number example: "50000.25" nextPaymentAmount: format: double description: The next payment amount due. type: number example: "4500.25" outstandingBalance: format: double description: Previous balance amount. type: number example: "4500.25" minimumDueAmount: format: double description: Minimum due amount for a payment cycle. type: number example: "500.25" lastStatementDate: format: date description: The date of the last statement in ISO 8601 date format YYYY-MM-DD. type: string example: "2016-10-03" paymentDueDate: format: date description: The payment due date in ISO 8601 date format YYYY-MM-DD. type: string example: "2016-10-05" sourceAccountIds: type: array items: $ref: '#/definitions/SourceAccountIds' productName: description: The name of the product. This is for destination account type: string example: Personal Checking Account accountNickName: description: Nick name of the destination account type: string example: James required: - destinationAccountId - displayDestinationAccountNumber - destinationAccountCurrencyCode - sourceAccountIds ExternalDomesticSourceAccounts: properties: sourceAccountId: description: The primary identifier for ownership of an account. The source account identifier in encrypted format. Typically, this is not displayed to the customer,use displayAccountNumber instead. type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d displaySourceAccountNumber: description: A masked account number that can be displayed to the customer type: string example: XXXXXX2364 sourceAccountCurrencyCode: description: The currency code of the source account in ISO 4217 format type: string example: SGD accountGroup: description: Account Group associated with the source Account. This is a reference data field. Please use /v1/utilities//referenceData/{accountGroup} resource to get valid value of this field with description. You can use accountGroup as the referenceCode parameter to retrieve the values. type: string example: SAVINGS_AND_INVESTMENTS availableBalance: format: double description: The available balance including any pending or in progress deposits and withdrawals type: number example: 50000.250000 nextPaymentAmount: format: double description: The next payment amount due. type: number example: 4500.250000 accountNickName: description: The nick name of the account assigned by the customer type: string example: James productName: description: The name of the product type: string example: Personal Checking Account required: - sourceAccountId - displaySourceAccountNumber - sourceAccountCurrencyCode - accountGroup ExtDmstcValidPayeeDestAcctsResponse: properties: sourceAccounts: type: array items: $ref: '#/definitions/ExternalDomesticSourceAccounts' payeeSourceAccountCombinations: type: array items: $ref: '#/definitions/ExternalDomesticPayeeSourceAccountCombinations' nextStartIndex: description: In some cases there is more data than what can be returned in a single response. If there is additional data available a nextStartIndex will be returned. Pass the nextStartIndex in your next request to retrieve the next set of data. type: string example: "11" required: - sourceAccounts - payeeSourceAccountCombinations InternalDomesticTransferResponse: properties: sourceAccount: $ref: '#/definitions/SourceAccount' transactionReferenceId: description: The unique transaction reference Id used to identify this transaction from all the other transactions type: string example: HBKFT160129X001373 required: - transactionReferenceId - sourceAccount DestinationSourceAcctCombinations: properties: destinationAccountId: description: The destination account identifier in encrypted format.Typically, this is not displayed to the customer. type: string example: 824f5141524b4d58576853766c786a45376e7637576e6d35695378515a726f494c36367763776775432f453d displayDestinationAccountNumber: description: A masked account number that can be displayed to the customer type: string example: XXXXXX2364 destinationAccountCurrencyCode: description: The currency code of the payee account in ISO 4217 format type: string example: SGD productName: description: The name of the product type: string example: Personal Checking Account availableBalance: description: The amount available to withdraw or transfer immediately. type: number format: double example: 50000.250000 nextPaymentAmount: description: The next payment amount due. type: number format: double example: 4500.250000 outstandingBalance: description: Previous balance amount. type: number format: double example: 4500.250000 minimumDueAmount: description: Minimum due amount for a payment cycle. type: number format: double example: 500.250000 lastStatementDate: description: The date of the last statement in ISO 8601 date format YYYY-MM-DD. type: string format: date example: "2016-10-03" paymentDueDate: description: The payment due date in ISO 8601 date format YYYY-MM-DD. type: string format: date example: "2016-10-05" sourceAccountIds: type: array items: $ref: '#/definitions/SourceAccountIds' accountNickName: description: The nick name of the account assigned by the customer type: string example: James required: - destinationAccountId - displayDestinationAccountNumber - destinationAccountCurrencyCode - sourceAccountIds PaymentMethod: properties: paymentMethod: description: The acceptable forms of remittance for a given payments and transfer transaction.This is a reference data field. Please use /v1/utilities/referenceData/{paymentMethod} resource to get valid value of this field with description. type: string example: GIRO Payee: properties: payeeId: description: The unique Id of the payee.Typically,this is not displayed to the customer. type: string example: C$0003019202$AU$XX$01000540000001 payeeName: description: The name of the payee type: string example: Singtel payeeNickname: description: The nickname of the payee type: string example: Singtel paymentType: description: The payment type.This is a reference data field. Please use /v1/utilities/referenceData/{paymentType} resource to get valid value of this field with description. You can use paymentType as reference code parameter to retrieve the values. type: string example: LOCAL_CITI displayAccountNumber: description: A masked account number that can be displayed to the customer. type: string example: XXXXXX2364 accountId: description: The account identifier of the payee in encrypted format.Typically, this is not displayed to the customer,use displayAccountNumber instead. type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d currencyCode: description: The currency code of the account in ISO 4217 format type: string example: USD paymentMethods: type: array items: $ref: '#/definitions/PaymentMethod' payeeStatus: description: The payee status. This is a reference data field. Please use /v1/utilities/referenceData/{payeeStatus} resource to get valid value of this field with description. You can use payeeStatus as reference code parameter to retrieve the values type: string example: ACTIVE merchantNumber: description: Unique identifier associated with the merchant. Applicable only for Australia. type: string example: "10000025142" billTypeCode: description: Bill Type Code is the sub category for the Merchant. Bill Payment Transaction can be uniquely identified by the combination of the merchant number & billTypeCode type: string example: "1" required: - payeeId - payeeName - payeeNickname - paymentType - displayAccountNumber - accountId - payeeStatus AdhocExternalDmstcSrcAcctEligibilityResponse: properties: sourceAccounts: type: array items: $ref: '#/definitions/SourceAccounts' nextStartIndex: description: In some cases there is more data than what can be returned in a single response. If there is additional data available a nextStartIndex will be returned. Pass the nextStartIndex in your next request to retrieve the next set of data. type: string example: "11" required: - sourceAccounts AdhocExtDmstcTransferPreprocessRequest: properties: sourceAccountId: description: The source account identifier in encrypted format.Typically, this is not displayed to the customer. type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d payeeAccountDetails: $ref: '#/definitions/PayeeAccountDetailsAdhocExtTransferPreprocess' transactionAmount: description: The transaction amount type: number format: double example: 4500.250000 transactionCurrencyCode: description: The currency code for the transaction amount in ISO 4217 format. type: string example: PLN chargeBearer: description: Field to identify charge bearer.The acceptable forms of remittance for a given payments and transfer transaction.This is a reference data field. Please use /v1/utilities/referenceData/{chargeBearer} resource to get valid value of this field with description. type: string example: BENEFICIARY paymentMethod: description: The acceptable forms of remittance for a given payments and transfer transaction.This is a reference data field. Please use /v1/utilities/referenceData/{paymentMethod} resource to get valid value of this field with description. type: string example: GIRO paymentType: description: The payment type.This is a reference data field. Please use /v1/utilities/referenceData/{paymentType} resource to get valid value of this field with description. type: string example: SWIFT_TRANSFER fxDealReferenceNumber: description: Fx deal reference number type: string example: "12345678" paymentScheduleType: type: string description: The payment schedule type. This is a reference data. Please use /v1/utilities/referenceData/{paymentScheduleType} resource to get valid value of this field. example: IMMEDIATE futureDatedTransaction: $ref: '#/definitions/FutureDatedTransaction' standingInstruction: $ref: '#/definitions/StandingInstruction' taxPaymentDetails: $ref: '#/definitions/TaxPaymentDetails' remarks: description: Payment notes. Free text from screen type: string transferPurpose: description: Purpose of transfer. Applicable if paymentMethod is GIRO, FAST. This is a reference data field.This is a reference data field. Please use /v1/utilities/referenceData/{transferPurpose} resource to get valid value of this field with description. type: string example: CASH_DISBURSEMENT required: - sourceAccountId - paymentMethod - transactionAmount - chargeBearer PayeeAccountDetailsAdhocExtTransferPreprocess: properties: payeeAccountNumber: description: The account number of the destination account type: string example: "251212582364" payeeName: description: Name of the beneficiary. type: string example: Albert Neigh payeeNickName: description: The nick name of the beneficiary assigned by the customer. type: string example: Albert payeeCurrencyCode: type: string description: The currency code of the destination account in ISO 4217 format example: SGD payeeAddress: $ref: '#/definitions/PayeeAddress' bankDetails: $ref: '#/definitions/BankDetailsExtTransfer' required: - payeeAccountNumber - payeeCurrencyCode BankDetailsExtTransfer: properties: bankCode: description: Bank Code of the payee. type: string example: "671290000017" payeeBankAddress: $ref: '#/definitions/PayeeBankAddress' required: - bankCode PayeeBankAddress: properties: addressLine1: description: Address line 1 type: string example: 40A Orchard Road addressLine2: description: Address line 2 type: string example: '#99-99 Macdonald House' addressLine3: description: Address line 3 type: string example: Poland-510121 countryName: description: This field is to indicate the name of the country. This is a reference data field. Please use /v1/utilities/referenceData/{countryName} resource to get valid value of this field with description. type: string example: POLAND required: - addressLine1 AdhocExtDmstcTransferPreprocessResponse: properties: controlFlowId: description: Control flow Id type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d debitDetails: $ref: '#/definitions/DebitDetails' creditDetails: $ref: '#/definitions/CreditDetails' foreignExchangeRate: description: Exchange rate type: number format: double example: 1.546100 transactionFee: description: Transaction fee type: number format: double example: 25.250000 feeCurrencyCode: description: Fee currency code in ISO 4217 Format. type: string example: SGD required: - controlFlowId - debitDetails - creditDetails AdhocInternalDmstcTransferPreprocessRequest: properties: sourceAccountId: description: The source account identifier in encrypted format.Typically, this is not displayed to the customer. type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d payeeAccountDetails: $ref: '#/definitions/PayeeAccountDetailsAdhocIntTransferPreprocess' transactionAmount: description: The transaction amount type: number format: double example: 4500.250000 transferCurrencyIndicator: description: Indicator to specify whether the transfer is in source account currency.The acceptable forms of remittance for a given payments and transfer transaction.This is a reference data field. Please use /v1/utilities/referenceData/{transferCurrencyIndicator} resource to get valid value of this field with description. type: string example: SOURCE_ACCOUNT_CURRENCY paymentScheduleType: type: string description: The payment schedule type. This is a reference data. Please use /v1/utilities/referenceData/{paymentScheduleType} resource to get valid value of this field. example: IMMEDIATE futureDatedTransaction: $ref: '#/definitions/FutureDatedTransaction' standingInstruction: $ref: '#/definitions/StandingInstruction' remarks: description: Free text that usually describes purpose of payment. type: string example: Personal required: - sourceAccountId - transferCurrencyIndicator - payeeAccountDetails - transactionAmount PayeeAccountDetailsAdhocIntTransferPreprocess: properties: payeeAccountNumber: description: The account number of the destination account type: string example: "251212582364" payeeName: description: Name of the payee. type: string example: Mark Jacobs payeeNickName: description: The nick name of the payee assigned by the customer. type: string example: MarkJ required: - payeeAccountNumber AdhocInternalDmstcTransferPreprocessResponse: properties: controlFlowId: description: Control flow Id type: string example: "12345678" debitDetails: $ref: '#/definitions/DebitDetails' creditDetails: $ref: '#/definitions/CreditDetails' foreignExchangeRate: description: 'The exchange rate that is applicable for the particular transfer. ' type: number format: double example: 1.800100 transactionFee: description: The charges that is being charged by the source bank for doing the transfer. type: number format: double example: 25.250000 required: - controlFlowId - foreignExchangeRate - transactionFee Remarks: properties: remarks: description: Free text that usually describes purpose of payment. type: string example: Personal required: - remarks BankDetailsSEPATransfer: properties: globalBankCode: description: This field is to indicate the SWIFT code(Society for Worldwide Interbank Financial Telecommunication code). An internationally-recognized identification code for banks around the world. type: string example: HKBAAU2SBNE bankName: description: Payee account bank name type: string example: HSBC Bank required: - globalBankCode SourceAccountDetails: properties: sourceAccountId: description: The source account identifier in encrypted format.Typically, this is not displayed to the customer. type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d displaySourceAccountNumber: description: A masked account number that can be displayed to the customer type: string example: XXXXXX2364 sourceAccountCurrencyCode: description: The currency code of the source account in ISO 4217 format type: string example: PLN sourceAccountAvailableBalance: description: The available balance including any pending or in progress deposits and withdrawals. type: number format: double example: 50000.250000 required: - displaySourceAccountNumber CrossBorderWireTransfersPayee: properties: payeeName: description: Name of the payee. type: string example: Adam Smith payeeNickName: description: The nick name of the payee assigned by the customer. type: string example: Adam payeeType: description: 'Identifies the type of payee based on the destination of the payee.This is a reference data field. Please use /v1/utilities/referenceData/{payeeType} resource to get valid value of this field with description. ' type: string example: SWIFT payeeStatus: description: The payee status. This is a reference data field. Please use /v1/utilities/referenceData/{payeeStatus} resource to get valid value of this field with description. type: string example: ACTIVE currencyCode: description: The currency code of the payee account in ISO 4217 format type: string example: GBP payeeCountryCode: description: ISO country code. This is a reference data field. Please use /v1/utilities/referenceData/{country} resource to get valid value of this field with description. type: string example: AU accountId: type: string description: The payee account identifier in encrypted format. example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d displayAccountNumber: description: A masked account number that can be displayed to the customer. type: string example: XXXXXX2364 beneficiaryBankName: description: Name of the bank. type: string example: Rabo Bank beneficiaryBankCode: description: The bank code of the external payee account. type: string example: "44525101" payeeAddress: $ref: '#/definitions/PayeeAddress' bankAddress: $ref: '#/definitions/BankAddress' payeeNotes: description: Free text that usually describes purpose of payment. type: string example: University Fee payment required: - payeeType - payeeName - accountId - displayAccountNumber - payeeNotes - payeeNickName - payeeCountryCode - beneficiaryBankName - beneficiaryBankCode CrossBorderWireTransfersPreprocessRequest: properties: sourceAccountId: description: The source account identifier in encrypted format.Typically, this is not displayed to the customer. type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d payeeId: description: The payee identifier in encrypted format.Typically, this is not displayed to the customer. type: string example: C$0003019202$AU$XX$01000540000001 transactionAmount: description: The transaction amount type: number format: double example: 4500.250000 transactionCurrencyCode: description: The currency code for the transaction amount in ISO 4217 format. type: string example: PLN chargeBearer: description: Field to identify charge bearer.The acceptable forms of remittance for a given payments and transfer transaction.This is a reference data field. Please use /v1/utilities/referenceData/{chargeBearer} resource to get valid value of this field with description. type: string example: BENEFICIARY paymentScheduleType: type: string description: The payment schedule type. This is a reference data. Please use /v1/utilities/referenceData/{paymentScheduleType} resource to get valid value of this field. example: IMMEDIATE futureDatedTransaction: $ref: '#/definitions/FutureDatedTransaction' standingInstruction: $ref: '#/definitions/StandingInstruction' remarks: type: array items: $ref: '#/definitions/Remarks' required: - sourceAccountId - payeeId - transactionAmount - chargeBearer CrossBorderWireTransfersPreprocessResponse: properties: controlFlowId: description: Control flow Id type: string example: "12345678" debitDetails: $ref: '#/definitions/DebitDetails' creditDetails: $ref: '#/definitions/CreditDetails' foreignExchangeRate: description: 'The exchange rate that is applicable for the particular transfer. ' type: number format: double example: 1.800100 transactionFee: description: The charges that is being charged by the source bank for doing the transfer. type: number format: double example: 25.250000 feeCurrencyCode: description: Fee currency code in ISO 4217 Format. type: string example: PLN required: - controlFlowId CrossBorderWireTransfersAccountPayeeEligibilityResponse: properties: sourceAccounts: type: array items: $ref: '#/definitions/SourceAccountsCrossBorderWireTransfer' payeeSourceAccountCombinations: type: array items: $ref: '#/definitions/PayeeSourceAccountCombinationsCrossBorderWireTransfer' nextStartIndex: description: In some cases there is more data than what can be returned in a single response. If there is additional data available a nextStartIndex will be returned. Pass the nextStartIndex in your next request to retrieve the next set of data. type: string example: "11" required: - sourceAccounts SourceAccountsCrossBorderWireTransfer: properties: sourceAccountId: description: The primary identifier for ownership of an account.The source account identifier in encrypted format.Typically, this is not displayed to the customer,use displayAccountNumber instead. type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d displaySourceAccountNumber: description: A masked account number that can be displayed to the customer type: string example: XXXXXX2364 productName: description: The name of the product type: string example: Personal Checking Account sourceAccountCurrencyCode: description: The currency code of the source account in ISO 4217 format type: string example: SGD accountNickname: type: string description: The nickname of the account assigned by the customer example: Credit Card Account for My Travels accountGroup: description: Account Group associated with the source Account.This is a reference data field. Please use /v1/utilities/referenceData/{accountGroup} resource to get valid value of this field with description. type: string example: SAVINGS_AND_INVESTMENTS availableBalance: description: The available balance including any pending or in progress deposits and withdrawals type: number format: double example: 50000.250000 required: - sourceAccountId - displaySourceAccountNumber - sourceAccountCurrencyCode - accountGroup PayeeSourceAccountCombinationsCrossBorderWireTransfer: properties: payeeId: description: Unique identifier associated with the payee.Typically, this is not displayed to the customer. type: string example: C$0003019202$AU$XX$01000540000001 displayPayeeAccountNumber: description: The display account number of the destination account. type: string example: XXXXXX2364 payeeAccountCurrencyCode: description: The currency code of the payee account in ISO 4217 format type: string example: SGD payeeName: description: Name of the payee. type: string example: Mark Jacobs payeeNickName: description: Payee account nick name type: string example: James payeeBankDetails: $ref: '#/definitions/PayeeBankDetailsCrossBorderWireTransfer' payeeAddress: $ref: '#/definitions/PayeeAddress' sourceAccountIds: type: array items: $ref: '#/definitions/SourceAccountIds' required: - payeeId - displayPayeeAccountNumber PayeeBankDetailsCrossBorderWireTransfer: properties: globalBankCode: description: This field is to indicate the SWIFT code(Society for Worldwide Interbank Financial Telecommunication code). An internationally-recognized identification code for banks around the world. type: string example: HKBAAU2SBNE bankName: description: Payee account bank name type: string example: HSBC Bank payeeBankAddress: $ref: '#/definitions/PayeeBankAddress' required: - globalBankCode PayeeBankDetails: properties: globalBankCode: description: This field is to indicate the SWIFT code(Society for Worldwide Interbank Financial Telecommunication code). An internationally-recognized identification code for banks around the world. type: string example: HKBAAU2SBNE countryName: description: This field is to indicate the name of the country. This is a reference data field. Please use /v1/utilities/referenceData/{countryName} resource to get valid value of this field with description. type: string example: POLAND required: - globalBankCode CrossBorderWireTransfersRequest: properties: controlFlowId: description: Control flow Id type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d required: - controlFlowId CrossBorderWireTransfersResponse: properties: transactionReferenceId: description: The unique transaction reference Id used to identify this transaction from all the other transactions type: string example: HBKFT160129X001373 sourceAccountDetails: $ref: '#/definitions/SourceAccountDetails' required: - transactionReferenceId - sourceAccountDetails AdhocCrossBorderWireTransfersSrcAcctEligibilityResponse: properties: sourceAccounts: type: array items: $ref: '#/definitions/SourceAccounts' nextStartIndex: description: In some cases there is more data than what can be returned in a single response. If there is additional data available a nextStartIndex will be returned. Pass the nextStartIndex in your next request to retrieve the next set of data. type: string example: "11" required: - sourceAccounts AdhocCrossBorderWireTransfersPreprocessRequest: properties: sourceAccountId: description: The source account identifier in encrypted format.Typically, this is not displayed to the customer. type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d payeeAccountDetails: $ref: '#/definitions/PayeeAccountDetailsAdhocCrossBorderWireTransferPreprocess' transactionAmount: description: The transaction amount type: number format: double example: 4500.250000 transactionCurrencyCode: description: The currency code for the transaction amount in ISO 4217 format. type: string example: PLN chargeBearer: description: Specifies which party(ies) will pay charges due for processing of the instruction. Please use /v1/utilities/referenceData/{chargeBearer} resource to get valid value of this field with description. type: string example: BENEFICIARY paymentScheduleType: type: string description: The payment schedule type. This is a reference data. Please use /v1/utilities/referenceData/{paymentScheduleType} resource to get valid value of this field. example: IMMEDIATE futureDatedTransaction: $ref: '#/definitions/FutureDatedTransaction' standingInstruction: $ref: '#/definitions/StandingInstruction' remarks: type: array items: $ref: '#/definitions/Remarks' required: - sourceAccountId - payeeAccountDetails - transactionAmount - chargeBearer - paymentScheduleType PayeeAccountDetailsAdhocCrossBorderWireTransferPreprocess: properties: payeeAccountNumber: description: The account number of the destination account type: string example: "251212582364" accountIbanFlag: description: This field is to indicate whether the account number is IBAN or not type: boolean example: true payeeName: description: Name of the payee. type: string example: Mark Jacobs payeeNickName: description: The nick name of the payee assigned by the customer. type: string example: MarkJ payeeCurrencyCode: type: string description: The currency code of the destination account in ISO 4217 format example: SGD payeeAddress: $ref: '#/definitions/PayeeAddress' payeeBankDetails: $ref: '#/definitions/PayeeBankDetailsAdhocCrossBorderWireTransferPreprocess' required: - payeeAccountNumber - payeeCurrencyCode PayeeBankDetailsAdhocCrossBorderWireTransferPreprocess: properties: payeeBankName: description: Name of the bank. type: string example: HSBC Bank globalBankCode: description: This field is to indicate the SWIFT code(Society for Worldwide Interbank Financial Telecommunication code). An internationally-recognized identification code for banks around the world. type: string example: HKBAAU2SBNE payeeBankAddress: $ref: '#/definitions/PayeeBankAddress' required: - globalBankCode AdhocCrossBorderWireTransfersPreprocessResponse: properties: controlFlowId: description: Control flow Id type: string example: "12345678" debitDetails: $ref: '#/definitions/DebitDetails' creditDetails: $ref: '#/definitions/CreditDetails' foreignExchangeRate: description: 'The exchange rate that is applicable for the particular transfer. ' type: number format: double example: 1.800100 transactionFee: description: The charges that is being charged by the source bank for doing the transfer. type: number format: double example: 25.250000 feeCurrencyCode: description: Fee currency code in ISO 4217 Format. type: string example: SGD required: - controlFlowId - foreignExchangeRate - transactionFee AccountProxyTransfersConfirmationRequest: properties: controlFlowId: description: The control flow Id type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d required: - controlFlowId AccountProxyTransfersConfirmationResponse: properties: sourceAccount: $ref: '#/definitions/SourceAccount' transactionReferenceId: description: The unique transaction reference Id used to identify this transaction from all the other transactions type: string example: HBKFT160129X001373 payeeEnrollmentStatus: description: Status to indicate if the payee is added or not to customers registered list of billers. This is a reference data. Please use /v1/utilities/referenceData/{payeeEnrollmentStatus} resource to get valid value of this field. type: string example: SUCCESS required: - transactionReferenceId - sourceAccount AccountProxyTransfersPreprocessRequest: properties: proxyPaymentType: description: The type of proxy payment.This is a reference data field. Please use /v1/utilities/referenceData/{proxyPaymentType} resource to get valid value of this field with description. type: string example: PAY_NOW sourceAccountId: description: The source account identifier in encrypted format.Typically, this is not displayed to the customer. type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d transactionAmount: description: The transaction amount type: number format: double example: 4500.250000 transactionCurrencyCode: description: The currency code for the transaction amount in ISO 4217 format. type: string example: PLN transferCurrencyIndicator: description: Indicator to specify whether the transfer is in source or destination account currency.The acceptable forms of remittance for a given payments and transfer transaction.This is a reference data field. Please use /v1/utilities/referenceData/{transferCurrencyIndicator} resource to get valid value of this field with description. type: string example: SOURCE_ACCOUNT_CURRENCY proxyAccountId: description: This field is used to refer the proxy account number. type: string example: "80328978" proxyAccountIdType: description: This field is used to refer the proxy account number. This is a reference data field. Please use /v1/utilities/referenceData/{proxyAccountIdType} resource to get valid value of this field with description. type: string example: PHONE_NUMBER chargeBearer: description: Field to identify charge bearer.The acceptable forms of remittance for a given payments and transfer transaction.This is a reference data field. Please use /v1/utilities/referenceData/{chargeBearer} resource to get valid value of this field with description. type: string example: BENEFICIARY billReferenceNumber: description: Bill payment reference number belongs to merchant. type: string example: "9012345678" remarks: description: Payment notes. Free text from screen type: string transferPurpose: description: Purpose of transfer. Applicable if paymentMethod is GIRO, FAST. This is a reference data field.This is a reference data field. Please use /v1/utilities/referenceData/{transferPurpose} resource to get valid value of this field with description. type: string example: CASH_DISBURSEMENT required: - sourceAccountId - proxyPaymentType - proxyAccountId - proxyAccountIdType - transactionAmount - transferCurrencyIndicator - chargeBearer AccountProxyTransfersPreprocessResponse: properties: controlFlowId: description: Control flow Id type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d debitDetails: $ref: '#/definitions/DebitDetails' creditDetails: $ref: '#/definitions/CreditDetails' foreignExchangeRate: description: Exchange rate type: number format: double example: 1.102100 forexType: description: This is an indicator if exchange rate received from host is Counter or Live. This is a reference data field. Please use /v1/utilities/referenceData/{forexType} resource to get valid value of this field with description. type: string example: LIVE forexConversionIndicator: description: This is the indicator if FX rate sent in response is computed on one Unit of Source Currency to Destination currency or one Unit of Destination Currency to Source Currency.This is a reference data field. Please use /v1/utilities/referenceData/{forexConversionIndicator} resource to get valid value of this field with description. type: string example: SOURCE_TO_DESTINATION transactionFee: description: Transaction fee type: number format: double example: 500.250000 feeCurrencyCode: description: Fee currency code in ISO 4217 format. type: string example: USD localCurrencyTransactionFee: description: This is the transactionFee in local currency type: number format: double example: 10.110000 localCurrencyCode: type: string description: Local currency code in ISO 4217 Format. example: SGD required: - controlFlowId AccountProxyTransfersRequest: properties: controlFlowId: description: The control flow Id type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d required: - controlFlowId AccountProxyTransfersResponse: properties: sourceAccount: $ref: '#/definitions/SourceAccount' transactionReferenceId: description: The unique transaction reference Id used to identify this transaction from all the other transactions type: string example: HBKFT160129X001373 payeeEnrollmentStatus: description: Status to indicate if the payee is added or not to customers registered list of billers. This is a reference data. Please use /v1/utilities/referenceData/{payeeEnrollmentStatus} resource to get valid value of this field. type: string example: SUCCESS required: - transactionReferenceId - sourceAccount AdhocAccountProxyTransfersPreprocessWithAddPayeeRequest: properties: proxyPaymentType: description: The type of proxy payment.This is a reference data field. Please use /v1/utilities/referenceData/{proxyPaymentType} resource to get valid value of this field with description. type: string example: PAY_NOW sourceAccountId: description: The source account identifier in encrypted format.Typically, this is not displayed to the customer. type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d transactionAmount: description: The transaction amount type: number format: double example: 4500.250000 transactionCurrencyCode: description: The currency code for the transaction amount in ISO 4217 format. type: string example: PLN transferCurrencyIndicator: description: Indicator to specify whether the transfer is in source or destination account currency.The acceptable forms of remittance for a given payments and transfer transaction.This is a reference data field. Please use /v1/utilities/referenceData/{transferCurrencyIndicator} resource to get valid value of this field with description. type: string example: SOURCE_ACCOUNT_CURRENCY proxyAccountId: description: This field is used to refer the proxy account number. type: string example: "80328978" proxyAccountIdType: description: This field is used to refer the proxy account number. This is a reference data field. Please use /v1/utilities/referenceData/{proxyAccountIdType} resource to get valid value of this field with description. type: string example: PHONE_NUMBER chargeBearer: description: Field to identify charge bearer.The acceptable forms of remittance for a given payments and transfer transaction.This is a reference data field. Please use /v1/utilities/referenceData/{chargeBearer} resource to get valid value of this field with description. type: string example: BENEFICIARY billReferenceNumber: description: Bill payment reference number belongs to merchant. type: string example: "9012345678" remarks: description: Payment notes. Free text from screen type: string transferPurpose: description: Purpose of transfer. Applicable if paymentMethod is GIRO, FAST. This is a reference data field.This is a reference data field. Please use /v1/utilities/referenceData/{transferPurpose} resource to get valid value of this field with description. type: string example: CASH_DISBURSEMENT payeeNickName: description: The nick name of the payee assigned by the customer. type: string example: MarkJ payeeEnrollmentFlag: type: boolean description: Flag to indicate the payee must be added to customers registered list of billers. example: true bankName: description: Name of the bank. Applicable only for CNIBPS. Customer can input BankName also on screen to Transfer the fund for proxy registered to Bank instead Default Bank type: string example: HSBC Bank customerName: description: Name of the customer. Applicable only for CNIBPS. specific to CNIBPS. Customer can input name on screen, which will be validated in IBPS system type: string required: - sourceAccountId - proxyPaymentType - proxyAccountId - proxyAccountIdType - transactionAmount - transferCurrencyIndicator - chargeBearer AdhocAccountProxyTransfersPreprocessWithAddPayeeResponse: properties: controlFlowId: description: Control flow Id type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d debitDetails: $ref: '#/definitions/DebitDetails' creditDetails: $ref: '#/definitions/CreditDetails' foreignExchangeRate: description: Exchange rate type: number format: double example: 1.102100 forexType: description: This is an indicator if exchange rate received from host is Counter or Live. This is a reference data field. Please use /v1/utilities/referenceData/{forexType} resource to get valid value of this field with description. type: string example: LIVE forexConversionIndicator: description: This is the indicator if FX rate sent in response is computed on one Unit of Source Currency to Destination currency or one Unit of Destination Currency to Source Currency.This is a reference data field. Please use /v1/utilities/referenceData/{forexConversionIndicator} resource to get valid value of this field with description. type: string example: SOURCE_TO_DESTINATION transactionFee: description: Transaction fee type: number format: double example: 500.250000 feeCurrencyCode: description: Fee currency code in ISO 4217 format. type: string example: USD localCurrencyTransactionFee: description: This is the transactionFee in local currency type: number format: double example: 10.110000 localCurrencyCode: type: string description: Local currency code in ISO 4217 Format. example: SGD transactionLimitRange: type: string description: This refers if customer's daily limit is witin in defined criteria.Valid values are <50K=0 , >50K and <300K=1 , >300K =2 example: "1" required: - controlFlowId AccountProxyTransfersSourceAccountEligibilityResponse: properties: sourceAccounts: type: array items: $ref: '#/definitions/SourceAccounts' nextStartIndex: description: In some cases there is more data than what can be returned in a single response. If there is additional data available a nextStartIndex will be returned. Pass the nextStartIndex in your next request to retrieve the next set of data. type: string example: "11" required: - sourceAccounts SourceAccounts: properties: sourceAccountId: description: The primary identifier for ownership of an account.The source account identifier in encrypted format.Typically, this is not displayed to the customer,use displayAccountNumber instead. type: string example: 724f5141524b4d58576853766c786a45376e7637576e6d35695378515a726f494c36367763776775432f453d displaySourceAccountNumber: description: A masked account number that can be displayed to the customer type: string example: XXXXXX2364 sourceAccountCurrencyCode: description: The currency code of the source account in ISO 4217 format type: string example: SGD accountGroup: description: Account Group associated with the source Account.This is a reference data field. Please use /v1/utilities//referenceData/{accountGroup} resource to get valid value of this field with description. You can use accountGroup as the referenceCode parameter to retrieve the values. type: string example: SAVINGS_AND_INVESTMENTS availableBalance: description: The available balance including any pending or in progress deposits and withdrawals type: number format: double example: 50000.250000 nextPaymentAmount: description: The next payment amount due. type: number format: double example: 4500.250000 productName: description: The name of the product type: string example: Personal Checking Account accountNickName: description: The nick name of the account assigned by the customer type: string example: James required: - sourceAccountId - displaySourceAccountNumber - sourceAccountCurrencyCode - accountGroup BillDetailsInquiryResponse: properties: invoiceNumber: description: This field is used to indicate the invoice number type: string example: "11000112122001" billDetails: type: array items: $ref: '#/definitions/BillDetails' customerMerchantReferenceDetails: type: array items: $ref: '#/definitions/CustomerMerchantReferenceDetails' required: - billDetails - customerMerchantReferenceDetails BillDetails: properties: billSequenceNumber: description: This field is used to refer the sequence number of the bill. type: string example: "11000112122001" billAmount: description: Bill Amount in local currency. type: number format: double example: 2500.110000 billDueDate: description: The bill due date in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2018-10-05" required: - billAmount - billDueDate CustomerMerchantReferenceDetails: properties: customerMerchantReferenceCode: description: Additional bill reference code. type: string example: EAMA customerMerchantReferenceDescription: description: The value associated with the corresponding additional Bill Reference Code. type: string example: "1234123412345" required: - customerMerchantReferenceCode - customerMerchantReferenceDescription DestinationListResponse: properties: paymentCountry: type: array items: $ref: '#/definitions/PaymentCountry' nextStartIndex: description: In some cases there is more data than what can be returned in a single response. If there is additional data available a nextStartIndex will be returned. Pass the nextStartIndex in your next request to retrieve the next set of data. type: string example: "11" required: - paymentCountry PaymentCountry: properties: countryName: description: This field is to indicate the country name of the payee. This is a reference data field. Please use /v1/utilities/referenceData/{countryName} resource to get valid value of this field with description. type: string example: INDIA countryCode: description: ISO country code. This is a reference data field. Please use /utilities/referenceData/{country} resource to get possible values of this field with descriptions. type: string example: IN localCurrencyCode: type: string description: This is the local currency code in ISO 4217 Format. example: SGD countryBankBranchIdentifier: description: This field is to indicate the name of the bank branch identifier supported for the country. type: string example: IFSC countryIbanFlag: description: This field is used to indicate if the country supports IBAN. type: boolean example: false required: - countryName - countryCode PersonalDomesticTransferConfirmationRequest: properties: controlFlowId: description: The control flow Id type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d required: - controlFlowId PersonalDomesticTransferConfirmationResponse: properties: sourceAccount: $ref: '#/definitions/SourceAccount' destinationAccount: $ref: '#/definitions/DestinationAccount' transactionReferenceId: description: The unique transaction reference Id used to identify this transaction from all the other transactions type: string example: HBKFT160129X001373 required: - transactionReferenceId - destinationAccount MerchantListResponse: properties: merchantInformation: type: array items: $ref: '#/definitions/MerchantInformationML' MerchantInformationML: properties: billerCategoryCode: description: Biller Category Code is a classification code that is assigned by a bank to a biller.This is a reference data field. Please use /v1/utilities/referenceData/{billerCategoryCode} resource to get valid value of this field with description type: string example: INTERNET merchants: type: array items: $ref: '#/definitions/Merchant' required: - merchants - billerCategoryCode Merchant: properties: merchantName: description: The name of the merchant. type: string example: Verizone Wireless merchantNameLocal: description: ' The name of the merchant in local language.' type: string example: БИЛÐ?ЙÐ? merchantNumber: description: A string that uniquely identifies a merchant. type: string example: "350002" required: - merchantName - merchantNumber MerchantDetailsResponse: properties: merchantDetails: type: array items: $ref: '#/definitions/MerchantDetails' MerchantDetails: properties: merchantCustomerRelationshipType: description: The relationship of the customer with the merchant. type: string example: HOME TELEPHONE merchantCustomerRelationshipTypeCode: description: The relationship code of the customer with the merchant. type: string example: "307" merchantCustomerRelationshipTypeLocal: description: The relationship of the customer with the merchant in local language. type: string example: домашний телефон required: - merchantCustomerRelationshipType PayeeSourceAccountCombinations: properties: payeeId: description: Unique identifier associated with the payee.Typically, this is not displayed to the customer. type: string example: C$0003019202$AU$XX$01000540000001 displayPayeeAccountNumber: description: The display account number of the destination account type: string example: XXXXXX4085 payeeAccountCurrencyCode: description: The currency code of the payee account in ISO 4217 format type: string example: SGD payeeNickName: description: Payee account nick name type: string example: James bankDetails: $ref: '#/definitions/BankDetails' paymentType: description: The payment type.This is a reference data field. Please use /v1/utilities/referenceData/{paymentType} resource to get valid value of this field with description. type: string example: GIRO paymentMethods: type: array items: $ref: '#/definitions/PaymentMethod' merchantNumber: description: Unique identifier associated with the merchant. Applicable only for Australia. type: string example: "10000025142" payeeName: description: Name of the payee.Applicable only for Australia. type: string example: Singtel payeeAddress: $ref: '#/definitions/PayeeAddress' sourceAccountIds: type: array items: $ref: '#/definitions/SourceAccountIds' required: - payeeAccountCurrencyCode - payeeNickName - paymentMethods - payeeId - sourceAccountIds BillPaymentsPreprocessResponse: properties: controlFlowId: description: Control flow Id type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d debitDetails: $ref: '#/definitions/DebitDetails' creditDetails: $ref: '#/definitions/CreditDetails' foreignExchangeRate: description: Exchange rate type: number format: double example: 1.101200 transactionFee: description: Transaction fee type: number format: double example: 25.250000 feeCurrencyCode: description: Fee currency code in ISO 4217 format. type: string example: USD payeeName: description: Name of the payee.Applicable only for Australia. type: string example: Singtel merchantNumber: description: Unique identifier associated with the merchant. Applicable only for Australia. type: string example: "10000025142" required: - controlFlowId BillPaymentsResponse: properties: sourceAccount: $ref: '#/definitions/SourceAccount' transactionReferenceId: description: The unique transaction reference Id used to identify this transaction from all the other transactions type: string example: HBKFT160129B001373 required: - transactionReferenceId - sourceAccount SourceAccountIds: properties: sourceAccountId: description: The source account identifier in encrypted format.Typically, this is not displayed to the customer. type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d required: - sourceAccountId BillPaymentsRequest: properties: controlFlowId: description: Control Flow Id type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d required: - controlFlowId BillPaymentsPreprocessRequest: properties: sourceAccountId: description: The source account identifier in encrypted format.Typically, this is not displayed to the customer. type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d transactionAmount: description: The transaction amount type: number format: double example: 4500.250000 transferCurrencyIndicator: description: Indicator to specify whether the transfer is in source or destination account currency.The acceptable forms of remittance for a given payments and transfer transaction.This is a reference data field. Please use /v1/utilities/referenceData/{transferCurrencyIndicator} resource to get valid value of this field with description. You can use transferCurrencyIndicator as the referenceCode parameter to retrieve the values. type: string example: SOURCE_ACCOUNT_CURRENCY payeeId: description: The payee identifier in encrypted format.Typically, this is not displayed to the customer. type: string example: C$0003019202$AU$XX$01000540000001 billTypeCode: description: Bill Type Code is the sub category for the Merchant. Bill Payment Transaction can be uniquely identified by the combination of the merchant number and billTypeCode type: string example: "1" remarks: description: Bill payment notes. Free text from screen. type: string customerReferenceNumber: description: This is the unique identifier against the biller assigned for each transaction. type: string example: "18618266214" paymentScheduleType: type: string description: The payment schedule type. This is a reference data. Please use /v1/utilities/referenceData/{paymentScheduleType} resource to get valid value of this field. example: IMMEDIATE paymentMethod: description: The acceptable forms of remittance for a given payments and transfer transaction.This is a reference data field. Please use /v1/utilities/referenceData/{paymentMethod} resource to get valid value of this field with description. type: string example: GIRO futureDatedTransaction: $ref: '#/definitions/FutureDatedTransaction' standingInstruction: $ref: '#/definitions/StandingInstruction' required: - sourceAccountId - transactionAmount - transferCurrencyIndicator - payeeId BillPaymentAccountPayeeEligibilityResponse: properties: sourceAccounts: type: array items: $ref: '#/definitions/BillPaymentSourceAccounts' payeeSourceAccountCombinations: type: array items: $ref: '#/definitions/BillPaymentPayeeSourceAccountCombinations' nextStartIndex: description: In some cases there is more data than what can be returned in a single response. If there is additional data available a nextStartIndex will be returned. Pass the nextStartIndex in your next request to retrieve the next set of data. type: string example: "11" required: - sourceAccounts - payeeSourceAccountCombinations SepaTransfersPreprocessRequest: properties: sourceAccountId: description: The source account identifier in encrypted format.Typically, this is not displayed to the customer. type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d payeeId: description: The payee identifier in encrypted format.Typically, this is not displayed to the customer. type: string example: C$0003019202$AU$XX$01000540000001 transactionAmount: description: The transaction amount type: number format: double example: 4500.250000 transactionCurrencyCode: description: The currency code for the transaction amount in ISO 4217 format. type: string example: PLN remarks: type: array items: $ref: '#/definitions/Remarks' required: - sourceAccountId - payeeId - transactionAmount SepaTransfersPreprocessResponse: properties: controlFlowId: description: Control flow Id type: string example: "12345678" debitDetails: $ref: '#/definitions/DebitDetails' creditDetails: $ref: '#/definitions/CreditDetails' foreignExchangeRate: description: 'The exchange rate that is applicable for the particular transfer. ' type: number format: double example: 1.800100 transactionFee: description: The charges that is being charged by the source bank for doing the transfer. type: number format: double example: 25.250000 feeCurrencyCode: description: Fee currency code in ISO 4217 Format. type: string example: PLN required: - controlFlowId SepaTransfersAccountPayeeEligibilityResponse: properties: sourceAccounts: type: array items: $ref: '#/definitions/SourceAccounts' payeeSourceAccountCombinations: type: array items: $ref: '#/definitions/PayeeSourceAccountCombinationsSEPATransfer' nextStartIndex: description: In some cases there is more data than what can be returned in a single response. If there is additional data available a nextStartIndex will be returned. Pass the nextStartIndex in your next request to retrieve the next set of data. type: string example: "11" required: - sourceAccounts PayeeSourceAccountCombinationsSEPATransfer: properties: payeeId: description: Unique identifier associated with the payee.Typically, this is not displayed to the customer. type: string example: C$0003019202$AU$XX$01000540000001 displayPayeeAccountNumber: description: The display account number of the destination account. type: string example: XXXXXX2364 payeeAccountCurrencyCode: description: The currency code of the payee account in ISO 4217 format type: string example: SGD payeeNickName: description: Payee account nick name type: string example: James bankDetails: $ref: '#/definitions/BankDetailsSEPATransfer' payeeAddress: $ref: '#/definitions/PayeeAddress' transferPurpose: description: Purpose of transfer. Applicable if paymentMethod is GIRO, FAST. This is a reference data field.This is a reference data field. Please use /v1/utilities/referenceData/{transferPurpose} resource to get valid value of this field with description. type: string example: CASH_DISBURSEMENT sourceAccountIds: type: array items: $ref: '#/definitions/SourceAccountIds' required: - payeeId - displayPayeeAccountNumber - sourceAccountIds SepaTransferRequest: properties: controlFlowId: description: Control flow Id type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d required: - controlFlowId SepaTransferResponse: properties: transactionReferenceId: description: The unique transaction reference Id used to identify this transaction from all the other transactions type: string example: HBKFT160129X001373 sourceAccountDetails: $ref: '#/definitions/SourceAccountDetails' required: - transactionReferenceId - sourceAccountDetails MerchantInformation: properties: merchantCustomerRelationshipType: description: The relationship of the customer with the merchant. type: string example: HOME TELEPHONE merchantCustomerRelationshipTypeLocal: description: The relationship of the customer with the merchant in local language. type: string example: домашний телефон billReferenceNumber: description: Bill payment Account number belongs to merchant. type: string example: "9012345678" required: - billReferenceNumber CitiGlobalTransfersPreprocessRequest: properties: sourceAccountId: description: The source account identifier in encrypted format.Typically, this is not displayed to the customer. type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d payeeId: description: The payee identifier in encrypted format.Typically, this is not displayed to the customer. type: string example: C$0003019202$AU$XX$01000540000001 transactionAmount: description: The transaction amount type: number format: double example: 4500.250000 transactionCurrencyCode: description: The currency code for the transaction amount in ISO 4217 format. type: string example: PLN transferPurpose: description: Purpose of transfer.Please use /v1/utilities/referenceData/{transferPurpose} resource to get valid value of this field with description. type: string example: GIFT required: - sourceAccountId - payeeId - transactionAmount CitiGlobalTransfersPreprocessResponse: properties: controlFlowId: description: Control flow Id type: string example: "12345678" debitDetails: $ref: '#/definitions/DebitDetails' creditDetails: $ref: '#/definitions/CreditDetails' foreignExchangeRate: description: 'The exchange rate that is applicable for the particular transfer. ' type: number format: double example: 1.800100 transactionFee: description: The charges that is being charged by the source bank for doing the transfer. type: number format: double example: 25.250000 feeCurrencyCode: description: Fee currency code in ISO 4217 Format. type: string example: PLN required: - controlFlowId CitiGlobalTransfersAccountPayeeEligibilityResponse: properties: sourceAccounts: type: array items: $ref: '#/definitions/SourceAccountsCitiGlobalTransfer' payeeSourceAccountCombinations: type: array items: $ref: '#/definitions/PayeeSourceAccountCombinationsCitiGlobalTransfer' nextStartIndex: description: In some cases there is more data than what can be returned in a single response. If there is additional data available a nextStartIndex will be returned. Pass the nextStartIndex in your next request to retrieve the next set of data. type: string example: "11" required: - sourceAccounts SourceAccountsCitiGlobalTransfer: properties: sourceAccountId: description: The primary identifier for ownership of an account.The source account identifier in encrypted format.Typically, this is not displayed to the customer,use displayAccountNumber instead. type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d displaySourceAccountNumber: description: A masked account number that can be displayed to the customer type: string example: XXXXXX2364 productName: description: The name of the product type: string example: Personal Checking Account sourceAccountCurrencyCode: description: The currency code of the source account in ISO 4217 format type: string example: SGD accountNickname: type: string description: The nickname of the account assigned by the customer example: Credit Card Account for My Travels accountGroup: description: Account Group associated with the source Account.This is a reference data field. Please use /v1/utilities/referenceData/{accountGroup} resource to get valid value of this field with description. type: string example: SAVINGS_AND_INVESTMENTS availableBalance: description: The available balance including any pending or in progress deposits and withdrawals type: number format: double example: 50000.250000 required: - sourceAccountId - displaySourceAccountNumber - sourceAccountCurrencyCode PayeeSourceAccountCombinationsCitiGlobalTransfer: properties: payeeId: description: Unique identifier associated with the payee.Typically, this is not displayed to the customer. type: string example: C$0003019202$AU$XX$01000540000001 displayPayeeAccountNumber: description: The display account number of the destination account. type: string example: XXXXXX2364 payeeAccountCurrencyCode: description: The currency code of the payee account in ISO 4217 format type: string example: SGD payeeName: description: Name of the payee. type: string example: Mark Jacobs payeeNickName: description: Payee account nick name type: string example: James payeeBankDetails: $ref: '#/definitions/PayeeBankDetailsCitiGlobalTransfer' sourceAccountIds: $ref: '#/definitions/SourceAccountIds' required: - payeeId - displayPayeeAccountNumber PayeeBankDetailsCitiGlobalTransfer: properties: bankName: description: Payee account bank name type: string example: Citi Bank International PLC countryName: description: This field is to indicate the name of the country. This is a reference data field. Please use /v1/utilities/referenceData/{countryName} resource to get valid value of this field with description. type: string example: POLAND CitiGlobalTransfersRequest: properties: controlFlowId: description: Control flow Id type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d required: - controlFlowId CitiGlobalTransfersResponse: properties: transactionReferenceId: description: The unique transaction reference Id used to identify this transaction from all the other transactions type: string example: HBKFT160129X001373 sourceAccountDetails: $ref: '#/definitions/SourceAccountDetails' required: - transactionReferenceId - sourceAccountDetails AdhocSepaTransfersSrcAcctEligibilityResponse: properties: sourceAccounts: type: array items: $ref: '#/definitions/SourceAccounts' nextStartIndex: description: In some cases there is more data than what can be returned in a single response. If there is additional data available a nextStartIndex will be returned. Pass the nextStartIndex in your next request to retrieve the next set of data. type: string example: "11" required: - sourceAccounts AdhocCitiGlobalTransfersSrcAcctEligibilityResponse: properties: sourceAccounts: type: array items: $ref: '#/definitions/SourceAccounts' nextStartIndex: description: In some cases there is more data than what can be returned in a single response. If there is additional data available a nextStartIndex will be returned. Pass the nextStartIndex in your next request to retrieve the next set of data. type: string example: "11" required: - sourceAccounts AdhocCitiGlobalTransfersPreprocessRequest: properties: sourceAccountId: description: The source account identifier in encrypted format.Typically, this is not displayed to the customer. type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d payeeAccountDetails: $ref: '#/definitions/PayeeAccountDetailsAdhocCitiGlobalTransferPreprocess' transactionAmount: description: The transaction amount type: number format: double example: 4500.250000 transferCurrencyIndicator: description: Indicator to specify whether the transfer is in source or destination account currency.The acceptable forms of remittance for a given payments and transfer transaction.This is a reference data field. Please use /v1/utilities/referenceData/{transferCurrencyIndicator} resource to get valid value of this field with description. type: string example: SOURCE_ACCOUNT_CURRENCY transferPurpose: description: This is to indicate the purpose of transfer. This is a reference data field.This is a reference data field. Please use /v1/utilities/referenceData/{transferPurpose} resource to get valid value of this field with description. type: string example: CASH_DISBURSEMENT remarks: description: Free text that usually describes purpose of payment. type: string example: Personal required: - sourceAccountId - payeeAccountDetails - transactionAmount - transferCurrencyIndicator PayeeAccountDetailsAdhocCitiGlobalTransferPreprocess: properties: payeeAccountNumber: description: The account number of the destination account type: string example: "251212582364" payeeName: description: Name of the payee. type: string example: Mark Jacobs payeeNickName: description: The nick name of the payee assigned by the customer. type: string example: MarkJ payeeCountryName: description: This field is to indicate the country name of the payee. This is a reference data field. Please use /v1/utilities/referenceData/{countryName} resource to get valid value of this field with description. type: string example: AUSTRALIA required: - payeeAccountNumber - payeeCountryName AdhocCitiGlobalTransfersPreprocessResponse: properties: controlFlowId: description: Control flow Id type: string example: "12345678" debitDetails: $ref: '#/definitions/DebitDetails' creditDetails: $ref: '#/definitions/CreditDetails' foreignExchangeRate: description: 'The exchange rate that is applicable for the particular transfer. ' type: number format: double example: 1.800100 transactionFee: description: The charges that is being charged by the source bank for doing the transfer. type: number format: double example: 25.250000 feeCurrencyCode: description: Fee currency code in ISO 4217 Format. type: string example: SGD required: - controlFlowId AdhocSepaTransfersPreprocessRequest: properties: sourceAccountId: description: The source account identifier in encrypted format.Typically, this is not displayed to the customer. type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d payeeAccountDetails: $ref: '#/definitions/PayeeAccountDetails' transactionAmount: description: The transaction amount type: number format: double example: 4500.250000 transactionCurrencyCode: description: The currency code for the transaction amount in ISO 4217 format. type: string example: PLN remarks: type: array items: $ref: '#/definitions/Remarks' required: - sourceAccountId - payeeAccountDetails - remarks - transactionCurrencyCode AdhocSepaTransfersPreprocessResponse: properties: controlFlowId: description: Control flow Id type: string example: "12345678" debitDetails: $ref: '#/definitions/DebitDetails' creditDetails: $ref: '#/definitions/CreditDetails' foreignExchangeRate: description: 'The exchange rate that is applicable for the particular transfer. ' type: number format: double example: 1.800100 transactionFee: description: The charges that is being charged by the source bank for doing the transfer. type: number format: double example: 25.250000 feeCurrencyCode: description: Fee currency code in ISO 4217 Format. type: string example: PLN required: - controlFlowId - foreignExchangeRate ErrorResponse: properties: type: description: Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again enum: - error - warn - invalid - fatal type: string code: description: Error code which qualifies the error type: string details: description: Human readable explanation specific to the occurrence of the problem type: string location: description: The name of the field that resulted in the error type: string moreInfo: description: URI to human readable documentation of the error type: object required: - type - code x-ibm-configuration: enforced: true testable: true phase: realized consumes: - application/json securityDefinitions: Client_id: type: apiKey description: pv52735 in: header name: X-IBM-Client-Id security: - Client_id: [] x-ibm-endpoints: - endpointUrl: https://sandbox.apihub.citi.com/gcb description: Custom Gateway API Endpoint type: - production - development ...