REST API for Oracle Fusion Cloud HCM

Manage Bank Accounts

An external bank account record holds the details of a given bank account. You must define an external bank account to make payments to a person through the electronic funds transfer. For more information on how to create a bank account for an employee, refer to the REST API for Oracle Financials Cloud guide.

Let's consider this scenario:

Rob wants to update his personal payment method with his new bank account details.

He does these tasks:

Using the payrollRelationships REST resource, retrieves his party number from the Oracle HCM cloud.
Using the externalBankAccounts REST resource, retrieves his new bank account details from Oracle Financials cloud.
Updates the personal payment method with the selected bank account on the HCM cloud.

Here's a graphic to help you understand this scenario.

Manage Bank Accounts

Rob updates his personal payment method on the Oracle HCM Cloud by submitting a PATCH operation on the payrollRelationship resource

Submit a PATCH request on the personalPaymentMethods resource.
Verify the details returned in the response.

Example URL

Use this resource URL format.

PATCH

https://<hostname>:<portno>/hcmRestApi/resources/11.13.18.05/personalPaymentMethods/<Generated Personal Payment Method Id>

Example Response

Here's an example of the response body in JSON format.

{
  "PersonalPaymentMethodId": 300100181650103,
  "Name": "My EFT Payment Method",
  "EffectiveStartDate": "2010-10-12",
  "EffectiveEndDate": "4712-12-31",
  "OrgPaymentMethodId": 300100005800591,
  "BankAccountId": 95808,
  "PaymentAmountType": "P",
  "Amount": null,
  "Percentage": 100,
  "Priority": 10,
  "PayrollRelationshipId": 300100006014818,
  "PartyId": 300100006001613,
  "PersonNumber": "300100006014805",
  "links": []
}