Jump to

• Request
• Response

Create a bank account transfer

post

/fscmRestApi/resources/11.13.18.05/cashBankAccountTransfers

Request

Header Parameters

• 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.
• Upsert-Mode:
  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

• BankAccountTransferId: integer (int64)
  The unique identifier of the bank account transfer.
• Businessunit: string
  Maximum Length: 240

  The disbursement bank account's business unit.
• ConversionRate: number
  The conversion rate used to convert the payment amount to the disbursement account currency. The conversion rate is required when the source bank account currency is different from the bank transfer currency.
• ConversionRateType: string
  Maximum Length: 30

  The type of conversion rate used to convert the payment amount to the disbursement account currency.
• FromBankAccountName: string
  Maximum Length: 360

  The name of the disbursement bank account.
• IsSettledWithIbyFlag: boolean
  Maximum Length: 1

  Default Value: true

  Indicates whether a payment needs to be settled with Oracle Fusion Payments.
• Memo: string
  Maximum Length: 255

  Additional information about the bank account transfer.
• PaymentAmount: number
  The amount received by the receiving bank account.
• PaymentMethod: string
  Maximum Length: 100

  The payment method selected for the bank account transfer.
• PaymentProfileName: string
  Maximum Length: 100

  The name of the payment profile selected from Oracle Fusion Payments' table.
• Status: string
  Maximum Length: 80

  The status of the bank account transfer. Valid values are New, Validated, Invalid, Pending Approval, Approved, Rejected, Settlement in Process, Settled, and Failed.
• ToBankAccountName: string
  Maximum Length: 360

  The name of the receiving bank account.
• TransactionDate: string (date)
  The date when a transfer or payment was made.

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":"80",
            "type":"string",
            "description":"The status of the bank account transfer. Valid values are New, Validated, Invalid, Pending Approval, Approved, Rejected, Settlement in Process, Settled, and Failed.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "TransferStatus"
                ]
            }
        },
        "BankAccountTransferId":{
            "type":"integer",
            "description":"The unique identifier of the bank account transfer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "Businessunit":{
            "maxLength":"240",
            "type":"string",
            "description":"The disbursement bank account's business unit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BUName"
                ]
            }
        },
        "ToBankAccountName":{
            "maxLength":"360",
            "type":"string",
            "description":"The name of the receiving bank account.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "DestBankAccountName"
                ]
            }
        },
        "PaymentAmount":{
            "type":"number",
            "description":"The amount received by the receiving bank account.",
            "nullable":false
        },
        "FromBankAccountName":{
            "maxLength":"360",
            "type":"string",
            "description":"The name of the disbursement bank account.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceBankAccountName"
                ]
            }
        },
        "ConversionRateType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of conversion rate used to convert the payment amount to the disbursement account currency.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ExcRateType"
                ]
            }
        },
        "PaymentProfileName":{
            "maxLength":"100",
            "type":"string",
            "description":"The name of the payment profile selected from Oracle Fusion Payments' table.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PmtProfileName"
                ]
            }
        },
        "ConversionRate":{
            "type":"number",
            "description":"The conversion rate used to convert the payment amount to the disbursement account currency. The conversion rate is required when the source bank account currency is different from the bank transfer currency.",
            "nullable":true
        },
        "PaymentMethod":{
            "maxLength":"100",
            "type":"string",
            "description":"The payment method selected for the bank account transfer.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PmtMethod"
                ]
            }
        },
        "IsSettledWithIbyFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a payment needs to be settled with Oracle Fusion Payments.",
            "nullable":false,
            "default":true
        },
        "Memo":{
            "maxLength":"255",
            "type":"string",
            "description":"Additional information about the bank account transfer.",
            "nullable":true
        },
        "TransactionDate":{
            "type":"string",
            "description":"The date when a transfer or payment was made.",
            "format":"date",
            "nullable":false
        }
    }
}

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 : cashBankAccountTransfers-item-response

Type: object

Show Source

• BankAccountTransferId: integer (int64)
  The unique identifier of the bank account transfer.
• BankAccountTransferNumber: integer (int64)
  Read Only: true

  The unique number sequence assigned to the bank account transfer.
• Businessunit: string
  Maximum Length: 240

  The disbursement bank account's business unit.
• ConversionRate: number
  The conversion rate used to convert the payment amount to the disbursement account currency. The conversion rate is required when the source bank account currency is different from the bank transfer currency.
• ConversionRateType: string
  Maximum Length: 30

  The type of conversion rate used to convert the payment amount to the disbursement account currency.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the row for the bank account transfer.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the row for bank account transfer was created.
• FromAmount: number
  Read Only: true

  The amount paid by the disbursement bank account.
• FromBankAccountName: string
  Maximum Length: 360

  The name of the disbursement bank account.
• FromCurrencyCode: string
  Read Only: true

  Maximum Length: 15

  The currency code of the disbursement bank account.
• FromExternalTrxId: integer (int64)
  Read Only: true

  The unique identifier of the external transaction generated for the disbursement bank account.
• IsSettledWithIbyFlag: boolean
  Maximum Length: 1

  Default Value: true

  Indicates whether a payment needs to be settled with Oracle Fusion Payments.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the row for bank account transfer was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the bank account transfer row.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The session login of the last user who updated the bank account transfer row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Memo: string
  Maximum Length: 255

  Additional information about the bank account transfer.
• PaymentAmount: number
  The amount received by the receiving bank account.
• PaymentCurrencyCode: string
  Read Only: true

  Maximum Length: 15

  The payment currency code for the bank account transfer.
• PaymentFile: integer (int64)
  Title: Reference

  Read Only: true

  The unique identifier of the payment file.
• PaymentMethod: string
  Maximum Length: 100

  The payment method selected for the bank account transfer.
• PaymentProfileName: string
  Maximum Length: 100

  The name of the payment profile selected from Oracle Fusion Payments' table.
• PaymentRequestId: integer (int64)
  Read Only: true

  The unique identifier of the payment request.
• PaymentStatus: string
  Read Only: true

  Maximum Length: 255

  The status of the payment.
• Status: string
  Maximum Length: 80

  The status of the bank account transfer. Valid values are New, Validated, Invalid, Pending Approval, Approved, Rejected, Settlement in Process, Settled, and Failed.
• ToBankAccountName: string
  Maximum Length: 360

  The name of the receiving bank account.
• ToCurrencyCode: string
  Read Only: true

  Maximum Length: 15

  The currency code of the receiving bank account.
• ToExternalTrxId: integer (int64)
  Read Only: true

  The unique identifier of the external transaction generated for the receiving bank account.
• TransactionDate: string (date)
  The date when a transfer or payment was made.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the row for bank account transfer was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FromExternalTrxId":{
            "type":"integer",
            "description":"The unique identifier of the external transaction generated for the disbursement bank account.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PaymentRequestId":{
            "type":"integer",
            "description":"The unique identifier of the payment request.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "BankAccountTransferId":{
            "type":"integer",
            "description":"The unique identifier of the bank account transfer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ToBankAccountName":{
            "maxLength":"360",
            "type":"string",
            "description":"The name of the receiving bank account.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "DestBankAccountName"
                ]
            },
            "x-queryable":true
        },
        "PaymentAmount":{
            "type":"number",
            "description":"The amount received by the receiving bank account.",
            "nullable":false,
            "x-queryable":true
        },
        "ConversionRateType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of conversion rate used to convert the payment amount to the disbursement account currency.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ExcRateType"
                ]
            },
            "x-queryable":true
        },
        "PaymentFile":{
            "title":"Reference",
            "type":"integer",
            "description":"The unique identifier of the payment file.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PaymentProfileName":{
            "maxLength":"100",
            "type":"string",
            "description":"The name of the payment profile selected from Oracle Fusion Payments' table.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PmtProfileName"
                ]
            },
            "x-queryable":true
        },
        "FromAmount":{
            "type":"number",
            "description":"The amount paid by the disbursement bank account.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "FromAmountInternal"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ToCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The currency code of the receiving bank account.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "DestCurrencyCode"
                ]
            },
            "x-queryable":true
        },
        "PaymentStatus":{
            "maxLength":"255",
            "type":"string",
            "description":"The status of the payment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "PaymentInstructionStatus",
                    "PaymentServiceRequestStatus"
                ]
            },
            "x-queryable":true
        },
        "TransactionDate":{
            "type":"string",
            "description":"The date when a transfer or payment was made.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the bank account transfer row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":"80",
            "type":"string",
            "description":"The status of the bank account transfer. Valid values are New, Validated, Invalid, Pending Approval, Approved, Rejected, Settlement in Process, Settled, and Failed.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "TransferStatus"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row for the bank account transfer.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Businessunit":{
            "maxLength":"240",
            "type":"string",
            "description":"The disbursement bank account's business unit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BUName"
                ]
            },
            "x-queryable":true
        },
        "FromBankAccountName":{
            "maxLength":"360",
            "type":"string",
            "description":"The name of the disbursement bank account.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceBankAccountName"
                ]
            },
            "x-queryable":true
        },
        "PaymentCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The payment currency code for the bank account transfer.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "PaymentCurrencyCodeInternal"
                ]
            },
            "x-queryable":true
        },
        "FromCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The currency code of the disbursement bank account.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "FromCurrencyCodeInternal"
                ]
            },
            "x-queryable":true
        },
        "ConversionRate":{
            "type":"number",
            "description":"The conversion rate used to convert the payment amount to the disbursement account currency. The conversion rate is required when the source bank account currency is different from the bank transfer currency.",
            "nullable":true,
            "x-queryable":true
        },
        "BankAccountTransferNumber":{
            "type":"integer",
            "description":"The unique number sequence assigned to the bank account transfer.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "BankTransferNumberInternal"
                ]
            },
            "x-queryable":true
        },
        "PaymentMethod":{
            "maxLength":"100",
            "type":"string",
            "description":"The payment method selected for the bank account transfer.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PmtMethod"
                ]
            },
            "x-queryable":true
        },
        "IsSettledWithIbyFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a payment needs to be settled with Oracle Fusion Payments.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "ToExternalTrxId":{
            "type":"integer",
            "description":"The unique identifier of the external transaction generated for the receiving bank account.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Memo":{
            "maxLength":"255",
            "type":"string",
            "description":"Additional information about the bank account transfer.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row for bank account transfer was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The session login of the last user who updated the bank account transfer row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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