Manage Organization Payment Methods

When creating a personal payment method, you select the organization payment method. An organization payment method defines how payroll payments are disbursed, including internal bank accounts and payment type.

You can submit a GET request on the OrganizationPaymentMethodsLOV resource to view a list of all organization payment methods applicable for the payroll relationship.

Retrieve Organization Payment Methods

To retrieve all the organization payment methods:

1. Submit a GET request on the OrganizationPaymentMethodsLOV resource.

2. Verify the details returned in the response.

Example URL

Use this resource URL format.

GET

https://<hostname>:<portno>/hcmRestApi/resources/11.13.18.05/organizationPaymentMethodsLOV

Example Response

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

{
  "items": [
    {
      "BaseOrgPayMethodName": "ZHRX-AU-CDRM-LDG001-Cheque",
      "OrgPaymentMethodId": 300100031625185,
      "OrgPaymentMethodName": "ZHRX-AU-CDRM-LDG001-Cheque",
      "CurrencyCode": "AUD",
      "EffectiveEndDate": "4712-12-31",
      "EffectiveStartDate": "2000-01-01",
      "PaymentTypeName": "Check",
      "Category": "CH",
      "LegislationCode": "AU",
      "LegislativeDataGroupId": 300100001794627,
      "links": []
    },
    {
      "BaseOrgPayMethodName": "ZHRX-AU-CDRM-LDG001-Direct Deposit",
      "OrgPaymentMethodId": 300100031625188,
      "OrgPaymentMethodName": "ZHRX-AU-CDRM-LDG001-Direct Deposit",
      "CurrencyCode": "AUD",
      "EffectiveEndDate": "4712-12-31",
      "EffectiveStartDate": "2000-01-01",
      "PaymentTypeName": "EFT",
      "Category": "MT",
      "LegislationCode": "AU",
      "LegislativeDataGroupId": 300100001794627,
      "links": []
    },
    {
      "BaseOrgPayMethodName": "ZHRX-AU-LDG001-OPM1-Cheque",
      "OrgPaymentMethodId": 300100016881652,
      "OrgPaymentMethodName": "ZHRX-AU-LDG001-OPM1-Cheque",
      "CurrencyCode": "AUD",
      "EffectiveEndDate": "4712-12-31",
      "EffectiveStartDate": "2000-01-01",
      "PaymentTypeName": "Check",
      "Category": "CH",
      "LegislationCode": "AU",
      "LegislativeDataGroupId": 300100001794627,
      "links": []
    },
    {
      "BaseOrgPayMethodName": "ZHRX-AU-LDG001-OPM1-DirectDebit",
      "OrgPaymentMethodId": 300100016881657,
      "OrgPaymentMethodName": "ZHRX-AU-LDG001-OPM1-DirectDebit",
      "CurrencyCode": "AUD",
      "EffectiveEndDate": "4712-12-31",
      "EffectiveStartDate": "2010-01-01",
      "PaymentTypeName": "EFT",
      "Category": "MT",
      "LegislationCode": "AU",
      "LegislativeDataGroupId": 300100001794627,
      "links": []
    }
  ],
  "count": 4,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": []
}