I am developing for the

market, looking for the

API Documentation.

Home

>

API Products

>

United Kingdom - Money Movement API Documentation

Money Movement

Summary

The Money Movement API allow you to move money from Citi customers account. Transfers can be made to predefined payees by customer and individuals not included in the payee list

The segment of API will allow to perform below category of transfers:

Personal Transfer- Allowing customer to initiate the money transfers within customer’s own Citi accounts.

Internal transfer- Allowing customer to initiate the money transfer from customer Citi own accounts to other Citi accounts locally.

External transfer- Allowing customer to initiate the money transfer from customer Citi own accounts to other bank accounts locally.

Bill Payment- Allowing customer to initiate the bill payment from customer Citi own accounts to billing organization.

Citi Global Transfer- Allowing customer to initiate the money transfer from customer Citi own accounts to other Citi bank accounts across various Countries.

SEPA Transfer- Allowing customer to initiate money transfer to other European bank accounts within the SEPA territory.

Cross border transfer- Allowing customer to initiate money transfer from customer own account to cross border bank accounts.

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 destination source account
get /v1/moneyMovement/payees Retrieve payee list
get /v1/moneyMovement/payees/{payeeId} Retrieve payee details
get /v1/moneyMovement/personalDomesticTransfers/destinationAccounts/sourceAccounts Retrieve destination source account - personal transfers
post /v1/moneyMovement/personalDomesticTransfers/preprocess Create personal transfer
post /v1/moneyMovement/personalDomesticTransfers Confirm personal transfer
get /v1/moneyMovement/internalDomesticTransfers/payees/sourceAccounts Retrieve destination source account - internal transfers
post /v1/moneyMovement/internalDomesticTransfers/preprocess Create internal transfer
post /v1/moneyMovement/internalDomesticTransfers Confirm internal transfer
post /v1/moneyMovement/internalDomesticTransfers/preprocess/adhoc Create adhoc internal transfer
get /v1/moneyMovement/externalDomesticTransfers/payees/sourceAccounts Retrieve destination source account - external transfers
post /v1/moneyMovement/externalDomesticTransfer/preprocess Create external transfer
post /v1/moneyMovement/externalDomesticTransfers Confirm external transfer
post /v1/moneyMovement/externalDomesticTransfers/preprocess/adhoc Create adhoc external transfer
get /v1/moneyMovement/billPayments/payees/sourceAccounts Retrieve destination source account bill pay
post /v1/moneyMovement/billPayments/preprocess Create bill payment
post /v1/moneyMovement/billPayments Confirm bill payment
post /v1/moneyMovement/billPayments/preprocess/adhoc Create adhoc bill payment
get /v1/moneyMovement/billPayments/merchants Merchant List
get /v1/moneyMovement/billPayments/merchants/{merchantNumber} Merchant Details
get /v1/moneyMovement/citiGlobalTransfers/payees/sourceAccounts Retrieve destination source account Citi global transfer
post /v1/moneyMovement/citiGlobalTransfers/preprocess Create Citi global transfer
post /v1/moneyMovement/citiGlobalTransfers Confirm Citi global transfer
post /v1/moneyMovement/citiGlobalTransfers/preprocess/adhoc Create adhoc Citi global transfer
get /v1/moneyMovement/crossBorderWireTransfers/payees/sourceAccounts Retrieve destination source account cross border transfer
post /v1/moneyMovement/crossBorderWireTransfers/preprocess Create cross border transfer
post /v1/moneyMovement/crossBorderWireTransfers Confirm cross border transfer
post /v1/moneyMovement/crossBorderWireTransfers/preprocess/adhoc Create adhoc cross border transfer
get /v1/emea/moneyMovement/sepaTransfers/payees/sourceAccounts Retrieve destination source account SEPA
post /v1/emea/moneyMovement/sepaTransfers/preprocess Create SEPA transfer
post /v1/moneyMovement/sepaTransfers Confirm SEPA transfer
post /v1/emea/moneyMovement/sepaTransfers/preprocess/adhoc Create adhoc SEPA transfer

Retrieve destination source account

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/utilities/referenceData/{paymentType} resource to get valid value of this field with description.
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/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
        • The available balance including any pending or in progress deposits and withdrawals
        • type : number
        • format : double
      • nextPaymentAmount
        • The next payment amount due.
        • type : number
        • format : double
      • 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/utilities/referenceData/{paymentType} resource to get valid value of this field with description.
        • 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
      • payeeAddress
        • properties : Array
      • 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
        • The amount available to withdraw or transfer immediately.
        • type : number
        • format : double
      • nextPaymentAmount
        • The next payment amount due.
        • type : number
        • format : double
      • outstandingBalance
        • Previous balance amount.
        • type : number
        • format : double
      • minimumDueAmount
        • Minimum due amount for a payment cycle.
        • type : number
        • format : double
      • lastStatementDate
        • The date of the last statement in ISO 8601 date format YYYY-MM-DD.
        • type : string
        • format : date
      • paymentDueDate
        • The payment due date in ISO 8601 date format YYYY-MM-DD.
        • type : string
        • format : date
      • 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",
        "payeeAddress": {
            "addressLine1": "40A Orchard Road",
            "addressLine2": "#99-99 Macdonald House",
            "addressLine3": "Singapore-510121",
            "countryName": "SINGAPORE"
        },
        "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
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : Array
    • type : string
  • 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
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/moneyMovement/payees/sourceAccounts
{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
401

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

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

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

Retrieve payee list

get /v1/moneyMovement/payees
Description

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

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/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/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/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
      • billTypeCode
        • Bill Type Code is the sub category for the Merchant. Bill Payment Transaction can be uniquely identified by the combination of the merchant number & billTypeCode
        • type : string
  • 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",
        "billTypeCode": "1"
    },
    "nextStartIndex": "11"
}
400

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

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

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

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

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

Retrieve payee details

get /v1/moneyMovement/payees/{payeeId}
Description

Returns the complete payee details associated with a payee id.

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.
Path Parameters
payeeId
string required
Unique identifier associated with the payee.
  • 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
  • internalDomesticPayee
      • payeeType
        • Identifies the type of payee based on the destination of the payee.This is a reference data field. Please use /v1/utilities/referenceData/{payeeType} resource to get valid value of this field with description.
        • type : string
      • payeeStatus
        • The payee status. This is a reference data field. Please use /v1/utilities/referenceData/{payeeStatus} resource to get valid value of this field with description.
        • type : string
      • currencyCode
        • The currency code of the payee account in ISO 4217 format
        • type : string
      • payeeName
        • Name of the payee.
        • type : string
      • payeeNickName
        • The nick name of the payee assigned by the customer.
        • type : string
      • paymentPriority
        • Priority to the payment used to identify urgency. This is a reference data field. Please use /v1/utilities/referenceData/{paymentPriority} resource to get valid value of this field with description.
        • type : string
      • payeeNotes
        • Free text that usually describes purpose of payment.
        • type : string
      • displayAccountNumber
        • A masked account number that can be displayed to the customer.
        • type : string
      • accountId
        • type : string
        • The account identifier of the payee in encrypted format.
      • displayCardNumber
        • A masked card number that can be displayed to the customer.
        • type : string
      • cardId
        • The card id in encrypted format
        • type : string
  • externalDomesticPayee
      • payeeType
        • Identifies the type of payee based on the destination of the payee.This is a reference data field. Please use /v1/utilities/referenceData/{payeeType} resource to get valid value of this field with description.
        • type : string
      • payeeStatus
        • The payee status. This is a reference data field. Please use /v1/utilities/referenceData/{payeeStatus} resource to get valid value of this field with description.
        • type : string
      • currencyCode
        • The currency code of the payee account in ISO 4217 format
        • type : string
      • payeeName
        • Name of the payee.
        • type : string
      • payeeNickName
        • The nick name of the payee assigned by the customer.
        • type : string
      • paymentPriority
        • Priority to the payment used to identify urgency. This is a reference data field. Please use /v1/utilities/referenceData/{paymentPriority} resource to get valid value of this field with description.
        • type : string
      • payeeNotes
        • Free text that usually describes purpose of payment.
        • type : string
      • displayAccountNumber
        • A masked account number that can be displayed to the customer.
        • type : string
      • accountId
        • type : string
        • The account identifier of the payee in encrypted format.
      • beneficiaryBankName
        • Name of the bank.
        • type : string
      • beneficiaryBankCode
        • The bank code of the external payee account.
        • type : string
      • utilityBillPaymentIndicator
        • Indicator to identify if the transfer is Utility Bill Payment. Applicable only for Russia. This is a reference data field. Please use /v1/utilities/referenceData/{utilityBillPaymentIndicator} resource to get valid value of this field with description.
        • type : string
      • beneficiaryIndividualTaxNumber
        • Indicator to identify if the transfer is Utility Bill Payment. Applicable only for Russia.
        • type : string
      • beneficiaryTaxRegistrationCode
        • Beneficiary tax registration code assigned by Russia government.
        • type : string
      • taxDeclarationype
        • The type of tax declaration filed by an individual
        • type : string
      • taxYear
        • Year of the tax payment.
        • type : string
      • taxPeriod
        • The period of the tax payment.
        • type : string
      • idType
        • Type of Identification document. This is a reference data field. Please use /v1/utilities/referenceData/{idType} resource to get valid values of this field with descriptions
        • type : string
      • idNumber
        • Unique identifier of identification document.
        • type : string
  • billPaymentPayee
      • payeeType
        • Identifies the type of payee based on the destination of the payee.This is a reference data field. Please use /v1/utilities/referenceData/{payeeType} resource to get valid value of this field with description.
        • type : string
      • payeeStatus
        • The payee status. This is a reference data field. Please use /v1/utilities/referenceData/{payeeStatus} resource to get valid value of this field with description.
        • type : string
      • currencyCode
        • The currency code of the payee account in ISO 4217 format
        • type : string
      • payeeNickName
        • The nick name of the payee assigned by the customer.
        • type : string
      • paymentPriority
        • Priority to the payment used to identify urgency. This is a reference data field. Please use /v1/utilities/referenceData/{paymentPriority} resource to get valid value of this field with description.
        • type : string
      • payeeNotes
        • Free text that usually describes purpose of payment.
        • type : string
      • merchantName
        • The name of the merchant.
        • type : string
      • merchantNameLocal
        • The name of the merchant in local language.
        • type : string
      • merchantNumber
        • A string that uniquely identifies a merchant.
        • type : string
      • merchantInformation
        • properties : Array
  • ibbsPayee
      • payeeType
        • Identifies the type of payee based on the destination of the payee.This is a reference data field. Please use /v1/utilities/referenceData/{payeeType} resource to get valid value of this field with description.
        • type : string
      • payeeStatus
        • The payee status. This is a reference data field. Please use /v1/utilities/referenceData/{payeeStatus} resource to get valid value of this field with description.
        • type : string
      • currencyCode
        • The currency code of the payee account in ISO 4217 format
        • type : string
      • payeeName
        • Name of the payee.
        • type : string
      • payeeNickName
        • The nick name of the payee assigned by the customer.
        • type : string
      • payeeNotes
        • Free text that usually describes purpose of payment.
        • type : string
      • paymentPriority
        • Priority to the payment used to identify urgency. This is a reference data field. Please use /v1/utilities/referenceData/{paymentPriority} resource to get valid value of this field with description.
        • type : string
      • displayAccountNumber
        • A masked account number that can be displayed to the customer.
        • type : string
      • accountId
        • type : string
        • The account identifier of the payee in encrypted format.
      • beneficiaryBankName
        • Name of the bank
        • type : string
      • beneficiaryBankCode
        • The bank code of the external payee account.
        • type : string
      • utilityBillPaymentIndicator
        • Indicator to identify if the transfer is Utility Bill Payment. Applicable only for Russia. This is a reference data field. Please use /v1/utilities/referenceData/{utilityBillPaymentIndicator} resource to get valid value of this field with description.
        • type : string
      • beneficiaryIndividualTaxNumber
        • Indicator to identify if the transfer is Utility Bill Payment. Applicable only for Russia.
        • type : string
      • beneficiaryTaxRegistrationCode
        • Beneficiary Tax registration code assigned by RU Government
        • type : string
  • citiGlobalTransferpayee
      • payeeName
        • Name of the payee.
        • type : string
      • payeeNickName
        • The nick name of the payee assigned by the customer.
        • type : string
      • payeeType
        • Identifies the type of payee based on the destination of the payee.This is a reference data field. Please use /v1/utilities/referenceData/{payeeType} resource to get valid value of this field with description.
        • type : string
      • payeeStatus
        • The payee status. This is a reference data field. Please use /v1/utilities/referenceData/{payeeStatus} resource to get valid value of this field with description.
        • type : string
      • currencyCode
        • The currency code of the payee account in ISO 4217 format
        • type : string
      • payeeCountryCode
        • ISO country code. This is a reference data field. Please use /v1/utilities/referenceData/{country} resource to get valid value of this field with description.
        • type : string
      • accountId
        • type : string
        • The payee account identifier in encrypted format.
      • displayAccountNumber
        • A masked account number that can be displayed to the customer.
        • type : string
      • payeeNotes
        • Free text that usually describes purpose of payment.
        • type : string
  • crossBorderWireTransfersPayee
      • payeeName
        • Name of the payee.
        • type : string
      • payeeNickName
        • The nick name of the payee assigned by the customer.
        • type : string
      • payeeType
        • Identifies the type of payee based on the destination of the payee.This is a reference data field. Please use /v1/utilities/referenceData/{payeeType} resource to get valid value of this field with description.
        • type : string
      • payeeStatus
        • The payee status. This is a reference data field. Please use /v1/utilities/referenceData/{payeeStatus} resource to get valid value of this field with description.
        • type : string
      • currencyCode
        • The currency code of the payee account in ISO 4217 format
        • type : string
      • payeeCountryCode
        • ISO country code. This is a reference data field. Please use /v1/utilities/referenceData/{country} resource to get valid value of this field with description.
        • type : string
      • accountId
        • type : string
        • The payee account identifier in encrypted format.
      • displayAccountNumber
        • A masked account number that can be displayed to the customer.
        • type : string
      • beneficiaryBankName
        • Name of the bank.
        • type : string
      • beneficiaryBankCode