Payment Processors (classic)

Informational resource that returns a list of all available and active payment processors that can be used to perform a payment, and the active payment methods which they support. A payment processor 'processes' the payment. Some Payment Processors require additional parameters to be passed. The API returns these with instructions in the 'Parameters' block in the response.

get/PaymentProcessors

Retrieve Payment Processors (classic)

Return a list of payment processors configured in the Salesforce environment and related Payment Methods.

Responses

Response examples

API was called successfully. Please look at the response code for further information!

{
  "ResponseCode": "001",
  "IsSuccess": true,
  "Processors": [
    {
      "SupportsRecurring": false,
      "RequiresAuthorization": true,
      "Parameters": [
        {
          "Required": true,
          "Name": "PAYMENT_PROFILE",
          "Description": "The payment profile object contains card or bank information.",
          "DataType": "Id"
        }
      ],
      "Name": "PaymentHub-SEPA",
      "PaymentMethods": "DirectDebit",
      "Target": [
        {
          "Name": "PRIMARY-BANK-ACCOUNT",
          "GlobalTarget": "PaymentHub-SEPA"
        }
      ]
    }
  ]
}

Was this page helpful?