• Payment API

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.

The Package Actions object

PackageNamestring

The name of the source connector package for which the action is to be performed.

Example
"PaymentHub-GiftAid"
actionsobject

List of actions that can be performed.

get

Retrieve Package Actions.

Return a list of possible Package Actions for a specific Salesforce environment.

Responses

Response examples

API was called successfully.

{
  "ResponseCode": "001",
  "IsSuccess": true,
  "PackageActions": [
    {
      "PackageName": "PaymentHub-GiftAid",
      "actions": {
        "name": "CreateGiftAidDeclaration",
        "Parameters": [
          {
            "Required": true,
            "Name": "issuer",
            "Description": "The issuer of the card or online banking account. Used to skip processor selection page for iDEAL payments.",
            "DataType": "String",
            "Enum": [
              {
                "value": "abnamro",
                "label": "ABN AMRO",
                "image": "https://external.findock.com/icons/payment-methods/ideal/abnamro.svg"
              }
            ]
          }
        ]
      }
    }
  ]
}

Was this page helpful?