Package Actions

Informational resource endpoint that returns the package actions possible and/or required for a certain Salesforce environment.

Package actions are additional actions that can be performed for a specific FinDock package, like a payment extension or source connector. These additional actions can be included in payment intent calls to the Payment API.

If package actions are available, please refer to the specific processor or source connector documentation for further information.

The Gift Aid package, for example, has package actions for declarations.

get/PackageActions

Get details of package-specific actions

This endpoint returns a list of unique actions that specific to a given source connector or payment extension.

Responses

Response examples

API was called successfully.

{
  "ResponseCode": "001",
  "IsSuccess": true,
  "PackageActions": [
    {
      "PackageName": "PaymentHub-GiftAid",
      "actions": [
        {
          "Parameters": [
            {
              "required": true,
              "name": "dateMade",
              "description": "Date made of the Gift Aid Declaration",
              "dataType": "Date"
            },
            {
              "name": "startDate",
              "description": "Start date of the Gift Aid Declaration",
              "dataType": "Date"
            },
            {
              "name": "endDate",
              "description": "End date of the Gift Aid Declaration",
              "dataType": "Date"
            },
            {
              "name": "confirmationDate",
              "description": "Confirmation Date of the Gift Aid Declaration",
              "dataType": "Date"
            },
            {
              "name": "acquisitionMethod",
              "description": "Acquisition Method",
              "dataType": "String"
            },
            {
              "name": "firstName",
              "description": "First Name",
              "dataType": "String"
            },
            {
              "name": "lastName",
              "description": "Last Name",
              "dataType": "String"
            },
            {
              "required": true,
              "name": "houseNameOrNumber",
              "description": "Housename or Number",
              "dataType": "String"
            },
            {
              "required": true,
              "name": "postalCode",
              "description": "Postal Code",
              "dataType": "String"
            },
            {
              "required": true,
              "name": "overseas",
              "description": "Overseas",
              "dataType": "Boolean"
            }
          ],
          "name": "CreateGiftAidDeclaration"
        },
        {
          "Parameters": [
            {
              "required": true,
              "name": "closeDate",
              "description": "Close date of the Gift Aid Declaration",
              "dataType": "Date"
            },
            {
              "name": "closeReason",
              "description": "Close Reason",
              "dataType": "String"
            },
            {
              "name": "comments",
              "description": "Comments",
              "dataType": "String"
            }
          ],
          "name": "CloseAllGiftAidDeclarations"
        }
      ]
    }
  ]
}

Was this page helpful?