Jump to

• Request
• Response

Create an intermediary bank account for an external bank account

post

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

Request

Path Parameters

• BankAccountId(required): integer(int64)
  Identifier of the external bank account.

Header Parameters

• Metadata-Context: string
  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".
• REST-Framework-Version: string
  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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• BankAccountId: integer (int64)
  External bank account identifier of the intermediary bank account
• BankAccountNumber: string
  Maximum Length: 100

  Account Number of the Intermediary bank account.
• BankBranchNumber: string
  Maximum Length: 30

  Bank branch number of the intermediary back where the intermediary account is held.
• BankCode: string
  Maximum Length: 30

  Bank code of the intermediary back where the intermediary account is held.
• BankName: string
  Maximum Length: 360

  Name of the bank for the intermediary account.
• BIC: string
  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.
• CheckDigits: string
  Maximum Length: 30

  Number added to the intermediary account number to verify its accuracy or validity when printed or transmitted.
• City: string
  Maximum Length: 60

  City where the intermediary bank account is held.
• Comments: string
  Maximum Length: 240

  Free-text comments associated with the intermediary bank account.
• CountryCode: string
  Maximum Length: 2

  Country code associated with the intermediary bank account.
• IBAN: string
  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.
• IntermediaryAccountId: integer (int64)
  Application-generated identifier for the intermediary account.
• InternalBankAccountId: integer (int64)
  Internal bank account identifier of the intermediary bank account

{
    "type":"object",
    "properties":{
        "BIC":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "BankAccountId":{
            "type":"integer",
            "description":"External bank account identifier of the intermediary bank account",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BankAccountNumber":{
            "maxLength":100,
            "type":"string",
            "description":"Account Number of the Intermediary bank account.",
            "nullable":true
        },
        "BankBranchNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Bank branch number of the intermediary back where the intermediary account is held.",
            "nullable":true
        },
        "BankCode":{
            "maxLength":30,
            "type":"string",
            "description":"Bank code of the intermediary back where the intermediary account is held.",
            "nullable":true
        },
        "BankName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the bank for the intermediary account.",
            "nullable":true
        },
        "CheckDigits":{
            "maxLength":30,
            "type":"string",
            "description":"Number added to the intermediary account number to verify its accuracy or validity when printed or transmitted.",
            "nullable":true
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"City where the intermediary bank account is held.",
            "nullable":true
        },
        "Comments":{
            "maxLength":240,
            "type":"string",
            "description":"Free-text comments associated with the intermediary bank account.",
            "nullable":true
        },
        "CountryCode":{
            "maxLength":2,
            "type":"string",
            "description":"Country code associated with the intermediary bank account.",
            "nullable":true
        },
        "IBAN":{
            "maxLength":50,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "IntermediaryAccountId":{
            "type":"integer",
            "description":"Application-generated identifier for the intermediary account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "InternalBankAccountId":{
            "type":"integer",
            "description":"Internal bank account identifier of the intermediary bank account",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  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".
• REST-Framework-Version:
  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-intermediaryBankAccounts-item-response

Type: object

Show Source

• BankAccountId: integer (int64)
  External bank account identifier of the intermediary bank account
• BankAccountNumber: string
  Maximum Length: 100

  Account Number of the Intermediary bank account.
• BankBranchNumber: string
  Maximum Length: 30

  Bank branch number of the intermediary back where the intermediary account is held.
• BankCode: string
  Maximum Length: 30

  Bank code of the intermediary back where the intermediary account is held.
• BankName: string
  Maximum Length: 360

  Name of the bank for the intermediary account.
• BIC: string
  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.
• CheckDigits: string
  Maximum Length: 30

  Number added to the intermediary account number to verify its accuracy or validity when printed or transmitted.
• City: string
  Maximum Length: 60

  City where the intermediary bank account is held.
• Comments: string
  Maximum Length: 240

  Free-text comments associated with the intermediary bank account.
• CountryCode: string
  Maximum Length: 2

  Country code associated with the intermediary bank account.
• IBAN: string
  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.
• IntermediaryAccountId: integer (int64)
  Application-generated identifier for the intermediary account.
• InternalBankAccountId: integer (int64)
  Internal bank account identifier of the intermediary bank account
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "BIC":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "BankAccountId":{
            "type":"integer",
            "description":"External bank account identifier of the intermediary bank account",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BankAccountNumber":{
            "maxLength":100,
            "type":"string",
            "description":"Account Number of the Intermediary bank account.",
            "nullable":true,
            "x-queryable":true
        },
        "BankBranchNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Bank branch number of the intermediary back where the intermediary account is held.",
            "nullable":true,
            "x-queryable":true
        },
        "BankCode":{
            "maxLength":30,
            "type":"string",
            "description":"Bank code of the intermediary back where the intermediary account is held.",
            "nullable":true,
            "x-queryable":true
        },
        "BankName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the bank for the intermediary account.",
            "nullable":true,
            "x-queryable":true
        },
        "CheckDigits":{
            "maxLength":30,
            "type":"string",
            "description":"Number added to the intermediary account number to verify its accuracy or validity when printed or transmitted.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"City where the intermediary bank account is held.",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "maxLength":240,
            "type":"string",
            "description":"Free-text comments associated with the intermediary bank account.",
            "nullable":true,
            "x-queryable":true
        },
        "CountryCode":{
            "maxLength":2,
            "type":"string",
            "description":"Country code associated with the intermediary bank account.",
            "nullable":true,
            "x-queryable":true
        },
        "IBAN":{
            "maxLength":50,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "IntermediaryAccountId":{
            "type":"integer",
            "description":"Application-generated identifier for the intermediary account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "InternalBankAccountId":{
            "type":"integer",
            "description":"Internal bank account identifier of the intermediary bank account",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top