1. REST API for Oracle Fusion Cloud Financials
  2. Tasks
  3. External Bank Accounts

Get an external bank account

get

/fscmRestApi/resources/11.13.18.05/externalBankAccounts/{BankAccountId}

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : externalBankAccounts-item-response
Type: object
Show Source
  • Account Owners
    Title: Account Owners
    The account owners resource is used to view, create, and modify the account owner of an external bank account.
  • Maximum Length: 30
    Two or three digits added to the end of an external bank account number in some countries, such as New Zealand. This format allows customers to have a single account number with differing suffixes that represent different types of accounts.
  • Title: Account Type
    Maximum Length: 25
    Type of external bank account. Possible values are Savings and Checking.
  • Maximum Length: 30
    Agency location code of the external bank account.
  • Title: Allow international payments
    Maximum Length: 1
    Default Value: N
    Indicates whether the external bank account can be used for foreign payments or only for domestic payments.
  • Maximum Length: 320
    Alternate name of the external bank account.
  • Identifier of the external bank account.
  • Maximum Length: 80
    Name of the external bank account.
  • Maximum Length: 100
    Account number of the external bank account.
  • Title: Branch Identifier
    Identifier of the bank branch where the external bank account is present.
  • Title: Bank Branch Name
    Maximum Length: 360
    Name of the bank branch where the customer or supplier has an external bank account.
  • Title: Branch Number
    Maximum Length: 30
    Number of a bank branch. This is known as a routing transit number in the United States and a sort code in the United Kingdom.
  • Title: Bank Branch Party Indicator
    Maximum Length: 1
    Default Value: Y
    Indicates whether an external bank account is associated with any external bank and branch created in Trading Community Architecture (TCA). If the value is Yes or Null, external bank and branch information is stored in TCA and the external bank and branch identifiers are stored on the external bank account. If the value is No, external bank and branch attributes are stored on the external bank account.
  • Title: Bank Identifier
    Identifier of the bank where the external bank account is present.
  • Title: Bank Name
    Maximum Length: 360
    Name of the bank where the customer has an external bank account.
  • Title: Bank Number
    Maximum Length: 30
    Code or identifier issued to an external bank by a banking regulatory authority.
  • Title: BIC
    Maximum Length: 30
    Bank Identifier Code (BIC), which is the identifier code used by SWIFT to identify an external bank or bank branch. The BIC is a universal method of identifying financial institutions to facilitate the automated processing of telecommunication messages in banking and related financial environments.
  • Maximum Length: 30
    Number added to the external bank account number to derive a further number as a means of verifying the accuracy or validity of the external account number as it is printed or transmitted.
  • Title: Country Code
    Maximum Length: 2
    Country code of the external bank account.
  • Title: Currency
    Maximum Length: 15
    Currency code of the external bank account.
  • Date when the external bank account becomes inactive.
  • Maximum Length: 50
    International Bank Account Number (IBAN), which is an alphanumeric sequence that conforms to the ISO standard for uniquely identifying a bank account number internationally. The standard IBAN carries all the routing information needed to get a payment from one bank to another.
  • Purpose of the external bank account. The value is based on the payment function of the external payee or the external payer of the account owner. The following are the expected values: PAYABLES_DISB - Supplier, EMPLOYEE_EXP - Person, EMPLOYEE_EXP - Employee, AR_CUSTOMER_REFUNDS - Refund, CUSTOMER_PAYMENT - Customer, ONETIME_PAYMENT - Onetime, and ADHOC_PAYMENT - Adhoc.
  • Links
  • Party identifier of the external bank account owner.
  • Maximum Length: 255
    Indicates whether the external payee and instrument assignments should be created along with the bank account. Valid values are Y and N. For internal use only.
  • Person identifier when the account owner is an employee.
  • Maximum Length: 30
    Reference number of a secondary external bank account, such as the Building Society Roll Number used in the United Kingdom.
  • Title: Start Date
    Date when the external bank account becomes active.
  • Read Only: true
    Vendor identifier when the account owner party is a supplier.
Nested Schema : Account Owners
Type: array
Title: Account Owners
The account owners resource is used to view, create, and modify the account owner of an external bank account.
Show Source
Nested Schema : externalBankAccounts-accountOwners-item-response
Type: object
Show Source
Links
accountOwners
Parameters:
  • BankAccountId: $request.path.BankAccountId
The account owners resource is used to view, create, and modify the account owner of an external bank account.
Back to Top

Examples

The following example shows how to retrieve an external bank account by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/78

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "BankAccountNumber": "XXX3526",
    "CountryCode": "DE",
    "BankBranchIdentifier": 300579,
    "BankIdentifier": 299009,
    ...
    "links": [
        {
              "rel": "self",
              "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/78",
              "name": "externalBankAccounts",
              "kind": "item",
              "properties": {
                                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000C78"
                            }
        },
        {
              "rel": "child",
              "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/78/child/accountOwners",
              "name": "accountOwners",
              "kind": "collection"
        },
        ...
    ]
}
Back to Top