Payment Methods

Informational resource endpoint that returns a list of all available payment methods and the processors that have those payment methods enabled.

A single org can have many method-processor combinations enabled. If there are multiple Payment Service Providers (PSPs) for a payment method, one can be set as the default processor for that method.

The Payment Method object

Namestring

The name of the payment method, e.g. Direct Debit, CreditCard or Ideal.

Example: "Direct Debit"

Processorsarray

Which payment processors can be used to perform payments with this payment method.

get/PaymentMethods

Retrieve Payment Methods

Return a list of payment methods configured in the Salesforce environment and related Payment Processors.

Responses

Response examples

API was called successfully.

{
  "PaymentMethods": {
    "Name": "Direct Debit",
    "Processors": [
      {
        "SupportsRecurring": true,
        "InitialPaymentOnRecurring": "unsupported",
        "RecurringRequiresInitialPayment": false,
        "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"
              }
            ]
          }
        ],
        "Name": "PaymentHub-SEPA",
        "Target": [
          {
            "Name": "PRIMARY-BANK-ACCOUNT",
            "publicTarget": "PaymentHub-SEPA"
          }
        ]
      }
    ]
  }
}

Was this page helpful?