Create Processor Route

POST

/api/:account_id/processor-routes/

Create a new processor route. A processor route is an ordered list of processors to use for card checkout.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

account_idstringRequired

This endpoint expects an object.

namestringRequired<=255 characters

Route name

processorslist of objectsRequired

Ordered list of processors

descriptionstring or nullOptional

Route description

Successful Response

idstring

Unique route identifier

namestring

Route name

processorslist of objects

Ordered list of processors

created_atdatetime

When the route was created

updated_atdatetime

When the route was last updated

descriptionstring or nullOptional

Route description

422

Unprocessable Entity Error

$	curl -X POST https://app.paymentkit.com/api/account_id/processor-routes/ \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "Primary Route",
>	"processors": [
>	{
>	"processor_id": "proc_live_stripe"
>	},
>	{
>	"processor_id": "proc_live_paypal"
>	}
>	]
>	}'

1	{
2	"id": "proute_live_a1b2c3d4e5f6",
3	"name": "Primary Route",
4	"processors": [
5	{
6	"processor_id": "proc_live_stripe"
7	},
8	{
9	"processor_id": "proc_live_paypal"
10	}
11	],
12	"created_at": "2024-04-10T14:22:00Z",
13	"updated_at": "2024-04-10T14:22:00Z",
14	"description": "Route for processing primary payment methods"
15	}