I am developing for the

market, looking for the

API Documentation.

Home

>

API Products

>

Australia - Money Movement API Documentation

Money Movement

Summary

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.

The Money Movement API uses the authorization_code grant type, for authorization details CLICK HERE

Want to try this API out on our Playground?

Go play now
Endpoints on this page
get /v1/moneyMovement/payees/sourceAccounts Retrieve dest src acct
get /v1/moneyMovement/payees Retrieve payee list
get /v1/moneyMovement/personalDomesticTransfers/destinationAccounts/sourceAccounts Retrieve dest src acct personal
post /v1/moneyMovement/personalDomesticTransfers/preprocess Create personal transfer
post /v1/moneyMovement/personalDomesticTransfers Confirm personal transfer
get /v1/moneyMovement/internalDomesticTransfers/payees/sourceAccounts Retrieve dest src acct internal
post /v1/moneyMovement/internalDomesticTransfers/preprocess Create internal transfer
post /v1/moneyMovement/internalDomesticTransfers Confirm internal transfer
get /v1/moneyMovement/externalDomesticTransfers/payees/sourceAccounts Retrieve dest src acct external
post /v1/moneyMovement/externalDomesticTransfer/preprocess Create external transfer
post /v1/moneyMovement/externalDomesticTransfers Confirm external transfer
get /v1/moneyMovement/billPayments/payees/sourceAccounts Retrieve dest src acct bill pay
post /v1/moneyMovement/billPayments/preprocess Create bill payment
post /v1/moneyMovement/billPayments/preprocess/adhoc Create adhoc bill payment
post /v1/moneyMovement/billPayments Confirm bill payment
post /v1/moneyMovement/accounts/{accountId}/autoDebit/adhoc Create Ad Hoc Auto Debit
post /v1/moneyMovement/accounts/{accountId}/autoDebit/adhoc/confirmation Confirm Ad Hoc Auto Debit
get /v1/moneyMovement/accounts/{accountId}/autoDebit Auto Debit Details
post /v1/moneyMovement/accounts/{accountId}/autoDebit Auto Debit Setup
put /v1/moneyMovement/accounts/{accountId}/autoDebit Auto Debit Update
delete /v1/moneyMovement/accounts/{accountId}/autoDebit Delete Auto Debit
post /v1/moneyMovement/accounts/{accountId}/autoDebit/confirmation Confirm Auto Debit
put /v1/moneyMovement/accounts/{accountId}/autoDebit/confirmation Confirm Auto Debit Update
get /v1/moneyMovement/drawees Drawee List
post /v1/moneyMovement/drawees Add Drawee
post /v1/moneyMovement/drawees/confirmation Confirm Add Drawee
delete /v1/moneyMovement/drawees/{draweeId} Delete Drawee
get /v1/moneyMovement/cards/sourceAccounts Retrieve Card Payment Source Account
post /v1/moneyMovement/cardPayments/preprocess Create Card Payment
post /v1/moneyMovement/cardPayments Confirm Card Payment
post /v1/moneyMovement/cardPayments/preprocess/adhoc Create Ad Hoc Card Payment

Retrieve dest src acct

get /v1/moneyMovement/payees/sourceAccounts
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.

Header Parameters
Authorization
string required
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==
uuid
string required
128 bit random UUID generated uniquely for every request.
Accept
string required
Content-Type that are acceptable for the response.
client_id
string required
Client ID generated during application registration.
Query Parameters
paymentType
string Optional
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.
nextStartIndex
string Optional
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.
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

Successful operation.
Definitions
  • sourceAccounts
      • sourceAccountId
        • 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
      • displaySourceAccountNumber
        • A masked account number that can be displayed to the customer
        • type : string
      • sourceAccountCurrencyCode
        • The currency code of the source account in ISO 4217 format
        • type : string
      • accountGroup
        • 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
      • availableBalance
        • format : double
        • The available balance including any pending or in progress deposits and withdrawals
        • type : number
      • nextPaymentAmount
        • format : double
        • The next payment amount due.
        • type : number
      • productName
        • The name of the product
        • type : string
      • accountNickName
        • The nick name of the account assigned by the customer
        • type : string
  • payeeSourceAccountCombinations
      • payeeId
        • Unique identifier associated with the payee. Typically, this is not displayed to the customer.
        • type : string
      • displayPayeeAccountNumber
        • The display account number of the destination account
        • type : string
      • payeeAccountCurrencyCode
        • The currency code of the payee account in ISO 4217 format
        • type : string
      • payeeNickName
        • Payee account nick name
        • type : string
      • bankDetails
        • properties : Array
      • paymentType
        • 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
      • paymentMethods
        • properties : Array
      • merchantNumber
        • Unique identifier associated with the merchant. Applicable only for Australia.
        • type : string
      • payeeName
        • Name of the payee. Applicable only for Australia.
        • type : string
      • sourceAccountIds
        • properties : Array
  • destinationSourceAcctCombinations
      • destinationAccountId
        • The destination account identifier in encrypted format. Typically, this is not displayed to the customer.
        • type : string
      • displayDestinationAccountNumber
        • A masked account number that can be displayed to the customer
        • type : string
      • destinationAccountCurrencyCode
        • The currency code of the payee account in ISO 4217 format
        • type : string
      • productName
        • The name of the product
        • type : string
      • availableBalance
        • format : double
        • The amount available to withdraw or transfer immediately.
        • type : number
      • nextPaymentAmount
        • format : double
        • The next payment amount due.
        • type : number
      • outstandingBalance
        • format : double
        • Previous balance amount.
        • type : number
      • minimumDueAmount
        • format : double
        • Minimum due amount for a payment cycle.
        • type : number
      • lastStatementDate
        • format : date
        • The date of the last statement in ISO 8601 date format YYYY-MM-DD.
        • type : string
      • paymentDueDate
        • format : date
        • The payment due date in ISO 8601 date format YYYY-MM-DD.
        • type : string
      • sourceAccountIds
        • properties : Array
      • accountNickName
        • The nick name of the account assigned by the customer
        • type : string
  • nextStartIndex
    • 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 Response for get /v1/moneyMovement/payees/sourceAccounts
{
    "sourceAccounts": {
        "sourceAccountId": "724f5141524b4d58576853766c786a45376e7637576e6d35695378515a726f494c36367763776775432f453d",
        "displaySourceAccountNumber": "XXXXXX2364",
        "sourceAccountCurrencyCode": "SGD",
        "accountGroup": "SAVINGS_AND_INVESTMENTS",
        "availableBalance": 50000.25,
        "nextPaymentAmount": 4500.25,
        "productName": "Personal Checking Account",
        "accountNickName": "James"
    },
    "payeeSourceAccountCombinations": {
        "payeeId": "C$0003019202$AU$XX$01000540000001",
        "displayPayeeAccountNumber": "XXXXXX4085",
        "payeeAccountCurrencyCode": "SGD",
        "payeeNickName": "James",
        "bankDetails": {
            "bankCode": "101",
            "bankName": "HSBC Bank"
        },
        "paymentType": "GIRO",
        "paymentMethods": {
            "paymentMethod": "GIRO"
        },
        "merchantNumber": "10000025142",
        "payeeName": "Singtel",
        "sourceAccountIds": {
            "sourceAccountId": "3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d"
        }
    },
    "destinationSourceAcctCombinations": {
        "destinationAccountId": "824f5141524b4d58576853766c786a45376e7637576e6d35695378515a726f494c36367763776775432f453d",
        "displayDestinationAccountNumber": "XXXXXX2364",
        "destinationAccountCurrencyCode": "SGD",
        "productName": "Personal Checking Account",
        "availableBalance": 50000.25,
        "nextPaymentAmount": 4500.25,
        "outstandingBalance": 4500.25,
        "minimumDueAmount": 500.25,
        "lastStatementDate": "2016-10-03",
        "paymentDueDate": "2016-10-05",
        "sourceAccountIds": {
            "sourceAccountId": "3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d"
        },
        "accountNickName": "James"
    },
    "nextStartIndex": "11"
}
400

TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : Array
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/moneyMovement/payees/sourceAccounts
{
    "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"
    ]
}
401

errorunAuthorizedAuthorization credential is missing or invalid
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : Array
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/moneyMovement/payees/sourceAccounts
{
    "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"
    ]
}
403

erroraccessNotConfiguredAccess is not configured for this resource
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : Array
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/moneyMovement/payees/sourceAccounts
{
    "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"
    ]
}
404

errorresourceNotFoundEmpty resource/resource not found
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : Array
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/moneyMovement/payees/sourceAccounts
{
    "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"
    ]
}
500

fatalserverUnavailableThe request failed due to an internal error
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : Array
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/moneyMovement/payees/sourceAccounts
{
    "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"
    ]
}

Retrieve payee list

get /v1/moneyMovement/payees
Description

Returns a list of payees (active and inactive) or destination accounts for the customer who authorized your app.

Header Parameters
Authorization
string required
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==
uuid
string required
128 bit random UUID generated uniquely for every request.
Accept
string required
Content-Type that are acceptable for the response.
client_id
string required
client id generated during consumer on-boarding
Query Parameters
paymentType
string Optional
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.
nextStartIndex
string Optional
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.
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

Successful operation.
Definitions
  • payeeList
      • payeeId
        • The unique Id of the payee. Typically,this is not displayed to the customer.
        • type : string
      • payeeName
        • The name of the payee
        • type : string
      • payeeNickname
        • The nickname of the payee
        • type : string
      • paymentType
        • 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
      • displayAccountNumber
        • A masked account number that can be displayed to the customer.
        • type : string
      • accountId
        • The account identifier of the payee in encrypted format. Typically, this is not displayed to the customer,use displayAccountNumber instead.
        • type : string
      • currencyCode
        • The currency code of the account in ISO 4217 format
        • type : string
      • paymentMethods
        • properties : Array
      • payeeStatus
        • 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
      • merchantNumber
        • Unique identifier associated with the merchant. Applicable only for Australia.
        • type : string
  • nextStartIndex
    • 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 Response for get /v1/moneyMovement/payees
{
    "payeeList": {
        "payeeId": "C$0003019202$AU$XX$01000540000001",
        "payeeName": "Singtel",
        "payeeNickname": "Singtel",
        "paymentType": "LOCAL_CITI",
        "displayAccountNumber": "XXXXXX2364",
        "accountId": "3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d",
        "currencyCode": "USD",
        "paymentMethods": {
            "paymentMethod": "GIRO"
        },
        "payeeStatus": "ACTIVE",
        "merchantNumber": "10000025142"
    },
    "nextStartIndex": "11"
}
400

TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : Array
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/moneyMovement/payees
{
    "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"
    ]
}
401

errorunAuthorizedAuthorization credentials are missing or invalid
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : Array
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/moneyMovement/payees
{
    "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"
    ]
}
403

erroraccessNotConfiguredAccess is not configured for this resource
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : Array
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/moneyMovement/payees
{
    "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"
    ]
}
404

errorresourceNotFoundEmpty resource/resource not found
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : Array
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/moneyMovement/payees
{
    "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"
    ]
}
500

fatalserverUnavailableThe request failed due to an internal error
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : Array
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/moneyMovement/payees
{
    "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"
    ]
}

Retrieve dest src acct personal

get /v1/moneyMovement/personalDomesticTransfers/destinationAccounts/sourceAccounts
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.

Header Parameters
Authorization
string required
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==
uuid
string required
128 bit random UUID generated uniquely for every request.
Accept
string required
Content-Type that are acceptable for the response.
client_id
string required
Client ID generated during application registration.
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

Successful operation.
Definitions
  • sourceAccounts
      • sourceAccountId
        • The source account ID in encrypted format. Typically, this is not displayed to the customer,use displayAccountNumber instead.
        • type : string
      • displaySourceAccountNumber
        • A masked account number that can be displayed to the customer.
        • type : string
      • sourceAccountCurrencyCode
        • The currency code of the source account in ISO 4217 format
        • type : string
      • accountGroup
        • 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
      • availableBalance
        • format : double
        • The available balance including any pending or in progress deposits and withdrawals
        • type : number
      • nextPaymentAmount
        • format : double
        • The next payment amount due.
        • type : number
      • productName
        • The name of the product
        • type : string
      • accountNickName
        • Nick name of the source account.
        • type : string
  • destinationSourceAcctCombinations
      • destinationAccountId
        • The destination account identifier in encrypted format. Typically, this is not displayed to the customer,use displayDestinationAccountNumber instead.
        • type : string
      • displayDestinationAccountNumber
        • A masked account number that can be displayed to the customer
        • type : string
      • destinationAccountCurrencyCode
        • The currency code of the payee account in ISO 4217 format
        • type : string
      • availableBalance
        • format : double
        • The amount available to withdraw or transfer immediately.
        • type : number
      • nextPaymentAmount
        • format : double
        • The next payment amount due.
        • type : number
      • outstandingBalance
        • format : double
        • Previous balance amount.
        • type : number
      • minimumDueAmount
        • format : double
        • Minimum due amount for a payment cycle.
        • type : number
      • lastStatementDate
        • format : date
        • The date of the last statement in ISO 8601 date format YYYY-MM-DD.
        • type : string
      • paymentDueDate
        • format : date
        • The payment due date in ISO 8601 date format YYYY-MM-DD.
        • type : string
      • sourceAccountIds
        • properties : Array
      • productName
        • The name of the product. This is for destination account
        • type : string
      • accountNickName
        • Nick name of the destination account
        • type : string
Example Response for get /v1/moneyMovement/personalDomesticTransfers/destinationAccounts/sourceAccounts
{
    "sourceAccounts": {
        "sourceAccountId": "3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d",
        "displaySourceAccountNumber": "XXXXXX2364",
        "sourceAccountCurrencyCode": "SGD",
        "accountGroup": "SAVINGS_AND_INVESTMENTS",
        "availableBalance": 50000.25,
        "nextPaymentAmount": 4500.25,
        "productName": "Personal Checking Account",
        "accountNickName": "James"
    },
    "destinationSourceAcctCombinations": {
        "destinationAccountId": "724f5141524b4d58576853766c786a45376e7637576e6d35695378515a726f494c36367763776775432f453d",
        "displayDestinationAccountNumber": "XXXXXX4085",
        "destinationAccountCurrencyCode": "SGD",
        "availableBalance": "50000.25",
        "nextPaymentAmount": "4500.25",
        "outstandingBalance": "4500.25",
        "minimumDueAmount": "500.25",
        "lastStatementDate": "2016-10-03",
        "paymentDueDate": "2016-10-05",
        "sourceAccountIds": {
            "sourceAccountId": "3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d"
        },
        "productName": "Personal Checking Account",
        "accountNickName": "James"
    }
}
400

TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : Array
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/moneyMovement/personalDomesticTransfers/destinationAccounts/sourceAccounts
{
    "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"
    ]
}
401

errorunAuthorizedAuthorization credential is missing or invalid
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : Array
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/moneyMovement/personalDomesticTransfers/destinationAccounts/sourceAccounts
{
    "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"
    ]
}
403

erroraccessNotConfiguredAccess is not configured for this resource
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : Array
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/moneyMovement/personalDomesticTransfers/destinationAccounts/sourceAccounts
{
    "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"
    ]
}
404

errorresourceNotFoundEmpty resource/resource not found
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : Array
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/moneyMovement/personalDomesticTransfers/destinationAccounts/sourceAccounts
{
    "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"
    ]
}
500

fatalserverUnavailableThe request failed due to an internal error
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : Array
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/moneyMovement/personalDomesticTransfers/destinationAccounts/sourceAccounts
{
    "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"
    ]
}

Create personal transfer

post /v1/moneyMovement/personalDomesticTransfers/preprocess
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.

Header Parameters
Authorization
string required
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==
uuid
string required
128 bit random UUID generated uniquely for every request.
Accept
string required
Content-Type that are acceptable for the response.
client_id
string required
Client ID generated during application registration.
Content-Type
string required
application/json
Body Parameters
PreprocessFundTransferRequest
required
Show schema
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

Successful operation.
Definitions
  • controlFlowId
    • Control flow Id
    • type : string
  • debitDetails
      • transactionDebitAmount
        • format : double
        • The transaction debit amount.
        • type : number
      • currencyCode
        • The currency code for the debit amount in ISO 4217 format.
        • type : string
  • creditDetails
      • transactionCreditAmount
        • format : double
        • The transaction credit amount.
        • type : number
      • currencyCode
        • The currency code for the credit amount in ISO 4217 format.
        • type : string
  • foreignExchangeRate
    • format : double
    • Exchange rate
    • type : number
  • transactionFee
    • format : double
    • Transaction fee
    • type : number
  • feeCurrencyCode
    • Fee currency code in ISO 4217 format.
    • type : string
Example Response for post /v1/moneyMovement/personalDomesticTransfers/preprocess
{
    "controlFlowId": "6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d",
    "debitDetails": {
        "transactionDebitAmount": 10000.25,
        "currencyCode": "AUD"
    },
    "creditDetails": {
        "transactionCreditAmount": 10000.25,
        "currencyCode": "AUD"
    },
    "foreignExchangeRate": 1.5461,
    "transactionFee": 25.25,
    "feeCurrencyCode": "USD"
}
400

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
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : Array
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for post /v1/moneyMovement/personalDomesticTransfers/preprocess
{
    "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"
    ]
}
401

errorunAuthorizedAuthorization credential is missing or invalid
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : Array
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for post /v1/moneyMovement/personalDomesticTransfers/preprocess
{
    "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"
    ]
}
403

erroraccessNotConfiguredAccess is not configured for this resource
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : Array
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for post /v1/moneyMovement/personalDomesticTransfers/preprocess
{
    "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"
    ]
}
500

fatalserverUnavailableThe request failed due to an internal error
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : Array
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for post /v1/moneyMovement/personalDomesticTransfers/preprocess
{
    "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"
    ]
}

Confirm personal transfer

post /v1/moneyMovement/personalDomesticTransfers
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.

Header Parameters
Authorization
string required
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==
uuid
string required
128 bit random UUID generated uniquely for every request.
Accept
string required
Content-Type that are acceptable for the response.
client_id
string required
Client ID generated during application registration.
Content-Type
string required
application/json
Body Parameters
PersonalDomesticTransferRequest
required
Show schema
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

Successful operation.
Definitions
  • sourceAccount
      • displaySourceAccountNumber
        • The display account number of the source account.
        • type : string
      • sourceAccountAvailableBalance
        • format : double
        • This is the amount after external domestic transfer completion.
        • type : number
      • sourceCurrencyCode
        • Currency code of the source account in ISO 4217 format.
        • type : string
  • destinationAccount
      • displayDestinationAccountNumber
        • A masked destination account number that can be displayed to the customer.
        • type : string
      • destinationAccountAvailableBalance
        • format : double
        • Available balance amount in destination account
        • type : number
      • destinationCurrencyCode
        • Currency code of the destination account in ISO 4217 format.
        • type : string
  • transactionReferenceId
    • The unique transaction reference Id used to identify this transaction from all the other transactions
    • type : string
Example Response for post /v1/moneyMovement/personalDomesticTransfers
{
    "sourceAccount": {
        "displaySourceAccountNumber": "XXXXXX2364",
        "sourceAccountAvailableBalance": 50000.25,
        "sourceCurrencyCode": "USD"
    },
    "destinationAccount": {
        "displayDestinationAccountNumber": "XXXXXX4085",
        "destinationAccountAvailableBalance": 2500,
        "destinationCurrencyCode": "SGD"
    },
    "transactionReferenceId": "HBKFT160129X001373"
}
400

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
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : Array
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for post /v1/moneyMovement/personalDomesticTransfers
{
    "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"
    ]
}
401

TypeCodeDetails
errorunAuthorizedAuthorization credential is missing or invalid
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : Array
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for post /v1/moneyMovement/personalDomesticTransfers
{
    "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"
    ]
}
403

erroraccessNotConfiguredAccess is not configured for this resource
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : Array
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for post /v1/moneyMovement/personalDomesticTransfers
{
    "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"
    ]
}
500

TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error
Definitions
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • type : string
    • enum : Array
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for post /v1/moneyMovement/personalDomesticTransfers
{
    "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"
    ]
}

Retrieve dest src acct internal

get /v1/moneyMovement/internalDomesticTransfers/payees/sourceAccounts
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.

Header Parameters
Authorization
string required
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==
uuid
string required
128 bit random UUID generated uniquely for every request.
Accept
string required
Content-Type that are acceptable for the response.
client_id
string required
Client ID generated during application registration.
Query Parameters
nextStartIndex
string Optional
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.
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

Successful operation.
Definitions
  • sourceAccounts
      • sourceAccountId
        • The source account identifier in encrypted format. Typically, this is not displayed to the customer,use displayAccountNumber instead.
        • type : string
      • displaySourceAccountNumber
        • A masked account number that can be displayed to the customer
        • type : string
      • sourceAccountCurrencyCode
        • The currency code of the source account in ISO 4217 format
        • type : string
      • accountGroup
        • 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.