Jump to

• Request
• Response
• Examples

Create a debit authorization

post

/fscmRestApi/resources/11.13.18.05/debitAuthorizations

Request

Header Parameters

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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

• AuthorizationMethod: string
  Title: Authorization Method

  Maximum Length: 255

  Method of delivering the debit authorization. Values include Digital Signature, Written Document, Phone, and Other.
• CancellationDate: string (date)
  Date when the debtor canceled the debit authorization.
• CreditorIdentificationNumber: string
  Maximum Length: 150

  Identification number of the creditor, as provided on the debit authorization document.
• CustomerBankAccountIdentifier(required): integer (int64)
  Title: Bank Account Number

  Identifier of a customer bank account.
• CustomerBankAccountNumber: string
  Maximum Length: 255

  Bank account number of a customer. For display purposes, the masked value is returned.
• CustomerPartyIdentifier(required): integer (int64)
  Title: Debtor Party Identifier

  Party identifier of the debtor.
• CustomerPartyName: string
  Title: Name

  Maximum Length: 360

  Party name of the debtor.
• CustomerPartyNumber: string
  Title: Registry ID

  Maximum Length: 30

  Party number of the debtor.
• DebitAuthorizationId: integer (int64)
  Title: Debit Authorization Identifier

  Identifier of a debit authorization.
• DebitAuthorizationReferenceNumber: string
  Maximum Length: 100

  Unique user-specified reference number of a debit authorization.
• debitAuthorizationVersions: array Debit Authorization Versions
  Title: Debit Authorization Versions

  The debit authorization version resource is used to view a debit authorization version.
• FinalCollectionDate: string (date)
  Date when the final collection of a direct debit was made, according to the debit authorization.
• Frequency: string
  Title: Frequency

  Maximum Length: 255

  Regularity with which direct debit instructions are created and processed.
• IBAN: string
  Maximum Length: 255

  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.
• LegalEntityIdentifier: integer (int64)
  Title: Legal Entity

  Identifier of a legal entity.
• LegalEntityName: string
  Title: Legal Entity

  Maximum Length: 240

  Name of the legal entity on the debit authorization.
• PrimaryIndicator: string
  Title: Primary

  Maximum Length: 1

  Default Value: N

  Indicates whether a debit authorization is primary.
• SigningDate: string (date)
  Date when the debtor signed the debit authorization.
• TransactionType: string
  Title: Transaction Type

  Maximum Length: 255

  Type of debit authorization, one-off or recurring.
• VersionNumber: integer (int32)
  Title: Version Number

  Default Value: 1

  Version number of the debit authorization. The version is set at 1 and increases with each new amendment.

{
    "required":[
        "CustomerBankAccountIdentifier",
        "CustomerPartyIdentifier"
    ],
    "type":"object",
    "properties":{
        "debitAuthorizationVersions":{
            "title":"Debit Authorization Versions",
            "type":"array",
            "description":"The debit authorization version resource is used to view a debit authorization version.",
            "items":{
                "$ref":"#/components/schemas/debitAuthorizations-debitAuthorizationVersions-item-post-request"
            }
        },
        "TransactionType":{
            "title":"Transaction Type",
            "maxLength":"255",
            "type":"string",
            "description":"Type of debit authorization, one-off or recurring.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LegalEntityIdentifier":{
            "title":"Legal Entity",
            "type":"integer",
            "description":"Identifier of a legal entity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CancellationDate":{
            "type":"string",
            "description":"Date when the debtor canceled the debit authorization.",
            "format":"date",
            "nullable":true
        },
        "IBAN":{
            "maxLength":"255",
            "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
        },
        "PrimaryIndicator":{
            "title":"Primary",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether a debit authorization is primary.",
            "nullable":true,
            "default":"N"
        },
        "CreditorIdentificationNumber":{
            "maxLength":"150",
            "type":"string",
            "description":"Identification number of the creditor, as provided on the debit authorization document.",
            "nullable":true
        },
        "AuthorizationMethod":{
            "title":"Authorization Method",
            "maxLength":"255",
            "type":"string",
            "description":"Method of delivering the debit authorization. Values include Digital Signature, Written Document, Phone, and Other.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FinalCollectionDate":{
            "type":"string",
            "description":"Date when the final collection of a direct debit was made, according to the debit authorization.",
            "format":"date",
            "nullable":true
        },
        "SigningDate":{
            "type":"string",
            "description":"Date when the debtor signed the debit authorization.",
            "format":"date",
            "nullable":true
        },
        "VersionNumber":{
            "title":"Version Number",
            "type":"integer",
            "description":"Version number of the debit authorization. The version is set at 1 and increases with each new amendment.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"6"
            }
        },
        "CustomerPartyIdentifier":{
            "title":"Debtor Party Identifier",
            "type":"integer",
            "description":"Party identifier of the debtor.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DebitAuthorizationId":{
            "title":"Debit Authorization Identifier",
            "type":"integer",
            "description":"Identifier of a debit authorization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CustomerBankAccountNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Bank account number of a customer. For display purposes, the masked value is returned.",
            "nullable":true
        },
        "CustomerPartyNumber":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"Party number of the debtor.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LegalEntityName":{
            "title":"Legal Entity",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the legal entity on the debit authorization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Frequency":{
            "title":"Frequency",
            "maxLength":"255",
            "type":"string",
            "description":"Regularity with which direct debit instructions are created and processed.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CustomerBankAccountIdentifier":{
            "title":"Bank Account Number",
            "type":"integer",
            "description":"Identifier of a customer bank account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CustomerPartyName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"Party name of the debtor.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DebitAuthorizationReferenceNumber":{
            "maxLength":"100",
            "type":"string",
            "description":"Unique user-specified reference number of a debit authorization.",
            "nullable":false
        }
    }
}

Nested Schema : Debit Authorization Versions

Type: array

Title: Debit Authorization Versions

The debit authorization version resource is used to view a debit authorization version.

Show Source

• Array of: object debitAuthorizations-debitAuthorizationVersions-item-post-request

{
    "title":"Debit Authorization Versions",
    "type":"array",
    "description":"The debit authorization version resource is used to view a debit authorization version.",
    "items":{
        "$ref":"#/components/schemas/debitAuthorizations-debitAuthorizationVersions-item-post-request"
    }
}

Nested Schema : debitAuthorizations-debitAuthorizationVersions-item-post-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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

Type: object

Show Source

• AuthorizationMethod: string
  Title: Authorization Method

  Maximum Length: 255

  Method of delivering the debit authorization. Values include Digital Signature, Written Document, Phone, and Other.
• BankAccountCountry: string
  Title: Country

  Read Only: true

  Maximum Length: 2

  Name of the country where a customer has a bank account.
• BankAccountCurrency: string
  Read Only: true

  Maximum Length: 15

  Currency of the customer's bank account.
• BankBranchName: string
  Read Only: true

  Maximum Length: 360

  Name of the bank branch where a customer has an account.
• BankName: string
  Read Only: true

  Maximum Length: 360

  Name of the bank where a customer has an account.
• BIC: string
  Read Only: true

  Maximum Length: 30

  Bank Identifier Code (BIC), which is the identifier code used by SWIFT to identify a 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.
• CancellationDate: string (date)
  Date when the debtor canceled the debit authorization.
• CreditorIdentificationNumber: string
  Maximum Length: 150

  Identification number of the creditor, as provided on the debit authorization document.
• CustomerBankAccountIdentifier: integer (int64)
  Title: Bank Account Number

  Identifier of a customer bank account.
• CustomerBankAccountNumber: string
  Maximum Length: 255

  Bank account number of a customer. For display purposes, the masked value is returned.
• CustomerPartyIdentifier: integer (int64)
  Title: Debtor Party Identifier

  Party identifier of the debtor.
• CustomerPartyName: string
  Title: Name

  Maximum Length: 360

  Party name of the debtor.
• CustomerPartyNumber: string
  Title: Registry ID

  Maximum Length: 30

  Party number of the debtor.
• DebitAuthorizationId: integer (int64)
  Title: Debit Authorization Identifier

  Identifier of a debit authorization.
• DebitAuthorizationReferenceNumber: string
  Maximum Length: 100

  Unique user-specified reference number of a debit authorization.
• debitAuthorizationVersions: array Debit Authorization Versions
  Title: Debit Authorization Versions

  The debit authorization version resource is used to view a debit authorization version.
• DirectDebitCount: integer (int64)
  Read Only: true

  Number of direct debit transactions attributed to a debit authorization.
• EffectiveEndDate: string (date)
  Read Only: true

  Date when the debit authorization ended.
• EffectiveStartDate: string (date)
  Read Only: true

  Date when the debit authorization started.
• FinalCollectionDate: string (date)
  Date when the final collection of a direct debit was made, according to the debit authorization.
• Frequency: string
  Title: Frequency

  Maximum Length: 255

  Regularity with which direct debit instructions are created and processed.
• IBAN: string
  Maximum Length: 255

  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.
• LegalEntityIdentifier: integer (int64)
  Title: Legal Entity

  Identifier of a legal entity.
• LegalEntityName: string
  Title: Legal Entity

  Maximum Length: 240

  Name of the legal entity on the debit authorization.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PrimaryIndicator: string
  Title: Primary

  Maximum Length: 1

  Default Value: N

  Indicates whether a debit authorization is primary.
• ReasonForAmendment: string
  Read Only: true

  Maximum Length: 255

  Reason for amending a debt authorization.
• SigningDate: string (date)
  Date when the debtor signed the debit authorization.
• Status: string
  Read Only: true

  Maximum Length: 255

  Indicates whether a debit authorization is active or inactive.
• TransactionType: string
  Title: Transaction Type

  Maximum Length: 255

  Type of debit authorization, one-off or recurring.
• VersionNumber: integer (int32)
  Title: Version Number

  Default Value: 1

  Version number of the debit authorization. The version is set at 1 and increases with each new amendment.

{
    "type":"object",
    "properties":{
        "BankName":{
            "maxLength":"360",
            "type":"string",
            "description":"Name of the bank where a customer has an account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionType":{
            "title":"Transaction Type",
            "maxLength":"255",
            "type":"string",
            "description":"Type of debit authorization, one-off or recurring.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SigningDate":{
            "type":"string",
            "description":"Date when the debtor signed the debit authorization.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerPartyIdentifier":{
            "title":"Debtor Party Identifier",
            "type":"integer",
            "description":"Party identifier of the debtor.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DebitAuthorizationId":{
            "title":"Debit Authorization Identifier",
            "type":"integer",
            "description":"Identifier of a debit authorization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CustomerBankAccountNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Bank account number of a customer. For display purposes, the masked value is returned.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerPartyNumber":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"Party number of the debtor.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LegalEntityName":{
            "title":"Legal Entity",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the legal entity on the debit authorization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BIC":{
            "maxLength":"30",
            "type":"string",
            "description":"Bank Identifier Code (BIC), which is the identifier code used by SWIFT to identify a 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,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":"255",
            "type":"string",
            "description":"Indicates whether a debit authorization is active or inactive.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "debitAuthorizationVersions":{
            "title":"Debit Authorization Versions",
            "type":"array",
            "description":"The debit authorization version resource is used to view a debit authorization version.",
            "items":{
                "$ref":"#/components/schemas/debitAuthorizations-debitAuthorizationVersions-item-response"
            }
        },
        "BankAccountCountry":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"Name of the country where a customer has a bank account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LegalEntityIdentifier":{
            "title":"Legal Entity",
            "type":"integer",
            "description":"Identifier of a legal entity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CancellationDate":{
            "type":"string",
            "description":"Date when the debtor canceled the debit authorization.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Date when the debit authorization ended.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IBAN":{
            "maxLength":"255",
            "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
        },
        "PrimaryIndicator":{
            "title":"Primary",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether a debit authorization is primary.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "CreditorIdentificationNumber":{
            "maxLength":"150",
            "type":"string",
            "description":"Identification number of the creditor, as provided on the debit authorization document.",
            "nullable":true,
            "x-queryable":true
        },
        "AuthorizationMethod":{
            "title":"Authorization Method",
            "maxLength":"255",
            "type":"string",
            "description":"Method of delivering the debit authorization. Values include Digital Signature, Written Document, Phone, and Other.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FinalCollectionDate":{
            "type":"string",
            "description":"Date when the final collection of a direct debit was made, according to the debit authorization.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "DirectDebitCount":{
            "type":"integer",
            "description":"Number of direct debit transactions attributed to a debit authorization.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "VersionNumber":{
            "title":"Version Number",
            "type":"integer",
            "description":"Version number of the debit authorization. The version is set at 1 and increases with each new amendment.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"6"
            },
            "x-queryable":true
        },
        "BankAccountCurrency":{
            "maxLength":"15",
            "type":"string",
            "description":"Currency of the customer's bank account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReasonForAmendment":{
            "maxLength":"255",
            "type":"string",
            "description":"Reason for amending a debt authorization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Frequency":{
            "title":"Frequency",
            "maxLength":"255",
            "type":"string",
            "description":"Regularity with which direct debit instructions are created and processed.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BankBranchName":{
            "maxLength":"360",
            "type":"string",
            "description":"Name of the bank branch where a customer has an account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Date when the debit authorization started.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerBankAccountIdentifier":{
            "title":"Bank Account Number",
            "type":"integer",
            "description":"Identifier of a customer bank account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CustomerPartyName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"Party name of the debtor.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DebitAuthorizationReferenceNumber":{
            "maxLength":"100",
            "type":"string",
            "description":"Unique user-specified reference number of a debit authorization.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Debit Authorization Versions

Type: array

Title: Debit Authorization Versions

The debit authorization version resource is used to view a debit authorization version.

Show Source

• Array of: object debitAuthorizations-debitAuthorizationVersions-item-response

{
    "title":"Debit Authorization Versions",
    "type":"array",
    "description":"The debit authorization version resource is used to view a debit authorization version.",
    "items":{
        "$ref":"#/components/schemas/debitAuthorizations-debitAuthorizationVersions-item-response"
    }
}

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 : debitAuthorizations-debitAuthorizationVersions-item-response

Type: object

Show Source

• CreditorIdentificationNumber: string
  Read Only: true

  Maximum Length: 150

  Identification number of the creditor, as provided on the debit authorization version.
• CustomerBankAccountNumber: string
  Read Only: true

  Maximum Length: 100

  Bank account number of a customer. For display purposes, the masked value is returned.
• CutomerBankAccountIdentifier: integer (int64)
  Read Only: true

  Identifier of a customer bank account.
• DebitAuthorizationId: integer (int64)
  Read Only: true

  Identifier of a debit authorization version.
• DebitAuthorizationReferenceNumber: string
  Read Only: true

  Maximum Length: 100

  Unique user-specified reference number of a debit authorization version.
• DirectDebitCount: integer (int64)
  Read Only: true

  Number of direct debit transactions attributed to a debit authorization version.
• EffectiveEndDate: string (date)
  Read Only: true

  Date when the debit authorization version ended.
• EffectiveStartDate: string (date)
  Read Only: true

  Date when the debit authorization version started.
• IBAN: string
  Read Only: true

  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.
• LegalEntityName: string
  Title: Legal Entity Name

  Read Only: true

  Maximum Length: 240

  Name of the legal entity, as provided on the debit authorization version.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ReasonForAmendment: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Reason for amending a debt authorization version.
• VersionNumber: integer (int32)
  Read Only: true

  Version number of a debit authorization, which is set at 1 and increases with each new amendment.

{
    "type":"object",
    "properties":{
        "EffectiveEndDate":{
            "type":"string",
            "description":"Date when the debit authorization version ended.",
            "format":"date",
            "nullable":false,
            "readOnly":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,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditorIdentificationNumber":{
            "maxLength":"150",
            "type":"string",
            "description":"Identification number of the creditor, as provided on the debit authorization version.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CutomerBankAccountIdentifier":{
            "type":"integer",
            "description":"Identifier of a customer bank account.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DirectDebitCount":{
            "type":"integer",
            "description":"Number of direct debit transactions attributed to a debit authorization version.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "VersionNumber":{
            "type":"integer",
            "description":"Version number of a debit authorization, which is set at 1 and increases with each new amendment.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"6"
            },
            "x-queryable":true
        },
        "DebitAuthorizationId":{
            "type":"integer",
            "description":"Identifier of a debit authorization version.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReasonForAmendment":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Reason for amending a debt authorization version.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerBankAccountNumber":{
            "maxLength":"100",
            "type":"string",
            "description":"Bank account number of a customer. For display purposes, the masked value is returned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LegalEntityName":{
            "title":"Legal Entity Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the legal entity, as provided on the debit authorization version.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Date when the debit authorization version started.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DebitAuthorizationReferenceNumber":{
            "maxLength":"100",
            "type":"string",
            "description":"Unique user-specified reference number of a debit authorization version.",
            "nullable":false,
            "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."
        }
    }
}

Links

debitAuthorizationVersions

Operation: /fscmRestApi/resources/11.13.18.05/debitAuthorizations/{debitAuthorizationsUniqID}/child/debitAuthorizationVersions

Parameters:

• debitAuthorizationsUniqID: $request.path.debitAuthorizationsUniqID

The debit authorization version resource is used to view a debit authorization version.

Back to Top

Examples

The following example shows how to create a debit authorization by submitting a POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/debitAuthorizations

Example Request Payload

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

{
"DebitAuthorizationReferenceNumber": "900301",
"CustomerBankAccountIdentifier": 1302,
"SigningDate": "2018-09-01",
"FinalCollectionDate": "2018-09-30",
"TransactionType": "Recurring",
"Frequency": "Annual",
"AuthorizationMethod": "Other",
"CustomerPartyIdentifier": 300100017679826,
"LegalEntityIdentifier": 204
}

Example Response Body

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

{
    "DebitAuthorizationReferenceNumber": "900301",
    "SigningDate": "2018-09-01",
    "TransactionType": "Recurring",
    "Frequency": "Annual",
    "FinalCollectionDate": "2018-09-30",
    "AuthorizationMethod": "Other",
    "CustomerPartyIdentifier": 300100017679826,
    "CustomerBankAccountIdentifier": 1302,
    "LegalEntityIdentifier": 204,
    ...
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/debitAuthorizations/00030000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800000167579D8400780000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800004EB9F6DD1400780000000EACED00057708000110F0841456B5",
            "name": "debitAuthorizations",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/debitAuthorizations/00030000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800000167579D8400780000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800004EB9F6DD1400780000000EACED00057708000110F0841456B5/child/debitAuthorizationVersions",
            "name": "debitAuthorizationVersions",
            "kind": "collection"
        },
        ...
    ]
}

Back to Top