Update a payment processor

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/settings/payment_processors/1e1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "payment_processor": {
      "description": "Cash taken at the counter",
      "credentials": {
        "maximumRetryOnFailure": "0"
      }
    }
  }'

from exsited import build_client

client = build_client()

response = client.settings.update_settings_payment_processor(
    "1e1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
    {
        "payment_processor": {
            "description": "Cash taken at the counter",
            "credentials": {"maximumRetryOnFailure": "0"},
        }
    },
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.settings.updateSettingsPaymentProcessor('1e1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d', {
    payment_processor: {description: 'Cash taken at the counter', credentials: {maximumRetryOnFailure: '0'}},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->settings->updateSettingsPaymentProcessor('1e1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d', [
    'payment_processor' => [
        'description' => 'Cash taken at the counter',
        'credentials' => ['maximumRetryOnFailure' => '0'],
    ],
]);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.settings.settings_dto.SettingsDto.SettingsPaymentProcessorSaved;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsPaymentProcessorSaved> response = client.settings().updateSettingsPaymentProcessor(
        "1e1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
        Map.of(
                "payment_processor", Map.of(
                        "description", "Cash taken at the counter",
                        "credentials", Map.of("maximumRetryOnFailure", "0"))));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Settings.UpdateSettingsPaymentProcessorAsync(
    "1e1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
    new Dictionary<string, object?>
    {
        ["payment_processor"] = new Dictionary<string, object?>
        {
            ["description"] = "Cash taken at the counter",
            ["credentials"] = new Dictionary<string, object?>
            {
                ["maximumRetryOnFailure"] = "0",
            },
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.settings.updateSettingsPaymentProcessor(
  '1e1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d',
  {
    'payment_processor': {
      'description': 'Cash taken at the counter',
      'credentials': {'maximumRetryOnFailure': '0'},
    },
  },
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Settings().UpdateSettingsPaymentProcessor(context.Background(), "1e1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d", map[string]any{
	"payment_processor": map[string]any{
		"description": "Cash taken at the counter",
		"credentials": map[string]any{"maximumRetryOnFailure": "0"},
	},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "payment_processor": {
    "accounting_code": "<unknown>",
    "conversion_rate": 123,
    "created_by": "<unknown>",
    "created_on": "<string>",
    "credentials": "<unknown>",
    "currency": {
      "code": "<string>",
      "href": "<string>",
      "id": "<string>",
      "name": "<string>",
      "object": "<string>"
    },
    "description": "<string>",
    "disconnected": true,
    "display_name": "<string>",
    "gateway_name": "<string>",
    "gateway_type": "<string>",
    "href": "<string>",
    "id": "<string>",
    "integration_state": "<string>",
    "is_default": true,
    "is_foreign_currency": true,
    "last_updated_by": "<unknown>",
    "last_updated_on": "<string>",
    "name": "<string>",
    "object": "<string>",
    "provider": "<string>",
    "status": "<string>",
    "version": 123
  }
}

PATCH

settings

payment_processors

{payment_processor_id}

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/settings/payment_processors/1e1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "payment_processor": {
      "description": "Cash taken at the counter",
      "credentials": {
        "maximumRetryOnFailure": "0"
      }
    }
  }'

from exsited import build_client

client = build_client()

response = client.settings.update_settings_payment_processor(
    "1e1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
    {
        "payment_processor": {
            "description": "Cash taken at the counter",
            "credentials": {"maximumRetryOnFailure": "0"},
        }
    },
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.settings.updateSettingsPaymentProcessor('1e1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d', {
    payment_processor: {description: 'Cash taken at the counter', credentials: {maximumRetryOnFailure: '0'}},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->settings->updateSettingsPaymentProcessor('1e1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d', [
    'payment_processor' => [
        'description' => 'Cash taken at the counter',
        'credentials' => ['maximumRetryOnFailure' => '0'],
    ],
]);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.settings.settings_dto.SettingsDto.SettingsPaymentProcessorSaved;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsPaymentProcessorSaved> response = client.settings().updateSettingsPaymentProcessor(
        "1e1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
        Map.of(
                "payment_processor", Map.of(
                        "description", "Cash taken at the counter",
                        "credentials", Map.of("maximumRetryOnFailure", "0"))));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Settings.UpdateSettingsPaymentProcessorAsync(
    "1e1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
    new Dictionary<string, object?>
    {
        ["payment_processor"] = new Dictionary<string, object?>
        {
            ["description"] = "Cash taken at the counter",
            ["credentials"] = new Dictionary<string, object?>
            {
                ["maximumRetryOnFailure"] = "0",
            },
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.settings.updateSettingsPaymentProcessor(
  '1e1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d',
  {
    'payment_processor': {
      'description': 'Cash taken at the counter',
      'credentials': {'maximumRetryOnFailure': '0'},
    },
  },
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Settings().UpdateSettingsPaymentProcessor(context.Background(), "1e1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d", map[string]any{
	"payment_processor": map[string]any{
		"description": "Cash taken at the counter",
		"credentials": map[string]any{"maximumRetryOnFailure": "0"},
	},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "payment_processor": {
    "accounting_code": "<unknown>",
    "conversion_rate": 123,
    "created_by": "<unknown>",
    "created_on": "<string>",
    "credentials": "<unknown>",
    "currency": {
      "code": "<string>",
      "href": "<string>",
      "id": "<string>",
      "name": "<string>",
      "object": "<string>"
    },
    "description": "<string>",
    "disconnected": true,
    "display_name": "<string>",
    "gateway_name": "<string>",
    "gateway_type": "<string>",
    "href": "<string>",
    "id": "<string>",
    "integration_state": "<string>",
    "is_default": true,
    "is_foreign_currency": true,
    "last_updated_by": "<unknown>",
    "last_updated_on": "<string>",
    "name": "<string>",
    "object": "<string>",
    "provider": "<string>",
    "status": "<string>",
    "version": 123
  }
}

Send the fields to change under payment_processor. Like a create, the update is refused unless it carries credentials.maximumRetryOnFailure as "0" or "1".

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token. To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its -d payload.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

payment_processor_id

string

required

The payment processor's id, as a listing or a create returns it.

Body

application/json

payment_processor

object

required

Show child attributes

Response

200 - application/json

The updated payment processor, under payment_processor.

payment_processor

object

Show child attributes

Guides

API reference

Authorizations

Path Parameters

Body

Response