Skip to main content
POST
Create a Routing
Creates a routing for one (account_id, payment_method) pair. Each routing references connections by their connection_id. Make sure your connections are created and ACTIVE for the requested payment_method before you call routing. Outputs that reference a decline, Merchant Advice Code or succeeded group by group_id need that group to exist on the account too — see Outcome groups.

Body

string (UUID)
required
The merchant account ID this routing rule applies to.
enum
required
E.g., CARD, PIX, WALLET. Immutable per routing — to route a different method, create a new routing.
string
required
Free-form label.
object
required
The route used when no condition_sets[] matches.
object[]
Optional. Ordered by sort_number — first matching set wins.

Response

string
Unique identifier for the routing.
string
Unique identifier for the account.
enum
The payment method this routing applies to (e.g., CARD).
string
Label for the routing.
object
The default routing logic, in the shape described in Retrieve a Routing.
object[]
Optional conditional logic.
string
ISO 8601 timestamp.
string
ISO 8601 timestamp.

Errors

Authorizations

PUBLIC-API-KEY
string
header
default:<Your PUBLIC-API-KEY>
required
PRIVATE-SECRET-KEY
string
header
default:<Your PRIVATE-SECRET-KEY>
required

Headers

X-Idempotency-Key
string<uuid>
required

Body

application/json
account_id
string<uuid>
required
Example:

"7825fc5e-e50a-4248-9ae8-5d3786afb0be"

payment_method
string
required
Example:

"CARD"

name
string
required
Example:

"Card routing"

default_route
object
required
condition_sets
object[]

Optional. Ordered by sort_number, first matching set wins.

Response

Created

id
string
Example:

"8f2c1d3e-4b5a-4c7d-8e9f-0a1b2c3d4e5f"

account_id
string
Example:

"acc-uuid"

payment_method
string
Example:

"CARD"

name
string
Example:

"Card routing"

default_route
object
condition_sets
object[]
created_at
string<date-time>
Example:

"2026-05-12T14:30:00Z"

updated_at
string<date-time>
Example:

"2026-05-12T14:30:00Z"