--- swagger: "2.0" info: description: |- The Money Movement API allows you to move money within the market of the account of the Citi customer who authorized your app. The API covers three types of transfers: Personal means moving money between a customer's own Citi accounts in the same market. Internal refers to moving money between the accounts of Citi customers in the same market. External refers to moving money from a Citi customer's account to accounts at other banks in the same market. In addition to transfers, the API allows you to pay bills within the market of the account of the Citi customer who authorized your app. title: Money Movement version: 1.0.0 x-ibm-name: moneymovement_100 schemes: - https basePath: /api consumes: - application/json produces: - application/json x-ibm-configuration: enforced: true phase: realized testable: true securityDefinitions: Client_id: type: apiKey name: X-IBM-Client-Id in: header description: pv52735 security: - Client_id: [] paths: /v1/moneyMovement/payees/sourceAccounts: get: summary: Retrieve dest src acct produces: - application/json description: Returns 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. responses: 200: schema: $ref: '#/definitions/ValidSourceDestinationAccountsResponse' 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: paymentType description: Payment Type. This is a reference data field. Please use /v1/apac/utilities/referenceData/{paymentType} resource to get valid value of this field with description. You can use paymentType as the 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: get: summary: Retrieve payee list description: Returns 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/apac/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/personalDomesticTransfers/destinationAccounts/sourceAccounts: get: summary: Retrieve dest src acct personal description: 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: Creates a new personal domestic 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. 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/PreprocessFundTransferRequest' in: body name: PreprocessFundTransferRequest required: true tags: [] /v1/moneyMovement/personalDomesticTransfers: post: summary: Confirm personal transfer description: Confirms 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
401: schema: $ref: '#/definitions/ErrorResponse' description:
TypeCodeDetails
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:
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 dest src acct internal description: 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: Creates a new Internal domestic 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. 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/PreprocessFundTransferRequest' in: body name: PreprocessFundTransferRequest required: true tags: [] /v1/moneyMovement/internalDomesticTransfers: post: summary: Confirm internal transfer description: 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:
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
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/InternalDomesticTransferRequest' in: body name: InternalDomesticTransferRequest required: true tags: [] /v1/moneyMovement/externalDomesticTransfers/payees/sourceAccounts: get: summary: Retrieve dest src acct external description: 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: Creates a new external domestic 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. 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/PreprocessFundTransferRequest' in: body name: PreprocessFundTransferRequest required: true tags: [] /v1/moneyMovement/externalDomesticTransfers: post: summary: Confirm external transfer description: 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
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/ExternalDomesticTransferRequest' in: body name: ExternalDomesticTransferRequest required: true tags: [] /v1/moneyMovement/billPayments/payees/sourceAccounts: get: summary: Retrieve dest src acct bill pay description: 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: Creates a new domestic bill payment 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. 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
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/preprocess/adhoc: post: summary: Create adhoc bill payment description: 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: post: summary: Confirm bill payment description: Confirms 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
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/BillPaymentsRequest' in: body name: BillPaymentsRequest required: true tags: [] /v1/moneyMovement/accounts/{accountId}/autoDebit/adhoc: post: summary: Create Ad Hoc Auto Debit description: Creates a new auto debit instruction from ad hoc drawee and verifies there are no errors. 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: accountId in: path description: The destination account identifier in encrypted format. type: string required: true - name: AutoDebitSetupAdhocRequest in: body required: true schema: $ref: '#/definitions/AutoDebitSetupAdhocRequest' responses: 200: description: Successful operation. 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidDestinationAccountDestination account is invalid
errorinvalidBankBank is invalid
errortransactionDeniedTransaction Denied
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/accounts/{accountId}/autoDebit/adhoc/confirmation: post: summary: Confirm Ad Hoc Auto Debit description: Confirms the ad hoc auto debit setup. It should be called after successful creation of ad hoc auto debit instruction. 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: accountId in: path description: The destination account identifier in encrypted format. 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: AutoDebitSetupAdhocConfirmationRequest in: body required: true schema: $ref: '#/definitions/AutoDebitSetupAdhocConfirmationRequest' responses: 200: description: Successful operation. 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidControlFlowIdControl flow ID is invalid
errorinvalidDestinationAccountDestination account 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/accounts/{accountId}/autoDebit: get: summary: Auto Debit Details description: Returns the auto debit instruction associated with an account. 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 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: accountId in: path description: The destination account identifier in encrypted format required: true type: string responses: 200: description: Successful operation. schema: $ref: '#/definitions/AutoDebitDetailsResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidDestinationAccountDestination account 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
schema: $ref: '#/definitions/ErrorResponse' 404: description:
errorresourceNotFoundEmpty resource/resource not found
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' post: summary: Auto Debit Setup description: Creates a new auto debit instruction and verifies there are no errors. 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: accountId in: path description: The destination account identifier in encrypted format. type: string required: true - name: AutoDebitSetupRequest in: body required: true schema: $ref: '#/definitions/AutoDebitSetupRequest' responses: 200: description: Successful operation. 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidDraweeDrawee is invalid
errorinvalidDestinationAccountDestination account is invalid
errortransactionDeniedTransaction Denied
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' put: summary: Auto Debit Update description: Allows to update the payment amount option associated with the auto debit instruction for an account. 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: accountId in: path description: The destination account identifier in encrypted format type: string required: true - name: AutoDebitUpdateRequest in: body required: true schema: $ref: '#/definitions/AutoDebitUpdateRequest' responses: 200: description: Successful operation. 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errortransactionDeniedTransaction Denied
errorinvalidDestinationAccountDestination account 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' delete: summary: Delete Auto Debit description: Allows customer to delete auto debit instruction associated with an account. 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: 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: accountId in: path description: The destination account identifier in encrypted format required: true type: string responses: 200: description: Successful operation. 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidDestinationAccountDestination account 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/accounts/{accountId}/autoDebit/confirmation: post: summary: Confirm Auto Debit description: Confirms the auto debit setup. It should be called after successful creation of auto debit instruction. 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: accountId in: path description: The destination account identifier in encrypted format type: string required: true - name: AutoDebitSetupConfirmationRequest in: body required: true schema: $ref: '#/definitions/AutoDebitSetupConfirmationRequest' responses: 200: description: Successful operation. 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidControlFlowIdControl flow ID is invalid
errorinvalidDestinationAccountDestination account 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' put: summary: Confirm Auto Debit Update description: Confirms the auto debit update instruction. It should be called after a successful auto debit instruction update. 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: accountId in: path description: The destination account identifier in encrypted format. type: string required: true - name: AutoDebitUpdateConfirmationRequest in: body required: true schema: $ref: '#/definitions/AutoDebitUpdateConfirmationRequest' responses: 200: description: Successful operation. 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidControlFlowIdControl flow ID is invalid
errorinvalidDestinationAccountDestination account 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/drawees: get: summary: Drawee List description: Returns a list of pre-existing drawees for an authorized customer. 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 consumer on-boarding type: string required: true - name: draweeId in: query description: Unique identifier associated with the draweeId. 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: 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/DraweeListResponse' 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' 404: description:
errorresourceNotFoundEmpty resource/resource not found
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' post: summary: Add Drawee description: Allows customer to add drawee for inbound transfer. 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: AddDraweeRequest in: body required: true schema: $ref: '#/definitions/AddDraweeRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/AddDraweeResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidBankBank is invalid
errortransactionDeniedTransaction Denied
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/drawees/confirmation: post: summary: Confirm Add Drawee description: Confirms the add drawee setup. It should be called after successful creation of add drawee. 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: AddDraweeConfirmationRequest in: body required: true schema: $ref: '#/definitions/AddDraweeConfirmationRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/AddDraweeConfirmationResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidControlFlowIdControl Flow Id is invalid
errorinvalidBankBank 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
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/moneyMovement/drawees/{draweeId}: delete: summary: Delete Drawee description: Allows customer to delete drawee details associated with a drawee 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: draweeId in: path description: Unique identifier associated with the drawee. 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. 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidDraweeIdDrawee Id 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/cards/sourceAccounts: get: summary: Retrieve Card Payment Source Account description: Returns all valid source accounts for credit card payments. Sources can be personal accounts or existing drawees. 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: 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/CardPaymentsSrcAcctEligibilityResponse' 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/cardPayments/preprocess: post: summary: Create Card Payment description: Creates a new credit card payment 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: 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: CardPaymentPreprocessRequest in: body required: true schema: $ref: '#/definitions/CardPaymentPreprocessRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/CardPaymentPreprocessResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidSourceAccountSource account is invalid
errorinvalidCardCard 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
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/cardPayments: post: summary: Confirm Card Payment description: Confirms the credit card payment. It should be called after successfully creating a credit card payment. 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: CardPaymentsRequest in: body required: true schema: $ref: '#/definitions/CardPaymentsRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/CardPaymentsResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidDraweeDrawee is invalid
errorinvalidCardCard is invalid
errorinvalidAccountCombinationInvalid source and destination account combination
errorinvalidTransactionAmountTransaction amount is invalid
errorpreprocessFxRateExpiredPre-process forex rate is expired
errortransactionAmountBelowMinimumTransaction amount below minimum amount
errortransactionAmountExceedsMaximumAllowed transaction amount limit for this transaction exceeded
errortransactionDeniedTransaction Denied
errorinsufficientFundInsufficient fund
errortransactionPendingReviewTransaction pending under review
errortempServiceSuspensionDueToNaturalCalamityTemporary service suspension due to natural calamities
errordailyTransactionAmountLimitReachedMaximum daily transaction amount limit reached
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
errorotpAuthorizationRequired
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/moneyMovement/cardPayments/preprocess/adhoc: post: summary: Create Ad Hoc Card Payment description: Creates a new ad hoc credit card payment. 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: AdhocCardPaymentPreprocessRequest in: body required: true schema: $ref: '#/definitions/AdhocCardPaymentPreprocessRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/AdhocCardPaymentPreprocessResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidDestinationAccountDestination account is invalid
errorinvalidTransactionAmountTransaction amount 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' definitions: 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 DraweeListResponse: properties: draweeList: type: array items: $ref: '#/definitions/Drawee' 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: - draweeList Drawee: properties: draweeId: description: Unique identifier associated with the drawee. type: string example: 097640000000000000000000000000023702XX0000015 draweeName: description: Name of the drawee. type: string example: Matt William displayDraweeAccountNumber: description: A masked account number that can be displayed to the customer type: string example: XXXXXX2391 draweeCurrencyCode: description: The currency code of the drawee account in ISO 4217 format type: string example: AUD draweeStatus: description: The drawee status. This is a reference data field. Please use /v1/utilities/referenceData/{draweeStatus} resource to get valid value of this field with description. type: string example: ACTIVE required: - draweeId - displayDraweeAccountNumber - draweeCurrencyCode CardPaymentPreprocessRequest: 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/apac/v1/apac/utilities/referenceData/{transferCurrencyIndicator} resource to get valid value of this field with description. You can use transferCurrencyIndicator as referenceCode parameter to retrieve the values. type: string example: SOURCE_ACCOUNT_CURRENCY destinationAccountId: description: This is the account reference to the card being paid to type: string example: 724f5141524b4d58576853766c786a45376e7637576e6d35695378515a726f494c36367763776775432f453d draweeId: description: Unique identifier associated with the drawee used for payment. type: string example: 824f5141524b4d58576853766c786a45376e7637576e6d35695378515a726f494c36367763776775432f453d chargeBearer: description: Field to identify charge bearer.The payment type.This is a reference data field. Please use /v1/apac/v1/apac/utilities/referenceData/{chargeBearer} resource to get valid value of this field with description. You can use chargeBearer as referenceCode parameter to retrieve the values. type: string example: BENEFICIARY 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. This is a reference data field.This is a reference data field. Please use /v1/apac/utilities/referenceData/{transferPurpose} resource to get valid value of this field with description. type: string example: CASH_DISBURSEMENT paymentSource: type: string description: Source of the payment. This is a reference data. Please use /v1/apac/utilities/referenceData/{paymentSource} resource to get valid value of this field. example: INTERNAL paymentScheduleType: type: string description: The payment schedule type. Recurring payment is not supported. This is a reference data. Please use /v1/apac/utilities/referenceData/{paymentScheduleType} resource to get valid value of this field. example: IMMEDIATE futureDatedTransaction: $ref: '#/definitions/FutureDatedTransaction' required: - transactionAmount - transferCurrencyIndicator - destinationAccountId - chargeBearer CardPaymentPreprocessResponse: properties: controlFlowId: description: Control flow Id type: string example: "12345678" debitDetails: $ref: '#/definitions/DebitDetailsCardPaymentPreproces' creditDetails: $ref: '#/definitions/CreditDetailsCardPaymentPreproces' 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 DebitDetailsCardPaymentPreproces: 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: SGD CreditDetailsCardPaymentPreproces: properties: transactionCreditAmount: description: The transaction credit amount. type: number format: double example: 7000.250000 currencyCode: description: The currency code for the credit amount in ISO 4217 format type: string example: USD CardPaymentsSrcAcctEligibilityResponse: properties: draweeSourceAccounts: type: array items: $ref: '#/definitions/DraweeSourceAccount' personalSourceAccounts: type: array items: $ref: '#/definitions/PersonalSourceAccount' cardDetails: type: array items: $ref: '#/definitions/CardDetails' required: - draweeSourceAccounts - personalSourceAccounts PersonalSourceAccount: properties: accountId: description: The account id in encrypted format. This is the account reference to the card being paid to and should be passed as destinationAccountId in the payment preprocess API type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d displayAccountNumber: description: A masked account number that can be displayed to the customer type: string example: XXXXXX2364 currencyCode: 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/apac/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 nextPaymentAmount: description: The next payment amount due. type: number format: double 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: - accountId - displayAccountNumber - currencyCode - accountGroup DraweeSourceAccount: properties: draweeId: description: Unique identifier associated with the drawee. type: string example: 824f5141524b4d58576853766c786a45376e7637576e6d35695378515a726f494c36367763776775432f453d displayAccountNumber: description: A masked account number of the drawee account that can be displayed to the customer type: string example: XXXXXX2364 currencyCode: description: The currency code of the drawee account in ISO 4217 format type: string example: SGD accountNickName: description: Drawee account nick name type: string example: James bankDetails: $ref: '#/definitions/BankDetailsCardPayments' required: - draweeId - displayAccountNumber - currencyCode BankDetailsCardPayments: properties: bankName: description: Drawee Bank Name. type: string example: HSBC Bank required: - bankName CardDetails: properties: accountId: description: The account id in encrypted format. This is the account reference to the card being paid to and should be passed as destinationAccountId in the payment preprocess API type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d displayAccountNumber: description: A masked account number that can be displayed to the customer. type: string example: XXXXXXXXXXXX4521 currencyCode: description: The currency code of the statement in ISO 4217 format type: string example: SGD productName: description: The name of the product type: string example: Citibank Platinum Visa outstandingBalance: description: The amount of money owed. type: number format: double example: 10000.250000 lastStatementBalance: description: The balance on last statement date type: number format: double example: 15000.250000 lastStatementDate: type: string format: date description: The date of the last statement in ISO 8601 date format YYYY-MM-DD example: "2015-06-25" minimumDueAmount: type: number format: double description: Minimum due amount for a payment cycle example: 1500.250000 paymentDueDate: type: string format: date description: The date of the next payment/payment due date in ISO 8601 date format YYYY-MM-DD example: "2015-06-12" personalSourceAccountIds: type: array items: $ref: '#/definitions/PersonalSourceAccountId' draweeSourceAccountIds: type: array items: $ref: '#/definitions/DraweeSourceAccountId' required: - accountId - displayAccountNumber - currencyCode DraweeSourceAccountId: properties: draweeId: description: Unique identifier associated with the drawee used for payment. type: string example: 824f5141524b4d58576853766c786a45376e7637576e6d35695378515a726f494c36367763776775432f453d required: - draweeId PersonalSourceAccountId: properties: accountId: description: The personal source account identifier in encrypted format.Typically, this is not displayed to the customer,use displayAccountNumber instead. type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d required: - accountId CardPaymentsRequest: properties: controlFlowId: description: Control flow Id type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d required: - controlFlowId CardPaymentsResponse: properties: transactionReferenceId: description: The unique transaction reference Id used to identify this transaction from all the other transactions type: string example: HBKFT160129X001373 paymentStatus: type: string description: Source of the payment. This is a reference data. Please use /v1/apac/utilities/referenceData/{paymentStatus} resource to get valid value of this field. example: PAYMENT_INITIATED debitDetails: $ref: '#/definitions/DebitDetailsCardPayments' creditDetails: $ref: '#/definitions/CreditDetailsCardPayments' required: - transactionReferenceId DebitDetailsCardPayments: properties: displayAccountNumber: type: string description: The masked source account number that can be displayed to the customer. example: XXXXXX2391 transactionDebitAmount: description: The transaction debit amount. type: number format: double example: 10000.250000 currencyCode: description: The currency code for the debit amount in ISO 4217 format type: string example: SGD debitDate: description: The date on which funds for card payment or transfer are debited from the source account in ISO 8601 date format YYYY-MM-DD. type: string format: date example: "2017-12-30" availableBalance: type: number format: double description: The amount available to withdraw or transfer immediately after the card payment. example: 15000.250000 CreditDetailsCardPayments: properties: displayAccountNumber: type: string description: The masked destination account number that can be displayed to the customer. example: XXXXXX4692 transactionCreditAmount: description: The transaction credit amount. type: number format: double example: 7000.250000 creditDate: description: The date on which funds from an card payment or transfer are made available to the destination account in ISO 8601 date format YYYY-MM-DD. type: string format: date example: "2017-12-31" availableBalance: description: The available balance of the destination account. type: number format: double example: 15000.250000 currencyCode: description: The currency code for the credit amount in ISO 4217 format. type: string example: USD AddDraweeConfirmationRequest: properties: controlFlowId: description: Control Flow Id type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d required: - controlFlowId AddDraweeConfirmationResponse: properties: draweeId: description: Unique identifier associated with the drawee. type: string example: 097640000000000000000000000000023702XX0000015 draweeStatus: description: The drawee status. This is a reference data field. Please use /v1/utilities/referenceData/{draweeStatus} resource to get valid value of this field with description. type: string example: ACTIVE required: - draweeId - draweeStatus AddDraweeRequest: properties: draweeName: description: Name of the drawee. type: string example: Matt William draweeAccountNumber: description: Account Number of the drawee type: string example: "251212582364" draweeAccountType: description: Type of the drawee's account. This is a reference data field. Please use /v1/apac/utilities/referenceData/{draweeAccountType} resource to get valid value of this field with description. type: string example: CHECKING_ACCOUNT draweeBankName: description: Bank name of the drawee. type: string example: HSBC Bank draweeBankCode: description: The bank code of the external drawee account. type: string example: "44525101" draweeCurrencyCode: description: The currency code of the drawee account in ISO 4217 format type: string example: AUD draweeNotes: description: Free text that usually describes purpose of payment. type: string example: Family maintenance required: - draweeAccountNumber - draweeBankName - draweeBankCode - draweeAccountType - draweeName - draweeNotes - draweeCurrencyCode AddDraweeResponse: properties: draweeId: description: Unique identifier associated with the drawee. type: string example: 097640000000000000000000000000023702XX0000015 draweeStatus: description: The drawee status. This is a reference data field. Please use /v1/utilities/referenceData/{draweeStatus} resource to get valid value of this field with description. type: string example: ACTIVE required: - draweeId AdhocCardPaymentPreprocessRequest: properties: 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/apac/v1/apac/utilities/referenceData/{transferCurrencyIndicator} resource to get valid value of this field with description. type: string example: SOURCE_ACCOUNT_CURRENCY accountId: description: This is the destination account identifier in encrypted format.Typically, this is not displayed to the customer. type: string example: 724f5141524b4d58576853766c786a45376e7637576e6d35695378515a726f494c36367763776775432f453d sourceAccountBankDetails: $ref: '#/definitions/SourceAccountBankDetails' required: - transactionAmount - transferCurrencyIndicator - accountId SourceAccountBankDetails: properties: accountNumber: description: Source account number. type: string example: "251212582364" accountHolderName: description: Name of the party that has been directed by the depositor to pay a certain sum of money to the person presenting the check or draft. type: string example: Mark Smith bankName: description: Bank name of the source account. type: string example: Westpac Banking Corporation bankCode: description: Bank code of the source account. type: string example: 33088 required: - bankName - accountNumber - bankCode - accountHolderName AdhocCardPaymentPreprocessResponse: properties: controlFlowId: description: Control flow Id type: string example: "12345678" debitDetails: $ref: '#/definitions/DebitDetails' creditDetails: $ref: '#/definitions/CreditDetails' required: - controlFlowId AutoDebitSetupAdhocConfirmationRequest: properties: controlFlowId: description: It is used to control the flow for subsequent requests in the session. type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d required: - controlFlowId AutoDebitSetupAdhocRequest: properties: sourceAccountHolderName: description: Name of the source account. type: string example: Matt William sourceAccountType: description: Type of the source account. This is a reference data field. Please use /v1/utilities/referenceData/{sourceAccountType} resource to get valid value of this field with description. type: string example: CHECKING_ACCOUNT sourceAccountNumber: description: Account number of the source. type: string example: "251212582364" sourceAccountBankName: description: Bank name of the source. type: string example: HSBC Bank sourceAccountBankCode: description: The bank code of the external source account. type: string example: "44525101" amountPaymentOption: type: string description: This is the type of amount to be paid. This is a reference data field. Please use /v1/utilities/referenceData/{amountPaymentOption} resource to get valid value of this field with description. example: MINIMUM_DUE_AMOUNT remarks: description: Free text that usually describes purpose of payment. type: string example: Family maintenance required: - sourceAccountBankName - sourceAccountBankCode - amountPaymentOption - sourceAccountHolderName - sourceAccountType - sourceAccountNumber AutoDebitUpdateConfirmationRequest: properties: controlFlowId: description: It is used to control the flow for subsequent requests in the session. type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d required: - controlFlowId AutoDebitSetupConfirmationRequest: properties: controlFlowId: description: It is used to control the flow for subsequent requests in the session. type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d required: - controlFlowId AutoDebitUpdateRequest: properties: amountPaymentOption: type: string description: This is the type of amount to be paid. This is a reference data field. Please use /v1/utilities/referenceData/{amountPaymentOption} resource to get valid value of this field with description. example: MINIMUM_DUE_AMOUNT required: - amountPaymentOption AutoDebitDetailsResponse: properties: sourceAccountDetails: $ref: '#/definitions/SourceAccountDetails' amountPaymentOption: type: string description: This is the type of amount to be paid. This is a reference data field. Please use /v1/utilities/referenceData/{amountPaymentOption} resource to get valid value of this field with description. example: MINIMUM_DUE_AMOUNT required: - sourceAccountDetails - amountPaymentOption BankDetailsAutoDebit: properties: bankName: description: Bank name of the source account. type: string example: HSBC Bank bankCode: description: The bank code of the source account. type: string example: "44525101" required: - bankCode SourceAccountDetails: properties: sourceAccountHolderName: description: Name of the source account. type: string example: Matt William sourceAccountId: description: The account identifier of the source account in encrypted format. It can be an existing or non-existing drawee or external account. type: string example: 724f5141524b4d58576853766c786a45376e7637576e6d35695378515a726f494c36367763776775432f453d displaySourceAccountNumber: description: The display account number of the source account type: string example: XXXXXX4085 sourceAccountCurrencyCode: description: The currency code of the source account in ISO 4217 format type: string example: SGD sourceAccountType: description: Type of the account. This is a reference data field. Please use /v1/apac/utilities/referenceData/{sourceAccountType} resource to get valid value of this field with description. type: string example: CHECKING_ACCOUNT bankDetails: $ref: '#/definitions/BankDetailsAutoDebit' required: - sourceAccountId - displaySourceAccountNumber - sourceAccountType - sourceAccountHolderName - sourceAccountCurrencyCode AutoDebitSetupRequest: properties: draweeId: description: Unique identifier associated with the drawee. type: string example: 824f5141524b4d58576853766c786a45376e7637576e6d35695378515a726f494c36367763776775432f453d amountPaymentOption: type: string description: This is the type of amount to be paid. This is a reference data field. Please use /v1/utilities/referenceData/{amountPaymentOption} resource to get valid value of this field with description. example: MINIMUM_DUE_AMOUNT required: - amountPaymentOption - draweeId 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 PreprocessForFundTransferResponse: properties: controlFlowId: description: Control flow Id type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d debitDetails: $ref: '#/definitions/DebitDetails' creditDetails: $ref: '#/definitions/CreditDetails' foreignExchangeRate: format: double description: Exchange rate type: number example: 1.546100 transactionFee: format: double description: Transaction fee type: number example: 25.250000 feeCurrencyCode: description: Fee currency code in ISO 4217 format. type: string example: USD required: - controlFlowId - debitDetails - creditDetails 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/apac/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 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/apac/utilities/referenceData/{paymentType} resource to get valid value of this field with description. You can use paymentType as the referenceCode parameter to retrieve the values. 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 sourceAccountIds: type: array items: $ref: '#/definitions/SourceAccountIds' required: - payeeAccountCurrencyCode - payeeNickName - paymentMethods - payeeId - sourceAccountIds BillPaymentsPreprocessResponse: properties: controlFlowId: description: It is used to control the flow for subsequent requests in the session. type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d debitDetails: $ref: '#/definitions/DebitDetails' creditDetails: $ref: '#/definitions/CreditDetails' foreignExchangeRate: format: double description: Exchange rate. type: number example: 1 feeCurrencyCode: description: Fee currency code in ISO 4217 format. type: string example: AUD transactionFee: format: double description: Transaction fee. type: number example: 25.250000 merchantName: description: Name of the merchant. Applicable only for Australia. type: string example: Telstra 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 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/apac/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 CreditDetails: properties: transactionCreditAmount: format: double description: The transaction credit amount. type: number example: 10000.250000 currencyCode: description: The currency code for the credit amount in ISO 4217 format. type: string example: AUD required: - transactionCreditAmount - currencyCode 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 PreprocessFundTransferRequest: properties: sourceAccountId: description: The source account identifier in encrypted format. Typically, this is not displayed to the customer. type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d transactionAmount: format: double description: The transaction amount type: number 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/apac/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 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/apac/utilities/referenceData/{chargeBearer} resource to get valid value of this field with description. You can use chargeBearer as the referenceCode parameter to retrieve the values. 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/apac/utilities/referenceData/{paymentMethod} resource to get valid value of this field with description. You can use paymentMethod as the referenceCode parameter to retrieve the values. 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/apac/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 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" 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/apac/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: The nick name of the account assigned by the customer type: string example: James required: - sourceAccountId - displaySourceAccountNumber - sourceAccountCurrencyCode - accountGroup 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/apac/v1/apac/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 DebitDetails: properties: transactionDebitAmount: format: double description: The transaction debit amount. type: number example: 10000.250000 currencyCode: description: The currency code for the debit amount in ISO 4217 format. type: string example: AUD required: - transactionDebitAmount - currencyCode 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 institutionsk code type: string example: "101" bankName: description: Payee account bank name type: string example: HSBC Bank required: - bankCode - bankName SourceAccountIds: 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. type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d required: - sourceAccountId 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 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" sourceAccountIds: type: array items: $ref: '#/definitions/SourceAccountIds' required: - payeeId - displayPayeeAccountNumber - payeeAccountCurrencyCode - payeeNickName - sourceAccountIds BillPaymentsRequest: properties: controlFlowId: description: Control Flow Id type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d required: - controlFlowId 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/apac/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 BillPaymentsPreprocessRequest: properties: sourceAccountId: description: The source account identifier in encrypted format. Typically, this is not displayed to the customer. type: string example: 29a3eb92-5195-42fa-9817-ccf2617f4888 transactionAmount: format: double description: The transaction amount type: number example: 10000.250000 transactionCurrencyCode: description: The transaction currency code in ISO 4217 format. type: string example: AUD merchantId: description: Unique identifier for the merchant. type: string example: 14e3eb92-2475-11er-8217-aar4568T1199 customerMerchantReferenceId: description: Denotes the unique reference identifier which customer has for a particular merchant. type: string example: 10000025142 remarks: description: Bill payment notes. Free text from screen. type: string required: - sourceAccountId - transactionAmount - merchantId - transactionCurrencyCode - customerMerchantReferenceId ErrorResponse: properties: 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 type: description: Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again type: string enum: - error - warn - invalid - fatal moreInfo: description: URI to human readable documentation of the error type: object required: - type - code 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: format: double description: The amount available to withdraw or transfer immediately. type: number example: 50000.250000 nextPaymentAmount: format: double description: The next payment amount due. type: number example: 4500.250000 outstandingBalance: format: double description: Previous balance amount. type: number example: 4500.250000 minimumDueAmount: format: double description: Minimum due amount for a payment cycle. type: number example: 500.250000 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' 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/apac/utilities/referenceData/{paymentMethod} resource to get valid value of this field with description. You can use paymentMethod as the referenceCode parameter to retrieve the values. type: string example: GIRO required: - paymentMethod 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 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/apac/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/apac/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" required: - payeeId - payeeName - payeeNickname - paymentType - displayAccountNumber - accountId - payeeStatus x-ibm-endpoints: - endpointUrl: https://sandbox.apihub.citi.com/gcb description: Custom Gateway API Endpoint type: - production - development ...