Update a debit authorization
/fscmRestApi/resources/11.13.18.05/debitAuthorizations/{debitAuthorizationsUniqID}
Request
-
debitAuthorizationsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- EffectiveStartDate, EffectiveEndDate and DebitAuthorizationId ---for the Debit Authorizations resource and used to uniquely identify an instance of Debit Authorizations. The client should not generate the hash key value. Instead, the client should query on the Debit Authorizations collection resource with a filter on the primary key values in order to navigate to a specific instance of Debit Authorizations.
For example: debitAuthorizations?q=EffectiveStartDate=<value1>;EffectiveEndDate=<value2>;DebitAuthorizationId=<value3>
-
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.
- application/json
object
-
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: 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. -
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.
-
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.
array
Debit Authorization Versions
object
Response
- application/json
Default Response
-
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.
object
-
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.
array
Debit Authorization Versions
array
Links
object
-
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.
array
Links
object
-
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
- debitAuthorizationVersions
-
Parameters:
- debitAuthorizationsUniqID:
$request.path.debitAuthorizationsUniqID
The debit authorization version resource is used to view a debit authorization version. - debitAuthorizationsUniqID:
Examples
The following example shows how to retrieve and update a debit authorization.
Get all the debit authorizations and use the self URI of the specific a debit authorization. Then, submit a PATCH request on the REST resource using cURL.
Here's the cURL command to retrieve all the debit authorizations.
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/debitAuthorizations
Example Response Body
{
"items": [
{
"DebitAuthorizationReferenceNumber": "300100037459936",
"CustomerBankAccountNumber": "XXXXXX1156",
"BankName": "Bank of America",
"BankBranchName": "New York",
...
"links": [
{
"rel": "self",
"href": "servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/debitAuthorizations/00030000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800000167579D8400780000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800004EB9F6DD1400780000000EACED00057708000110F0841456B5",
"name": "debitAuthorizations",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "child",
"href": "servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/debitAuthorizations/00030000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800000167579D8400780000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800004EB9F6DD1400780000000EACED00057708000110F0841456B5/child/debitAuthorizationVersions",
"name": "debitAuthorizationVersions",
"kind": "collection"
},
...
]
},
...
],
"count": 25,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href": "servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/debitAuthorizations",
"name": "debitAuthorizations",
"kind": "collection"
}
]
}
A
hash key of EffectiveStartDate
, EffectiveEndDate
, and DebitAuthorizationId
identifies
a debit authorization.
Here's the cURL command that uses the hash key in the self URI to retrieve the debit authorization.
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/debitAuthorizations/00030000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800000167579D8400780000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800004EB9F6DD1400780000000EACED00057708000110F0841456B5
Here's the cURL command that uses the hash key in the self URI to update the debit authorization.
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/debitAuthorizations/00030000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800000167579D8400780000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800004EB9F6DD1400780000000EACED00057708000110F0841456B5
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "Frequency": "Daily", "AuthorizationMethod": "Phone" }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "DebitAuthorizationReferenceNumber": "900301", "CustomerBankAccountNumber": "XXXX6916", "Frequency": "Daily", "AuthorizationMethod": "Phone", ... { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/debitAuthorizations/00030000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800000167579D8400780000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800004EB9F6DD1400780000000EACED00057708000110F0841456B5", "name": "debitAuthorizations", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/debitAuthorizations/00030000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800000167579D8400780000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800004EB9F6DD1400780000000EACED00057708000110F0841456B5/child/debitAuthorizationVersions", "name": "debitAuthorizationVersions", "kind": "collection" }, ... ] }