Payment Methods

This is an informational resource endpoint that returns a list of all available payment processors and methods.

An org can have many method-processor combinations enabled. If there are multiple processors (PSPs) available for a payment method, one may be set to be the default processor for that method.

get/PaymentMethods

Get payment methods and processors

This endpoint returns a complete list of activated payment methods in the Salesforce org and the payment processors configured to process those methods.

Responses

Response examples

API was called successfully.

{
  "PaymentMethods": {
    "Name": "DirectDebit",
    "Processors": [
      {
        "Name": "PaymentHub-SEPA",
        "IsDefault": true,
        "Targets": [
          {
            "publicTarget": "PaymentHub-SEPA",
            "Name": "Main SEPA Account"
          },
          {
            "publicTarget": "PaymentHub-SEPA",
            "Name": "Region One SEPA Account"
          },
          {
            "publicTarget": "PaymentHub-SEPA",
            "Name": "Region Two SEPA Account"
          }
        ],
        "Parameters": {
          "Required": true,
          "Name": "iban",
          "Description": "The IBAN of the payer's bank account.",
          "DataType": "String",
          "Enum": {
            "svg": "https://external.findock.com/icon/payment-methods/sepadirectdebit.svg"
          }
        },
        "SupportsRecurring": true,
        "InitialPaymentOnRecurring": "unsupported",
        "RecurringRequiresInitialPayment": false
      }
    ]
  }
}

Was this page helpful?