Salesforce Payments Management API

GET Retrieve the payment settings associated with a specific channel.

GET /commerce/management/channels/${channelId}/payment/settings

Operation ID: getChannelPaymentSettings.

Parameters

• channelId (path, string, required, style: simple) ID of the channel.

Responses

• 200 Success

  Media type: application/json. Schema: ChannelPaymentSettingsOutputRepresentation.

  Example: GetPaymentSettingsSuccess Details of the channel payment settings.

  {
    "merchantAccountId": "8zbSG0000009Rc5YAE",
    "stripeAccountId": "acct_1PYNXfIdWE9Sjzxm",
    "paymentMethodSetDevName": "AMER_US",
    "isSavedPaymentMethodSharingEnabled": true,
    "isManualCaptureEnabled": true,
    "isBusinessAchEnabled": true
  }

• 401 Unauthorized Access

  Media type: application/json.

  Example: NoAccessError User do not have right permission

  {
    "errorCode": "UNAUTHORIZED_ACCESS",
    "message": "You don't have access to this resource."
  }

• 404 Resource Not Found

  Media type: application/json.

  Example: InvalidChannelId Invalid ChannelId is provided

  {
    "errorCode": "RESOURCE_NOT_FOUND",
    "message": "Provide a valid channelId."
  }